EGroupware / egroupware

calendar/inc/class.calendar_ical.inc.php

Doc Comments +10 added lines, -7 removed lines

@@ -200,7 +200,7 @@ 
 	 *                          default 0 => export whole series (or events, if not recurring)
 	 * @param string $principalURL ='' Used for CalDAV exports
 	 * @param string $charset ='UTF-8' encoding of the vcalendar, default UTF-8
-	 * @param int|string $current_user =0 uid of current user to only export that one as participant for method=REPLY
+	 * @param integer $current_user =0 uid of current user to only export that one as participant for method=REPLY
 	 * @return string|boolean string with iCal or false on error (e.g. no permission to read the event)
 	 */
 	function &exportVCal($events, $version='1.0', $method='PUBLISH', $recur_date=0, $principalURL='', $charset='UTF-8', $current_user=0)
@@ -1119,16 +1119,14 @@ 
 	 * Import an iCal
 	 *
 	 * @param string|resource $_vcalData
-	 * @param int $cal_id=-1 must be -1 for new entries!
-	 * @param string $etag=null if an etag is given, it has to match the current etag or the import will fail
-	 * @param boolean $merge=false	merge data with existing entry
-	 * @param int $recur_date=0 if set, import the recurrence at this timestamp,
+	 * @param int $cal_id must be -1 for new entries!
+	 * @param int $recur_date if set, import the recurrence at this timestamp,
 	 *                          default 0 => import whole series (or events, if not recurring)
 	 * @param string $principalURL='' Used for CalDAV imports
-	 * @param int $user=null account_id of owner, default null
 	 * @param string $charset  The encoding charset for $text. Defaults to
 	 *                         utf-8 for new format, iso-8859-1 for old format.
-	 * @param string $caldav_name=null name from CalDAV client or null (to use default)
+	 * @param string $caldav_name name from CalDAV client or null (to use default)
+	 * @param integer $etag
 	 * @return int|boolean|null cal_id > 0 on success, false on failure or 0 for a failed etag|permission denied or null for "403 Forbidden"
 	 */
 	function importVCal($_vcalData, $cal_id=-1, $etag=null, $merge=false, $recur_date=0, $principalURL='', $user=null, $charset=null, $caldav_name=null,$skip_notification=false)
@@ -3265,6 +3263,10 @@ 
 		return $event;
 	}
 
