EGroupware / egroupware

api/src/Storage/Customfields.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
 	 * @param string $app
 	 * @param boolean $all_private_too =false should all the private fields be returned too, default no
 	 * @param string $only_type2 =null if given only return fields of type2 == $only_type2
-	 * @return boolen true: if there is a custom field useing html, false if not
+	 * @return boolean true: if there is a custom field useing html, false if not
 	 */
 	public static function use_html($app, $all_private_too=false, $only_type2=null)
 	{

api/src/Storage/History.php

Doc Comments +2 added lines

@@ -112,6 +112,8 @@
 
 	/**
 	 * Static function to add a history record
+	 * @param string $field_code
+	 * @param string $new_value
 	 */
 	public static function static_add($appname, $id, $user, $field_code, $new_value, $old_value = '')
 	{

api/src/Storage/Merge.php

Doc Comments +14 added lines, -7 removed lines

@@ -368,9 +368,9 @@ 
 	 *
 	 * Calls get_links() repeatedly to get all the combinations for the content.
 	 *
-	 * @param $app String appname
+	 * @param string $app String appname
 	 * @param $id String ID of record
-	 * @param $prefix
+	 * @param string $prefix
 	 * @param $content String document content
 	 */
 	protected function get_all_links($app, $id, $prefix, &$content)
@@ -530,7 +530,7 @@ 
 	 * @param mixed $app_limit app_limit, if not set checks the global limit
 	 * @param string $checkas [AND|ISALLOWED], AND default; if set to ISALLOWED it is checked if Export is allowed
 	 *
-	 * @return bool - true if no export is allowed or a limit is set, false if there is no restriction
+	 * @return boolean|null - true if no export is allowed or a limit is set, false if there is no restriction
 	 */
 	public static function hasExportLimit($app_limit,$checkas='AND')
 	{
@@ -579,6 +579,9 @@ 
 		return $content;
 	}
 
+	/**
+	 * @param string $mimetype
+	 */
 	protected function apply_styles (&$content, $mimetype, $mso_application_progid=null)
 	{
 		if (!isset($mso_application_progid))
@@ -1169,6 +1172,8 @@ 
 
 	/**
 	 * Convert numeric values in spreadsheets into actual numeric values
+	 * @param string $content
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_numbers(&$content, $names, $mimetype)
 	{
@@ -1238,6 +1243,7 @@ 
 
 	/**
 	 * Convert date / timestamp values in spreadsheets into actual date / timestamp values
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_dates(&$content, $names, &$values, $mimetype)
 	{
@@ -1342,6 +1348,7 @@ 
 	/**
 	 * Expand link_to custom fields with the merge replacements from the app
 	 * but only if the template uses them.
+	 * @param string $app
 	 */
 	public function cf_link_to_expand($values, $content, &$replacements, $app = null)
 	{
@@ -1407,7 +1414,7 @@ 
 	/**
 	 * Process special flags, such as IF or NELF
 	 *
-	 * @param content Text to be examined and changed
+	 * @param content string to be examined and changed
 	 * @param replacements array of markers => replacement
 	 *
 	 * @return changed content
@@ -1720,8 +1727,7 @@ 
 	 * Get a list of document actions / files from the given directory
 	 *
 	 * @param string $dirs Directory(s comma or space separated) to search
-	 * @param string $prefix='document_' prefix for array keys
-	 * @param array|string $mime_filter=null allowed mime type(s), default all, negative filter if $mime_filter[0] === '!'
+	 * @param array|string $mime_filter allowed mime type(s), default all, negative filter if $mime_filter[0] === '!'
 	 * @return array List of documents, suitable for a selectbox.  The key is document_<filename>.
 	 */
 	public static function get_documents($dirs, $prefix='document_', $mime_filter=null, $app='')
@@ -1988,7 +1994,8 @@ 
 	 *
 	 * @param string &$document maybe relative path of document, on return true absolute path to existing document
 	 * @param string $dirs comma or whitespace separated directories
-	 * @return string|boolean false if document exists, otherwise string with error-message
+	 * @param string $document
+	 * @return false|string false if document exists, otherwise string with error-message
 	 */
 	public static function check_document(&$document, $dirs)
 	{

api/src/Storage/Tracking.php

Doc Comments +1 added lines, -2 removed lines

@@ -528,7 +528,7 @@ 
 	 * @param array $data current entry
 	 * @param array $old = null old/last state of the entry or null for a new entry
 	 * @param boolean $deleted = null can be set to true to let the tracking know the item got deleted or undelted
-	 * @param array $email_notified=null if present will return the emails notified, if given emails in that list will not be notified
+	 * @param array $email_notified if present will return the emails notified, if given emails in that list will not be notified
 	 * @return boolean true on success, false on error (error messages are in $this->errors)
 	 */
 	public function do_notifications($data,$old,$deleted=null,&$email_notified=null)
@@ -824,7 +824,6 @@ 
 	 * The default implementation prefers depending on the prefer_user_as_sender class-var the user over
 	 * what is returned by get_config('sender').
 	 *
-	 * @param int $user account_lid of user
 	 * @param array $data
 	 * @param array $old
 	 * @param bool $prefer_id returns the userid rather than email

api/src/Translation.php

Doc Comments +1 added lines, -1 removed lines

@@ -742,7 +742,7 @@
 	 *
 	 * @param string $app application name
 	 * @param string $lang language code
-	 * @return the full path of the filename for the requested app and language
+	 * @return string full path of the filename for the requested app and language
 	 */
 	static function get_lang_file($app,$lang)
 	{

api/src/Vfs.php

Doc Comments +4 added lines, -4 removed lines

@@ -152,7 +152,7 @@ 
 	 * dir working on just the eGW VFS: returns directory object
 	 *
 	 * @param string $path filename with absolute path in the eGW VFS
-	 * @return Directory
+	 * @return \Directory
 	 */
 	static function dir($path)
 	{
@@ -1295,7 +1295,7 @@ 
 	 * Also works around PHP under Windows returning dirname('/something') === '\\', which is NOT understood by EGroupware's VFS!
 	 *
 	 * @param string $_url path or url
-	 * @return string|boolean parent or false if there's none ($path == '/')
+	 * @return false|string parent or false if there's none ($path == '/')
 	 */
 	static function dirname($_url)
 	{
@@ -1719,7 +1719,7 @@ 
 	 * checkLock() helper
 	 *
 	 * @param  string resource path to check for locks
-	 * @return array|boolean false if there's no lock, else array with lock info
+	 * @return string|null false if there's no lock, else array with lock info
 	 */
 	static function checkLock($path)
 	{
@@ -1935,7 +1935,7 @@ 
 	/**
 	 * Copies the files given in $src to $dst.
 	 *
-	 * @param array $src contains the source file
+	 * @param string[] $src contains the source file
 	 * @param string $dst is the destination directory
 	 * @param int& $errs =null on return number of errors happened
 	 * @param array& $copied =null on return files copied

api/src/Vfs/Dav/Directory.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	/**
 	 * Returns available diskspace information
 	 *
-	 * @return array [ available-space, free-space ]
+	 * @return false[] [ available-space, free-space ]
 	 */
 	function getQuotaInfo()
 	{

api/src/Vfs/Dav/File.php

Doc Comments +2 added lines, -2 removed lines

@@ -62,7 +62,7 @@ 
 	 *
 	 * Return null if the ETag can not effectively be determined
 	 *
-	 * @return mixed
+	 * @return string|null
 	 */
 	function getETag()
 	{
@@ -78,7 +78,7 @@ 
 	 *
 	 * If null is returned, we'll assume application/octet-stream
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	function getContentType()
 	{

api/src/Vfs/Filesystem/StreamWrapper.php

Doc Comments +3 added lines, -3 removed lines

@@ -271,7 +271,7 @@ 
 	 *
 	 * If you have cached data in your stream but not yet stored it into the underlying storage, you should do so now.
 	 *
-	 * @return booelan TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored.
+	 * @return boolean TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored.
 	 */
 	function stream_flush ( )
 	{
@@ -507,7 +507,7 @@ 
 	 *
 	 * @param string $url URL that was passed to opendir() and that this object is expected to explore.
 	 * @param int $options
-	 * @return booelan
+	 * @return boolean
 	 */
 	function dir_opendir ( $url, $options )
 	{
@@ -616,7 +616,7 @@ 
 	 * It should reset the output generated by dir_readdir(). i.e.:
 	 * The next call to dir_readdir() should return the first entry in the location returned by dir_opendir().
 	 *
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function dir_rewinddir ( )
 	{