adamjakab / SuiteCRM

include/DetailView/DetailView2.php

Doc Comments +2 added lines, -2 removed lines

@@ -54,10 +54,10 @@
      * This is the DetailView constructor responsible for processing the new
      * Meta-Data framework
      *
-     * @param $module String value of module this detail view is for
+     * @param string $module String value of module this detail view is for
      * @param $focus An empty sugarbean object of module
      * @param $id The record id to retrieve and populate data for
-     * @param $metadataFile String value of file location to use in overriding default metadata file
+     * @param string $metadataFile String value of file location to use in overriding default metadata file
      * @param tpl String value of file location to use in overriding default Smarty template
      */
 

include/dir_inc.php

Doc Comments +3 added lines

@@ -236,6 +236,9 @@
     return $the_array;
 }
 
+/**
+ * @param string $the_dir
+ */
 function findAllFilesRelative( $the_dir, $the_array ){
     if(!is_dir($the_dir)) {
 		return $the_array;

include/EditView/EditView2.php

Doc Comments +1 added lines, -1 removed lines

@@ -573,7 +573,7 @@
      * generated view.
      * @param $showTitle boolean value indicating whether or not to show a title on the resulting page
      * @param $ajaxSave boolean value indicating whether or not the operation is an Ajax save request
-     * @return HTML display for view as String
+     * @return string display for view as String
      */
     function display($showTitle = true, $ajaxSave = false)
     {

include/EditView/SubpanelQuickCreate.php

Doc Comments +1 added lines, -1 removed lines

@@ -186,7 +186,7 @@
      *  4. module/editviewdefs.php
      *
      * @param $module
-     * @param $view
+     * @param string $view
      * @return string The path to the viewdefs file to use
      */
     public function getModuleViewDefsSourceFile($module, $view) {

include/EditView/SugarVCR.php

Doc Comments +7 added lines

@@ -46,6 +46,7 @@ 
 
  	/**
  	 * records the query in the session for later retrieval
+ 	 * @param string $query
  	 */
  	static function store($module, $query){
  		$_SESSION[$module .'2_QUERY'] = $query;
@@ -79,6 +80,9 @@ 
  		return $menu;
  	}
 
+    /**
+     * @param string $module
+     */
     static function menu($module, $offset, $isAuditEnabled, $saveAndContinue = false ){
         $html_text = "";
         if ($offset < 0)
@@ -173,6 +177,9 @@ 
  		return $ids;
  	}
 
+ 	/**
+ 	 * @param string $module
+ 	 */
  	static function recordIDs($module, $rids, $offset, $totalCount){
  		$index = $offset;
  		$index++;

include/externalAPI/Base/ExternalAPIBase.php

Doc Comments +4 added lines, -1 removed lines

@@ -110,6 +110,9 @@ 
         return array('success' => true);
     }
 
+    /**
+     * @param string $value
+     */
     protected function getValue($value)
     {
         if(!empty($this->$value)) {
@@ -209,7 +212,7 @@ 
 	 * that are being checked deal with handling the behavior of closing/hiding windows/tabs that
 	 * are displayed when prompting for OAUTH validation
 	 *
-	 * @param $callback_url String value of callback URL
+	 * @param string $callback_url String value of callback URL
 	 * @return String value of URL with applicable formatting
 	 */
 	protected function formatCallbackURL($callback_url)

include/externalAPI/cmis_repository_wrapper.php

Doc Comments +35 added lines

@@ -151,6 +151,9 @@ 
         return $retval;
     }
 
+    /**
+     * @param string $contentType
+     */
     function doPost($url, $content, $contentType, $charset = null)
     {
         $retval = $this->doRequest($url, "POST", $content, $contentType);
@@ -367,6 +370,10 @@ 
         return CMISRepositoryWrapper :: extractObjectFromNode($doc);
 
     }
+
+    /**
+     * @param DOMDocument $xmlnode
+     */
     static function extractObjectFromNode($xmlnode)
     {
         // Extracts the contents of an Object and organizes them into:
@@ -430,6 +437,10 @@ 
         return CMISRepositoryWrapper :: extractTypeDefFromNode($doc);
 
     }
+
+    /**
+     * @param DOMDocument $xmlnode
+     */
     static function extractTypeDefFromNode($xmlnode)
     {
         // Extracts the contents of an Object and organizes them into:
@@ -501,6 +512,10 @@ 
         $doc->loadXML($xmldata);
         return CMISRepositoryWrapper :: extractObjectFeedFromNode($doc);
     }
+
+    /**
+     * @param DOMDocument $xmlnode
+     */
     static function extractObjectFeedFromNode($xmlnode)
     {
         // Process a feed and extract the objects
@@ -533,6 +548,10 @@ 
         $doc->loadXML($xmldata);
         return CMISRepositoryWrapper :: extractTypeFeedFromNode($doc);
     }
+
+    /**
+     * @param DOMDocument $xmlnode
+     */
     static function extractTypeFeedFromNode($xmlnode)
     {
         // Process a feed and extract the objects
@@ -560,6 +579,10 @@ 
         $doc->loadXML($xmldata);
         return CMISRepositoryWrapper :: extractWorkspaceFromNode($doc);
     }
+
+    /**
+     * @param DOMDocument $xmlnode
+     */
     static function extractWorkspaceFromNode($xmlnode)
     {
         // Assumes only one workspace for now
@@ -672,6 +695,9 @@ 
         $this->_objTypeId_cache[$obj->id] = $obj->properties["cmis:objectTypeId"];
     }
 
+    /**
+     * @param stdClass $objs
+     */
     function cacheFeedInfo($objs)
     {
         foreach ($objs->objectList as $obj)
@@ -680,6 +706,9 @@ 
         }
     }
 
+    /**
+     * @param stdClass $typs
+     */
     function cacheTypeFeedInfo($typs)
     {
         foreach ($typs->objectList as $typ)
@@ -724,6 +753,9 @@ 
         return $obj->properties["cmis:name"];
     }
 
+    /**
+     * @param string $linkName
+     */
     function getTypeLink($typeId, $linkName)
     {
         if ($this->_type_cache[$typeId]->links)
@@ -734,6 +766,9 @@ 
         return $typ->links[$linkName];
     }
 
+    /**
+     * @param string $linkName
+     */
     function getLink($objectId, $linkName)
     {
         if ($this->_link_cache[$objectId][$linkName])

include/formbase.php

Doc Comments +6 added lines

@@ -235,6 +235,9 @@ 
 }
 
 //eggsurplus: abstract to simplify unit testing
+/**
+ * @return string
+ */
 function buildRedirectURL($return_id='', $return_module='') 
 {
     if(isset($_REQUEST['return_module']) && $_REQUEST['return_module'] != "")
@@ -339,6 +342,9 @@ 
     }
 }
 
+/**
+ * @param string $fieldname
+ */
 function getLikeForEachWord($fieldname, $value, $minsize=4)
 {
 	$value = trim($value);

include/generic/LayoutManager.php

Doc Comments +7 added lines

@@ -62,11 +62,18 @@
 		$this->DBHelper = $GLOBALS['db'];
 	}
 
+	/**
+	 * @param string $key
+	 * @param string $value
+	 */
 	function setAttribute($key,$value)
 	{
 		$this->defs[$key] = $value;
 	}
 
+	/**
+	 * @param string $key
+	 */
 	function setAttributePtr($key,&$value)
 	{
 		$this->defs[$key] = $value;