From: psc Date: Tue, 26 Jan 2010 09:50:33 +0000 (+0000) Subject: Add some doxygen tags to the plugin class X-Git-Url: https://git.tokkee.org/?p=gosa.git;a=commitdiff_plain;h=c0faedcea78f161af50736f52b0d0d6696212a73 Add some doxygen tags to the plugin class git-svn-id: https://oss.gonicus.de/repositories/gosa/branches/2.6-lhm@15302 594d385d-05f5-0310-b6e9-bd551577e9d8 --- diff --git a/trunk/gosa-core/include/class_plugin.inc b/trunk/gosa-core/include/class_plugin.inc index b96d78f1a..d517efd5b 100644 --- a/trunk/gosa-core/include/class_plugin.inc +++ b/trunk/gosa-core/include/class_plugin.inc @@ -252,9 +252,7 @@ class plugin } - /*! \brief execute plugin - - Generates the html output for this node + /*! \brief Generates the html output for this node */ function execute() { @@ -266,8 +264,7 @@ class plugin session::set('LOCK_VARS_USED',array()); } - /*! \brief execute plugin - Removes object from parent + /*! \brief Removes object from parent */ function remove_from_parent() { @@ -305,7 +302,7 @@ class plugin } - /*! \brief Save HTML posted data to object + /*! \brief Save HTML posted data to object */ function save_object() { @@ -343,7 +340,7 @@ class plugin } - /* Save data to LDAP, depending on is_account we save or delete */ + /*! \brief Save data to LDAP, depending on is_account we save or delete */ function save() { /* include global link_info */ @@ -438,7 +435,7 @@ class plugin } } - /* Check formular input */ + /*! \brief Check formular input */ function check() { $message= array(); @@ -562,14 +559,14 @@ class plugin } } - /* Indicate whether a password change is needed or not */ + /* \brief Indicate whether a password change is needed or not */ function password_change_needed() { return FALSE; } - /* Show header message for tab dialogs */ + /*! \brief Show header message for tab dialogs */ function show_enable_header($button_text, $text, $disabled= FALSE) { if (($disabled == TRUE) || (!$this->acl_is_createable())){ @@ -585,7 +582,7 @@ class plugin } - /* Show header message for tab dialogs */ + /*! \brief Show header message for tab dialogs */ function show_disable_header($button_text, $text, $disabled= FALSE) { if (($disabled == TRUE) || !$this->acl_is_removeable()){ @@ -601,7 +598,7 @@ class plugin } - /* Show header message for tab dialogs */ + /*! \brief Show header message for tab dialogs */ function show_header($button_text, $text, $disabled= FALSE) { echo "FIXME: show_header should be replaced by show_disable_header and show_enable_header
"; @@ -618,7 +615,7 @@ class plugin return($display); } - + /*! \brief Executes commands after an object has been created */ function postcreate($add_attrs= array()) { /* Find postcreate entries for this class */ @@ -661,6 +658,7 @@ class plugin } } + /*! \brief Execute commands after an object has been modified */ function postmodify($add_attrs= array()) { /* Find postcreate entries for this class */ @@ -702,6 +700,7 @@ class plugin } } + /*! \brief Executes a command after an object has been removed */ function postremove($add_attrs= array()) { /* Find postremove entries for this class */ @@ -744,7 +743,7 @@ class plugin } } - /* Create unique DN */ + /*! \brief Create unique DN */ function create_unique_dn($attribute, $base) { $ldap= $this->config->get_ldap_link(); @@ -907,14 +906,18 @@ class plugin - /*! \brief Move a given ldap object indentified by $src_dn \ - to the given destination $dst_dn \ - * Ensure that all references are updated (ogroups) \ - * Update ACLs \ - * Update accessTo \ - @param String The source dn. - @param String The destination dn. - @return Boolean TRUE on success else FALSE. + /*! \brief Rename/Move a given src_dn to the given dest_dn + * + * Move a given ldap object indentified by $src_dn to the + * given destination $dst_dn + * + * - Ensure that all references are updated (ogroups) + * - Update ACLs + * - Update accessTo + * + * \param string 'src_dn' the source DN. + * \param string 'dst_dn' the destination DN. + * \return boolean TRUE on success else FALSE. */ function rename($src_dn, $dst_dn) { @@ -1005,7 +1008,7 @@ class plugin } - + function move($src_dn, $dst_dn) { /* Do not copy if only upper- lowercase has changed */ @@ -1046,7 +1049,7 @@ class plugin } - /* Move/Rename complete trees */ + /* \brief Move/Rename complete trees */ function recursive_move($src_dn, $dst_dn) { /* Check if the destination entry exists */ @@ -1096,6 +1099,7 @@ class plugin } + /*! \brief Prepare for Copy & Paste */ function PrepareForCopyPaste($source) { $todo = $this->attributes; @@ -1132,6 +1136,7 @@ class plugin } } + /*! \brief Get gosaUnitTag for the given DN */ function get_gosaUnitTag($dn = "") { if ($dn == "") { @@ -1167,7 +1172,8 @@ class plugin } } - + + /*! \brief Add unit tag */ function tag_attrs(&$at, $dn= "", $tag= "", $show= false) { /* Skip tagging? @@ -1211,7 +1217,11 @@ class plugin } - /* Add possibility to stop remove process */ + /*! \brief Test for removability of the object + * + * Allows testing of conditions for removal of object. If removal should be aborted + * the function needs to remove an error message. + * */ function allow_remove() { $reason= ""; @@ -1219,7 +1229,7 @@ class plugin } - /* Create a snapshot of the current object */ + /*! \brief Create a snapshot of the current object */ function create_snapshot($type= "snapshot", $description= array()) { @@ -1311,6 +1321,7 @@ class plugin } } + /*! \brief Remove a snapshot */ function remove_snapshot($dn) { $ui = get_userinfo(); @@ -1326,8 +1337,12 @@ class plugin } - /* returns true if snapshots are enabled, and false if it is disalbed - There will also be some errors psoted, if the configuration failed */ + /*! \brief Test if snapshotting is enabled + * + * Test weither snapshotting is enabled or not. There will also be some errors posted, + * if the configuration failed + * \return TRUE if snapshots are enabled, and FALSE if it is disabled + */ function snapshotEnabled() { $config = $this->config; @@ -1357,8 +1372,7 @@ class plugin } - /* Return available snapshots for the given base - */ + /* \brief Return available snapshots for the given base */ function Available_SnapsShots($dn,$raw = false) { if(!$this->snapshotEnabled()) return(array()); @@ -1484,7 +1498,7 @@ class plugin } - /* Restore selected snapshot */ + /* \brief Restore selected snapshot */ function restore_snapshot($dn) { if(!$this->snapshotEnabled()) return(array()); @@ -1618,6 +1632,7 @@ class plugin } + /*! \brief Return plugin informations for acl handling */ static function plInfo() { return array(); @@ -1691,11 +1706,12 @@ class plugin } - /*! \brief Returns a list of all available departments for this object. - If this object is new, all departments we are allowed to create a new user in are returned. - If this is an existing object, return all deps. we are allowed to move tis object too. - - @return Array [dn] => "..name" // All deps. we are allowed to act on. + /*! \brief Returns a list of all available departments for this object. + * + * If this object is new, all departments we are allowed to create a new user in + * are returned. If this is an existing object, return all deps. + * We are allowed to move tis object too. + * \return array [dn] => "..name" // All deps. we are allowed to act on. */ function get_allowed_bases() { @@ -1730,8 +1746,8 @@ class plugin /* This function updates ACL settings if $old_dn was used. - * $old_dn specifies the actually used dn - * $new_dn specifies the destiantion dn + * \param string 'old_dn' specifies the actually used dn + * \param string 'new_dn' specifies the destiantion dn */ function update_acls($old_dn,$new_dn,$output_changes = FALSE) { @@ -1815,9 +1831,10 @@ class plugin - /* This function enables the entry Serial ID check. - * If an entry was edited while we have edited the entry too, - * an error message will be shown. + /*! \brief Enable the Serial ID check + * + * This function enables the entry Serial ID check. If an entry was edited while + * we have edited the entry too, an error message will be shown. * To configure this check correctly read the FAQ. */ function enable_CSN_check() @@ -1829,7 +1846,7 @@ class plugin /*! \brief Prepares the plugin to be used for multiple edit * Update plugin attributes with given array of attribtues. - * @param array Array with attributes that must be updated. + * \param array Array with attributes that must be updated. */ function init_multiple_support($attrs,$all) { @@ -1859,7 +1876,7 @@ class plugin /*! \brief Returns all values that have been modfied in multiple edit mode. - @return array Cotaining all mdofied values. + \return array Cotaining all modified values. */ function get_multi_edit_values() { @@ -1883,10 +1900,7 @@ class plugin } - /*! \brief execute plugin - - Generates the html output for this node - */ + /*! \brief Generates the html output for this node for multi edit*/ function multiple_execute() { /* This one is empty currently. Fabian - please fill in the docu code */ @@ -1900,7 +1914,7 @@ class plugin } - /*! \brief Save HTML posted data to object for multiple edit + /*! \brief Save HTML posted data to object for multiple edit */ function multiple_save_object() { @@ -1939,7 +1953,7 @@ class plugin } - /*! \brief Returns all attributes of this plugin, + /*! \brief Returns all attributes of this plugin, to be able to detect multiple used attributes in multi_plugg::detect_multiple_used_attributes(). @return array Attributes required for intialization of multi_plug @@ -1952,7 +1966,7 @@ class plugin /*! \brief Check given values in multiple edit - @return array Error messages + \return array Error messages */ function multiple_check() { @@ -1962,7 +1976,7 @@ class plugin /*! \brief Returns the snapshot header part for "Actions" menu in management dialogs - @param $layer_menu + \param $layer_menu */ function get_snapshot_header($base,$category) {