chamilo / chamilo-lms

main/inc/lib/groupmanager.lib.php

Doc Comments +13 added lines, -10 removed lines

@@ -369,7 +369,7 @@ 
      * @author Christophe Gesche <christophe.gesche@claroline.net>
      * @author Hugues Peeters <hugues.peeters@claroline.net>
      * @author Bart Mollet
-     * @param  mixed  $groupIdList - group(s) to delete. It can be a single id
+     * @param  mixed  $group_ids - group(s) to delete. It can be a single id
      *                                (int) or a list of id (array).
      * @param string $course_code Default is current course
      * @return integer              - number of groups deleted.
@@ -573,7 +573,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -724,7 +724,7 @@ 
      * @param int $group_id The id of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -786,9 +786,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -994,6 +994,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1172,7 +1174,7 @@ 
      *         Hugues Peeters     <hugues.peeters@claroline.net> - original version
      * @author Roan Embrechts - virtual course support, code cleaning
      * @author Bart Mollet - code cleaning, use other GroupManager-functions
-     * @return void
+     * @return false|null
      */
     public static function fill_groups($group_ids)
     {
@@ -1625,7 +1627,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1644,7 +1646,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($group_ids)
@@ -1676,7 +1678,7 @@ 
 
     /**
      * Unsubscribe all tutors from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @see unsubscribe_all_users. This function is almost an exact copy of that function.
      * @return bool TRUE if successful
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1861,6 +1863,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

main/inc/lib/hook/HookManagement.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 
     /**
      * Return a list an associative array where keys are the active hook observer class name
-     * @param $eventName
+     * @param string $eventName
      *
      * @return array
      */

main/inc/lib/login.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -266,6 +266,7 @@ 
      * @global bool   $is_platformAdmin
      * @global bool   $is_allowedCreateCourse
      * @global object $_user
+     * @param boolean $reset
      */
     public static function init_user($user_id, $reset)
     {
@@ -355,7 +356,7 @@ 
      * @global type $is_allowed_in_course
      *
      * @param type $course_id
-     * @param type $reset
+     * @param boolean $reset
      */
     static function init_course($course_id, $reset)
     {

main/inc/lib/model.lib.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
 
     /**
      * Useful finder - experimental akelos like only use in notification.lib.php send function
+     * @param string $type
      */
     public function find($type, $options = null)
     {

main/inc/lib/myspace.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -634,7 +634,6 @@ 
      * @param   int $sessionId  The session ID
      * @param   int $courseId   The course ID
      * @param   int $exerciseId The quiz ID
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
      * @return  string  HTML array of results formatted for gridJS
      * @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
      */
@@ -1222,6 +1221,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1556,6 +1556,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1576,7 +1577,6 @@ 
     /**
      * Fills in session reporting data
      *
-     * @param integer $user_id the id of the user
      * @param array $url_params additonal url parameters
      * @param array $row the row information (the other columns)
      * @return string html code
@@ -2206,6 +2206,7 @@ 
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
      * @version Dokeos 1.8.6
      * @since October 2008
+     * @param integer $number_of_items
      */
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
     {
@@ -2308,7 +2309,6 @@ 
     /**
      * Checks if there are repeted users in a given array
      * @param  array $usernames list of the usernames in the uploaded file
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
      * @return array with the $usernames array and the $user_array array
      * @author Julio Montoya Armas
      */

main/inc/lib/notification.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -219,7 +219,7 @@
      * @param array	    $user_list recipients: user list of ids
      * @param string	$title
      * @param string	$content
-     * @param array	    $sender_info
+     * @param array	    $senderInfo
      * result of api_get_user_info() or GroupPortalManager:get_group_data()
      */
     public function save_notification(

main/inc/lib/nusoap/class.nusoap_base.php

Doc Comments +7 added lines, -7 removed lines

@@ -306,7 +306,7 @@ 
 	/**

 	* gets the current debug data for this instance

 	*

-	* @return   debug data

+	* @return   string data

 	* @access   public

 	*/

 	function &getDebug() {

@@ -319,7 +319,7 @@ 
 	* gets the current debug data for this instance as an XML comment

 	* this may change the contents of the debug data

 	*

-	* @return   debug data as an XML comment

+	* @return   string data as an XML comment

 	* @access   public

 	*/

 	function &getDebugAsXMLComment() {

@@ -352,7 +352,7 @@ 
 	/**

 	* returns error string if present

 	*

-	* @return   mixed error string or false

+	* @return   string|false error string or false

 	* @access   public

 	*/

 	function getError(){

@@ -365,7 +365,7 @@ 
 	/**

 	* sets error string

 	*

-	* @return   boolean $string error string

+	* @return   boolean|null $string error string

 	* @access   private

 	*/

 	function setError($str){

@@ -801,7 +801,7 @@ 
     * returns false, if not prefixed

     *

     * @param string $str The prefixed string

-    * @return mixed The prefix or false if there is no prefix

+    * @return string|false The prefix or false if there is no prefix

     * @access public

     */

 	function getPrefix($str){

@@ -832,7 +832,7 @@ 
     * or false if no prefixes registered for the given namespace

     *

     * @param string $ns The namespace

-    * @return mixed The prefix, false if the namespace has no prefixes

+    * @return string The prefix, false if the namespace has no prefixes

     * @access public

     */

 	function getPrefixFromNamespace($ns) {

@@ -898,7 +898,7 @@ 
 *

 * @param    int $timestamp Unix time stamp

 * @param	boolean $utc Whether the time stamp is UTC or local

-* @return	mixed ISO 8601 date string or false

+* @return	string|false ISO 8601 date string or false

 * @access   public

 */

 function timestamp_to_iso8601($timestamp,$utc=true){

main/inc/lib/nusoap/class.soap_server.php

Doc Comments +8 added lines, -7 removed lines

@@ -843,7 +843,7 @@ 
 	*

 	* @param	array	$headers	The HTTP headers

 	* @param	string	$data		unprocessed request data from client

-	* @return	mixed	value of the message, decoded into a PHP type

+	* @return	false|null	value of the message, decoded into a PHP type

 	* @access   private

 	*/

     function parseRequest($headers, $data) {

@@ -951,10 +951,10 @@ 
 	* @param    string $name the name of the PHP function, class.method or class..method

 	* @param    array $in assoc array of input values: key = param name, value = param type

 	* @param    array $out assoc array of output values: key = param name, value = param type

-	* @param	mixed $namespace the element namespace for the method or false

-	* @param	mixed $soapaction the soapaction for the method or false

-	* @param	mixed $style optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically

-	* @param	mixed $use optional (encoded|literal) or false

+	* @param	string $namespace the element namespace for the method or false

+	* @param	string $soapaction the soapaction for the method or false

+	* @param	string $style optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically

+	* @param	string $use optional (encoded|literal) or false

 	* @param	string $documentation optional Description to include in WSDL

 	* @param	string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)

 	* @access   public

@@ -1041,11 +1041,12 @@ 
     * Acts as a flag to enable internal WSDL generation

     *

     * @param string $serviceName, name of the service

-    * @param mixed $namespace optional 'tns' service namespace or false

+    * @param string $namespace optional 'tns' service namespace or false

     * @param mixed $endpoint optional URL of service endpoint or false

     * @param string $style optional (rpc|document) WSDL style (also specified by operation)

     * @param string $transport optional SOAP transport

-    * @param mixed $schemaTargetNamespace optional 'types' targetNamespace for service schema or false

+    * @param mixed $schemaTargetNamespace optional 'types' targetNamespace for service schema or false
+    * @param string $serviceName

     */

     function configureWSDL($serviceName,$namespace = false,$endpoint = false,$style='rpc', $transport = 'http://schemas.xmlsoap.org/soap/http', $schemaTargetNamespace = false)

     {

main/inc/lib/nusoap/class.soap_transport_http.php

Doc Comments +6 added lines, -6 removed lines

@@ -169,10 +169,6 @@ 
 	/**

 	* establish an HTTP connection

 	*

-	* @param    integer $timeout set connection timeout in seconds

-	* @param	integer $response_timeout set response timeout in seconds

-	* @return	boolean true if connected, false if not

-	* @access   private

 	*/

 	function connect($connection_timeout=0,$response_timeout=30){

 	  	// For PHP 4.3 with OpenSSL, change https scheme to ssl, then treat like

@@ -731,7 +727,7 @@ 
 	*

 	* @param    string $data message data

 	* @param	array $cookies cookies to send

-	* @return	boolean	true if OK, false if problem

+	* @return	boolean|null	true if OK, false if problem

 	* @access   private

 	*/

 	function sendRequest($data, $cookies = NULL) {

@@ -1166,7 +1162,7 @@ 
 	 * sets the content-type for the SOAP message to be sent

 	 *

 	 * @param	string $type the content type, MIME style

-	 * @param	mixed $charset character set used for encoding (or false)

+	 * @param	string $charset character set used for encoding (or false)

 	 * @access	public

 	 */

 	function setContentType($type, $charset = false) {

@@ -1199,6 +1195,10 @@ 
 	/*

 	 * TODO: allow a Set-Cookie string to be parsed into multiple cookies

 	 */

+
+	/**
+	 * @param string $cookie_str
+	 */
 	function parseCookie($cookie_str) {

 		$cookie_str = str_replace('; ', ';', $cookie_str) . ';';

 		$data = preg_split('/;/', $cookie_str);