adamjakab / SuiteCRM

ModuleInstall/ModuleScanner.php

Doc Comments +1 added lines

@@ -707,6 +707,7 @@
 	/**
 	 *This function will scan the Manifest for disabled actions specified in $GLOBALS['sugar_config']['moduleInstaller']['disableActions']
 	 *if $GLOBALS['sugar_config']['moduleInstaller']['disableRestrictedCopy'] is set to false or not set it will call on scanCopy to ensure that it is not overriding files
+	 * @param string $manifestPath
 	 */
     public function scanManifest($manifestPath)
     {

ModuleInstall/PackageManager/PackageController.php

Doc Comments +3 added lines, -3 removed lines

@@ -145,7 +145,7 @@ 
          * @param category_id   this is passed via POST and is the category id of the release we wish to download
          * @param package_id   this is passed via POST and is the package id of the release we wish to download
          * @param release_id   this is passed via POST and is the release id of the release we wish to download
-         * @return bool         true is successful in downloading, false otherwise
+         * @return boolean|null         true is successful in downloading, false otherwise
          */
         function download(){
             global $sugar_config;
@@ -345,8 +345,8 @@ 
         /**
          * Remove metadata files such as foo-manifest
          * Enter description here ...
-         * @param unknown_type $file
-         * @param unknown_type $meta
+         * @param string $file
+         * @param string $meta
          */
         protected function rmMetaFile($file, $meta)
         {

ModuleInstall/PackageManager/PackageManager.php

Doc Comments +20 added lines, -9 removed lines

@@ -133,7 +133,7 @@ 
 
     /**
      * Get a list of categories from the SugarDepot
-     * @param category_id   the category id of parent to obtain
+     * @param category_id   string category id of parent to obtain
      * @param filter        an array of filters to pass to limit the query
      * @return array        an array of categories for display on the client
      */
@@ -150,6 +150,9 @@ 
         return $nodes;
     }
 
+    /**
+     * @param string $category_id
+     */
     function getPackages($category_id, $filter = array()){
         $nodes = array();
         $results = PackageManagerComm::getPackages($category_id, $filter);
@@ -182,10 +185,10 @@ 
     /**
      * Retrieve the package as specified by the $id from the heartbeat server
      *
-     * @param category_id   the category_id to which the release belongs
-     * @param package_id    the package_id to which the release belongs
-     * @param release_id    the release_id to download
-     * @return filename - the path to which the zip file was saved
+     * @param category_id   string category_id to which the release belongs
+     * @param package_id    string package_id to which the release belongs
+     * @param release_id    string release_id to download
+     * @return string|null - the path to which the zip file was saved
      */
     public function download($category_id, $package_id, $release_id)
     {
@@ -207,8 +210,8 @@ 
      * Given the Mambo username, password, and download key attempt to authenticate, if
      * successful then store these credentials
      *
-     * @param username      Mambo username
-     * @param password      Mambo password
+     * @param username      string username
+     * @param password      string password
      * @param systemname   the user's download key
      * @return              true if successful, false otherwise
      */
@@ -261,8 +264,8 @@ 
     /**
      * Retrieve documentation for the given release or package
      *
-     * @param package_id	the specified package to retrieve documentation
-     * @param release_id	the specified release to retrieve documentation
+     * @param package_id	string specified package to retrieve documentation
+     * @param release_id	string specified release to retrieve documentation
      *
      * @return documents
      */
@@ -356,6 +359,9 @@ 
 
     private $cleanUpDirs = array();
 
+    /**
+     * @param false|string $dir
+     */
     private function addToCleanup($dir)
     {
         if(empty($this->cleanUpDirs)) {
@@ -380,6 +386,11 @@ 
         return( "$my_zip_dir/$file_in_zip" );
     }
 
+    /**
+     * @param string $zip_file
+     *
+     * @return string
+     */
     function extractManifest( $zip_file,$base_tmp_upgrade_dir ) {
         global $sugar_config;
         $base_upgrade_dir       = $this->upload_dir."/upgrades";

ModuleInstall/PackageManager/PackageManagerComm.php

Doc Comments +4 added lines, -4 removed lines

@@ -150,7 +150,7 @@ 
      * A generic function which given a category_id some filter will
      * return an object which contains categories and packages
      *
-     * @param category_id  the category_id to fetch
+     * @param category_id  string category_id to fetch
      * @param filter       a filter which will limit theh number of results returned
      * @return categories_and_packages
      * @see categories_and_packages
@@ -236,7 +236,7 @@ 
      * Call the PackageManagerDownloader function which uses curl in order to download the specified file
      *
      * @param filename	the file to download
-     * @return path to downloaded file
+     * @return string to downloaded file
      */
     static public function performDownload($filename){
         PackageManagerComm::initialize();
@@ -267,7 +267,7 @@ 
     /**
      * Log that the user has clicked on a document
      *
-     * @param document_id	the document the user has clicked on
+     * @param document_id	string document the user has clicked on
      */
     function downloadedDocumentation($document_id){
     	 PackageManagerComm::initialize();
@@ -293,7 +293,7 @@ 
      /**
      * Ping the server to determine if we have established proper communication
      *
-     * @return true if we can communicate with the server and false otherwise
+     * @return boolean if we can communicate with the server and false otherwise
     */
      function isAlive(){
         PackageManagerComm::initialize(false);

ModuleInstall/PackageManager/PackageManagerDisplay.php

Doc Comments +2 added lines

@@ -302,6 +302,7 @@ 
      * A Static method used to build the initial treeview when the page is first displayed
      *
      * @param String div_id - this div in which to display the tree
+     * @param string $div_id
      * @return Tree - the tree that is built
      */
     static function buildTreeView($div_id, $isAlive = true){
@@ -332,6 +333,7 @@ 
      * @param String type - module/patch....
      * @param String manifest - the path to the manifest file
      * @param String modify_field - the field to update when the radio button is changed
+     * @param string $form_action
      * @return String - a form used to display the license
      */
     function getLicenseDisplay($license_file, $form_action, $next_step, $zipFile, $type, $manifest, $modify_field){

ModuleInstall/PackageManager/PackageManagerDownloader.php

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
 	 * @param save_dir			(optional) if specified it will direct where to save the file once downloaded
 	 * @param download_sever	(optional) if specified it will direct the url for the download
 	 *
-	 * @return the full path of the saved file
+	 * @return string full path of the saved file
 	 */
 	function download($session_id, $file_name, $save_dir = '', $download_server = ''){
 		if(empty($save_dir)){

modules/ACL/ACLController.php

Doc Comments +8 added lines, -1 removed lines

@@ -76,6 +76,9 @@ 
 	}
 	/* END - SECURITY GROUPS */	
 
+	/**
+	 * @param string $value
+	 */
 	static function requireOwner($category, $value, $type='module'){
 			global $current_user;
 			if(is_admin($current_user))return false;
@@ -83,6 +86,10 @@ 
 	}
 
 	/* BEGIN - SECURITY GROUPS */
+
+	/**
+	 * @param string $value
+	 */
 	static function requireSecurityGroup($category, $value, $type='module'){
 			global $current_user;
 			if(is_admin($current_user))return false;
@@ -142,7 +149,7 @@ 
 	 * Check to see if the module is available for this user.
 	 *
 	 * @param String $module_name
-	 * @return true if they are allowed.  false otherwise.
+	 * @return boolean if they are allowed.  false otherwise.
 	 */
 	static function checkModuleAllowed($module_name, $actions)
 	{

modules/ACLActions/ACLAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
      * returns the label  associated with an access level
      * these label definitions  exist in the definitions in modules/ACLActions/actiondefs.php
      * @param INT $access - the access level you want the color for
-     * @return the access level label or false if the level does not exist
+     * @return string|false access level label or false if the level does not exist
      */
     protected static function AccessLabel($access){
         global $ACLActionAccessLevels;

modules/ACLRoles/ACLRole.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
  *
  * Sets the relationship between a role and an action and sets the access level of that relationship
  *
- * @param GUID $role_id - the role id
+ * @param string $role_id - the role id
  * @param GUID $action_id - the ACL Action id
  * @param int $access - the access level ACL_ALLOW_ALL ACL_ALLOW_NONE ACL_ALLOW_OWNER...
  */