update README to reflect inclusion in squirrelmail-core-plugins

[squirrelmail.git] / plugins / change_password / backend / template.php

diff --git a/plugins/change_password/backend/template.php b/plugins/change_password/backend/template.php
index 2669fc2248ad0200887070b0bd545d9d745d9b51..0417683388e53423d101f311df9f4e099d623546 100644 (file)
--- a/plugins/change_password/backend/template.php
+++ b/plugins/change_password/backend/template.php
@@ -1,11 +1,17 @@
 <?php
-/*
- This is a template for a password changing mechanism. Currently,
- this contains two parts: the first is to register your function
- in the squirrelmail_plugin_hooks global, and the second is
- the function that does the actual changing.
-
- Replace the word template everywhere with a name for your backend.
+/**
+ * Change password backend template
+ *
+ * This is a template for a password changing mechanism. Currently,
+ * this contains two parts: the first is to register your function
+ * in the squirrelmail_plugin_hooks global, and the second is
+ * the function that does the actual changing.
+ *
+ * Replace the word template everywhere with a name for your backend.
+ *
+ * @version $Id$
+ * @package plugins
+ * @subpackage change_password
  */
 
 /**
@@ -17,8 +23,22 @@
  * Define here the name of your password changing function.
  */
 global $squirrelmail_plugin_hooks;
-$squirrelmail_plugin_hooks['change_password_dochange']['template'] = 
-       'cpw_template_dochange';
+$squirrelmail_plugin_hooks['change_password_dochange']['template'] =
+        'cpw_template_dochange';
+$squirrelmail_plugin_hooks['change_password_init']['template'] =
+        'cpw_template_init';
+
+
+/**
+ * Use this function to do any backend-specific initialization,
+ * e.g. checking requirements, before the password change form
+ * is displayed to the user.
+ */
+function cpw_template_init()
+{
+
+}
+
 
 /**
  * This is the function that is specific to your backend. It takes
@@ -30,7 +50,7 @@ $squirrelmail_plugin_hooks['change_password_dochange']['template'] =
  * CPW_CURRENT_NOMATCH -> "Your current password is not correct."
  * CPW_INVALID_PW -> "Your new password contains invalid characters."
  *
- * @param array data The username/currentpw/newpw data. 
+ * @param array data The username/currentpw/newpw data.
  * @return array Array of error messages.
  */
 function cpw_template_dochange($data)
@@ -48,4 +68,4 @@ function cpw_template_dochange($data)
     user_error('No valid backend defined: this is just a template', E_USER_ERROR);
 
     return $msgs;
-}
+}
\ No newline at end of file