EGroupware / egroupware

phpgwapi/inc/class.ldap.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param boolean $exception_on_error=false true: throw Exceptions in ldapConnect instead of echoing error and returning false
+	 * @param boolean $exception_on_error true: throw Exceptions in ldapConnect instead of echoing error and returning false
 	 */
 	function __construct($exception_on_error=false)
 	{
@@ -61,7 +61,7 @@ 
 	/**
 	 * Returns information about connected ldap server
 	 *
-	 * @return ldapserverinfo|null
+	 * @return ldapserverinfo
 	 */
 	function getLDAPServerInfo()
 	{
@@ -178,7 +178,7 @@ 
 	 * @param string $host ldap host
 	 * @param string $dn ldap dn
 	 * @param string $passwd ldap pw
-	 * @return resource|boolean resource from ldap_connect() or false on error
+	 * @return boolean resource from ldap_connect() or false on error
 	 */
 	private function _connect($host, $dn, $passwd)
 	{

phpgwapi/inc/class.ldapserverinfo.inc.php

Doc Comments +2 added lines, -1 removed lines

@@ -70,7 +70,7 @@ 
 	/**
 	* gets the version
 	*
-	* @return integer the supported ldap version
+	* @return string the supported ldap version
 	*/
 	function getVersion()
 	{
@@ -131,6 +131,7 @@ 
 	/**
 	* checks for supported objectclasses
 	*
+	* @param string $_objectClass
 	* @return bool returns true if the ldap server supports this objectclass
 	*/
 	function supportsObjectClass($_objectClass)

phpgwapi/inc/class.mailDomainSigner.inc.php

Doc Comments +2 added lines, -4 removed lines

@@ -309,10 +309,8 @@
    * @param string $h Signed header fields, A colon-separated list of header field names that identify the header fields presented to the signing algorithm
    * @param array $_h Array of headers in same order with $h (Signed header fields)
    * @param string $body Raw Email Body String
-   * @param string $_c='relaxed/relaxed' header/body canonicalzation algorithm, default "relaxed/relaxed", can also be any combination of "relaxed" or "simple"
-   * @param string $_a='rsa-sha1' could also be eg. 'rsa/sha256' and other hashes supported by openssl for rsa signing
-   * @param string $_dkim=null template for creating DKIM signature, default as for email appropriate
-   * @return string|boolean DKIM-Signature Header String, or false if an error happend, eg. unimplemented canonicalization requested
+   * @param string $_dkim
+   * @return false|string DKIM-Signature Header String, or false if an error happend, eg. unimplemented canonicalization requested
    * @access public
    * @author Ahmad Amarullah
    */

phpgwapi/inc/class.network.inc.php

Doc Comments +11 added lines

@@ -36,6 +36,9 @@ 
 			$this->set_addcrlf($addcrlf);
 		}
 
+		/**
+		 * @param boolean $value
+		 */
 		function set_addcrlf($value)
 		{
 			$this->addcrlf = $value;
@@ -50,6 +53,11 @@ 
 			return $str;
 		}
 
+		/**
+		 * @param string $code
+		 * @param string $msg
+		 * @param string $desc
+		 */
 		function set_error($code,$msg,$desc)
 		{
 			$this->error = array('code','msg','desc');
@@ -61,6 +69,9 @@ 
 			return 0;
 		}
 
+		/**
+		 * @param integer $port
+		 */
 		function open_port($server,$port,$timeout=15)
 		{
 			switch($port)

phpgwapi/inc/class.nextmatchs.inc.php

Doc Comments +36 added lines

@@ -89,6 +89,11 @@ 
 		@param $img_src ?
 		@param $label ?
 		*/
+
+		/**
+		 * @param string $align
+		 * @param string $img
+		 */
 		function set_icon($align,$img,$label)
 		{
 			$var = array(
@@ -134,6 +139,11 @@ 
 		@param $link ?
 		@param $extravars ?
 		*/
+
+		/**
+		 * @param string $align
+		 * @param string $img
+		 */
 		function set_link($align,$img,$link,$alt,$extravars)
 		{
 			$var = Array(
@@ -244,6 +254,10 @@ 
 		@param $total ?
 		@param $extradate ?
 		*/
+
+		/**
+		 * @param integer $start
+		 */
 		function left($scriptname,$start,$total,$extradata = '')
 		{
 			$extravars = Array(
@@ -290,6 +304,10 @@ 
 		@param $total ?
 		@param $extradate ?
 		*/
+
+		/**
+		 * @param integer $start
+		 */
 		function right($scriptname,$start,$total,$extradata = '')
 		{
 			$extravars = Array(
@@ -470,6 +488,10 @@ 
 		@abstract ?
 		@param $filter_obj
 		*/
+
+		/**
+		 * @param integer $filter_obj
+		 */
 		function filter($filter_obj,$yours=0)
 		{
 			if (is_array($yours))
@@ -654,6 +676,11 @@ 
 		@param $text ?
 		@param $extra default ''
 		*/
+
+		/**
+		 * @param string $var
+		 * @param string $program
+		 */
 		function show_sort_order($sort,$var,$order,$program,$text,$extra='',$build_a_href=True)
 		{
 			if ($order == $var)
@@ -848,6 +875,11 @@ 
 		@param $link ?
 		@param $extravars ?
 		*/
+
+		/**
+		 * @param string $align
+		 * @param string $img
+		 */
 		function set_link_imap($align,$img,$alt_text,$out_vars)
 		{
 			$img_full = $GLOBALS['egw']->common->image('phpgwapi',$img);
@@ -855,6 +887,10 @@ 
 			return '<a href="'.$out_vars['common_uri'].'&start='.$out_vars['start'].'">'.$image_part.'</a>';
 		}
 
+		/**
+		 * @param string $align
+		 * @param string $img
+		 */
 		function set_icon_imap($align,$img,$alt_text)
 		{
 			$img_full = $GLOBALS['egw']->common->image('phpgwapi',$img);

phpgwapi/inc/class.schema_proc.inc.php

Doc Comments +10 added lines, -20 removed lines

@@ -92,7 +92,6 @@ 
 	 * Constructor of schema-processor
 	 *
 	 * @param string $dbms type of the database: 'mysql','pgsql','mssql','maxdb'
-	 * @param object $db=null database class, if null we use $GLOBALS['egw']->db
 	 * @return schema_proc
 	 */
 	function __construct($dbms=False,$db=null)
@@ -416,7 +415,7 @@ 
 	/**
 	 * Check if we have an old, not automaticaly droped sequence and drop it
 	 *
-	 * @param $sTableName
+	 * @param string $sTableName
 	 * @param bool $preserveValue
 	 */
 	function _PostgresTestDropOldSequence($sTableName,$preserveValue=False)
@@ -529,9 +528,9 @@ 
 	/**
 	 * Create an (unique) Index over one or more columns
 	 *
-	 * @param string $sTablename table-name
+	 * @param string $sTableName table-name
 	 * @param array $aColumnNames columns for the index
-	 * @param boolean $bUnique=false true for a unique index, default false
+	 * @param boolean $bUnique true for a unique index, default false
 	 * @param array/string $options='' db-sepecific options, default '' = none
 	 * @param string $sIdxName='' name of the index, if not given (default) its created automaticaly
 	 * @return int 2: no error, 1: errors, but continued, 0: errors aborted
@@ -789,7 +788,7 @@ 
 	 * Creates all tables for one application
 	 *
 	 * @param array $aTables array of eGW table-definitions
-	 * @param boolean $bOutputHTML=false should we give diagnostics, default False
+	 * @param boolean $bOutputHTML should we give diagnostics, default False
 	 * @return boolean True on success, False if an (fatal) error occured
 	 */
 	function ExecuteScripts($aTables, $bOutputHTML=False)
@@ -827,9 +826,6 @@ 
 	/**
 	* Return the value of a column
 	*
-	* @param string/integer $Name name of field or positional index starting from 0
-	* @param bool $strip_slashes string escape chars from field(optional), default false
-	* @return string the field value
 	*/
 	function f($value,$strip_slashes=False)
 	{
@@ -859,12 +855,7 @@ 
 	/**
 	* Execute a query
 	*
-	* @param string $Query_String the query to be executed
-	* @param mixed $line the line method was called from - use __LINE__
-	* @param string $file the file method was called from - use __FILE__
-	* @param int $offset row to start from
-	* @param int $num_rows number of rows to return (optional), if unset will use $GLOBALS['phpgw_info']['user']['preferences']['common']['maxmatchs']
-	* @return ADORecordSet or false, if the query fails
+	* @param integer $line
 	*/
 	function query($sQuery, $line='', $file='')
 	{
@@ -880,8 +871,6 @@ 
 	*	if the row exists db::update is called else a new row with $date merged with $where gets inserted (data has precedence)
 	* @param int $line line-number to pass to query
 	* @param string $file file-name to pass to query
-	* @param string $app=false string with name of app, this need to be set in setup anyway!!!
-	* @return ADORecordSet or false, if the query fails
 	*/
 	function insert($table,$data,$where,$line,$file,$app=False,$use_prepared_statement=false)
 	{
@@ -892,8 +881,8 @@ 
 	 * Execute the Sql statements in an array and give diagnostics, if any error occures
 	 *
 	 * @param $aSql array of SQL strings to execute
-	 * @param $debug_level int for which debug_level (and higher) should the diagnostics always been printed
-	 * @param $debug string variable number of arguments for the debug_message functions in case of an error
+	 * @param integer $debug_level int for which debug_level (and higher) should the diagnostics always been printed
+	 * @param string $debug string variable number of arguments for the debug_message functions in case of an error
 	 * @return int 2: no error, 1: errors, but continued, 0: errors aborted
 	 */
 	function ExecuteSqlArray($aSql,$debug_level,$debug)
@@ -935,7 +924,7 @@ 
 	 * b) we use the table-names plus all column-names and remove dublicate parts
 	 *
 	 * @internal
-	 * @param $sTableName string name of the table
+	 * @param string $sTableName string name of the table
 	 * @param $aColumnNames array of column-names or string with a single column-name
 	 * @return string the index-name
 	 */
@@ -992,6 +981,7 @@ 
 
 	/**
 	 * Giving a non-fatal error-message
+	 * @param string $str
 	 */
 	function error($str)
 	{
@@ -1020,7 +1010,7 @@ 
 	 *
 	 * The parameters get formated depending on their type.
 	 *
-	 * @param $msg string message with parameters/variables like lang(), eg. '%1'
+	 * @param string $msg string message with parameters/variables like lang(), eg. '%1'
 	 * @param $backtrace include a function-backtrace, default True=On
 	 *	should only be set to False=Off, if your code ensures a call with backtrace=On was made before !!!
 	 * @param $param mixed a variable number of parameters, to be inserted in $msg

phpgwapi/inc/class.solink.inc.php

Doc Comments +7 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
 	 *
 	 * @param int $link_id link to update
 	 * @param string $remark new text for the remark
-	 * @return boolean true on success, else false
+	 * @return ADORecordSet true on success, else false
 	 */
 	static function update_remark($link_id,$remark)
 	{
@@ -172,6 +172,11 @@ 
 		return is_array($id) ? $links : ($links[$id] ? $links[$id] : array());
 	}
 
+	/**
+	 * @param boolean $left
+	 * @param string $only_app
+	 * @param boolean $not_only
+	 */
 	private function _add2links($row,$left,$only_app,$not_only,array &$links)
 	{
 		$linked_app = $left ? $row['link_app2'] : $row['link_app1'];
@@ -202,7 +207,7 @@ 
 	 * @param string $id ='' id in $app, if no integer link_id given in $app_link_id
 	 * @param string $app2 ='' appname of 2. endpoint of the link, if no integer link_id given in $app_link_id
 	 * @param string $id2 ='' id in $app2, if no integer link_id given in $app_link_id
-	 * @return array with link-data or False
+	 * @return boolean with link-data or False
 	 */
 	static function get_link($app_link_id,$id='',$app2='',$id2='')
 	{

phpgwapi/inc/class.Template.inc.php

Doc Comments +32 added lines

@@ -64,6 +64,10 @@ 
 		/* public: setroot(pathname $root)
 		 * root:   new template directory.
 		 */
+
+		/**
+		 * @param string $root
+		 */
 		function set_root($root)
 		{
 			if ($this->debug && $this->check_debug('set_root'))
@@ -127,6 +131,11 @@ 
 		 * extract the template $handle from $parent,
 		 * place variable {$name} instead.
 		 */
+
+		/**
+		 * @param string $parent
+		 * @param string $handle
+		 */
 		function set_block($parent, $handle, $name = '')
 		{
 			if ($this->debug && $this->check_debug('set_block',$parent,$handle,$name))
@@ -253,6 +262,10 @@ 
 			return $str;
 		}
 
+		/**
+		 * @param string $target
+		 * @param string $handle
+		 */
 		function pparse($target, $handle, $append = false)
 		{
 			print $this->parse($target, $handle, $append);
@@ -260,12 +273,24 @@ 
 		}
 
 		/* This is short for finish parse */
+
+		/**
+		 * @param string $target
+		 * @param string $handle
+		 *
+		 * @return string
+		 */
 		function fp($target, $handle, $append = False)
 		{
 			return $this->finish($this->parse($target, $handle, $append));
 		}
 
 		/* This is a short cut for print finish parse */
+
+		/**
+		 * @param string $target
+		 * @param string $handle
+		 */
 		function pfp($target, $handle, $append = False)
 		{
 			echo $this->finish($this->parse($target, $handle, $append));
@@ -307,6 +332,10 @@ 
 		/* public: get_undefined($handle)
 		 * handle: handle of a template.
 		 */
+
+		/**
+		 * @param string $handle
+		 */
 		function get_undefined($handle)
 		{
 			if (!$this->loadfile($handle))
@@ -476,6 +505,9 @@ 
 			}
 		}
 
+		/**
+		 * @param string $str
+		 */
 		function check_debug($str)
 		{
 			if (!$this->debug) return False;

phpgwapi/inc/class.tplsavant2.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
 	   * @param bool $fallback if true the default fallback template dir is returned
 	   * @param string $appname appication name optional can be derived from $GLOBALS['egw_info']['flags']['currentapp'];
 	   * @access public
-	   * @return void
+	   * @return string|false
 	   */
 	  function get_tpl_dir($fallback=false,$appname = '')
 	  {