/**
* setStateID - call this before getDocuments() if you want to limit to a specific state.
*
- * @param integer The stateid from the doc_states table.
+ * @param int $stateid The stateid from the doc_states table.
* @access public
*/
function setStateID($stateid) {
/**
* setDocGroupID - call this before getDocuments() if you want to limit to a specific doc_group.
*
- * @param integer The doc_group from the doc_groups table.
+ * @param int $docgroupid The doc_group from the doc_groups table.
* @access public
*/
function setDocGroupID($docgroupid) {
/**
* setSort - call this before getDocuments() if you want to order the query.
*
- * @param string ASC or DESC : default ASC
+ * @param string $sort ASC or DESC : default ASC
* @access public
*/
function setSort($sort) {
/**
* setOrder - call this before getDocuments() if you want to sort the query.
*
- * @param array Ordered Columns names: default title
+ * @param array $columns Ordered Columns names: default title
* @access public
*/
function setOrder($columns = array('title')) {
/**
* buildArrays - Build the arrays to call html_build_select_box_from_arrays()
*
- * @param array Array of groups.
- * @param array Reference to the array of ids that will be build
- * @param array Reference to the array of group names
- * @param array Array of IDs of groups that should not be displayed
- * @param int The ID of the parent whose childs are being showed (0 for root groups)
- * @param int The current level
+ * @param array $group_arr Array of groups.
+ * @param array $id_array Reference to the array of ids that will be build
+ * @param array $text_array Reference to the array of group names
+ * @param array $dont_display Array of IDs of groups that should not be displayed
+ * @param int $parent The ID of the parent whose childs are being showed (0 for root groups)
+ * @param int $level The current level
*/
function buildArrays($group_arr, &$id_array, &$text_array, &$dont_display, $parent = 0, $level = 0) {
if (!is_array($group_arr) || !array_key_exists("$parent", $group_arr)) return;
/**
* checkAuth - implement checkAuth called by HTTP_WebDAV_Server
- * to ensure authentification against user and pass
+ * to ensure authentication against user and pass
*
- * @param int group id
- * @param string username
- * @param string password
+ * @param int $group_id group id
+ * @param string $user username
+ * @param string $pass password
* @return bool success
*/
function checkAuth($group_id, $user, $pass) {
/**
* Function PrintAttachLink
*
- * @param object The message.
- * @param int The group id.
- * @param int The forum id.
+ * @param object $msg The message.
+ * @param int $group_id The group id.
+ * @param int $forum_id The forum id.
*
* @return returns link to attachment /delete if corresponding; else returns a message about no attachment found
*/
/**
* PrintAdminOptions - prints the administrator option for an individual forum, to link to the pending messages management
*
- * @param int The Forum ID.
+ * @param int $forum_id The Forum ID.
*/
function PrintAdminPendingOption($forum_id) {
$res1 = db_query_params ('SELECT * FROM forum_pending_messages WHERE msg_id=$1',
array ($msgids[$i]));
if (!$res1) {
- $error_msg .= "DB Error: " . db_error();
+ $error_msg .= "DB Error " . db_error() . "<br />";
break;
}
$res2 = db_query_params ('SELECT * FROM forum_pending_attachment WHERE msg_id=$1',
array ($msgids[$i]));
if (!$res2) {
- $error_msg .= "DB Error " . db_error();
+ $error_msg .= "DB Error " . db_error() . "<br />";
break;
}
$f = new Forum($this->g,$forum_id);
/**
* createTracker - Create a specific tracker from data in the specified group
- * @param string Tracker type (bugs, support, ...)
- * @param Group The group which the tracker belongs to
- * @param array Tracker data from JSON
- * @return ArtifactType the tracker created
+ * @param string $tracker Tracker type (bugs, support, ...)
+ * @param Group $group The group which the tracker belongs to
+ * @param array $data Tracker data from JSON
+ * @return ArtifactType the tracker created
*/
function createTracker($tracker, $group, $data){
/**
* CallHook() - call a particular hook.
*
- * @param string the "handle" of the hook.
- * @param array array of parameters to pass the hook.
+ * @param string $hookname the "handle" of the hook.
+ * @param array $params array of parameters to pass the hook.
* @return bool true only
*/
function CallHook($hookname, &$params) {
/**
* exit_disabled() - Return a 'Disabled Feature' error
- * @param string toptab needed for navigation
+ * @param string $toptab needed for navigation
*/
function exit_disabled($toptab='') {
exit_error('DISABLED FEATURE');
/**
* gfLdapAdd() - Wrapper for ldap_add()
*
- * @param string dn
- * @param string entry
+ * @param string $dn dn
+ * @param string $entry entry
*
* @return bool
*/
/**
* gfLdapDelete() - Wrapper for ldap_delete()
*
- * @param string dn
+ * @param string $dn dn
*
* @return bool
*/
/**
* gfLdapModify() - Wrapper for ldap_modify()
*
- * @param string dn
- * @param string entry
+ * @param string $dn dn
+ * @param string $entry entry
*
* @return bool
*/
* gfLdapModifyIfExists() - Wrapper for ldap_modify()
* works like gfLdapModify, but returns true if the LDAP entry does not exist
*
- * @param string dn
- * @param string entry
+ * @param string $dn dn
+ * @param string $entry entry
*
* @return bool
*/
/**
* gfLdapModAdd() - Wrapper for ldap_mod_add()
*
- * @param string dn
- * @param string entry
+ * @param string $dn dn
+ * @param string $entry entry
*
* @return bool
*/
/**
* gfLdapModDel() - Wrapper for ldap_mod_del()
*
- * @param string dn
- * @param string entry
+ * @param string $dn dn
+ * @param string $entry entry
*
* @return bool
*/
/**
* gfLdapRead() - Wrapper for ldap_read()
*
- * @param string dn
- * @param string filter
- * @param int attrs
+ * @param string $dn dn
+ * @param string $filter filter
+ * @param int $attrs attrs
*
* @return resource
*/
/**
* sysCheckUser() - Check for the existence of a user
*
- * @param int The user ID of the user to check
- * @return boolean true on success/false on error
+ * @param int $user_id The user ID of the user to check
+ * @return bool true on success/false on error
*
*/
function sysCheckUser($user_id) {
/**
* sysCreateUser() - Create a user
*
- * @param int The user ID of the user to create
- * @return boolean success or not
+ * @param int $user_id The user ID of the user to create
+ * @return bool success or not
*
*/
function sysCreateUser($user_id) {
/**
* sysCheckCreateUser() - Check that a user has been created
*
- * @param int The ID of the user to check
- * @return boolean true on success/false on error
+ * @param int $user_id The ID of the user to check
+ * @return bool true on success/false on error
*
*/
function sysCheckCreateUser($user_id) {
/**
* sysCheckCreateGroup() - Check that a group has been created
*
- * @param int The ID of the user to check
- * @return boolean true on success/false on error
+ * @param int $user_id The ID of the user to check
+ * @return bool true on success/false on error
*
*/
function sysCheckCreateGroup($user_id) {
/**
* sysRemoveUser() - Remove a user
*
- * @param int The user ID of the user to remove
- * @return boolean true on success/false on failure
+ * @param int $user_id The user ID of the user to remove
+ * @return bool true on success/false on failure
*
*/
function sysRemoveUser($user_id) {
/**
* sysUserSetAttribute() - Set an attribute for a user
*
- * @param int The user ID
- * @param string The attribute to set
- * @param string The new value of the attribute
- * @return boolean true on success/false on error
+ * @param int $user_id The user ID
+ * @param string $attr The attribute to set
+ * @param string $value The new value of the attribute
+ * @return bool true on success/false on error
*
*/
function sysUserSetAttribute($user_id,$attr,$value) {
/**
* sysCheckGroup() - Check for the existence of a group
*
- * @param int The ID of the group to check
- * @return boolean true on success/false on error
+ * @param int $group_id The ID of the group to check
+ * @return bool true on success/false on error
*
*/
function sysCheckGroup($group_id) {
/**
* sysCreateGroup() - Create a group
*
- * @param int The ID of the group to create
- * @return bool true on success/false on error
+ * @param int $group_id The ID of the group to create
+ * @return bool true on success/false on error
*
*/
function sysCreateGroup($group_id) {
/**
* sysRemoveGroup() - Remove a group
*
- * @param int The ID of the group to remove
- * @return bool true on success/false on error
+ * @param int $group_id The ID of the group to remove
+ * @return bool true on success/false on error
*
*/
function sysRemoveGroup($group_id) {
/**
* sysGroupAddUser() - Add a user to a group
*
- * @param int The ID of the group two which the user will be added
- * @param int The ID of the user to add
- * @param bool ignored
- * @return boolean true on success/false on error
+ * @param int $group_id The ID of the group two which the user will be added
+ * @param int $user_id The ID of the user to add
+ * @param bool $foo ignored
+ * @return bool true on success/false on error
*/
function sysGroupAddUser($group_id,$user_id,$foo=NULL) {
return $this->sysGroupCheckUser($group_id,$user_id) ;
/**
* sysGroupCheckUser() - Sync user's Unix permissions with their FF permissions within a group
*
- * @param int The ID of the group
- * @param int The ID of the user
- * @return boolean true on success/false on error
+ * @param int $group_id The ID of the group
+ * @param int $user_id The ID of the user
+ * @return bool true on success/false on error
*/
function sysGroupCheckUser($group_id,$user_id) {
db_begin () ;
* conformant, but it does pass all the given
* examples (in RFC2047).
*
- * @param string Input header value to decode
+ * @param string $input Input header value to decode
* @return string Decoded header value
* @access private
*/
/**
* create - create a new ProjectGroup in the database.
*
- * @param string The project name.
- * @param string The project description.
- * @param string The email address to send new notifications to.
- * @return boolean success.
+ * @param string $project_name The project name.
+ * @param string $description The project description. * @param string The email address to send new notifications to.
+ * @param string $send_all_posts_to The email address to send new notifications to.
+ * @return bool success.
*/
function create($project_name,$description,$send_all_posts_to='') {
if (strlen($project_name) < 3) {
* Return true if given value is empty
*
* @access private
- * @param mixed Value to test
+ * @param mixed $value Value to test
* @return boolean
*/
function isValueEmpty($value) {
}
/**
- * Append feebback in the global Response object.
+ * Append feedback in the global Response object.
* @access private
*/
function addFeedback($level, $error) {
* Generate error message according to settings.
*
* Takes in account user requirement 'required' and
- * 'disableFeedback'. Empty error messages are disarded.
+ * 'disableFeedback'. Empty error messages are discarded.
* @access private
*/
function populateFeedback() {
* If the test succeeded, the error message is cleared (either custom or
* built-in messages).
* @access private
- * @param Integer Index of the Rule that was applied.
- * @param Boolean Result of the test.
+ * @param int $i Index of the Rule that was applied.
+ * @param bool $result Result of the test.
*/
function errorMessage($i, $result) {
if($result === true) {
* Apply each rule on the given value and prepare feedback.
*
* @access private
- * @param mixed Value to test.
+ * @param mixed $value Value to test.
*/
function checkEachRules($value) {
$isValid = true;
/**
* Run validation on given value.
*
- * @param mixed Value to test.
+ * @param mixed $value Value to test.
* @return bool
*/
function validate($value) {