chamilo / chamilo-lms

app/Migrations/AbstractMigrationChamilo.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
     }
 
     /**
-     * @param $variable
+     * @param string $variable
      * @return mixed
      */
     public function getConfigurationValue($variable)

main/admin/group_list.php

Doc Comments +1 added lines, -2 removed lines

@@ -204,7 +204,6 @@ 
  * lock = the user can no longer use this account
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $active the current state of the account
- * @param int $user_id The user id
  * @param string $url_params
  * @return string Some HTML-code with the lock/unlock button
  */
@@ -236,7 +235,7 @@ 
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $status, do we want to lock the user ($status=lock) or unlock it ($status=unlock)
  * @param int $user_id The user id
- * @return language variable
+ * @return string|null variable
  */
 function lock_unlock_user($status, $user_id) {
     $user_table = Database :: get_main_table(TABLE_MAIN_USER);

main/admin/settings.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -907,7 +907,7 @@ 
  * display the edit and delete icons in the sortable table
  *
  * @param integer $id the id of the template
- * @return html code for the link to edit and delete the template
+ * @return string code for the link to edit and delete the template
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version August 2008
@@ -923,7 +923,7 @@ 
  * Display the image of the template in the sortable table
  *
  * @param string $image the image
- * @return html code for the image
+ * @return string code for the image
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version August 2008
@@ -1120,7 +1120,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */

main/admin/sub_language_add.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
  * @param   string  ISO code (fr_FR, ...)
  * @param   int     Whether the sublanguage is published (0=unpublished, 1=published)
  * @param   int     ID del idioma padre
- * @return  int     New sub language ID or false on error
+ * @return  false|string     New sub language ID or false on error
  */
 function add_sub_language ($original_name,$english_name,$isocode,$sublanguage_available,$parent_id) {
     $tbl_admin_languages    = Database :: get_main_table(TABLE_MAIN_LANGUAGE);

main/admin/user_update_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 /**
  * Update users from the imported data
  * @param   array   $users List of users
- * @return  void
+ * @return  false|null
  * @uses global variable $inserted_in_course, which returns the list of courses the user was inserted in
  */
 

main/attendance/attendance_controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 
     /**
      * Restores an attendance entry and fallback to attendances rendering
-     * @param int	$attendanceId
+     * @param int	$attendance_id
      */
     public function attendance_restore($attendance_id)
     {

main/auth/cas/authcas.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 require_once api_get_path(SYS_PATH).'main/auth/external_login/functions.inc.php';
 
 /**
-* @return true if cas is configured
+* @return boolean if cas is configured
 *
 **/
 function cas_configured() {

main/auth/cas/lib/CAS.php

Doc Comments +4 added lines, -4 removed lines

@@ -516,7 +516,7 @@ 
 	/**

 	 * Logs a string in debug mode.

 	 *

-	 * @param $str the string to write

+	 * @param string $str the string to write

 	 *

 	 * @private

 	 */

@@ -537,7 +537,7 @@ 
 	 * This method is used by interface methods to print an error and where the function

 	 * was originally called from.

 	 *

-	 * @param $msg the message to print

+	 * @param string $msg the message to print

 	 *

 	 * @private

 	 */

@@ -664,7 +664,7 @@ 
 	/**

 	 * This method returns the phpCAS version.

 	 *

-	 * @return the phpCAS version.

+	 * @return string phpCAS version.

 	 */

 	function getVersion() {

 		return PHPCAS_VERSION;

@@ -1070,7 +1070,7 @@ 
 	 * @warning should not be called only after phpCAS::forceAuthentication()

 	 * or phpCAS::checkAuthentication().

 	 *

-	 * @return the login name of the authenticated user

+	 * @return string login name of the authenticated user

 	 */

 	function getUser() {

 		global $PHPCAS_CLIENT, $PHPCAS_AUTH_CHECK_CALL;

main/auth/cas/lib/CAS/client.php

Doc Comments +41 added lines, -39 removed lines

@@ -74,7 +74,7 @@ 
 	 *
 	 * Used by CASClient::PrintHTMLHeader() and CASClient::printHTMLFooter().
 	 *
-	 * @param $str the string to filter and output
+	 * @param string $str the string to filter and output
 	 *
 	 * @private
 	 */
@@ -187,7 +187,7 @@ 
 	/**
 	 * This method returns the language used by phpCAS.
 	 *
-	 * @return a string representing the language
+	 * @return string string representing the language
 	 *
 	 * @private
 	 */
@@ -212,7 +212,7 @@ 
 	/**
 	 * This method returns a string depending on the language.
 	 *
-	 * @param $str the index of the string in $_string.
+	 * @param integer $str the index of the string in $_string.
 	 *
 	 * @return the string corresponding to $index in $string.
 	 *
@@ -233,7 +233,7 @@ 
 	 * This method is used to set the language used by phpCAS. 
 	 * @note Can be called only once.
 	 *
-	 * @param $lang a string representing the language.
+	 * @param string $lang a string representing the language.
 	 *
 	 * @public
 	 * @sa CAS_LANG_FRENCH, CAS_LANG_ENGLISH
@@ -420,7 +420,7 @@ 
 	
 	/**
 	 * This method is used to retrieve the service validating URL of the CAS server.
-	 * @return a URL.
+	 * @return string URL.
 	 * @private
 	 */
 	function getServerServiceValidateURL()
@@ -441,7 +441,7 @@ 
 		}
 	/**
 	 * This method is used to retrieve the SAML validating URL of the CAS server.
-	 * @return a URL.
+	 * @return string URL.
 	 * @private
 	 */
 	function getServerSamlValidateURL()
@@ -460,7 +460,7 @@ 
 		}
 	/**
 	 * This method is used to retrieve the proxy validating URL of the CAS server.
-	 * @return a URL.
+	 * @return string URL.
 	 * @private
 	 */
 	function getServerProxyValidateURL()
@@ -541,7 +541,7 @@ 
 	
 	/**
 	 * This method checks to see if the request is secured via HTTPS
-	 * @return true if https, false otherwise
+	 * @return boolean if https, false otherwise
 	 * @private
 	 */
 	function isHttps() {
@@ -561,7 +561,7 @@ 
 	 * CASClient constructor.
 	 *
 	 * @param $server_version the version of the CAS server
-	 * @param $proxy TRUE if the CAS client is a CAS proxy, FALSE otherwise
+	 * @param boolean $proxy TRUE if the CAS client is a CAS proxy, FALSE otherwise
 	 * @param $server_hostname the hostname of the CAS server
 	 * @param $server_port the port the CAS server is running on
 	 * @param $server_uri the URI the CAS server is responding on
@@ -759,7 +759,7 @@ 
 	 * @warning should be called only after CASClient::forceAuthentication() or 
 	 * CASClient::isAuthenticated(), otherwise halt with an error.
 	 *
-	 * @return the login name of the authenticated user
+	 * @return string login name of the authenticated user
 	 */
 	function getUser()
 		{
@@ -831,7 +831,7 @@ 
 	/**
 	 * This method is called to be sure that the user is authenticated. When not 
 	 * authenticated, halt by redirecting to the CAS server; otherwise return TRUE.
-	 * @return TRUE when the user is authenticated; otherwise halt.
+	 * @return boolean when the user is authenticated; otherwise halt.
 	 * @public
 	 */
 	function forceAuthentication()
@@ -877,7 +877,7 @@ 
 	
 	/**
 	 * This method is called to check whether the user is authenticated or not.
-	 * @return TRUE when the user is authenticated, FALSE otherwise.
+	 * @return boolean when the user is authenticated, FALSE otherwise.
 	 * @public
 	 */
 	function checkAuthentication()
@@ -933,7 +933,7 @@ 
 	 * This method is called to check if the user is authenticated (previously or by
 	 * tickets given in the URL).
 	 *
-	 * @return TRUE when the user is authenticated. Also may redirect to the same URL without the ticket.
+	 * @return boolean when the user is authenticated. Also may redirect to the same URL without the ticket.
 	 *
 	 * @public
 	 */
@@ -1003,7 +1003,7 @@ 
 	
 	/**
 	 * This method tells if the current session is authenticated.
-	 * @return true if authenticated based soley on $_SESSION variable
+	 * @return boolean if authenticated based soley on $_SESSION variable
 	 * @since 0.4.22 by Brendan Arnold
 	 */
 	function isSessionAuthenticated ()
@@ -1017,7 +1017,7 @@ 
 	 *
 	 * @note This function switches to callback mode when needed.
 	 *
-	 * @return TRUE when the user has already been authenticated; FALSE otherwise.
+	 * @return boolean when the user has already been authenticated; FALSE otherwise.
 	 *
 	 * @private
 	 */
@@ -1129,7 +1129,7 @@ 
 	}
 	
 	/**
-	 * @return true if the current request is a logout request.
+	 * @return boolean if the current request is a logout request.
 	 * @private
 	 */
 	function isLogoutRequest() {
@@ -1241,7 +1241,7 @@ 
 	
 	/**
 	 * This method returns the Service Ticket provided in the URL of the request.
-	 * @return The service ticket.
+	 * @return string service ticket.
 	 * @private
 	 */
 	function getST()
@@ -1257,7 +1257,7 @@ 
 	
 	/**
 	 * This method tells if a Service Ticket was stored.
-	 * @return TRUE if a Service Ticket has been stored.
+	 * @return boolean if a Service Ticket has been stored.
 	 * @private
 	 */
 	function hasST()
@@ -1330,7 +1330,7 @@ 
 	 * $text_reponse and $tree_response on success. These parameters are used later
 	 * by CASClient::validatePGT() for CAS proxies.
 	 * Used for all CAS 1.0 validations
-	 * @param $validate_url the URL of the request to the CAS server.
+	 * @param string $validate_url the URL of the request to the CAS server.
 	 * @param $text_response the response of the CAS server, as is (XML text).
 	 * @param $tree_response the response of the CAS server, as a DOM XML tree.
 	 *
@@ -1460,7 +1460,7 @@ 
 	 * $text_reponse and $tree_response on success. These parameters are used later
 	 * by CASClient::validatePGT() for CAS proxies.
 	 *
-	 * @param $validate_url the URL of the request to the CAS server.
+	 * @param string $validate_url the URL of the request to the CAS server.
 	 * @param $text_response the response of the CAS server, as is (XML text).
 	 * @param $tree_response the response of the CAS server, as a DOM XML tree.
 	 *
@@ -1648,7 +1648,7 @@ 
 	
 	/**
 	 * This method returns the Proxy Granting Ticket given by the CAS server.
-	 * @return The Proxy Granting Ticket.
+	 * @return string Proxy Granting Ticket.
 	 * @private
 	 */
 	function getPGT()
@@ -1664,7 +1664,7 @@ 
 	
 	/**
 	 * This method tells if a Proxy Granting Ticket was stored.
-	 * @return TRUE if a Proxy Granting Ticket has been stored.
+	 * @return boolean if a Proxy Granting Ticket has been stored.
 	 * @private
 	 */
 	function hasPGT()
@@ -1697,7 +1697,7 @@ 
 	/**
 	 * This method sets/unsets callback mode.
 	 *
-	 * @param $callback_mode TRUE to set callback mode, FALSE otherwise.
+	 * @param boolean $callback_mode TRUE to set callback mode, FALSE otherwise.
 	 *
 	 * @private
 	 */
@@ -1710,7 +1710,7 @@ 
 	 * This method returns TRUE when the CAs client is running i callback mode, 
 	 * FALSE otherwise.
 	 *
-	 * @return A boolean.
+	 * @return boolean boolean.
 	 *
 	 * @private
 	 */
@@ -1734,7 +1734,7 @@ 
 	 * fact the URL of the current request without any CGI parameter, except if
 	 * phpCAS::setFixedCallbackURL() was used).
 	 *
-	 * @return The callback URL
+	 * @return string callback URL
 	 *
 	 * @private
 	 */
@@ -1777,6 +1777,7 @@ 
 	 * This method sets the callback url.
 	 *
 	 * @param $callback_url url to set callback 
+	 * @param string $url
 	 *
 	 * @private
 	 */
@@ -1861,7 +1862,7 @@ 
 	/**
 	 * This method reads a PGT from its Iou and deletes the corresponding storage entry.
 	 *
-	 * @param $pgt_iou the PGT Iou
+	 * @param string $pgt_iou the PGT Iou
 	 *
 	 * @return The PGT corresponding to the Iou, FALSE when not found.
 	 *
@@ -1991,7 +1992,7 @@ 
 	 * @param $err_code an error code (PHPCAS_SERVICE_OK on success).
 	 * @param $err_msg an error message (empty on success).
 	 *
-	 * @return a Proxy Ticket, or FALSE on error.
+	 * @return false|string Proxy Ticket, or FALSE on error.
 	 *
 	 * @private
 	 */
@@ -2093,14 +2094,14 @@ 
 	/**
 	 * This method is used to acces a remote URL.
 	 *
-	 * @param $url the URL to access.
+	 * @param string $url the URL to access.
 	 * @param $cookies an array containing cookies strings such as 'name=val'
 	 * @param $headers an array containing the HTTP header lines of the response
 	 * (an empty array on failure).
 	 * @param $body the body of the response, as a string (empty on failure).
 	 * @param $err_msg an error message, filled on failure.
 	 *
-	 * @return TRUE on success, FALSE otherwise (in this later case, $err_msg
+	 * @return boolean on success, FALSE otherwise (in this later case, $err_msg
 	 * contains an error message).
 	 *
 	 * @private
@@ -2197,7 +2198,7 @@ 
 	/**
 	 * This method is used to build the SAML POST body sent to /samlValidate URL.
 	 *
-	 * @return the SOAP-encased SAMLP artifact (the ticket).
+	 * @return string SOAP-encased SAMLP artifact (the ticket).
 	 *
 	 * @private
 	 */
@@ -2235,7 +2236,7 @@ 
 	 * @param $output the output of the service (also used to give an error
 	 * message on failure).
 	 *
-	 * @return TRUE on success, FALSE otherwise (in this later case, $err_code
+	 * @return boolean on success, FALSE otherwise (in this later case, $err_code
 	 * gives the reason why it failed and $output contains an error message).
 	 *
 	 * @public
@@ -2382,7 +2383,7 @@ 
 	
 	/**
 	 * This method returns the Proxy Ticket provided in the URL of the request.
-	 * @return The proxy ticket.
+	 * @return string proxy ticket.
 	 * @private
 	 */
 	function getPT()
@@ -2401,14 +2402,14 @@ 
 	
 	/**
 	 * This method tells if a Proxy Ticket was stored.
-	 * @return TRUE if a Proxy Ticket has been stored.
+	 * @return boolean if a Proxy Ticket has been stored.
 	 * @private
 	 */
 	function hasPT()
 		{ return !empty($this->_pt); }
 	/**
 	 * This method returns the SAML Ticket provided in the URL of the request.
-	 * @return The SAML ticket.
+	 * @return string SAML ticket.
 	 * @private
 	 */
 	function getSA()
@@ -2424,7 +2425,7 @@ 
 	
 	/**
 	 * This method tells if a SAML Ticket was stored.
-	 * @return TRUE if a SAML Ticket has been stored.
+	 * @return boolean if a SAML Ticket has been stored.
 	 * @private
 	 */
 	function hasSA()
@@ -2442,6 +2443,7 @@ 
 	/**
 	 * This method is used to validate a ST or PT; halt on failure
 	 * Used for all CAS 2.0 validations
+	 * @param string $validate_url
 	 * @return bool TRUE when successfull, halt otherwise by calling CASClient::authError().
 	 *
 	 * @private
@@ -2556,7 +2558,7 @@ 
 	 * This method returns the URL of the current request (without any ticket
 	 * CGI parameter).
 	 *
-	 * @return The URL
+	 * @return string URL
 	 *
 	 * @private
 	 */
@@ -2634,7 +2636,7 @@ 
 	/**
 	 * This method sets the URL of the current request 
 	 *
-	 * @param $url url to set for service
+	 * @param string $url url to set for service
 	 *
 	 * @private
 	 */
@@ -2649,9 +2651,9 @@ 
 	/**
 	 * This method is used to print the HTML output when the user was not authenticated.
 	 *
-	 * @param $failure the failure that occured
+	 * @param string $failure the failure that occured
 	 * @param $cas_url the URL the CAS server was asked for
-	 * @param $no_response the response from the CAS server (other 
+	 * @param boolean $no_response the response from the CAS server (other 
 	 * parameters are ignored if TRUE)
 	 * @param $bad_response bad response from the CAS server ($err_code
 	 * and $err_msg ignored if TRUE)