adamjakab / SuiteCRM

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

include/nusoap/class.soapclient.php

Doc Comments +1 added lines

@@ -892,6 +892,7 @@
 	/**
 	* dynamically creates proxy class code
 	*
+	* @param integer $r
 	* @return   string PHP/NuSOAP code for the proxy class
 	* @access   private
 	*/

include/nusoap/class.wsdl.php

Doc Comments +3 added lines, -3 removed lines

@@ -928,7 +928,7 @@ 
 	/**
 	* serialize the parsed wsdl
 	*
-	* @param mixed $debug whether to put debug=1 in endpoint URL
+	* @param integer $debug whether to put debug=1 in endpoint URL
 	* @return string serialization of WSDL
 	* @access public
 	*/
@@ -1151,7 +1151,7 @@ 
 	 * @param string $direction (input|output)
 	 * @param mixed $parameters parameter value(s)
 	 * @param string $bindingType (soap|soap12)
-	 * @return mixed parameters serialized as XML or false on error (e.g. operation not found)
+	 * @return false|string parameters serialized as XML or false on error (e.g. operation not found)
 	 * @access public
 	 */
 	function serializeRPCParameters($operation, $direction, $parameters, $bindingType = 'soap') {
@@ -1251,7 +1251,7 @@ 
 	 * @param string $operation operation name
 	 * @param string $direction (input|output)
 	 * @param mixed $parameters parameter value(s)
-	 * @return mixed parameters serialized as XML or false on error (e.g. operation not found)
+	 * @return false|string parameters serialized as XML or false on error (e.g. operation not found)
 	 * @access public
 	 * @deprecated
 	 */

include/nusoap/class.xmlschema.php

Doc Comments +1 added lines, -1 removed lines

@@ -837,7 +837,7 @@
     * returns a sample serialization of a given type, or false if no type by the given name
     *
     * @param string $type name of type
-    * @return mixed
+    * @return string|false
     * @access public
     * @deprecated
     */

include/nusoap/nusoap.php

Doc Comments +25 added lines, -23 removed lines

@@ -552,7 +552,7 @@ 
 	/**
 	* gets the current debug data for this instance
 	*
-	* @return   debug data
+	* @return   string data
 	* @access   public
 	*/
 	function &getDebug() {
@@ -565,7 +565,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() {
@@ -596,7 +596,7 @@ 
 	/**
 	* returns error string if present
 	*
-	* @return   mixed error string or false
+	* @return   string|false error string or false
 	* @access   public
 	*/
 	function getError(){
@@ -609,7 +609,7 @@ 
 	/**
 	* sets error string
 	*
-	* @return   boolean $string error string
+	* @return   boolean|null $string error string
 	* @access   private
 	*/
 	function setError($str){
@@ -1045,7 +1045,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){
@@ -1076,7 +1076,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) {
@@ -1145,7 +1145,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){
@@ -1484,7 +1484,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();
@@ -2527,7 +2527,7 @@ 
     * returns a sample serialization of a given type, or false if no type by the given name
     *
     * @param string $type name of type
-    * @return mixed
+    * @return string|false
     * @access public
     * @deprecated
     */
@@ -2970,7 +2970,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
@@ -3381,10 +3381,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
@@ -3943,7 +3939,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) {
@@ -4378,7 +4374,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) {
@@ -4411,6 +4407,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);
@@ -5571,7 +5571,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) {
@@ -5678,7 +5678,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
@@ -5768,11 +5768,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)
     {
@@ -6937,7 +6938,7 @@ 
 	/**
 	* serialize the parsed wsdl
 	*
-	* @param mixed $debug whether to put debug=1 in endpoint URL
+	* @param integer $debug whether to put debug=1 in endpoint URL
 	* @return string serialization of WSDL
 	* @access public
 	*/
@@ -7160,7 +7161,7 @@ 
 	 * @param string $direction (input|output)
 	 * @param mixed $parameters parameter value(s)
 	 * @param string $bindingType (soap|soap12)
-	 * @return mixed parameters serialized as XML or false on error (e.g. operation not found)
+	 * @return false|string parameters serialized as XML or false on error (e.g. operation not found)
 	 * @access public
 	 */
 	function serializeRPCParameters($operation, $direction, $parameters, $bindingType = 'soap') {
@@ -7260,7 +7261,7 @@ 
 	 * @param string $operation operation name
 	 * @param string $direction (input|output)
 	 * @param mixed $parameters parameter value(s)
-	 * @return mixed parameters serialized as XML or false on error (e.g. operation not found)
+	 * @return false|string parameters serialized as XML or false on error (e.g. operation not found)
 	 * @access public
 	 * @deprecated
 	 */
@@ -9804,6 +9805,7 @@ 
 	/**
 	* dynamically creates proxy class code
 	*
+	* @param integer $r
 	* @return   string PHP/NuSOAP code for the proxy class
 	* @access   private
 	*/

include/nusoap/nusoapmime.php

Doc Comments +1 added lines, -1 removed lines

@@ -564,7 +564,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) {

include/OutboundEmail/OutboundEmail.php

Doc Comments +5 added lines, -6 removed lines

@@ -134,7 +134,7 @@ 
 	 * override account.
 	 *
 	 * @param unknown_type $user_id
-	 * @return unknown
+	 * @return boolean
 	 */
 	function doesUserOverrideAccountRequireCredentials($user_id)
 	{
@@ -229,7 +229,7 @@ 
 	 * Retrieves a cascading mailer set
 	 * @param object user
 	 * @param string mailer_id
-	 * @return object
+	 * @return OutboundEmail
 	 */
 	function getUserMailerSettings(&$user, $mailer_id='', $ieId='') {
 		$mailer = '';
@@ -267,7 +267,6 @@ 
 	 * their outbound account set to this object.
 	 *
 	 * @param SugarBean $user
-	 * @param string $outbound_id
 	 * @return array
 	 */
 	function getAssociatedInboundAccounts($user)
@@ -291,7 +290,7 @@ 
 	 * Retrieves a cascading mailer set
 	 * @param object user
 	 * @param string mailer_id
-	 * @return object
+	 * @return OutboundEmail
 	 */
 	function getInboundMailerSettings($user, $mailer_id='', $ieId='') {
 		$mailer = '';
@@ -390,7 +389,7 @@ 
 	/**
 	 * Populates this instance
 	 * @param string $id
-	 * @return object $this
+	 * @return OutboundEmail $this
 	 */
 	function retrieve($id) {
 		require_once('include/utils/encryption_utils.php');
@@ -428,7 +427,7 @@ 
 	/**
 	 * Generate values for saving into outbound_emails table
 	 * @param array $keys
-	 * @return array
+	 * @return string
 	 */
 	protected function getValues(&$keys)
 	{