+	/**
+	 * @param integer $contentID
+	 * @param string $charset
+	 */
 	function search($_vcalData, $contentID=null, $relax=false, $charset=null)
 	{
 		if (($events = $this->icaltoegw($_vcalData, $charset)))
@@ -3325,6 +3327,7 @@ 
 	 * @param string $method ='PUBLISH' or eg. 'REPLY'
 	 * @param array $extra =null extra attributes to add
 	 * 	X-CALENDARSERVER-MASK-UID can be used to not include an event specified by this uid as busy
+	 * @return string|null
 	 */
 	function freebusy($user,$end=null,$utc=true, $charset='UTF-8', $start=null, $method='PUBLISH', array $extra=null)
 	{

resources/inc/class.resources_bo.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -79,7 +79,7 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param int $user=null account_id of user to use for Acl, default current user
+	 * @param integer $user
 	 */
 	function __construct($user=null)
 	{
@@ -681,7 +681,7 @@ 
 	/**
 	 * @author Cornelius Weiss <egw@von-und-zu-weiss.de>
 	 * query infolog for entries matching $pattern
-	 * @param string|array $pattern if it's a string it is the string we will search for as a criteria, if it's an array we
+	 * @param string $pattern if it's a string it is the string we will search for as a criteria, if it's an array we
 	 * 	will seach for 'search' key in this array to get the string criteria. others keys handled are actually used
 	 *	for calendar disponibility.
 	 * @param array $options Array of options for the search
@@ -895,7 +895,7 @@ 
 	 * Cornelius Weiss <egw@von-und-zu-weiss.de>
 	 * @param array $file array with key => value
 	 * @param int $resource_id
-	 * @return mixed string with msg if somthing went wrong; nothing if all right
+	 * @return string|null string with msg if somthing went wrong; nothing if all right
 	 */
 	function save_picture($file,$resource_id)
 	{

calendar/inc/class.calendar_import_ical.inc.php

Doc Comments +2 added lines, -3 removed lines

@@ -102,8 +102,7 @@ 
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function import( $_stream, importexport_definition $_definition ) {
 
@@ -178,7 +177,6 @@ 
 	/**
 	 * Add a warning message about conflicting events
 	 *
-	 * @param int $record_num Current record index
 	 * @param Array $conflicts List of found conflicting events
 	 */
 	public function conflict_warning(&$event, &$conflicts)
@@ -201,6 +199,7 @@ 
 	 *
 	 * @param string $owner
 	 * @param array|string $timespan
+	 * @param integer $skip_notification
 	 */
 	protected function purge_calendar($owner, $timespan, $skip_notification)
 	{

api/src/Vfs.php

Doc Comments +4 added lines, -4 removed lines

@@ -174,7 +174,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)
 	{
@@ -1351,7 +1351,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)
 	{
@@ -1780,7 +1780,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)
 	{
@@ -2063,6 +2063,7 @@ 
 
 	/**
 	 * Moves the files given in src to dst
+	 * @param string|boolean $dst
 	 */
 	static public function move_files(array $src, $dst, &$errs, array &$moved)
 	{
@@ -2253,7 +2254,6 @@ 
 	 * In order for the appropriate error message to be returned, do not define this method if your wrapper does not support removing directories.
 	 *
 	 * @param string $path
-	 * @param int $options Possible values include STREAM_REPORT_ERRORS.
 	 * @return boolean TRUE on success or FALSE on failure.
 	 */
 	static function rmdir($path)

api/src/Vfs/Sqlfs/StreamWrapper.php

Doc Comments +7 added lines, -4 removed lines

@@ -504,7 +504,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 ( )
 	{
@@ -673,6 +673,8 @@ 
 
 	/**
 	 * due to problems with recursive directory creation, we have our own here
+	 * @param false|string $pathname
+	 * @param integer $mode
 	 */
 	protected static function mkdir_recursive($pathname, $mode, $depth=0)
 	{
@@ -1058,7 +1060,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 )
 	{
@@ -1458,7 +1460,7 @@ 
 	 *
 	 * @param string $path string with path
 	 * @param int $rights =null rights to set, or null to delete the entry
-	 * @param int|boolean $owner =null owner for whom to set the rights, null for the current user, or false to delete all rights for $path
+	 * @param boolean $owner =null owner for whom to set the rights, null for the current user, or false to delete all rights for $path
 	 * @param int $fs_id =null fs_id to use, to not query it again (eg. because it's already deleted)
 	 * @return boolean true if acl is set/deleted, false on error
 	 */
@@ -1782,6 +1784,7 @@ 
 	 * Replace the password of an url with '...' for error messages
 	 *
 	 * @param string &$url
+	 * @param string $url
 	 */
 	static protected function _remove_password(&$url)
 	{
@@ -1797,7 +1800,7 @@ 
 	/**
 	 * Get storage mode from url (get parameter 'storage', eg. ?storage=db)
 	 *
-	 * @param string|array $url complete url or array of url-parts from parse_url
+	 * @param string $url complete url or array of url-parts from parse_url
 	 * @return int self::STORE2FS or self::STORE2DB
 	 */
 	static function url2operation($url)

api/tests/Vfs/SharingBase.php

Doc Comments +3 added lines, -2 removed lines

@@ -314,7 +314,7 @@ 
 	 *
 	 * @param string $path
 	 *
-	 * @return array of paths
+	 * @return string[] of paths
 	 */
 	protected function addFiles($path, $content = false)
 	{
@@ -413,6 +413,7 @@ 
 	 * Test that a share link can be made, and that only that path is available
 	 *
 	 * @param string $path
+	 * @param string $mode
 	 */
 	public function shareLink($path, $mode, $extra = array())
 	{
@@ -473,7 +474,7 @@ 
 	 * Test to make sure that a directory link leads to a limited filemanager
 	 * interface (not a file or 404).
 	 *
-	 * @param type $link
+	 * @param string $link
 	 * @param type $share
 	 */
 	public function checkDirectoryLink($link, $share)

api/src/Mail.php

Doc Comments +18 added lines, -13 removed lines

@@ -455,7 +455,7 @@ 
 	 * forceEAProfileLoad
 	 * used to force the load of a specific emailadmin profile; we assume administrative use only (as of now)
 	 * @param int $_profile_id
-	 * @return object instance of Mail (by reference)
+	 * @return Mail instance of Mail (by reference)
 	 */
 	public static function &forceEAProfileLoad($_profile_id)
 	{
@@ -753,7 +753,7 @@ 
 	/**
 	 * Get all identities of given mailaccount
 	 *
-	 * @param int|Mail\Account $account account-object or acc_id
+	 * @param integer $account account-object or acc_id
 	 * @return array - array(email=>realname)
 	 */
 	function getAccountIdentities($account)
@@ -1409,7 +1409,7 @@ 
 	 * @param array $_filter filter to apply to getSortedList
 	 * @param mixed $_thisUIDOnly = null, if given fetch the headers of this uid only (either one, or array of uids)
 	 * @param boolean $_cacheResult = true try touse the cache of getSortedList
-	 * @param mixed $_fetchPreviews = false (boolean/int) fetch part of the body of the messages requested (if integer the number is assumed to be the number of chars to be returned for preview; if set to true 300 chars are returned (when available))
+	 * @param boolean $_fetchPreviews = false (boolean/int) fetch part of the body of the messages requested (if integer the number is assumed to be the number of chars to be returned for preview; if set to true 300 chars are returned (when available))
 	 * @return array result as array(header=>array,total=>int,first=>int,last=>int)
 	 */
 	function getHeaders($_folderName, $_startMessage, $_numberOfMessages, $_sort, $_reverse, $_filter, $_thisUIDOnly=null, $_cacheResult=true, $_fetchPreviews=false)
@@ -2015,6 +2015,7 @@ 
 	 *
 	 * @param mixed _sort the integer sort order / or a valid and handeled SORTSTRING (right now: UID/ARRIVAL/INTERNALDATE (->ARRIVAL))
 	 * @param bool _reverse wether to add REVERSE to the Sort String or not
+	 * @param integer $_sort
 	 * @return the sort sequence for horde search
 	 */
 	function _getSortString($_sort, $_reverse=false)
@@ -3402,7 +3403,7 @@ 
 	 * @param string $_mailbox
 	 * @param string $delimiter
 	 * @param string $prefix
-	 * @param string $reclevel 0, counter to keep track of the current recursionlevel
+	 * @param integer $reclevel 0, counter to keep track of the current recursionlevel
 	 * @return array of mailboxes
 	 */
 	function getMailBoxesRecursive($_mailbox, $delimiter, $prefix, $reclevel=0)
@@ -3452,7 +3453,7 @@ 
 	 * abstraction layer for getDraftFolder, getTemplateFolder, getTrashFolder and getSentFolder
 	 * @param string $_type the type to fetch (Drafts|Template|Trash|Sent)
 	 * @param boolean $_checkexistance trigger check for existance
-	 * @param boolean& $created =null on return true: if folder was just created, false if not
+	 * @param boolean $created =null on return true: if folder was just created, false if not
 	 * @return mixed string or false
 	 */
 	function _getSpecialUseFolder($_type, $_checkexistance=TRUE, &$created=null)
@@ -3584,7 +3585,7 @@ 
 	/**
 	 * getTemplateFolder wrapper for _getSpecialUseFolder Type Template
 	 * @param boolean $_checkexistance trigger check for existance
-	 * @return mixed string or false
+	 * @return string string or false
 	 */
 	function getTemplateFolder($_checkexistance=TRUE)
 	{
@@ -3614,7 +3615,7 @@ 
 	/**
 	 * getOutboxFolder wrapper for _getSpecialUseFolder Type Outbox
 	 * @param boolean $_checkexistance trigger check for existance
-	 * @return mixed string or false
+	 * @return string string or false
 	 */
 	function getOutboxFolder($_checkexistance=TRUE)
 	{
@@ -4506,7 +4507,7 @@ 
 	/**
 	 * get part of the message, if its stucture is indicating its of multipart alternative style
 	 * a wrapper for multipartmixed
-	 * @param string/int $_uid the messageuid,
+	 * @param integer $_uid the messageuid,
 	 * @param Horde_Mime_Part $_structure structure for parsing
 	 * @param string $_htmlMode how to display a message, html, plain text, ...
 	 * @param boolean $_preserveSeen flag to preserve the seenflag by using body.peek
@@ -5167,6 +5168,9 @@ 
 		return $message;
 	}
 
+	/**
+	 * @param integer $cols
+	 */
 	static function wordwrap($str, $cols, $cut, $dontbreaklinesstartingwith=false)
 	{
 		$lines = explode("\n", $str);
@@ -5619,7 +5623,6 @@ 
 	 * @param string $_partID = null
 	 * @param string $_folder = null
 	 * @param boolean $_preserveSeen = false flag to preserve the seenflag by using body.peek
-	 * @param Horde_Imap_Client_Fetch_Query $fquery=null default query just structure
 	 * @return Horde_Mime_Part
 	 */
 	function getStructure($_uid, $_partID=null, $_folder=null, $_preserveSeen=false)
@@ -6163,6 +6166,7 @@ 
 	 * @param string|resource _header header part of message or resource with hole message
 	 * @param string _body body part of message, only used if _header is NO resource
 	 * @param string _flags = '\\Recent'the imap flags to set for the saved message
+	 * @param string|null $_body
 	 *
 	 * @return the id of the message appended or exception
 	 * @throws Exception\WrongUserinput
@@ -6241,6 +6245,7 @@ 
 	 * @param preserveHTML flag to pass through to getdisplayableBody, null for both text and HTML
 	 * @param addHeaderSection flag to be able to supress headersection
 	 * @param includeAttachments flag to be able to supress possible attachments
+	 * @param Mail $mailClass
 	 * @return array/bool with 'mailaddress'=>$mailaddress,
 	 *				'subject'=>$subject,
 	 *				'message'=>$message,
@@ -6443,7 +6448,7 @@ 
 	 * We also dont want empty filenames, using lang('empty') instead.
 	 *
 	 * @param string $filename
-	 * @return Cleaned filename, with problematic characters replaced with ' '.
+	 * @return string filename, with problematic characters replaced with ' '.
 	 */
 	static function clean_subject_for_filename($filename)
 	{
@@ -6740,7 +6745,7 @@ 
 	 *
 	 * @param Mailer $_mailObject instance of the Mailer Object to be used
 	 * @param string $_html2parse the html to parse and to be altered, if conditions meet
-	 * @param $mail_bo mail bo object
+	 * @param Mail|null $mail_bo mail bo object
 	 * @return array|null return inline images stored as tmp file in vfs as array of attachments otherwise null
 	 */
 	static function processURL2InlineImages(Mailer $_mailObject, &$_html2parse, $mail_bo)
@@ -6863,7 +6868,7 @@ 
 	 * @param Storage\Merge Storage\Merge bo_merge object
 	 * @param string $document the full filename
 	 * @param array $SendAndMergeTocontacts array of contact ids
-	 * @param string& $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if
+	 * @param string|null $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if
 	 *					folder is modified
 	 * @param string& $importID ID for the imported message, used by attachments to identify them unambiguously
 	 * @return mixed array of messages with success and failed messages or exception
@@ -7113,7 +7118,7 @@ 
 	/**
 	 * Parses a message/rfc mail from file to the mailobject
 	 *
-	 * @param object $mailer instance of the SMTP Mailer Object
+	 * @param Mailer $mailer instance of the SMTP Mailer Object
 	 * @param string $tmpFileName string that points/leads to the file to be imported
 	 * @throws Exception\NotFound if $fle is not found
 	 */

addressbook/inc/class.addressbook_import_contacts_csv.inc.php

Doc Comments +1 added lines, -3 removed lines

@@ -44,9 +44,7 @@
 
 	/**
 	 * imports entries according to given definition object.
-	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function init(importexport_definition &$_definition ) {
 

api/src/Framework.php

Doc Comments +6 added lines, -10 removed lines

@@ -78,6 +78,7 @@ 
 	 * Constructor
 	 *
 	 * The constructor instanciates the class in $GLOBALS['egw']->framework, from where it should be used
+	 * @param string $template
 	 */
 	function __construct($template)
 	{
@@ -576,8 +577,9 @@ 
 	/**
 	 * Get login logo or background image base on requested config type
 	 *
-	 * @param type $type config type to fetch. e.g.: "login_logo_file"
-	 * @param type $find_type type of image to search on as alternative option. e.g.: "logo"
+	 * @param string $type config type to fetch. e.g.: "login_logo_file"
+	 * @param type string type of image to search on as alternative option. e.g.: "logo"
+	 * @param string $find_type
 	 *
 	 * @return string returns full url of the image
 	 */
@@ -601,7 +603,7 @@ 
 	/**
 	 * Returns Html with user and time
 	 *
-	 * @return void
+	 * @return string
 	 */
 	protected static function _user_time_info()
 	{
@@ -1032,7 +1034,6 @@ 
 	 *
 	 * Themes are css file in the template directory
 	 *
-	 * @param string $themes_dir ='css'
 	 */
 	function list_themes()
 	{
@@ -1199,11 +1200,6 @@ 
 	/**
 	* Add menu items to the topmenu template class to be displayed
 	*
-	* @param array $app application data
-	* @param mixed $alt_label string with alternative menu item label default value = null
-	* @param string $urlextra string with alternate additional code inside <a>-tag
-	* @access protected
-	* @return void
 	*/
 	abstract function _add_topmenu_item(array $app_data,$alt_label=null);
 
@@ -1460,7 +1456,7 @@ 
 	 * @param string $action "add" or "delete"
 	 * @param boolean|int|string $group ID of the group to create the favorite for, or 'all' for all users
 	 * @param array $filters =array() key => value pairs for the filter
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function ajax_set_favorite($app, $name, $action, $group, $filters = array())
 	{