EGroupware / egroupware

admin/inc/class.admin_ui.inc.php

Doc Comments +4 added lines

@@ -491,6 +491,10 @@
 	protected static function call_hook()
 	{
 		self::$hook_data = array();
+
+		/**
+		 * @param string $appname
+		 */
 		function display_section($appname,$file,$file2=False)
 		{
 			admin_ui::$hook_data[$appname] = $file2 ? $file2 : $file;

admin/inc/class.customfields.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -548,7 +548,7 @@
 	 * Validate and create a new content type
 	 *
 	 * @param array $content
-	 * @return string|boolean New type ID, or false for error
+	 * @return false|string New type ID, or false for error
 	 */
 	function create_content_type(&$content)
 	{

api/src/Accounts.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)
 	{

api/src/Accounts/Ldap.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)

api/src/Accounts/Univention.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)
 	{

api/src/Acl.php

Doc Comments +3 added lines, -3 removed lines

@@ -166,7 +166,7 @@ 
 	 * Delete ACL record in the repository of the class
 	 *
 	 * @param string $appname appname or '' for $GLOBALS['egw_info']['flags']['currentapp']
-	 * @param string/boolean $location location or false for all locations
+	 * @param boolean $location location or false for all locations
 	 * @return array all ACL records from $this->data.
 	 */
 	function delete($appname,$location)
@@ -267,8 +267,8 @@ 
 	/**
 	 * check required rights agains the internal repository (included rights of $this->account_id and all it's memberships)
 	 *
-	 * @param $location app location
-	 * @param $required required right to check against
+	 * @param string $location app location
+	 * @param integer $required required right to check against
 	 * @param $appname optional defaults to currentapp
 	 * @return boolean
 	 */

api/src/Asyncservice.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)
 	{

api/src/Auth.php

Doc Comments +5 added lines, -4 removed lines

@@ -84,8 +84,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)
 	{
@@ -294,7 +294,7 @@ 
 	 *
 	 * uses the encryption type set in setup and calls the appropriate encryption functions
 	 *
-	 * @param $password password to encrypt
+	 * @param string $password password to encrypt
 	 */
 	static function encrypt_password($password,$sql=False)
 	{
@@ -406,6 +406,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)
@@ -618,7 +619,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)
 	{

api/src/CalDAV.php

Doc Comments +11 added lines, -9 removed lines

@@ -311,6 +311,8 @@ 
 	 * @param string $path
 	 * @param array &$dav
 	 * @param array &$allow
+	 * @param integer[] $dav
+	 * @param boolean $allow
 	 */
 	function OPTIONS($path, &$dav, &$allow)
 	{
@@ -606,7 +608,7 @@ 
 	 * @param string $path / or /<username>/
 	 * @param int $user
 	 * @param int $depth
-	 * @return string|boolean http status or true|false
+	 * @return boolean http status or true|false
 	 */
 	protected function add_home(array &$files, $path, $user, $depth)
 	{
@@ -738,7 +740,7 @@ 
 	 * @param string $path /<username>/
 	 * @param int $app
 	 * @param int $user
-	 * @return string|boolean http status or true|false
+	 * @return boolean http status or true|false
 	 */
 	protected function add_shared(array &$files, $path, $app, $user)
 	{
@@ -1380,7 +1382,7 @@ 
 	 * @param int|string $id
 	 * @param array $attach array of array with values for keys 'name', 'params', 'value'
 	 * @param boolean $delete_via_put
-	 * @return boolean false on error, eg. invalid managed id, for false an xml-error body has been send
+	 * @return null|false false on error, eg. invalid managed id, for false an xml-error body has been send
 	 */
 	public static function handle_attach($app, $id, $attach, $delete_via_put=false)
 	{
@@ -1584,7 +1586,7 @@ 
 	 * @param string $managed_id
 	 * @param string $app =null app-name to check against path
 	 * @param string|int $id =null id to check agains path
-	 * @return string|boolean "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id
+	 * @return false|string "/apps/$app/$id/something" or false if not found or not belonging to given $app/$id
 	 */
 	static public function managed_id2path($managed_id, $app=null, $id=null)
 	{
@@ -1783,7 +1785,7 @@ 
 	 * MKCOL method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MKCOL($options)
 	{
@@ -1796,7 +1798,7 @@ 
 	 * MOVE method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function MOVE($options)
 	{
@@ -1809,7 +1811,7 @@ 
 	 * COPY method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function COPY($options, $del=false)
 	{
@@ -1822,7 +1824,7 @@ 
 	 * LOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string|boolean   true on success
 	 */
 	function LOCK(&$options)
 	{
@@ -1856,7 +1858,7 @@ 
 	 * UNLOCK method handler
 	 *
 	 * @param  array  general parameter passing array
-	 * @return bool   true on success
+	 * @return string   true on success
 	 */
 	function UNLOCK(&$options)
 	{