adamjakab / SuiteCRM

modules/Users/authentication/SAMLAuthenticate/lib/onelogin/saml/xmlsec.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * Determine if the document passes the security test.
      *
      * @return
-     *   TRUE if the document passes. This could throw a generic Exception
+     boolean   TRUE if the document passes. This could throw a generic Exception
      *   if the document or key cannot be found.
      */
     

modules/Users/authentication/SAMLAuthenticate/lib/xmlseclibs/xmlseclibs.php

Doc Comments +39 added lines, -1 removed lines

@@ -46,6 +46,9 @@ 
 */
 
 /* helper function */
+/**
+ * @param DOMNodeList $arAtts
+ */
 function sortAndAddAttrs($element, $arAtts) {
    $newAtts = array();
    foreach ($arAtts AS $attnode) {
@@ -58,6 +61,10 @@ 
 }
 
 /* helper function */
+/**
+ * @param DOMDocument $tree
+ * @param boolean $withcomments
+ */
 function canonical($tree, $element, $withcomments) {
     if ($tree->nodeType != XML_DOCUMENT_NODE) {
         $dom = $tree->ownerDocument;
@@ -433,6 +440,9 @@ 
         return openssl_verify ($data, $signature, $this->key, $algo);
     }
 
+    /**
+     * @return string
+     */
     public function encryptData($data) {
         switch ($this->cryptParams['library']) {
             case 'mcrypt':
@@ -444,6 +454,11 @@ 
         }
     }
 
+    /**
+     * @param string $data
+     *
+     * @return string
+     */
     public function decryptData($data) {
         switch ($this->cryptParams['library']) {
             case 'mcrypt':
@@ -475,6 +490,9 @@ 
         return $this->cryptParams['method'];
     }
 
+    /**
+     * @param integer $type
+     */
     static function makeAsnSegment($type, $string) {
         switch ($type){
             case 0x02:
@@ -501,6 +519,11 @@ 
     }
 
     /* Modulus and Exponent must already be base64 decoded */
+
+    /**
+     * @param string $modulus
+     * @param string $exponent
+     */
     static function convertRSA($modulus, $exponent) {
         /* make an ASN publicKeyInfo */
         $exponentEncoding = XMLSecurityKey::makeAsnSegment(0x02, $exponent);
@@ -533,7 +556,7 @@ 
      * Will return the X509 certificate in PEM-format if this key represents
      * an X509 certificate.
      *
-     * @return  The X509 certificate or NULL if this key doesn't represent an X509-certificate.
+     * @return  string|null X509 certificate or NULL if this key doesn't represent an X509-certificate.
      */
     public function getX509Certificate() {
         return $this->x509Certificate;
@@ -596,6 +619,9 @@ 
         return $guid;
     }
 
+    /**
+     * @param string $objDoc
+     */
     public function locateSignature($objDoc) {
         if ($objDoc instanceof DOMDocument) {
             $doc = $objDoc;
@@ -613,6 +639,9 @@ 
         return NULL;
     }
 
+    /**
+     * @param string $name
+     */
     public function createNewSignNode($name, $value=NULL) {
         $doc = $this->sigNode->ownerDocument;
         if (! is_null($value)) {
@@ -1045,6 +1074,9 @@ 
         return NULL;
     }
 
+    /**
+     * @param XMLSecurityKey $objKey
+     */
     public function verify($objKey) {
         $doc = $this->sigNode->ownerDocument;
         $xpath = new DOMXPath($doc);
@@ -1057,6 +1089,9 @@ 
         return $objKey->verifySignature($this->signedInfo, base64_decode($sigValue));
     }
 
+    /**
+     * @return string
+     */
     public function signData($objKey, $data) {
         return $objKey->signData($data);
     }
@@ -1152,6 +1187,9 @@ 
         }
     }
 
+    /**
+     * @param DOMNode $parentRef
+     */
     static function staticAdd509Cert($parentRef, $cert, $isPEMFormat=TRUE, $isURL=False, $xpath=NULL) {
           if ($isURL) {
             $cert = file_get_contents($cert);

modules/Users/authentication/SAMLAuthenticate/SAMLAuthenticateUser.php

Doc Comments +1 added lines, -1 removed lines

@@ -338,7 +338,7 @@
     /**
      * Fetches user by provided ID and field name
      *
-     * @param mixed $id
+     * @param string $id
      * @param string $field
      * @return User
      */

modules/Users/password_utils.php

Doc Comments +3 added lines

@@ -79,6 +79,9 @@
 		return $mod_strings['LBL_EMAIL_NOT_SENT'];
 }
 
+/**
+ * @param string $username
+ */
 function  hasPasswordExpired($username){
     $current_user= new user();
     $usr_id=$current_user->retrieve_user_id($username);

modules/Users/User.php

Doc Comments +4 added lines, -9 removed lines

@@ -269,7 +269,7 @@ 
 	 *
 	 * @param string $name Name of the preference to set
 	 * @param string $value Value to set preference to
-	 * @param null $nosession For BC, ignored
+	 * @param integer $nosession For BC, ignored
 	 * @param string $category Name of the category to retrieve
 	 */
 	public function setPreference(
@@ -560,10 +560,6 @@ 
 
 	/**
 	 * @deprecated
-	* @param string $user_name - Must be non null and at least 2 characters
-	* @param string $user_password - Must be non null and at least 1 character.
-	* @desc Take an unencrypted username and password and return the encrypted password
-	* @return string encrypted password for storage in DB and comparison against DB password.
 	*/
 	function encrypt_password($user_password)
 	{
@@ -598,8 +594,8 @@ 
      *
      * @param string id ID of the User
      * @param bool encode encode the result
-     * @return object User bean
-     * @return null null if no User found
+     * @return User|null User bean
+     * @return User|null null if no User found
      */
 	function retrieve($id = -1, $encode = true, $deleted = true) {
 		$ret = parent::retrieve($id, $encode, $deleted);
@@ -735,7 +731,7 @@ 
 
 	/**
 	 * Check that md5-encoded password matches existing hash
-	 * @param string $password MD5-encoded password
+	 * @param string $password_md5 MD5-encoded password
 	 * @param string $user_hash DB hash
 	 * @return bool Match or not?
 	 */
@@ -1647,7 +1643,6 @@ 
     /**
      * Get user first day of week.
      *
-     * @param [User] $user user object, current user if not specified
      * @return int : 0 = Sunday, 1 = Monday, etc...
      */
     public function get_first_day_of_week()

modules/Users/UserViewHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -760,7 +760,7 @@
      * setUserType
      * This function is used to set the user_type variable for a given User instance
      *
-     * @param Mixed $user The user instance to set the user_type variable on
+     * @param SugarBean $user The user instance to set the user_type variable on
      * @return String value representing the user type
      */
     function setUserType($user)

modules/Users/views/view.wizard.php

Doc Comments +2 added lines, -2 removed lines

@@ -267,7 +267,7 @@ 
      * in the array.
      *
      * @param array $currenciesArray Array of currencies to sort
-     * @return array|string Array of sorted currencies with the US Dollar as the first
+     * @return string Array of sorted currencies with the US Dollar as the first
      */
     public function correctCurrenciesSymbolsSort($currenciesArray)
     {
@@ -289,7 +289,7 @@ 
      *
      * @see correctCurrenciesSymbolsSort
      * @param $array
-     * @return array|string Javascript code snippet of currencies array
+     * @return string Javascript code snippet of currencies array
      */
     public function pushCurrencyArrayToString($array)
     {

modules/vCals/HTTP_WebDAV_Server_vCal.php

Doc Comments +2 added lines, -2 removed lines

@@ -392,7 +392,7 @@ 
          * PUT method handler
          *
          * @param  array  parameter passing array
-         * @return bool   true on success
+         * @return boolean|null   true on success
          */
         function PUT(&$options)
         {
@@ -416,7 +416,7 @@ 
          * UNLOCK method handler
          *
          * @param  array  general parameter passing array
-         * @return bool   true on success
+         * @return string   true on success
          */
         function unlock(&$options)
         {

modules/vCals/vCal.php

Doc Comments +2 added lines, -2 removed lines

@@ -314,7 +314,7 @@ 
      * escape iCal chars as per RFC 5545: http://tools.ietf.org/html/rfc5545#section-3.3.11
      *
      * @param string $string string to escape chars
-     * @return escaped string
+     * @return string string
      */
     public static function escape_ical_chars($string)
     {
@@ -326,7 +326,7 @@ 
      * unescape iCal chars as per RFC 5545: http://tools.ietf.org/html/rfc5545#section-3.3.11
      *
      * @param string $string string to escape chars
-     * @return unescaped string
+     * @return string string
      */
     public static function unescape_ical_chars($string)
     {