chamilo / chamilo-lms

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

@@ -523,7 +523,7 @@ 
     /**

      * Logs a string in debug mode.

      *

-     * @param $str the string to write

+     * @param string $str the string to write

      *

      * @private

      */

@@ -545,7 +545,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

      */

@@ -678,7 +678,7 @@ 
     /**

      * This method returns the phpCAS version.

      *

-     * @return the phpCAS version.

+     * @return string phpCAS version.

      */

     function getVersion()

     {

@@ -1105,7 +1105,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()

     {

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

Doc Comments +41 added lines, -39 removed lines

@@ -73,7 +73,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
      */
@@ -185,7 +185,7 @@ 
     /**
      * This method returns the language used by phpCAS.
      *
-     * @return a string representing the language
+     * @return string string representing the language
      *
      * @private
      */
@@ -211,7 +211,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.
      *
@@ -232,7 +232,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
@@ -426,7 +426,7 @@ 
 
     /**
      * This method is used to retrieve the service validating URL of the CAS server.
-     * @return a URL.
+     * @return string URL.
      * @private
      */
     function getServerServiceValidateURL()
@@ -448,7 +448,7 @@ 
 
     /**
      * This method is used to retrieve the SAML validating URL of the CAS server.
-     * @return a URL.
+     * @return string URL.
      * @private
      */
     function getServerSamlValidateURL()
@@ -468,7 +468,7 @@ 
 
     /**
      * This method is used to retrieve the proxy validating URL of the CAS server.
-     * @return a URL.
+     * @return string URL.
      * @private
      */
     function getServerProxyValidateURL()
@@ -549,7 +549,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()
@@ -570,7 +570,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
@@ -778,7 +778,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()
     {
@@ -860,7 +860,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()
@@ -906,7 +906,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()
@@ -960,7 +960,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
      */
@@ -1026,7 +1026,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()
@@ -1040,7 +1040,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
      */
@@ -1154,7 +1154,7 @@ 
     }
 
     /**
-     * @return true if the current request is a logout request.
+     * @return boolean if the current request is a logout request.
      * @private
      */
     function isLogoutRequest()
@@ -1270,7 +1270,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()
@@ -1290,7 +1290,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()
@@ -1365,7 +1365,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.
      *
@@ -1497,7 +1497,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.
      *
@@ -1684,7 +1684,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()
@@ -1704,7 +1704,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()
@@ -1739,7 +1739,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
      */
@@ -1752,7 +1752,7 @@ 
      * This method returns TRUE when the CAs client is running i callback mode,
      * FALSE otherwise.
      *
-     * @return A boolean.
+     * @return boolean boolean.
      *
      * @private
      */
@@ -1776,7 +1776,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
      */
@@ -1820,6 +1820,7 @@ 
      * This method sets the callback url.
      *
      * @param $callback_url url to set callback
+     * @param string $url
      *
      * @private
      */
@@ -1904,7 +1905,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.
      *
@@ -2037,7 +2038,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
      */
@@ -2140,14 +2141,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
@@ -2250,7 +2251,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
      */
@@ -2289,7 +2290,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
@@ -2436,7 +2437,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()
@@ -2457,7 +2458,7 @@ 
 
     /**
      * 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()
@@ -2467,7 +2468,7 @@ 
 
     /**
      * This method returns the SAML Ticket provided in the URL of the request.
-     * @return The SAML ticket.
+     * @return string SAML ticket.
      * @private
      */
     function getSA()
@@ -2487,7 +2488,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()
@@ -2507,6 +2508,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
@@ -2623,7 +2625,7 @@ 
      * This method returns the URL of the current request (without any ticket
      * CGI parameter).
      *
-     * @return The URL
+     * @return string URL
      *
      * @private
      */
@@ -2701,7 +2703,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
      */
@@ -2716,9 +2718,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)

main/auth/cas/lib/CAS/domxml-php4-to-php5.php

Doc Comments +7 added lines

@@ -811,6 +811,9 @@ 
         $this->myDOMXPath = new DOMXPath($this->myOwnerDocument->myDOMNode);
     }
 
+    /**
+     * @param string $eval_str
+     */
     function xpath_eval($eval_str, $contextnode = null)
     {
         if (method_exists($this->myDOMXPath, 'evaluate')) {
@@ -824,6 +827,10 @@ 
         return ($xp->type === XPATH_UNDEFINED) ? false : $xp;
     }
 
+    /**
+     * @param string $prefix
+     * @param string $namespaceURI
+     */
     function xpath_register_ns($prefix, $namespaceURI)
     {
         return $this->myDOMXPath->registerNamespace($prefix, $namespaceURI);