adamjakab / SuiteCRM

include/utils/db_utils.php

Doc Comments +1 added lines

@@ -42,6 +42,7 @@
 
 /**
  * @deprecated use DBManager::convert() instead.
+ * @param string $type
  */
 function db_convert($string, $type, $additional_parameters=array(),$additional_parameters_oracle_only=array())
 	{

include/utils/encryption_utils.php

Doc Comments +6 added lines

@@ -40,6 +40,10 @@ 
 
 require_once('include/Pear/Crypt_Blowfish/Blowfish.php');
 
+/**
+ * @param string $key
+ * @param string $data
+ */
 function sugarEncode($key, $data){
 	return base64_encode($data);
 }
@@ -84,6 +88,7 @@ 
  * Uses blowfish to encrypt data and base 64 encodes it. It stores the iv as part of the data
  * @param STRING key - key to base encoding off of
  * @param STRING data - string to be encrypted and encoded
+ * @param string $key
  * @return string
  */
 function blowfishEncode($key, $data){
@@ -96,6 +101,7 @@ 
  * Uses blowfish to decode data assumes data has been base64 encoded with the iv stored as part of the data
  * @param STRING key - key to base decoding off of
  * @param STRING encoded base64 encoded blowfish encrypted data
+ * @param string $key
  * @return string
  */
 function blowfishDecode($key, $encoded){

include/utils/file_utils.php

Doc Comments +12 added lines, -3 removed lines

@@ -61,6 +61,9 @@ 
     return( $appendpath.$path );
 }
 
+/**
+ * @param string $file
+ */
 function create_cache_directory($file)
 {
     $paths = explode('/',$file);
@@ -170,6 +173,9 @@ 
     return( $write_to_file );
 }
 
+/**
+ * @param string $file
+ */
 function create_custom_directory($file)
 {
     $paths = explode('/',$file);
@@ -241,8 +247,8 @@ 
 /**
  * Function to compare two directory structures and return the items in path_a that didn't match in path_b
  *
- * @param	$path_a The path of the first root directory to scan - must end with '/'
- * @param	$path_b The path of the second root directory to scan - must end with '/'
+ * @param	string $path_a The path of the first root directory to scan - must end with '/'
+ * @param	string $path_b The path of the second root directory to scan - must end with '/'
  * @param	$ignore_dirs array of filenames/directory names to ignore running md5 on - default 'cache' and 'upload'
  * @result	array containing all the md5s of everything in $path_a that didn't have a match in $path_b
  */
@@ -374,7 +380,7 @@ 
  * extension and returns a best guess mime content type.
  *
  * @param $filename String of filename to return mime content type
- * @return mime content type as String value (defaults to 'application/octet-stream' for filenames with extension, empty otherwise)
+ * @return string content type as String value (defaults to 'application/octet-stream' for filenames with extension, empty otherwise)
  *
  */
 function get_mime_content_type_from_filename($filename)
@@ -467,6 +473,9 @@ 
 
 }
 */
+/**
+ * @param string $name
+ */
 function cleanFileName($name)
 {
     return preg_replace('/[^\w-._]+/i', '', $name);

include/utils/layout_utils.php

Doc Comments +4 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
  *
  * @param  $form_title string to display as the title in the header
  * @param  $other_text string to next to the title.  Typically used for form buttons.
- * @param  $show_help  boolean which determines if the print and help links are shown.
+ * @param  false|string $show_help  boolean which determines if the print and help links are shown.
  * @return string HTML
  */
 function get_form_header(
@@ -165,9 +165,10 @@ 
  *
  * @deprecated use SugarView::getModuleTitle() for MVC modules, or getClassicModuleTitle() for non-MVC modules
  *
- * @param  $module       string  to next to the title.  Typically used for form buttons.
- * @param  $module_title string  to display as the module title
+ * @param  string $module       string  to next to the title.  Typically used for form buttons.
+ * @param  string $module_title string  to display as the module title
  * @param  $show_help    boolean which determines if the print and help links are shown.
+ * @param boolean $show_create
  * @return string HTML
  */
 function get_module_title(

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);
 	}