EGroupware / egroupware

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/Handler.php

Doc Comments +3 added lines, -4 removed lines

@@ -151,7 +151,7 @@ 
 	 *
 	 * @param string $path
 	 * @param array $filter
-	 * @param array|boolean $start false=return all or array(start,num)
+	 * @param integer[] $start false=return all or array(start,num)
 	 * @param int &$total
 	 * @return array with "files" array with values for keys path and props
 	 */
@@ -193,7 +193,6 @@ 
 	 * Read an entry
 	 *
 	 * @param string|int $id
-	 * @param string $path =null implementation can use it, used in call from _common_get_put_delete
 	 * @return array|boolean array with entry, false if no read rights, null if $id does not exist
 	 */
 	abstract function read($id /*,$path=null*/);
@@ -238,7 +237,7 @@ 
 	 * Get the etag for an entry, can be reimplemented for other algorithm or field names
 	 *
 	 * @param array|int $entry array with event or cal_id
-	 * @return string|boolean string with etag or false
+	 * @return false|string string with etag or false
 	 */
 	function get_etag($entry)
 	{
@@ -423,7 +422,7 @@ 
 	/**
 	 * Identify know GroupDAV agents by HTTP_USER_AGENT header
 	 *
-	 * @return string|boolean agent name or false
+	 * @return string|false agent name or false
 	 */
 	static function get_agent()
 	{

api/src/CalDAV/Principals.php

Doc Comments +8 added lines, -11 removed lines

@@ -256,7 +256,7 @@ 
 	 * @param array &$options
 	 * @param array &$files
 	 * @param int $user account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function expand_property_report($path,&$options,&$files,$user)
 	{
@@ -1191,7 +1191,7 @@ 
 	 * Check if resource is a location
 	 *
 	 * @param array|int $resource
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	public static function resource_is_location($resource)
 	{
@@ -1470,7 +1470,6 @@ 
 	 * Get proxy-groups for given user $account: users or groups who GRANT proxy rights to $account
 	 *
 	 * @param int $account who is the proxy
-	 * @param string|array $app_proxys =null applications for which proxys should be added
 	 * @return array with href props
 	 */
 	protected function get_resource_proxy_groups($account)
@@ -1608,8 +1607,6 @@ 
 	/**
 	 * Do propfind of /principals/
 	 *
-	 * @param string $name name of group or empty
-	 * @param string $rest name of rest of path behind group-name
 	 * @param array $options
 	 * @return array|string array with files or HTTP error code
 	 */
@@ -1640,7 +1637,7 @@ 
 	 * @param array &$options
 	 * @param int $id
 	 * @param int $user =null account_id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function get(&$options,$id,$user=null)
 	{
@@ -1655,7 +1652,7 @@ 
 	 * @param array &$options
 	 * @param int $id
 	 * @param int $user =null account_id of owner, default null
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function put(&$options,$id,$user=null)
 	{
@@ -1669,7 +1666,7 @@ 
 	 *
 	 * @param array &$options
 	 * @param int $id
-	 * @return mixed boolean true on success, false on failure or string with http status (eg. '404 Not Found')
+	 * @return boolean boolean true on success, false on failure or string with http status (eg. '404 Not Found')
 	 */
 	function delete(&$options,$id)
 	{
@@ -1681,7 +1678,7 @@ 
 	/**
 	 * Read an entry
 	 *
-	 * @param string|int $id
+	 * @param integer $id
 	 * @return array/boolean array with entry, false if no read rights, null if $id does not exist
 	 */
 	function read($id)
@@ -1696,7 +1693,7 @@ 
 	 *
 	 * @param int $acl Api\Acl::READ, Api\Acl::EDIT or Api\Acl::DELETE
 	 * @param array|int $entry entry-array or id
-	 * @return boolean null if entry does not exist, false if no access, true if access permitted
+	 * @return null|boolean null if entry does not exist, false if no access, true if access permitted
 	 */
 	function check_access($acl,$entry)
 	{
@@ -1739,7 +1736,7 @@ 
 	 *
 	 * @param string $path path of collection
 	 * @param int $user =null owner of the collection, default current user
-	 * @return array with privileges
+	 * @return string[] with privileges
 	 */
 	public function current_user_privileges($path, $user=null)
 	{

api/src/CalDAV/PropfindIterator.php

Doc Comments +1 added lines

@@ -94,6 +94,7 @@
 	 * @param Handler $handler
 	 * @param array $filter filter for propfind call
 	 * @param array $files =array() extra files/responses to return too
+	 * @param string $path
 	 */
 	public function __construct(Handler $handler, $path, array $filter,array &$files=array())
 	{

api/src/Categories.php

Doc Comments +6 added lines, -6 removed lines

@@ -322,13 +322,13 @@ 
 	 * return a sorted array populated with categories (main sorting criteria is hierachy!)
 	 *
 	 * @param int $start =0 see $limit
-	 * @param boolean|int $limit if true limited query to maxmatches rows (starting with $start)
+	 * @param boolean $limit if true limited query to maxmatches rows (starting with $start)
 	 * @param string $query ='' query-pattern
 	 * @param string $sort ='ASC' sort order, either defaults to 'ASC'
 	 * @param string $order ='cat_name' order by
 	 * @param boolean|string $globals includes the global egroupware categories or not,
 	 * 	'all_no_acl' to return global and all non-private user categories independent of ACL
-	 * @param array|int $parent_id =0 return only subcats of $parent_id(s)
+	 * @param integer $parent_id =0 return only subcats of $parent_id(s)
 	 * @param boolean $unserialize_data =true return $cat['data'] as array (not serialized array)
 	 * @return array with cats
 	 */
@@ -507,7 +507,7 @@ 
 	 * @param mixed $category category as array or the category_id
 	 * @param boolean $no_acl_check =false if true, grants are NOT checked, gives access to all non-private categories of all users
 	 * @param boolean $allow_global_read if true, global cats are allowed (independent of app) for reading
-	 * @return boolean true permission granted, false for permission denied, null for category does not exist
+	 * @return null|boolean true permission granted, false for permission denied, null for category does not exist
 	 */
 	public function check_perms($needed, $category, $no_acl_check=false, $allow_global_read=false)
 	{
@@ -675,7 +675,7 @@ 
 	 * check_consistency4update - for edit
 	 *
 	 * @param array $values array with cat-data (it need to be complete, as everything get's written)
-	 * @return mixed string/boolean errorstring if consitency check failed / true if the consistency check did not fail
+	 * @return string|boolean string/boolean errorstring if consitency check failed / true if the consistency check did not fail
 	 */
 	function check_consistency4update($values)
 	{
@@ -822,7 +822,7 @@ 
 	 *
 	 * @param int|array $cat
 	 * @param boolean $application_global =false true check for application global categories only (appname == 'phpgw')
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	static function is_global($cat,$application_global=false)
 	{
@@ -1030,7 +1030,7 @@ 
 	 *
 	 * @param string appname
 	 *
-	 * @return Returns the URL, but you do not need to do anything with it.
+	 * @return string the URL, but you do not need to do anything with it.
 	 */
 	public static function css($appname)
 	{