EGroupware / egroupware

phpgwapi/inc/adodb/toexport.inc.php

Doc Comments +4 added lines

@@ -60,6 +60,10 @@
 	if ($fp) fclose($fp);
 }
 
+/**
+ * @param string $sep
+ * @param string $sepreplace
+ */
 function _adodb_export(&$rs,$sep,$sepreplace,$fp=false,$addtitles=true,$quote = '"',$escquote = '"',$replaceNewLine = ' ')
 {
 	if (!$rs) return '';

phpgwapi/inc/class.accounts.inc.php

Doc Comments +4 added lines, -5 removed lines

@@ -360,7 +360,7 @@ 
 	 * All key of the returned array use the 'account_' prefix.
 	 * For backward compatibility some values are additionaly availible without the prefix, using them is depricated!
 	 *
-	 * @param int|string $id numeric account_id or string with account_lid (use of default value of 0 is depricated!!!)
+	 * @param integer $id numeric account_id or string with account_lid (use of default value of 0 is depricated!!!)
 	 * @param boolean $set_depricated_names =false set _additionaly_ the depricated keys without 'account_' prefix
 	 * @return array/boolean array with account data (keys: account_id, account_lid, ...) or false if account not found
 	 */
@@ -400,7 +400,7 @@ 
 	 * - 'account_firstname','account_lastname','account_email','account_fullname','account_phone'
 	 *
 	 * @param int|string $id
-	 * @return string|boolean json or false if not found
+	 * @return string json or false if not found
 	 */
 	function json($id)
 	{
@@ -791,7 +791,7 @@ 
 	 * Not all existing accounts are visible because off account_selection preference: 'none' or 'groupmembers'
 	 *
 	 * @param int|string $account_id nummeric account_id or account_lid
-	 * @return boolean true = account is visible, false = account not visible, null = account does not exist
+	 * @return null|boolean true = account is visible, false = account not visible, null = account does not exist
 	 */
 	function visible($account_id)
 	{
@@ -986,7 +986,6 @@ 
 	 *
 	 * @param string $account_lid
 	 * @param string $passwd
-	 * @param array $GLOBALS['auto_create_acct'] values for 'firstname', 'lastname', 'email' and 'primary_group'
 	 * @return int|boolean account_id or false on error
 	 */
 	function auto_add($account_lid, $passwd)
@@ -1106,7 +1105,7 @@ 
 	 *
 	 * We use now an instance-wide read-cache storing account-data and members(hips).
 	 *
-	 * @param int|array $account_ids user- or group-id(s) for which cache should be invalidated, default 0 = only search/name2id cache
+	 * @param integer $account_ids user- or group-id(s) for which cache should be invalidated, default 0 = only search/name2id cache
 	 */
 	static function cache_invalidate($account_ids=0)
 	{

phpgwapi/inc/class.accounts_ads.inc.php

Doc Comments +5 added lines, -5 removed lines

@@ -129,7 +129,7 @@ 
 	/**
 	 * Factory method and singelton to get adLDAP object for given configuration or default server config
 	 *
-	 * @param array $config=null values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection'
+	 * @param array $config values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection'
 	 * @return adLDAP
 	 * @throws adLDAPException
 	 */
@@ -1138,7 +1138,7 @@ 
 	 *
 	 * @param int $_account_id
 	 * @param string $ip
-	 * @return int lastlogin time
+	 * @return boolean lastlogin time
 	 */
 	function update_lastlogin($_account_id, $ip)
 	{
@@ -1335,7 +1335,7 @@ 
 	 * - activate user
 	 *
 	 * @param array $attributes The attributes to set to the user account
-	 * @return bool
+	 * @return string|boolean
 	 */
 	public function create($attributes)
 	{
@@ -1525,7 +1525,7 @@ 
     * @param string $username The username to query
     * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
     * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
+    * @return string|boolean
     */
     public function modify($username, $attributes, $isGUID = false)
     {
@@ -1590,7 +1590,7 @@ 
 	 * Extended to allow to specify $attribute["container"] as string, because array hardcodes "OU=", while Samba4 and win2008r2 uses "CN=Users"
 	 *
 	 * @param array $attributes Default attributes of the group
-	 * @return bool
+	 * @return string|boolean
 	 */
 	public function create($attributes)
 	{

phpgwapi/inc/class.accounts_ldap.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -190,7 +190,7 @@ 
 	 * If no account_id is set in data the account is added and the new id is set in $data.
 	 *
 	 * @param array $data array with account-data
-	 * @return int|boolean the account_id or false on error
+	 * @return false|string the account_id or false on error
 	 */
 	function save(&$data)
 	{
@@ -995,7 +995,7 @@ 
 	 *
 	 * @param int $_account_id
 	 * @param string $ip
-	 * @return int lastlogin time
+	 * @return boolean lastlogin time
 	 */
 	function update_lastlogin($_account_id, $ip)
 	{
@@ -1097,7 +1097,6 @@ 
 	 * @param int $gid gidnumber of group to set
 	 * @param array $objectclass =null should we set the member and uniqueMember attributes (groupOf(Unique)Names|univentionGroup) (default detect it)
 	 * @param string $use_cn =null if set $cn is used instead $gid and the attributes are returned, not written to ldap
-	 * @param boolean $uniqueMember =null should we set the uniqueMember attribute (default detect it)
 	 * @return boolean/array false on failure, array or true otherwise
 	 */
 	function set_members($members, $gid, array $objectclass=null, $use_cn=null)

phpgwapi/inc/class.accounts_sql.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -639,7 +639,7 @@
 	 *
 	 * @param int $account_id
 	 * @param string $ip
-	 * @return int lastlogin time
+	 * @return string|boolean lastlogin time
 	 */
 	function update_lastlogin($account_id, $ip)
 	{

phpgwapi/inc/class.accounts_univention.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
 	 * If no account_id is set in data the account is added and the new id is set in $data.
 	 *
 	 * @param array $data array with account-data
-	 * @return int|boolean the account_id or false on error
+	 * @return false|string the account_id or false on error
 	 */
 	function save(&$data)
 	{

phpgwapi/inc/class.asyncservice.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -324,7 +324,7 @@ 
 	 * cancels a timer
 	 *
 	 * @param string $id has to be the one used to set it.
-	 * @return boolean True if the timer exists and is not expired.
+	 * @return integer True if the timer exists and is not expired.
 	 */
 	function cancel_timer($id)
 	{
@@ -470,7 +470,7 @@ 
 	/**
 	 * reads all matching db-rows / jobs
 	 *
-	 * @param string $id =0 reads all expired rows / jobs ready to run\
+	 * @param integer $id =0 reads all expired rows / jobs ready to run\
 	 * 	!= 0 reads all rows/jobs matching $id (sql-wildcards '%' and '_' can be used)
 	 * @param array|string $cols ='*' string or array of column-names / select-expressions
 	 * @param int|bool $offset =False offset for a limited query or False (default)
@@ -558,7 +558,7 @@ 
 	/**
 	 * delete db-row / job with $id
 	 *
-	 * @return boolean False if $id not found else True
+	 * @return integer False if $id not found else True
 	 */
 	function delete($id)
 	{

phpgwapi/inc/class.auth.inc.php

Doc Comments +4 added lines, -3 removed lines

@@ -59,8 +59,8 @@ 
 	 * check if users are supposed to change their password every x sdays, then check if password is of old age
 	 * or the devil-admin reset the users password and forced the user to change his password on next login.
 	 *
-	 * @param string& $message =null on return false: message why password needs to be changed
-	 * @return boolean true: all good, false: password change required, null: password expires in N days
+	 * @param string $message =null on return false: message why password needs to be changed
+	 * @return boolean|null true: all good, false: password change required, null: password expires in N days
 	 */
 	static function check_password_change(&$message=null)
 	{
@@ -386,6 +386,7 @@ 
 	 * @param string $form_val user input value for comparison
 	 * @param string $db_val   stored value / hash (from database)
 	 * @param string &$type    detected crypt type on return
+	 * @param string $type
 	 * @return boolean	 True on successful comparison
 	*/
 	static function crypt_compare($form_val, $db_val, &$type)
@@ -598,7 +599,7 @@ 
 	 * @param string $forbid_name =null if "yes" username or full-name split by delimiters AND longer then 3 chars are
 	 *  forbidden to be included in password, default to whatever set in config for "passwd_forbid_name"
 	 * @param array|int $account =null array with account_lid and account_fullname or account_id for $forbid_name check
-	 * @return mixed false if password is considered "safe" (or no requirements) or a string $message if "unsafe"
+	 * @return string|false false if password is considered "safe" (or no requirements) or a string $message if "unsafe"
 	 */
 	static function crackcheck($passwd, $reqstrength=null, $minlength=null, $forbid_name=null, $account=null)
 	{

phpgwapi/inc/class.auth_pam.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 	 *
 	 * @param string $old_passwd must be cleartext or empty to not to be checked
 	 * @param string $new_passwd must be cleartext
-	 * @param int $account_id=0 account id of user whose passwd should be changed
+	 * @param int $account_id account id of user whose passwd should be changed
 	 * @return boolean true if password successful changed, false otherwise
 	 */
 	function change_password($old_passwd, $new_passwd, $account_id=0)