summaryrefslogtreecommitdiff
path: root/classes/iauthmodule.php
diff options
context:
space:
mode:
Diffstat (limited to 'classes/iauthmodule.php')
-rw-r--r--classes/iauthmodule.php13
1 files changed, 12 insertions, 1 deletions
diff --git a/classes/iauthmodule.php b/classes/iauthmodule.php
index e714cc6ca..39aae4cc2 100644
--- a/classes/iauthmodule.php
+++ b/classes/iauthmodule.php
@@ -1,5 +1,16 @@
<?php
interface IAuthModule {
+ /**
+ * @param string $login
+ * @param string $password
+ * optional third string $service
+ * @return int|false user_id
+ */
function authenticate($login, $password); // + optional third parameter: $service
- function hook_auth_user(...$args); // compatibility wrapper due to how hooks work
+
+ /** this is a pluginhost compatibility wrapper that invokes $this->authenticate(...$args) (Auth_Base)
+ * @param mixed $args = ($login, $password, $service)
+ * @return int|false user_id
+ */
+ function hook_auth_user(...$args);
}