adamjakab / SuiteCRM

modules/UpgradeWizard/uw_utils.php

Doc Comments +22 added lines, -3 removed lines

@@ -283,7 +283,7 @@ 
  *
  * @param string the directory name to remove
  * @param boolean whether to just empty the given directory, without deleting the given directory.
- * @return boolean True/False whether the directory was deleted.
+ * @return boolean|null True/False whether the directory was deleted.
  */
 
 function copyRecursiveBetweenDirectories($from,$to){
@@ -1176,6 +1176,7 @@ 
 
 /**
  * is a file that we blow away automagically
+ * @param string $file
  */
 function isAutoOverwriteFile($file) {
 	$overwriteDirs = array(
@@ -1811,6 +1812,9 @@ 
 	return $errors;
 }
 
+/**
+ * @param string $file_path
+ */
 function fileCopy($file_path){
 	if(file_exists(clean_path($_SESSION['unzip_dir'].'/'.$_SESSION['zip_from_dir'].'/'.$file_path))) {
 		$file = clean_path($_SESSION['unzip_dir'].'/'.$_SESSION['zip_from_dir'].'/'.$file_path);
@@ -1930,6 +1934,9 @@ 
 }
 
 if ( !function_exists('extractFile') ) {
+/**
+ * @return string
+ */
 function extractFile($zip_file, $file_in_zip) {
     global $base_tmp_upgrade_dir;
 
@@ -1947,6 +1954,9 @@ 
 }
 
 if ( !function_exists('extractManifest') ) {
+/**
+ * @return string
+ */
 function extractManifest($zip_file) {
 	logThis('extracting manifest.');
     return(extractFile($zip_file, "manifest.php"));
@@ -2027,7 +2037,7 @@ 
 /**
  * Verifies a manifest from a patch or module to be compatible with the current Sugar version and flavor
  * @param array manifest Standard manifest array
- * @return string Error message, blank on success
+ * @return null|boolean Error message, blank on success
  */
 function validate_manifest($manifest) {
 	logThis('validating manifest.php file');
@@ -2548,6 +2558,9 @@ 
     }
 }
 
+/**
+ * @param boolean $disable
+ */
 function handleExecuteSqlKeys($db, $tableName, $disable)
 {
     if(empty($tableName)) return true;
@@ -2659,6 +2672,9 @@ 
 }
 
 
+/**
+ * @param string $query
+ */
 function getAlterTable($query){
 	$query = strtolower($query);
 	if (preg_match('/^\s*alter\s+table\s+/', $query)) {
@@ -2877,6 +2893,9 @@ 
 	return $currState;
 }
 
+/**
+ * @param string $step
+ */
 function didThisStepRunBefore($step,$SubStep=''){
 	if($step == null) return;
 	$upgrade_progress_dir = sugar_cached('upgrades/temp');
@@ -3249,7 +3268,7 @@ 
  * to have the value of the $column_name parameter
  *
  * @param $bean SugarBean which we are adding team_set_id column to
- * @param $column_name The name of the column containing the default team_set_id value
+ * @param string $column_name The name of the column containing the default team_set_id value
  */
 function upgradeTeamColumn($bean, $column_name) {
 	//first let's check to ensure that the team_set_id field is defined, if not it could be the case that this is an older

modules/UserPreferences/UserPreference.php

Doc Comments +2 added lines, -2 removed lines

@@ -185,7 +185,7 @@ 
      * Loads preference by category from database. Saving will be done in utils.php -> sugar_cleanup
      *
      * @param string $category name of the category to retreive, defaults to global scope
-     * @return bool successful?
+     * @return null|boolean successful?
      */
     public function loadPreferences(
         $category = 'global'
@@ -291,7 +291,6 @@ 
      * sugar_cleanup if a setPreference has been called during one round trip.
      *
      * @global user will use current_user if no user specificed in $user param
-     * @param user $user User object to retrieve, otherwise user current_user
      * @param bool $all save all of the preferences? (Dangerous)
      *
      */
@@ -387,6 +386,7 @@ 
     /**
      * Updates every user pref with a new key value supports 2 levels deep, use append to
      * array if you want to append the value to an array
+     * @param string $key
      */
     public static function updateAllUserPrefs(
         $key,

modules/Users/authentication/AuthenticationController.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
 	 * This is called on every page hit.
 	 * It returns true if the current session is authenticated or false otherwise
 	 *
-	 * @return booelan
+	 * @return boolean
 	 */
 	public function sessionAuthenticate()
 	{

modules/Users/authentication/EmailAuthenticate/EmailAuthenticateUser.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
     /**
      * Sends the users password to the email address or sends
      *
-     * @param unknown_type $user_id
+     * @param string $user_id
      * @param unknown_type $password
      */
     function sendEmailPassword($user_id, $password){

modules/Users/authentication/LDAPAuthenticate/LDAPAuthenticateUser.php

Doc Comments +2 added lines, -1 removed lines

@@ -239,7 +239,7 @@ 
 
 	/**
 	 * takes in a name and creates the appropriate search filter for that user name including any additional filters specified in the system settings page
-	 * @param $name
+	 * @param string $name
 	 * @return String
 	 */
 	function getUserNameFilter($name){
@@ -339,6 +339,7 @@ 
 	 /**
     * @return string appropriate value for username when binding to directory server.
     * @param string $user_name the value provided in login form
+    * @param string $password
     * @desc Take the login username and return either said username for AD or lookup
      * distinguished name using anonymous credentials for OpenLDAP.
      * Contributions by Erik Mitchell erikm@logicpd.com

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

Doc Comments +4 added lines, -1 removed lines

@@ -50,7 +50,7 @@ 
      * Generate the request.
      *
      * @return
-     *   A fully qualified URL that can be redirected to in order to process
+     string   A fully qualified URL that can be redirected to in order to process
      *   the authorization request.
      */
     public function create() {
@@ -76,6 +76,9 @@ 
       }
     }
 
+    /**
+     * @param integer $length
+     */
     private function generateUniqueID($length) {
       $chars = "abcdef0123456789";
       $chars_len = strlen($chars);

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
      */