adamjakab / SuiteCRM

include/utils/LogicHook.php

Doc Comments +4 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
 	/**
 	 * Static Function which returns and instance of LogicHook
 	 *
-	 * @return unknown
+	 * @return LogicHook
 	 */
 	static function initialize(){
 		if(empty($GLOBALS['logic_hook']))
@@ -153,6 +153,9 @@ 
 		return $hook_array;
 	}
 
+	/**
+	 * @param string $module_dir
+	 */
 	public function getHooks($module_dir, $refresh = false)
 	{
 	    if($refresh || !isset(self::$hooks[$module_dir])) {
@@ -169,7 +172,6 @@ 
 	 * @param string $module_dir
 	 * @param string $event
 	 * @param array $arguments
-	 * @param SugarBean $bean
 	 */
 	function call_custom_logic($module_dir, $event, $arguments = null){
 		// declare the hook array variable, it will be defined in the included file.
@@ -198,7 +200,6 @@ 
 	 * @param array $hook_array
 	 * @param string $event
 	 * @param array $arguments
-	 * @param SugarBean $bean
 	 */
 	function process_hooks($hook_array, $event, $arguments){
 		// Now iterate through the array for the appropriate hook

include/utils/progress_bar_utils.php

Doc Comments +8 added lines

@@ -92,6 +92,10 @@ 
 	progress_bar_flush();
 }
 
+/**
+ * @param string $name
+ * @param integer $total
+ */
 function display_progress_bar($name,$current, $total)
 {
 	$percent = $current/$total * 100;
@@ -115,6 +119,10 @@ 
 	progress_bar_flush();
 }
 
+/**
+ * @param string $name
+ * @param integer $total
+ */
 function update_progress_bar($name,$current, $total)
 {
 	$percent = $current/$total * 100;

include/utils/sugar_file_utils.php

Doc Comments +8 added lines, -8 removed lines

@@ -48,7 +48,7 @@ 
  * 0777 by default.
  *
  * @param $pathname - String value of the directory to create
- * @param $mode - The integer value of the permissions mode to set the created directory to
+ * @param integer $mode - The integer value of the permissions mode to set the created directory to
  * @param $recursive - boolean value indicating whether or not to create recursive directories if needed
  * @param $context
  * @return boolean - Returns true on success false on failure
@@ -103,10 +103,10 @@ 
  * 0777 by default.
  *
  * @param $filename - String value of the file to create
- * @param $mode - The integer value of the permissions mode to set the created file to
+ * @param string $mode - The integer value of the permissions mode to set the created file to
  * @param $$use_include_path - boolean value indicating whether or not to search the the included_path
  * @param $context
- * @return boolean - Returns a file pointer on success, false otherwise
+ * @return resource - Returns a file pointer on success, false otherwise
  */
 function sugar_fopen($filename, $mode, $use_include_path=false, $context=null){
 	//check to see if the file exists, if not then use touch to create it.
@@ -132,7 +132,7 @@ 
  *
  * @param $filename - String value of the file to create
  * @param $data - The data to be written to the file
- * @param $flags - int as specifed by file_put_contents parameters
+ * @param integer $flags - int as specifed by file_put_contents parameters
  * @param $context
  * @return int - Returns the number of bytes written to the file, false otherwise.
  */
@@ -162,8 +162,8 @@ 
  * This is an atomic version of sugar_file_put_contents.  It attempts to circumvent the shortcomings of file_put_contents
  * by creating a temporary unique file and then doing an atomic rename operation.
  *
- * @param $filename - String value of the file to create
- * @param $data - The data to be written to the file
+ * @param string $filename - String value of the file to create
+ * @param string $data - The data to be written to the file
  * @param string $mode String value of the parameter to specify the type of access you require to the file stream
  * @param boolean $use_include_path set to '1' or TRUE if you want to search for the file in the include_path too
  * @param context $context Context to pass into fopen operation
@@ -212,7 +212,7 @@ 
  * @param $filename - String value of the file to create
  * @param $use_include_path - boolean value indicating whether or not to search the the included_path
  * @param $context
- * @return string|boolean - Returns a file data on success, false otherwise
+ * @return false|string - Returns a file data on success, false otherwise
  */
 function sugar_file_get_contents($filename, $use_include_path=false, $context=null){
 	//check to see if the file exists, if not then use touch to create it.
@@ -241,7 +241,7 @@ 
  * may be set with the permissions specified in the configuration file (if set).
  *
  * @param $filename - The name of the file being touched.
- * @param $time - The touch time. If time  is not supplied, the current system time is used.
+ * @param integer $time - The touch time. If time  is not supplied, the current system time is used.
  * @param $atime - If present, the access time of the given filename is set to the value of atime
  * @return boolean - Returns TRUE on success or FALSE on failure.
  *

include/utils/zip_utils.php

Doc Comments +6 added lines

@@ -48,6 +48,9 @@ 
 if ( isset($GLOBALS['log']) && class_implements($GLOBALS['log'],'LoggerTemplate') ) {
     $GLOBALS['log']->deprecated('Use of PCLZip has been deprecated. Please enable the zip extension in your PHP install ( see http://www.php.net/manual/en/zip.installation.php for more details ).');
 }
+/**
+ * @param false|string $zip_dir
+ */
 function unzip( $zip_archive, $zip_dir, $forceOverwrite = false ){
     if( !is_dir( $zip_dir ) ){
         if (!defined('SUGAR_PHPUNIT_RUNNER'))
@@ -100,6 +103,9 @@ 
     }
 }
 
+/**
+ * @param string $zip_dir
+ */
 function zip_dir( $zip_dir, $zip_archive ){
     $archive    = new PclZip( $zip_archive );
     $v_list     = $archive->create( $zip_dir );

include/vCard.php

Doc Comments +29 added lines

@@ -87,9 +87,23 @@ 
 	function setTitle($title){
 		$this->setProperty("TITLE",$title );
 	}
+
+	/**
+	 * @param string $org
+	 * @param string $dep
+	 */
 	function setORG($org, $dep){
 		$this->setProperty("ORG","$org;$dep" );
 	}
+
+	/**
+	 * @param string $address
+	 * @param string $city
+	 * @param string $state
+	 * @param string $postal
+	 * @param string $country
+	 * @param string $type
+	 */
 	function setAddress($address, $city, $state,$postal, $country, $type, $encoding=''){
 		if(!empty($encoding)) {
 			$encoding = ";ENCODING={$encoding}";
@@ -97,16 +111,27 @@ 
 		$this->setProperty("ADR;$type$encoding",";;$address;$city;$state;$postal;$country" );
 	}
 
+	/**
+	 * @param string $first_name
+	 * @param string $last_name
+	 */
 	function setName($first_name, $last_name, $prefix){
 		$this->name = strtr($first_name.'_'.$last_name, ' ' , '_');
 		$this->setProperty('N',$last_name.';'.$first_name.';;'.$prefix );
 		$this->setProperty('FN',"$prefix $first_name $last_name");
 	}
 
+	/**
+	 * @param string $address
+	 */
 	function setEmail($address){
 		$this->setProperty('EMAIL;INTERNET', $address);
 	}
 
+	/**
+	 * @param string $number
+	 * @param string $type
+	 */
 	function setPhoneNumber( $number, $type)
 	{
 		if($type != 'FAX') {
@@ -116,6 +141,10 @@ 
 		    $this->setProperty("TEL;WORK;$type", $number);
 		}
 	}
+
+	/**
+	 * @param string $date
+	 */
 	function setBirthDate($date){
 			$this->setProperty('BDAY',$date);
 	}

include/ytree/ExtNode.php

Doc Comments +4 added lines

@@ -74,6 +74,10 @@
 	//node.data object in javascript.
 	//users can add a collection of paramaters that will
 	//be passed to objects responding to tree events
+
+ 	/**
+ 	 * @param string $name
+ 	 */
  	function set_property($name, $value, $is_param=false) {
  		if(!empty($name) && ($value === 0 || !empty($value))) {
  			if ($is_param==false) {

include/ytree/Node.php

Doc Comments +8 added lines

@@ -73,6 +73,10 @@ 
 	//node.data object in javascript.
 	//users can add a collection of paramaters that will
 	//be passed to objects responding to tree events
+
+ 	/**
+ 	 * @param string $name
+ 	 */
  	function set_property($name, $value, $is_param=false) {
  		if(!empty($name) && ($value === 0 || !empty($value))) {
  			if ($is_param==false) {
@@ -84,6 +88,10 @@ 
  	}
  	
 	//add a child node.
+
+ 	/**
+ 	 * @param Node $node
+ 	 */
  	function add_node($node) {
   		$this->nodes[$node->uid]=$node;
   	}

install/install_utils.php

Doc Comments +37 added lines, -2 removed lines

@@ -56,6 +56,7 @@ 
  * Calls a custom function (if it exists) based on the first parameter,
  *   and returns result of function call, or 'undefined' if the function doesn't exist
  * @param string function name to call in custom install hooks
+ * @param string $function_name
  * @return mixed function call result, or 'undefined'
  */
 function installerHook($function_name, $options = array()){
@@ -1267,6 +1268,9 @@ 
     return $ret_val;
 }
 
+/**
+ * @param string $start_file
+ */
 function recursive_make_writable($start_file)
     {
     $ret_val = make_writable($start_file);
@@ -1366,6 +1370,9 @@ 
 }
 
 
+/**
+ * @param string $name
+ */
 function print_debug_array( $name, $debug_array ){
     ksort( $debug_array );
 
@@ -1537,7 +1544,7 @@ 
  * it will addd to the return array
  *
  * @param intput_array haystack to check
- * @param needles list of needles to search for
+ * @param needles string[] of needles to search for
  * @param output_array the array to add the keys to
  */
 function copyFromArray($input_array, $needles, $output_array){
@@ -1555,7 +1562,7 @@ 
  * puts it into the cache/upload dir to be handed off to langPackUnpack();
  *
  * @param object file UploadFile object
- * @return bool true if successful
+ * @return null|boolean true if successful
  */
 function langPackFinalMove($file) {
     global $sugar_config;
@@ -1567,6 +1574,12 @@ 
     return true;
 }
 
+/**
+ * @param string $type
+ * @param string $manifest
+ * @param string $license_file
+ * @param string $clean_file
+ */
 function getLicenseDisplay($type, $manifest, $zipFile, $next_step, $license_file, $clean_file) {
     return PackageManagerDisplay::getLicenseDisplay($license_file, 'install.php', $next_step, $zipFile, $type, $manifest, $clean_file);
 }
@@ -1578,6 +1591,8 @@ 
  * @param string manifest path to manifest file
  * @param string zipFile path to uploaded zip file
  * @param int nextstep current step
+ * @param string $type
+ * @param string $manifest
  * @return string ret <form> for this package
  */
 function getPackButton($type, $manifest, $zipFile, $next_step, $uninstallable='Yes', $showButtons=true) {
@@ -1749,6 +1764,9 @@ 
 }
 
 if ( !function_exists('extractFile') ) {
+/**
+ * @return string
+ */
 function extractFile( $zip_file, $file_in_zip, $base_tmp_upgrade_dir){
     $my_zip_dir = mk_temp_dir( $base_tmp_upgrade_dir );
     unzip_file( $zip_file, $file_in_zip, $my_zip_dir );
@@ -1757,6 +1775,9 @@ 
 }
 
 if ( !function_exists('extractManifest') ) {
+/**
+ * @return string
+ */
 function extractManifest( $zip_file,$base_tmp_upgrade_dir ) {
     return( extractFile( $zip_file, "manifest.php",$base_tmp_upgrade_dir ) );
 }
@@ -1997,6 +2018,10 @@ 
 }
 
 
+/**
+ * @param integer $quantity
+ * @param string $string
+ */
 function add_digits($quantity, &$string, $min = 0, $max = 9) {
     for($i=0; $i < $quantity; $i++) {
         $string .= mt_rand($min,$max);
@@ -2014,6 +2039,11 @@ 
     return $phone;
 }
 
+/**
+ * @param integer $year
+ * @param integer $mnth
+ * @param integer $day
+ */
 function create_date($year=null,$mnth=null,$day=null)
 {
     global $timedate;
@@ -2028,6 +2058,11 @@ 
     return $timedate->nowDb();
 }
 
+/**
+ * @param integer $hr
+ * @param integer $min
+ * @param integer $sec
+ */
 function create_time($hr=null,$min=null,$sec=null)
 {
     global $timedate;

install/installConfig.php

Doc Comments +12 added lines, -6 removed lines

@@ -85,6 +85,9 @@ 
 class InstallLayout
 {
 
+    /**
+     * @param string $name
+     */
     public static function getSelect($name, $options, $default) {
         $out = "<select name=\"$name\">";
         foreach($options as $key => $value) {
@@ -117,7 +120,7 @@ 
 
     /**
      * @param $title page title
-     * @param $styles linked css files (string)
+     * @param string $styles linked css files (string)
      * @param $scripts linked javascript files (string)
      * @return string Install page layout header
      */
@@ -138,11 +141,11 @@ 
 
 
     /**
-     * @param $name form tag name
-     * @param $id form tag id
+     * @param string $name form tag name
+     * @param string $id form tag id
      * @param $errs form errors
      * @param $title form header line
-     * @param $items form items (string)
+     * @param string $items form items (string)
      * @param $controlls form controll buttons (string)
      * @return string
      */
@@ -178,8 +181,8 @@ 
 
 
     /**
-     * @param $header install page head
-     * @param $form install page form step
+     * @param string $header install page head
+     * @param string $form install page form step
      * @return string install page
      */
     private function getOutput($header, $form, $sugar_md, $mod_strings)
@@ -1088,6 +1091,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $formId
+     */
     private function getFormControlls($mod_strings, $formId) {
         $out =<<<EOQ
         <div id="checkingDiv" style="display:none">