adamjakab / SuiteCRM

include/MVC/View/SugarView.php

Doc Comments +6 added lines, -2 removed lines

@@ -1039,6 +1039,7 @@ 
      *
      * @param string option - the option that we want to know the valye of
      * @param bool default - what the default value should be if we do not find the option
+     * @param string $option
      *
      * @return bool - the value of the option
      */
@@ -1273,7 +1274,7 @@ 
     * Return the "breadcrumbs" to display at the top of the page
     *
     * @param  bool $show_help optional, true if we show the help links
-    * @return HTML string containing breadcrumb title
+    * @return string string containing breadcrumb title
     */
     public function getModuleTitle(
         $show_help = true
@@ -1446,6 +1447,9 @@ 
     	}
     }
 
+    /**
+     * @param string $module
+     */
     protected function getModuleTitleIconPath($module)
     {
     	$iconPath = "";
@@ -1496,7 +1500,7 @@ 
     /**
      * Fetch config values to be put into an array for JavaScript
      *
-     * @return array
+     * @return string[]
      */
     protected function getSugarConfigJS(){
         global $sugar_config;

include/MVC/View/ViewFactory.php

Doc Comments +5 added lines

@@ -53,6 +53,7 @@ 
 	/**
 	 * load the correct view
 	 * @param string $type View Type
+	 * @param string $module
 	 * @return valid view
 	 */
 	static function loadView($type = 'default', $module, $bean = null, $view_object_map = array(), $target_module=''){
@@ -98,6 +99,7 @@ 
 
 	/**
 	 * Load the view_<view>_config.php file which holds options used by the view.
+	 * @param string $type
 	 */
 	static function _loadConfig(&$view, $type){
 		$view_config_custom = array();
@@ -199,6 +201,8 @@ 
 	 * This is a private function which just helps the getView function generate the
 	 * proper view object
 	 *
+	 * @param string $file
+	 * @param string $type
 	 * @return a valid SugarView
 	 */
 	static function _buildFromFile($file, &$bean, $view_object_map, $type, $module){
@@ -242,6 +246,7 @@ 
 	 * @param object bean = the bean to pass to the view
 	 * @param array view_object_map - the array which holds obejcts to pass between the
 	 *                                controller and the view.
+	 * @param string $class
 	 *
 	 * @return SugarView
 	 */

include/MVC/View/views/view.list.php

Doc Comments +1 added lines

@@ -272,6 +272,7 @@
 
       /**
        *
+       * @param string $module
        * @return SearchForm
        */
     protected function getSearchForm2($seed, $module, $action = "index")

include/MVC/View/views/view.metadata.php

Doc Comments +7 added lines

@@ -47,6 +47,9 @@ 
 	
 	
  	
+ 	/**
+ 	 * @param string $name
+ 	 */
  	function displayCheckBoxes($name,$values, $selected =array(), $attr=''){
  		echo "<div $attr style='overflow:auto;float:left;width:200px;height:200px' >";
 		foreach($values as $value){
@@ -56,6 +59,10 @@ 
 		echo "</div>";
  	}
  	
+ 	/**
+ 	 * @param string $name
+ 	 * @param string[] $values
+ 	 */
  	function displaySelect($name,$values, $selected ='', $attr=''){
  		echo "<select name='$name' $attr>";
 		foreach($values as $value){

include/nusoap/class.nusoap_base.php

Doc Comments +7 added lines, -7 removed lines

@@ -356,7 +356,7 @@ 
 	/**
 	* gets the current debug data for this instance
 	*
-	* @return   debug data
+	* @return   string data
 	* @access   public
 	*/
 	function &getDebug() {
@@ -369,7 +369,7 @@ 
 	* gets the current debug data for this instance as an XML comment
 	* this may change the contents of the debug data
 	*
-	* @return   debug data as an XML comment
+	* @return   string data as an XML comment
 	* @access   public
 	*/
 	function &getDebugAsXMLComment() {
@@ -402,7 +402,7 @@ 
 	/**
 	* returns error string if present
 	*
-	* @return   mixed error string or false
+	* @return   string|false error string or false
 	* @access   public
 	*/
 	function getError(){
@@ -415,7 +415,7 @@ 
 	/**
 	* sets error string
 	*
-	* @return   boolean $string error string
+	* @return   boolean|null $string error string
 	* @access   private
 	*/
 	function setError($str){
@@ -851,7 +851,7 @@ 
     * returns false, if not prefixed
     *
     * @param string $str The prefixed string
-    * @return mixed The prefix or false if there is no prefix
+    * @return string|false The prefix or false if there is no prefix
     * @access public
     */
 	function getPrefix($str){
@@ -882,7 +882,7 @@ 
     * or false if no prefixes registered for the given namespace
     *
     * @param string $ns The namespace
-    * @return mixed The prefix, false if the namespace has no prefixes
+    * @return string The prefix, false if the namespace has no prefixes
     * @access public
     */
 	function getPrefixFromNamespace($ns) {
@@ -948,7 +948,7 @@ 
 *
 * @param    int $timestamp Unix time stamp
 * @param	boolean $utc Whether the time stamp is UTC or local
-* @return	mixed ISO 8601 date string or false
+* @return	string|false ISO 8601 date string or false
 * @access   public
 */
 function timestamp_to_iso8601($timestamp,$utc=true){

include/nusoap/class.soap_fault.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
     * @param string $faultcode (SOAP-ENV:Client | SOAP-ENV:Server)
     * @param string $faultactor only used when msg routed between multiple actors
     * @param string $faultstring human readable error message
-    * @param mixed $faultdetail detail, typically a string or array of string
+    * @param string $faultdetail detail, typically a string or array of string
 	*/
 	function nusoap_fault($faultcode,$faultactor='',$faultstring='',$faultdetail=''){
 		parent::nusoap_base();

include/nusoap/class.soap_server.php

Doc Comments +5 added lines, -4 removed lines

@@ -892,7 +892,7 @@ 
 	*
 	* @param	array	$headers	The HTTP headers
 	* @param	string	$data		unprocessed request data from client
-	* @return	mixed	value of the message, decoded into a PHP type
+	* @return	false|null	value of the message, decoded into a PHP type
 	* @access   private
 	*/
     function parseRequest($headers, $data) {
@@ -999,7 +999,7 @@ 
 	* @param    string $name the name of the PHP function, class.method or class..method
 	* @param    array $in assoc array of input values: key = param name, value = param type
 	* @param    array $out assoc array of output values: key = param name, value = param type
-	* @param	mixed $namespace the element namespace for the method or false
+	* @param	string $namespace the element namespace for the method or false
 	* @param	mixed $soapaction the soapaction for the method or false
 	* @param	mixed $style optional (rpc|document) or false Note: when 'document' is specified, parameter and return wrappers are created for you automatically
 	* @param	mixed $use optional (encoded|literal) or false
@@ -1089,11 +1089,12 @@ 
     * Acts as a flag to enable internal WSDL generation
     *
     * @param string $serviceName, name of the service
-    * @param mixed $namespace optional 'tns' service namespace or false
-    * @param mixed $endpoint optional URL of service endpoint or false
+    * @param string $namespace optional 'tns' service namespace or false
+    * @param string $endpoint optional URL of service endpoint or false
     * @param string $style optional (rpc|document) WSDL style (also specified by operation)
     * @param string $transport optional SOAP transport
     * @param mixed $schemaTargetNamespace optional 'types' targetNamespace for service schema or false
+    * @param string $serviceName
     */
     function configureWSDL($serviceName,$namespace = false,$endpoint = false,$style='rpc', $transport = 'http://schemas.xmlsoap.org/soap/http', $schemaTargetNamespace = false)
     {

include/nusoap/class.soap_transport_http.php

Doc Comments +6 added lines, -6 removed lines

@@ -221,10 +221,6 @@ 
 	/**
 	* establish an HTTP connection
 	*
-	* @param    integer $timeout set connection timeout in seconds
-	* @param	integer $response_timeout set response timeout in seconds
-	* @return	boolean true if connected, false if not
-	* @access   private
 	*/
 	function connect($connection_timeout=0,$response_timeout=30){
 	  	// For PHP 4.3 with OpenSSL, change https scheme to ssl, then treat like
@@ -783,7 +779,7 @@ 
 	*
 	* @param    string $data message data
 	* @param	array $cookies cookies to send
-	* @return	boolean	true if OK, false if problem
+	* @return	boolean|null	true if OK, false if problem
 	* @access   private
 	*/
 	function sendRequest($data, $cookies = NULL) {
@@ -1218,7 +1214,7 @@ 
 	 * sets the content-type for the SOAP message to be sent
 	 *
 	 * @param	string $type the content type, MIME style
-	 * @param	mixed $charset character set used for encoding (or false)
+	 * @param	string $charset character set used for encoding (or false)
 	 * @access	public
 	 */
 	function setContentType($type, $charset = false) {
@@ -1251,6 +1247,10 @@ 
 	/*
 	 * TODO: allow a Set-Cookie string to be parsed into multiple cookies
 	 */
+
+	/**
+	 * @param string $cookie_str
+	 */
 	function parseCookie($cookie_str) {
 		$cookie_str = str_replace('; ', ';', $cookie_str) . ';';
 		$data = preg_split('/;/', $cookie_str);

include/nusoap/class.soap_val.php

Doc Comments +1 added lines, -1 removed lines

@@ -104,7 +104,7 @@
 	*
 	* @param    string $name optional name
 	* @param    mixed $type optional type name
-	* @param	mixed $value optional value
+	* @param	integer $value optional value
 	* @param	mixed $element_ns optional namespace of value
 	* @param	mixed $type_ns optional namespace of type
 	* @param	mixed $attributes associative array of attributes to add to element serialization