adamjakab / SuiteCRM

install/TeamDemoData.php

Doc Comments +1 added lines

@@ -180,6 +180,7 @@
 	
 	/**
 	 * 
+	 * @param string $name
 	 */
 	function _quick_create($name)
 	{

install/UserDemoData.php

Doc Comments +2 added lines

@@ -64,6 +64,7 @@ 
 
 	/**
 	 * Constructor for creating user demo data
+	 * @param integer $seed_user
 	 */
 	function UserDemoData($seed_user, $large_scale_test = false)
 	{
@@ -163,6 +164,7 @@ 
 
 	/**
 	 *
+	 * @param string $name
 	 */
 	function _quick_create_user($name)
 	{

jssource/jsmin.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,8 +13,8 @@
      * line and mult-line comments. Pass 2 performs some sanitation on each of the lines
      * and pass 3 works on stripping out unnecessary spaces.
      *
-     * @param string $js
-     * @param string $currentOptions
+     * @param string $text
+     * @param string $compression
      * @return void
      */
     private function __construct($text, $compression) {

jssource/Minifier.php

Doc Comments +2 added lines

@@ -361,6 +361,7 @@ 
      * Pushes the index ahead to the next instance of the supplied string. If it is found the first character of the
      * string is returned.
      *
+     * @param string $string
      * @return string|false Returns the first character of the string if found, false otherwise.
      */
     protected function getNext($string)
@@ -449,6 +450,7 @@ 
     /**
      * Checks to see if a character is alphanumeric.
      *
+     * @param string|false $char
      * @return bool
      */
     static protected function isAlphaNumeric($char)

jssource/minify_utils.php

Doc Comments +11 added lines

@@ -81,6 +81,10 @@ 
      * and places the concatenated file in root directory
      * @from_path root directory where processing should take place
      */
+
+    /**
+     * @param string $from_path
+     */
     function ConcatenateFiles($from_path){
 
         // Minifying the group files takes a long time sometimes.
@@ -205,6 +209,9 @@ 
 
     }
 
+    /**
+     * @param string $bu_path
+     */
     function create_backup_folder($bu_path){
         $bu_path = str_replace('\\', '/', $bu_path);
         //get path after root
@@ -244,6 +251,10 @@ 
      * @from_path file name and path to be processed
      * @to_path file name and path to be  used to place newly compressed contents
      */
+
+    /**
+     * @param string $from_path
+     */
     function CompressFiles($from_path,$to_path){
     if(!defined('JSMIN_AS_LIB')){
         define('JSMIN_AS_LIB', true);

ModuleInstall/ModuleInstaller.php

Doc Comments +24 added lines, -3 removed lines

@@ -82,6 +82,10 @@ 
     *
     * Finally it runs over a list of defined tasks; then install_beans, then install_custom_fields, then clear the Vardefs, run a RepairAndClear, then finally call rebuild_relationships.
     */
+
+	/**
+	 * @param false|string $base_dir
+	 */
 	function install($base_dir, $is_upgrade = false, $previous_version = ''){
 		if(defined('TEMPLATE_URL'))SugarTemplateUtilities::disableCache();
         if ((defined('MODULE_INSTALLER_PACKAGE_SCAN') && MODULE_INSTALLER_PACKAGE_SCAN)
@@ -309,6 +313,7 @@ 
 	 * Removes any files that were added by the loaded module. If the files already existed prior to install
 	 * it will be handled by copy_path with the uninstall parameter.
 	 *
+	 * @param string $backup_path
 	 */
 	function uninstall_new_files($cp, $backup_path){
 		$zip_files = $this->dir_get_files($cp['from'],$cp['from']);
@@ -1097,7 +1102,7 @@ 
     /**
      * Check labels inside label files and remove them
      * 
-     * @param $basePath - path to files with labels
+     * @param string $basePath - path to files with labels
      * @param array $labelDefinitions - format like output from AbstractRelationship buildLabels()
      */
     public function uninstallLabels($basePath, $labelDefinitions)
@@ -1122,7 +1127,7 @@ 
      * 
      * @param $uninstalLabes
      * @param $definition
-     * @param $filename
+     * @param string $filename
      */
     protected function uninstallLabel($uninstalLabes, $definition, $filename)
     {
@@ -1154,7 +1159,7 @@ 
      * Save labels that not need be uninstalled at this case
      * 
      * @param $filename
-     * @param $stringsName
+     * @param string $stringsName
      * @param $strings
      */
     protected function saveContentToFile($filename, $stringsName, $strings)
@@ -1366,6 +1371,10 @@ 
      * For each definition it calls db->createTableParams to build the relationships table if it does not exist,
      * and SugarBean::createRelationshipMeta to add the relationship into the 'relationships' table.
      */
+
+	/**
+	 * @param string $file
+	 */
 	function install_relationship($file)
 	{
 		$_REQUEST['moduleInstaller'] = true;
@@ -1791,6 +1800,10 @@ 
      * custom/Extension/modules/$module/<path> (_override files last) and concatenates them to custom/modules/$module/<path>/<file>.
      * Then it does the same thing in custom/Extension/application/<path>, concatenating those files and copying the result to custom/application/<path>/<file>
      */
+
+	/**
+	 * @param string $name
+	 */
 	function merge_files($path, $name, $filter = '', $application = false){
 		if(!$application){
 		$GLOBALS['log']->debug( get_class($this)."->merge_files() : merging module files in custom/Extension/modules/<module>/$path to custom/modules/<module>/$path$name");
@@ -1988,6 +2001,11 @@ 
 	}
 
 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:15:18 PM 	*/
+/**
+ * @param string $source
+ * @param string $dest
+ * @param string $backup_path
+ */
 function copy_recursive_with_backup( $source, $dest, $backup_path, $uninstall=false ) {
 	if(is_file($source)) {
 	    if($uninstall) {
@@ -2510,6 +2528,9 @@ 
 
 }
 
+    /**
+     * @param string $action
+     */
     function UpdateSystemTabs($action, $installed_modules){
         require_once("modules/MySettings/TabController.php");
         $controller = new TabController();

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";