Enalean / tuleap

plugins/IM/include/jabbex_api/lib/group_mng/Openfire.php

Doc Comments +8 added lines

@@ -44,9 +44,17 @@
 	public function set_group_short_name($short_name){
 		$this->group_short_name = $short_name;
 	}
+
+	/**
+	 * @param string $full_name
+	 */
 	public function set_group_full_name($full_name){
 		$this->group_full_name = $full_name;
 	}
+
+	/**
+	 * @param Jabber $jab
+	 */
 	public function set_jab_connector(&$jab){
 		$this->jab = &$jab;
 	}

plugins/IM/include/jabbex_api/lib/jabberclass-0.9/class_Jabber.php

Doc Comments +48 added lines

@@ -188,6 +188,10 @@ 
 	if (function_exists('mhash')) { // is the Mhash extension installed?
 
 		// implement the sha1() function using mhash
+
+		/**
+		 * @param string $str
+		 */
 		function sha1($str) {
 			return bin2hex(mhash(MHASH_SHA1, $str));
 		}
@@ -360,12 +364,20 @@ 
 	
 
 	// returns a unique ID to be sent with packets
+
+	/**
+	 * @param string $prefix
+	 */
 	function _unique_id($prefix) {
 		$this->_unique_counter++;
 		return $prefix."_" . md5(time() . $this->_remote_ip . $this->_unique_counter);
 	}
 	
 	// public method for creating a log entry
+
+	/**
+	 * @param string $msg
+	 */
 	function log($msg,$level=1) {
 		$this->_log($msg,$level);
 	}
@@ -449,6 +461,10 @@ 
 	//                    specify the correct IP to connect to here
 	//	
 	//
+
+	/**
+	 * @param string $server_host
+	 */
 	function connect($server_host,$server_port=5222,$connect_timeout=null,$alternate_ip=false) {
 		
 		if (is_null($connect_timeout)) $connect_timeout = DEFAULT_CONNECT_TIMEOUT;
@@ -545,11 +561,20 @@ 
 	
 	// sets a user's presence (when simply used to set your availability, it's more convenient
 	// to call this way, as usually only the first 2 fields are necessary)
+
+	/**
+	 * @param string $show
+	 * @param string $status
+	 */
 	function set_presence($show = NULL, $status = NULL, $to = NULL, $priority = NULL) {
 		return $this->send_presence(NULL,$to,$show,$status,$priority);
 	}
 	
 	// sends presence to another contact/entity
+
+	/**
+	 * @param string $type
+	 */
 	function send_presence($type = NULL, $to = NULL, $show = NULL, $status = NULL, $priority = NULL) {
 		$xml = "<presence";
 		$xml .= ($to) ? " to='$to'" : '';
@@ -586,6 +611,9 @@ 
 	   return strtr($string, $trans);
 	}	
 	
+	/**
+	 * @param string $payload
+	 */
 	function message($to, $type = "normal", $id = NULL, $body = NULL, $thread = NULL, $subject = NULL, $payload = NULL, $raw = false) {
 		if ($to && ($body || $subject || $payload)) {
 			if (!$id) $id = $this->_unique_id("msg");
@@ -939,6 +967,11 @@ 
 	
 	// Sets a handler for a particular IQ packet ID (and optionally packet type).
 	// Assumes that $method is the name of a method of $this
+
+	/**
+	 * @param string $method
+	 * @param string $type
+	 */
 	function _set_iq_handler($method,$id,$type=NULL) {
 		if (is_null($type)) $type = "_all";
 		$this->_iq_handlers[$id][$type] = array(&$this,$method);
@@ -1477,6 +1510,10 @@ 
 	}
 	
 	// request software version from a JabberID
+
+	/**
+	 * @param string $jid
+	 */
 	function request_version($jid) {
 		
 		$this->_log('Requesting version information from '.$jid);
@@ -2048,6 +2085,9 @@ 
 		return $transport;
 	}
 		
+	/**
+	 * @param string $domain
+	 */
 	function get_transport($domain) {
 		$transport = @$this->services[$domain]["type"];
 		return $this->standardize_transport($transport);
@@ -2060,6 +2100,11 @@ 
 	// ==== Packet Handling & Connection Methods =============================================
 
 	// generates and transmits an IQ packet
+
+	/**
+	 * @param string $xmlns
+	 * @param string $from
+	 */
 	function _send_iq($to = NULL, $type = 'get', $id = NULL, $xmlns = NULL, $payload = NULL, $from = NULL) {
 		if (!preg_match("/^(get|set|result|error)$/", $type)) {
 			unset($type);
@@ -2166,6 +2211,9 @@ 
 		return array_shift($this->_packet_queue);
 	}
 	
+	/**
+	 * @param string $incoming
+	 */
 	function _split_incoming($incoming) {
 		$temp = preg_split("/<(message|iq|presence|stream)(?=[\:\s\>])/", $incoming, -1, PREG_SPLIT_DELIM_CAPTURE);
 		$array = array();

plugins/IM/include/jabbex_api/lib/jabberclass-0.9/class_SHA1Library.php

Doc Comments +15 added lines

@@ -129,6 +129,10 @@ 
 	 * Perform the appropriate triplet combination function for the current
 	 * iteration
 	 */
+
+	/**
+	 * @param integer $t
+	 */
 	function sha1_ft($t, $b, $c, $d)
 	{
 		if($t < 20) return ($b & $c) | ((~$b) & $d);
@@ -142,6 +146,10 @@ 
 	 * Silly php does not understand the inline-if operator well when nested,
 	 * so that's why it's ()ed now.
 	 */
+
+	/**
+	 * @param integer $t
+	 */
 	function sha1_kt($t)
 	{
 		return ($t < 20) ?  1518500249 : (($t < 40) ?  1859775393 :
@@ -183,6 +191,10 @@ 
 	/*
 	 * Bitwise rotate a 32-bit number to the left.
 	 */
+
+	/**
+	 * @param integer $cnt
+	 */
 	function rol($num, $cnt)
 	{
 		return ($num << $cnt) | $this->zerofill_rightshift($num, (32 - $cnt));
@@ -254,6 +266,9 @@ 
 
 if ( !function_exists('sha1') )
 {
+	/**
+	 * @param string $string
+	 */
 	function sha1( $string, $raw_output = false )
 	{
 		$library = &new SHA1Library();

plugins/IM/include/jabbex_api/lib/jabberclass-0.9/class_XMLParser.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 	// _xml_depth()
 	// (c) Hans Anderson / http://www.hansanderson.com/php/xml/
 
+	/**
+	 * @param integer $i
+	 */
 	function _xml_depth($vals, &$i) {
 		$children = array();
 

plugins/IM/www/webmuc/lib/jsjac/utils/packer/class.JavaScriptPacker.php

Doc Comments +38 added lines

@@ -102,6 +102,10 @@ 
 	}
 	
 	// apply all parsing routines
+
+	/**
+	 * @param string $script
+	 */
 	private function _pack($script) {
 		for ($i = 0; isset($this->_parsers[$i]); $i++) {
 			$script = call_user_func(array(&$this,$this->_parsers[$i]), $script);
@@ -111,6 +115,10 @@ 
 	
 	// keep a list of parsing functions, they'll be executed all at once
 	private $_parsers = array();
+
+	/**
+	 * @param string $parser
+	 */
 	private function _addParser($parser) {
 		$this->_parsers[] = $parser;
 	}
@@ -196,6 +204,10 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $regexp
+	 * @param string $encode
+	 */
 	private function _analyze($script, $regexp, $encode) {
 		// analyse
 		// retreive all words in the script
@@ -362,6 +374,10 @@ 
 	}
 	
 	// mmm.. ..which one do i need ??
+
+	/**
+	 * @param integer $ascii
+	 */
 	private function _getEncoder($ascii) {
 		return $ascii > 10 ? $ascii > 36 ? $ascii > 62 ?
 		       '_encode95' : '_encode62' : '_encode36' : '_encode10';
@@ -404,6 +420,9 @@ 
 		return $res . chr(($charCode % $this->_encoding) + 161);
 	}
 	
+	/**
+	 * @param string $string
+	 */
 	private function _safeRegExp($string) {
 		return '/'.preg_replace('/\$/', '\\\$', $string).'/';
 	}
@@ -430,6 +449,9 @@ 
 	}
 	
 	
+	/**
+	 * @param string $aName
+	 */
 	private function _getJSFunction($aName) {
 		if (defined('self::JSFUNCTION'.$aName))
 			return constant('self::JSFUNCTION'.$aName);
@@ -552,6 +574,9 @@ 
 	private $QUOTE = '/\'/';
 	private $DELETED = '/\\x01[^\\x01]*\\x01/';//g
 	
+	/**
+	 * @param string $expression
+	 */
 	public function add($expression, $replacement = '') {
 		// count the number of sub-expressions
 		//  - add one because each pattern is itself a sub-expression
@@ -685,6 +710,10 @@ 
 	private $buffer;
 	
 	// encode escaped characters
+
+	/**
+	 * @param string $escapeChar
+	 */
 	private function _escape($string, $escapeChar) {
 		if ($escapeChar) {
 			$this->buffer = $escapeChar;
@@ -704,6 +733,10 @@ 
 	}
 	
 	// decode escaped characters
+
+	/**
+	 * @param string $escapeChar
+	 */
 	private function _unescape($string, $escapeChar) {
 		if ($escapeChar) {
 			$regexp = '/'.'\\'.$escapeChar.'/';
@@ -729,6 +762,11 @@ 
 		return $this->buffer['escapeChar'] . $temp;
 	}
 	
+	/**
+	 * @param string $string
+	 *
+	 * @return string
+	 */
 	private function _internalEscape($string) {
 		return preg_replace($this->ESCAPE, '', $string);
 	}

plugins/ldap/include/LDAP.class.php

Doc Comments +23 added lines, -2 removed lines

@@ -129,6 +129,11 @@ 
         }
     }
 
+    /**
+     * @param string $servers
+     * @param string $binddn
+     * @param string $bindpwd
+     */
     private function authenticatedBindConnect($servers, $binddn, $bindpwd) {
         $ds = false;
         foreach (split('[,;]', $servers) as $ldap_server) {
@@ -332,7 +337,7 @@ 
      * Search a specific Distinguish Name
      *
      * @param String $dn         DN to retreive
-     * @param Array  $attributes Restrict the LDAP fields to fetch
+     * @param string[]  $attributes Restrict the LDAP fields to fetch
      * 
      * @return LDAPResultIterator
      */
@@ -438,7 +443,7 @@ 
      * @param String   $name      Name of the group to look for
      * @param Integer  $sizeLimit Limit the amount of result sent
      * 
-     * @return LDAPResultIterator
+     * @return AppendIterator
      */
     function searchUserAsYouType($name, $sizeLimit, $validEmail=false) {
         $apIt  = new AppendIterator();
@@ -529,6 +534,9 @@ 
         }
     }
 
+    /**
+     * @param string $dn
+     */
     public function add($dn, array $info) {
         $ds = $this->getWriteConnexion();
         if (@ldap_add($ds, $dn, $info)) {
@@ -537,6 +545,9 @@ 
         throw new LDAP_Exception_AddException(ldap_error($ds), $dn);
     }
 
+    /**
+     * @param string $dn
+     */
     public function update($dn, array $info) {
         $ds = $this->getWriteConnexion();
         if (@ldap_modify($ds, $dn, $info)) {
@@ -545,6 +556,9 @@ 
         throw new LDAP_Exception_UpdateException(ldap_error($ds), $dn);
     }
 
+    /**
+     * @param string $dn
+     */
     public function delete($dn) {
         $ds = $this->getWriteConnexion();
         if (@ldap_delete($ds, $dn)) {
@@ -553,10 +567,17 @@ 
         throw new LDAP_Exception_DeleteException(ldap_error($ds), $dn);
     }
 
+    /**
+     * @param string $old_dn
+     * @param string $new_root_dn
+     */
     public function renameUser($old_dn, $new_root_dn) {
         return $this->rename($old_dn, $new_root_dn, $this->getLDAPParam('write_people_dn'));
     }
 
+    /**
+     * @param string $newparent
+     */
     private function rename($old_dn, $newrdn, $newparent) {
         $ds = $this->getWriteConnexion();
         if (@ldap_rename($ds, $old_dn, $newrdn, $newparent, true)) {

plugins/ldap/include/LDAP_CleanUpManager.class.php

Doc Comments +5 added lines, -1 removed lines

@@ -28,6 +28,9 @@ 
      */
     private $retentionPeriod;
 
+    /**
+     * @param string $period
+     */
     public function __construct($period) {
         $this->retentionPeriod = $period;
     }
@@ -112,8 +115,9 @@ 
      * Retrieve a collection of active projects of a given user
      *
      * @param Integer userId
+     * @param PFUser $userId
      *
-     * @return Array
+     * @return Project[]
      */
     private function getUserProjects($userId) {
         $pm = $this->_getProjectManager();

plugins/ldap/include/LDAP_DirectoryCleanUpDao.class.php

Doc Comments +3 added lines

@@ -32,6 +32,8 @@ 
      * @param Integer userId
      *
      * @param Integer deletionDate date on which suspended user will be deleted
+     * @param integer $userId
+     * @param double $deletionDate
      *
      * @return Boolean
      */
@@ -47,6 +49,7 @@ 
      * @param Integer userId
      *
      * @param Integer deletionDate
+     * @param integer $userId
      *
      * @return Boolean
      */

plugins/ldap/include/LDAP_DirectorySynchronization.class.php

Doc Comments +5 added lines

@@ -148,6 +148,8 @@ 
     /**
      * Wrapper for LDAP_SyncReminderNotificationManager object
      *
+     * @param ProjectManager $projectManager
+     * @param UserManager $userManager
      * @return LDAP_SyncReminderNotificationManager
      */
     protected function getLdapSyncReminderNotificationManager($projectManager, $userManager) {
@@ -173,6 +175,9 @@ 
         return LDAP_UserSync::instance();
     }
 
+    /**
+     * @param string $retentionPeriod
+     */
     protected function getLdapSyncNotificationManager(ProjectManager $projectManager, $retentionPeriod){
         return new LDAP_SyncNotificationManager($projectManager, $retentionPeriod);
     }