diff options
author | Christoph Burschka | 2013-12-30 02:43:36 +0100 |
---|---|---|
committer | Christoph Burschka | 2013-12-30 02:43:36 +0100 |
commit | 76f95b2d3e9d0372d013d455b67aa18e151c2f6f (patch) | |
tree | 918f453f9e7df3970b6f22d7f1f4d1bdfb78a537 | |
parent | Markdown doesn't like <> brackets. (diff) | |
download | ejabberd-auth-php-76f95b2d3e9d0372d013d455b67aa18e151c2f6f.tar.gz |
Explain how the class methods work.
-rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -19,8 +19,13 @@ In order to create a new plugin named {xyz}, you will need the following: * A class extending EjabberdAuthBridge and implementing its methods. * A file named {xyz}.module that contains the function {xyz}_init(). -* {xyz}_init() will receive its appropriate conf array in config.php. -* {xyz}_init() must return an instance of the extended class. + +{xyz}_init() will receive its appropriate conf array in config.php and must +return an instance of the extended class. + +The class methods must return boolean values indicating success or failure. +It is generally recommended NOT to allow account creation, account deletion or +password changes, and instead to simply return FALSE in these methods. ## LICENSE |