chamilo / chamilo-lms

main/inc/lib/nusoap/nusoapmime.php

Doc Comments +1 added lines, -1 removed lines

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

Spacing +10 added lines, -10 removed lines

@@ -86,7 +86,7 @@ 
 	* @access public

 	*/

 	function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {

-		if (! $cid) {

+		if (!$cid) {

 			$cid = md5(uniqid(time()));

 		}

 

@@ -221,7 +221,7 @@ 
 	* @access   private

 	*/

     function parseResponse($headers, $data) {

-		$this->debug('Entering parseResponse() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);

+		$this->debug('Entering parseResponse() for payload of length '.strlen($data).' and type of '.$headers['content-type']);

 		$this->responseAttachments = array();

 		if (strstr($headers['content-type'], 'multipart/related')) {

 			$this->debug('Decode multipart/related');

@@ -229,7 +229,7 @@ 
 			foreach ($headers as $k => $v) {

 				$input .= "$k: $v\r\n";

 			}

-			$params['input'] = $input . "\r\n" . $data;

+			$params['input'] = $input."\r\n".$data;

 			$params['include_bodies'] = true;

 			$params['decode_bodies'] = true;

 			$params['decode_headers'] = true;

@@ -238,11 +238,11 @@ 
 

 			foreach ($structure->parts as $part) {

 				if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {

-					$this->debug('Have root part of type ' . $part->headers['content-type']);

+					$this->debug('Have root part of type '.$part->headers['content-type']);

 					$root = $part->body;

 					$return = parent::parseResponse($part->headers, $part->body);

 				} else {

-					$this->debug('Have an attachment of type ' . $part->headers['content-type']);

+					$this->debug('Have an attachment of type '.$part->headers['content-type']);

 					$info['data'] = $part->body;

 					$info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';

 					$info['contenttype'] = $part->headers['content-type'];

@@ -316,7 +316,7 @@ 
 	* @access public

 	*/

 	function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {

-		if (! $cid) {

+		if (!$cid) {

 			$cid = md5(uniqid(time()));

 		}

 

@@ -451,7 +451,7 @@ 
 	* @access   private

 	*/

     function parseRequest($headers, $data) {

-		$this->debug('Entering parseRequest() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);

+		$this->debug('Entering parseRequest() for payload of length '.strlen($data).' and type of '.$headers['content-type']);

 		$this->requestAttachments = array();

 		if (strstr($headers['content-type'], 'multipart/related')) {

 			$this->debug('Decode multipart/related');

@@ -459,7 +459,7 @@ 
 			foreach ($headers as $k => $v) {

 				$input .= "$k: $v\r\n";

 			}

-			$params['input'] = $input . "\r\n" . $data;

+			$params['input'] = $input."\r\n".$data;

 			$params['include_bodies'] = true;

 			$params['decode_bodies'] = true;

 			$params['decode_headers'] = true;

@@ -468,10 +468,10 @@ 
 

 			foreach ($structure->parts as $part) {

 				if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {

-					$this->debug('Have root part of type ' . $part->headers['content-type']);

+					$this->debug('Have root part of type '.$part->headers['content-type']);

 					$return = parent::parseRequest($part->headers, $part->body);

 				} else {

-					$this->debug('Have an attachment of type ' . $part->headers['content-type']);

+					$this->debug('Have an attachment of type '.$part->headers['content-type']);

 					$info['data'] = $part->body;

 					$info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';

 					$info['contenttype'] = $part->headers['content-type'];

Indentation +418 added lines, -418 removed lines

@@ -52,224 +52,224 @@ 
 * @access   public

 */

 class nusoap_client_mime extends nusoap_client {

-	/**

-	 * @var array Each array element in the return is an associative array with keys

-	 * data, filename, contenttype, cid

-	 * @access private

-	 */

-	var $requestAttachments = array();

-	/**

-	 * @var array Each array element in the return is an associative array with keys

-	 * data, filename, contenttype, cid

-	 * @access private

-	 */

-	var $responseAttachments;

-	/**

-	 * @var string

-	 * @access private

-	 */

-	var $mimeContentType;

-

-	/**

-	* adds a MIME attachment to the current request.

-	*

-	* If the $data parameter contains an empty string, this method will read

-	* the contents of the file named by the $filename parameter.

-	*

-	* If the $cid parameter is false, this method will generate the cid.

-	*

-	* @param string $data The data of the attachment

-	* @param string $filename The filename of the attachment (default is empty string)

-	* @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)

-	* @param string $cid The content-id (cid) of the attachment (default is false)

-	* @return string The content-id (cid) of the attachment

-	* @access public

-	*/

-	function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {

-		if (! $cid) {

-			$cid = md5(uniqid(time()));

-		}

-

-		$info['data'] = $data;

-		$info['filename'] = $filename;

-		$info['contenttype'] = $contenttype;

-		$info['cid'] = $cid;

-

-		$this->requestAttachments[] = $info;

-

-		return $cid;

-	}

-

-	/**

-	* clears the MIME attachments for the current request.

-	*

-	* @access public

-	*/

-	function clearAttachments() {

-		$this->requestAttachments = array();

-	}

-

-	/**

-	* gets the MIME attachments from the current response.

-	*

-	* Each array element in the return is an associative array with keys

-	* data, filename, contenttype, cid.  These keys correspond to the parameters

-	* for addAttachment.

-	*

-	* @return array The attachments.

-	* @access public

-	*/

-	function getAttachments() {

-		return $this->responseAttachments;

-	}

-

-	/**

-	* gets the HTTP body for the current request.

-	*

-	* @param string $soapmsg The SOAP payload

-	* @return string The HTTP body, which includes the SOAP payload

-	* @access private

-	*/

-	function getHTTPBody($soapmsg) {

-		if (count($this->requestAttachments) > 0) {

-			$params['content_type'] = 'multipart/related; type="text/xml"';

-			$mimeMessage = new Mail_mimePart('', $params);

-			unset($params);

-

-			$params['content_type'] = 'text/xml';

-			$params['encoding']     = '8bit';

-			$params['charset']      = $this->soap_defencoding;

-			$mimeMessage->addSubpart($soapmsg, $params);

-

-			foreach ($this->requestAttachments as $att) {

-				unset($params);

-

-				$params['content_type'] = $att['contenttype'];

-				$params['encoding']     = 'base64';

-				$params['disposition']  = 'attachment';

-				$params['dfilename']    = $att['filename'];

-				$params['cid']          = $att['cid'];

-

-				if ($att['data'] == '' && $att['filename'] <> '') {

-					if ($fd = fopen($att['filename'], 'rb')) {

-						$data = fread($fd, filesize($att['filename']));

-						fclose($fd);

-					} else {

-						$data = '';

-					}

-					$mimeMessage->addSubpart($data, $params);

-				} else {

-					$mimeMessage->addSubpart($att['data'], $params);

-				}

-			}

-

-			$output = $mimeMessage->encode();

-			$mimeHeaders = $output['headers'];

-

-			foreach ($mimeHeaders as $k => $v) {

-				$this->debug("MIME header $k: $v");

-				if (strtolower($k) == 'content-type') {

-					// PHP header() seems to strip leading whitespace starting

-					// the second line, so force everything to one line

-					$this->mimeContentType = str_replace("\r\n", " ", $v);

-				}

-			}

-

-			return $output['body'];

-		}

-

-		return parent::getHTTPBody($soapmsg);

-	}

-

-	/**

-	* gets the HTTP content type for the current request.

-	*

-	* Note: getHTTPBody must be called before this.

-	*

-	* @return string the HTTP content type for the current request.

-	* @access private

-	*/

-	function getHTTPContentType() {

-		if (count($this->requestAttachments) > 0) {

-			return $this->mimeContentType;

-		}

-		return parent::getHTTPContentType();

-	}

-

-	/**

-	* gets the HTTP content type charset for the current request.

-	* returns false for non-text content types.

-	*

-	* Note: getHTTPBody must be called before this.

-	*

-	* @return string the HTTP content type charset for the current request.

-	* @access private

-	*/

-	function getHTTPContentTypeCharset() {

-		if (count($this->requestAttachments) > 0) {

-			return false;

-		}

-		return parent::getHTTPContentTypeCharset();

-	}

-

-	/**

-	* processes SOAP message returned from server

-	*

-	* @param	array	$headers	The HTTP headers

-	* @param	string	$data		unprocessed response data from server

-	* @return	mixed	value of the message, decoded into a PHP type

-	* @access   private

-	*/

+    /**

+     * @var array Each array element in the return is an associative array with keys

+     * data, filename, contenttype, cid

+     * @access private

+     */

+    var $requestAttachments = array();

+    /**

+     * @var array Each array element in the return is an associative array with keys

+     * data, filename, contenttype, cid

+     * @access private

+     */

+    var $responseAttachments;

+    /**

+     * @var string

+     * @access private

+     */

+    var $mimeContentType;

+

+    /**

+     * adds a MIME attachment to the current request.

+     *

+     * If the $data parameter contains an empty string, this method will read

+     * the contents of the file named by the $filename parameter.

+     *

+     * If the $cid parameter is false, this method will generate the cid.

+     *

+     * @param string $data The data of the attachment

+     * @param string $filename The filename of the attachment (default is empty string)

+     * @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)

+     * @param string $cid The content-id (cid) of the attachment (default is false)

+     * @return string The content-id (cid) of the attachment

+     * @access public

+     */

+    function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {

+        if (! $cid) {

+            $cid = md5(uniqid(time()));

+        }

+

+        $info['data'] = $data;

+        $info['filename'] = $filename;

+        $info['contenttype'] = $contenttype;

+        $info['cid'] = $cid;

+

+        $this->requestAttachments[] = $info;

+

+        return $cid;

+    }

+

+    /**

+     * clears the MIME attachments for the current request.

+     *

+     * @access public

+     */

+    function clearAttachments() {

+        $this->requestAttachments = array();

+    }

+

+    /**

+     * gets the MIME attachments from the current response.

+     *

+     * Each array element in the return is an associative array with keys

+     * data, filename, contenttype, cid.  These keys correspond to the parameters

+     * for addAttachment.

+     *

+     * @return array The attachments.

+     * @access public

+     */

+    function getAttachments() {

+        return $this->responseAttachments;

+    }

+

+    /**

+     * gets the HTTP body for the current request.

+     *

+     * @param string $soapmsg The SOAP payload

+     * @return string The HTTP body, which includes the SOAP payload

+     * @access private

+     */

+    function getHTTPBody($soapmsg) {

+        if (count($this->requestAttachments) > 0) {

+            $params['content_type'] = 'multipart/related; type="text/xml"';

+            $mimeMessage = new Mail_mimePart('', $params);

+            unset($params);

+

+            $params['content_type'] = 'text/xml';

+            $params['encoding']     = '8bit';

+            $params['charset']      = $this->soap_defencoding;

+            $mimeMessage->addSubpart($soapmsg, $params);

+

+            foreach ($this->requestAttachments as $att) {

+                unset($params);

+

+                $params['content_type'] = $att['contenttype'];

+                $params['encoding']     = 'base64';

+                $params['disposition']  = 'attachment';

+                $params['dfilename']    = $att['filename'];

+                $params['cid']          = $att['cid'];

+

+                if ($att['data'] == '' && $att['filename'] <> '') {

+                    if ($fd = fopen($att['filename'], 'rb')) {

+                        $data = fread($fd, filesize($att['filename']));

+                        fclose($fd);

+                    } else {

+                        $data = '';

+                    }

+                    $mimeMessage->addSubpart($data, $params);

+                } else {

+                    $mimeMessage->addSubpart($att['data'], $params);

+                }

+            }

+

+            $output = $mimeMessage->encode();

+            $mimeHeaders = $output['headers'];

+

+            foreach ($mimeHeaders as $k => $v) {

+                $this->debug("MIME header $k: $v");

+                if (strtolower($k) == 'content-type') {

+                    // PHP header() seems to strip leading whitespace starting

+                    // the second line, so force everything to one line

+                    $this->mimeContentType = str_replace("\r\n", " ", $v);

+                }

+            }

+

+            return $output['body'];

+        }

+

+        return parent::getHTTPBody($soapmsg);

+    }

+

+    /**

+     * gets the HTTP content type for the current request.

+     *

+     * Note: getHTTPBody must be called before this.

+     *

+     * @return string the HTTP content type for the current request.

+     * @access private

+     */

+    function getHTTPContentType() {

+        if (count($this->requestAttachments) > 0) {

+            return $this->mimeContentType;

+        }

+        return parent::getHTTPContentType();

+    }

+

+    /**

+     * gets the HTTP content type charset for the current request.

+     * returns false for non-text content types.

+     *

+     * Note: getHTTPBody must be called before this.

+     *

+     * @return string the HTTP content type charset for the current request.

+     * @access private

+     */

+    function getHTTPContentTypeCharset() {

+        if (count($this->requestAttachments) > 0) {

+            return false;

+        }

+        return parent::getHTTPContentTypeCharset();

+    }

+

+    /**

+     * processes SOAP message returned from server

+     *

+     * @param	array	$headers	The HTTP headers

+     * @param	string	$data		unprocessed response data from server

+     * @return	mixed	value of the message, decoded into a PHP type

+     * @access   private

+     */

     function parseResponse($headers, $data) {

-		$this->debug('Entering parseResponse() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);

-		$this->responseAttachments = array();

-		if (strstr($headers['content-type'], 'multipart/related')) {

-			$this->debug('Decode multipart/related');

-			$input = '';

-			foreach ($headers as $k => $v) {

-				$input .= "$k: $v\r\n";

-			}

-			$params['input'] = $input . "\r\n" . $data;

-			$params['include_bodies'] = true;

-			$params['decode_bodies'] = true;

-			$params['decode_headers'] = true;

-

-			$structure = Mail_mimeDecode::decode($params);

-

-			foreach ($structure->parts as $part) {

-				if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {

-					$this->debug('Have root part of type ' . $part->headers['content-type']);

-					$root = $part->body;

-					$return = parent::parseResponse($part->headers, $part->body);

-				} else {

-					$this->debug('Have an attachment of type ' . $part->headers['content-type']);

-					$info['data'] = $part->body;

-					$info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';

-					$info['contenttype'] = $part->headers['content-type'];

-					$info['cid'] = $part->headers['content-id'];

-					$this->responseAttachments[] = $info;

-				}

-			}

-

-			if (isset($return)) {

-				$this->responseData = $root;

-				return $return;

-			}

-

-			$this->setError('No root part found in multipart/related content');

-			return '';

-		}

-		$this->debug('Not multipart/related');

-		return parent::parseResponse($headers, $data);

-	}

+        $this->debug('Entering parseResponse() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);

+        $this->responseAttachments = array();

+        if (strstr($headers['content-type'], 'multipart/related')) {

+            $this->debug('Decode multipart/related');

+            $input = '';

+            foreach ($headers as $k => $v) {

+                $input .= "$k: $v\r\n";

+            }

+            $params['input'] = $input . "\r\n" . $data;

+            $params['include_bodies'] = true;

+            $params['decode_bodies'] = true;

+            $params['decode_headers'] = true;

+

+            $structure = Mail_mimeDecode::decode($params);

+

+            foreach ($structure->parts as $part) {

+                if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {

+                    $this->debug('Have root part of type ' . $part->headers['content-type']);

+                    $root = $part->body;

+                    $return = parent::parseResponse($part->headers, $part->body);

+                } else {

+                    $this->debug('Have an attachment of type ' . $part->headers['content-type']);

+                    $info['data'] = $part->body;

+                    $info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';

+                    $info['contenttype'] = $part->headers['content-type'];

+                    $info['cid'] = $part->headers['content-id'];

+                    $this->responseAttachments[] = $info;

+                }

+            }

+

+            if (isset($return)) {

+                $this->responseData = $root;

+                return $return;

+            }

+

+            $this->setError('No root part found in multipart/related content');

+            return '';

+        }

+        $this->debug('Not multipart/related');

+        return parent::parseResponse($headers, $data);

+    }

 }

 

 /*

  *	For backwards compatiblity, define soapclientmime unless the PHP SOAP extension is loaded.

  */

 if (!extension_loaded('soap')) {

-	class soapclientmime extends nusoap_client_mime {

-	}

+    class soapclientmime extends nusoap_client_mime {

+    }

 }

 

 /**

@@ -282,214 +282,214 @@ 
 * @access   public

 */

 class nusoap_server_mime extends nusoap_server {

-	/**

-	 * @var array Each array element in the return is an associative array with keys

-	 * data, filename, contenttype, cid

-	 * @access private

-	 */

-	var $requestAttachments = array();

-	/**

-	 * @var array Each array element in the return is an associative array with keys

-	 * data, filename, contenttype, cid

-	 * @access private

-	 */

-	var $responseAttachments;

-	/**

-	 * @var string

-	 * @access private

-	 */

-	var $mimeContentType;

-

-	/**

-	* adds a MIME attachment to the current response.

-	*

-	* If the $data parameter contains an empty string, this method will read

-	* the contents of the file named by the $filename parameter.

-	*

-	* If the $cid parameter is false, this method will generate the cid.

-	*

-	* @param string $data The data of the attachment

-	* @param string $filename The filename of the attachment (default is empty string)

-	* @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)

-	* @param string $cid The content-id (cid) of the attachment (default is false)

-	* @return string The content-id (cid) of the attachment

-	* @access public

-	*/

-	function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {

-		if (! $cid) {

-			$cid = md5(uniqid(time()));

-		}

-

-		$info['data'] = $data;

-		$info['filename'] = $filename;

-		$info['contenttype'] = $contenttype;

-		$info['cid'] = $cid;

-

-		$this->responseAttachments[] = $info;

-

-		return $cid;

-	}

-

-	/**

-	* clears the MIME attachments for the current response.

-	*

-	* @access public

-	*/

-	function clearAttachments() {

-		$this->responseAttachments = array();

-	}

-

-	/**

-	* gets the MIME attachments from the current request.

-	*

-	* Each array element in the return is an associative array with keys

-	* data, filename, contenttype, cid.  These keys correspond to the parameters

-	* for addAttachment.

-	*

-	* @return array The attachments.

-	* @access public

-	*/

-	function getAttachments() {

-		return $this->requestAttachments;

-	}

-

-	/**

-	* gets the HTTP body for the current response.

-	*

-	* @param string $soapmsg The SOAP payload

-	* @return string The HTTP body, which includes the SOAP payload

-	* @access private

-	*/

-	function getHTTPBody($soapmsg) {

-		if (count($this->responseAttachments) > 0) {

-			$params['content_type'] = 'multipart/related; type="text/xml"';

-			$mimeMessage = new Mail_mimePart('', $params);

-			unset($params);

-

-			$params['content_type'] = 'text/xml';

-			$params['encoding']     = '8bit';

-			$params['charset']      = $this->soap_defencoding;

-			$mimeMessage->addSubpart($soapmsg, $params);

-

-			foreach ($this->responseAttachments as $att) {

-				unset($params);

-

-				$params['content_type'] = $att['contenttype'];

-				$params['encoding']     = 'base64';

-				$params['disposition']  = 'attachment';

-				$params['dfilename']    = $att['filename'];

-				$params['cid']          = $att['cid'];

-

-				if ($att['data'] == '' && $att['filename'] <> '') {

-					if ($fd = fopen($att['filename'], 'rb')) {

-						$data = fread($fd, filesize($att['filename']));

-						fclose($fd);

-					} else {

-						$data = '';

-					}

-					$mimeMessage->addSubpart($data, $params);

-				} else {

-					$mimeMessage->addSubpart($att['data'], $params);

-				}

-			}

-

-			$output = $mimeMessage->encode();

-			$mimeHeaders = $output['headers'];

-

-			foreach ($mimeHeaders as $k => $v) {

-				$this->debug("MIME header $k: $v");

-				if (strtolower($k) == 'content-type') {

-					// PHP header() seems to strip leading whitespace starting

-					// the second line, so force everything to one line

-					$this->mimeContentType = str_replace("\r\n", " ", $v);

-				}

-			}

-

-			return $output['body'];

-		}

-

-		return parent::getHTTPBody($soapmsg);

-	}

-

-	/**

-	* gets the HTTP content type for the current response.

-	*

-	* Note: getHTTPBody must be called before this.

-	*

-	* @return string the HTTP content type for the current response.

-	* @access private

-	*/

-	function getHTTPContentType() {

-		if (count($this->responseAttachments) > 0) {

-			return $this->mimeContentType;

-		}

-		return parent::getHTTPContentType();

-	}

-

-	/**

-	* gets the HTTP content type charset for the current response.

-	* returns false for non-text content types.

-	*

-	* Note: getHTTPBody must be called before this.

-	*

-	* @return string the HTTP content type charset for the current response.

-	* @access private

-	*/

-	function getHTTPContentTypeCharset() {

-		if (count($this->responseAttachments) > 0) {

-			return false;

-		}

-		return parent::getHTTPContentTypeCharset();

-	}

-

-	/**

-	* processes SOAP message received from client

-	*

-	* @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

-	* @access   private

-	*/

+    /**

+     * @var array Each array element in the return is an associative array with keys

+     * data, filename, contenttype, cid

+     * @access private

+     */

+    var $requestAttachments = array();

+    /**

+     * @var array Each array element in the return is an associative array with keys

+     * data, filename, contenttype, cid

+     * @access private

+     */

+    var $responseAttachments;

+    /**

+     * @var string

+     * @access private

+     */

+    var $mimeContentType;

+

+    /**

+     * adds a MIME attachment to the current response.

+     *

+     * If the $data parameter contains an empty string, this method will read

+     * the contents of the file named by the $filename parameter.

+     *

+     * If the $cid parameter is false, this method will generate the cid.

+     *

+     * @param string $data The data of the attachment

+     * @param string $filename The filename of the attachment (default is empty string)

+     * @param string $contenttype The MIME Content-Type of the attachment (default is application/octet-stream)

+     * @param string $cid The content-id (cid) of the attachment (default is false)

+     * @return string The content-id (cid) of the attachment

+     * @access public

+     */

+    function addAttachment($data, $filename = '', $contenttype = 'application/octet-stream', $cid = false) {

+        if (! $cid) {

+            $cid = md5(uniqid(time()));

+        }

+

+        $info['data'] = $data;

+        $info['filename'] = $filename;

+        $info['contenttype'] = $contenttype;

+        $info['cid'] = $cid;

+

+        $this->responseAttachments[] = $info;

+

+        return $cid;

+    }

+

+    /**

+     * clears the MIME attachments for the current response.

+     *

+     * @access public

+     */

+    function clearAttachments() {

+        $this->responseAttachments = array();

+    }

+

+    /**

+     * gets the MIME attachments from the current request.

+     *

+     * Each array element in the return is an associative array with keys

+     * data, filename, contenttype, cid.  These keys correspond to the parameters

+     * for addAttachment.

+     *

+     * @return array The attachments.

+     * @access public

+     */

+    function getAttachments() {

+        return $this->requestAttachments;

+    }

+

+    /**

+     * gets the HTTP body for the current response.

+     *

+     * @param string $soapmsg The SOAP payload

+     * @return string The HTTP body, which includes the SOAP payload

+     * @access private

+     */

+    function getHTTPBody($soapmsg) {

+        if (count($this->responseAttachments) > 0) {

+            $params['content_type'] = 'multipart/related; type="text/xml"';

+            $mimeMessage = new Mail_mimePart('', $params);

+            unset($params);

+

+            $params['content_type'] = 'text/xml';

+            $params['encoding']     = '8bit';

+            $params['charset']      = $this->soap_defencoding;

+            $mimeMessage->addSubpart($soapmsg, $params);

+

+            foreach ($this->responseAttachments as $att) {

+                unset($params);

+

+                $params['content_type'] = $att['contenttype'];

+                $params['encoding']     = 'base64';

+                $params['disposition']  = 'attachment';

+                $params['dfilename']    = $att['filename'];

+                $params['cid']          = $att['cid'];

+

+                if ($att['data'] == '' && $att['filename'] <> '') {

+                    if ($fd = fopen($att['filename'], 'rb')) {

+                        $data = fread($fd, filesize($att['filename']));

+                        fclose($fd);

+                    } else {

+                        $data = '';

+                    }

+                    $mimeMessage->addSubpart($data, $params);

+                } else {

+                    $mimeMessage->addSubpart($att['data'], $params);

+                }

+            }

+

+            $output = $mimeMessage->encode();

+            $mimeHeaders = $output['headers'];

+

+            foreach ($mimeHeaders as $k => $v) {

+                $this->debug("MIME header $k: $v");

+                if (strtolower($k) == 'content-type') {

+                    // PHP header() seems to strip leading whitespace starting

+                    // the second line, so force everything to one line

+                    $this->mimeContentType = str_replace("\r\n", " ", $v);

+                }

+            }

+

+            return $output['body'];

+        }

+

+        return parent::getHTTPBody($soapmsg);

+    }

+

+    /**

+     * gets the HTTP content type for the current response.

+     *

+     * Note: getHTTPBody must be called before this.

+     *

+     * @return string the HTTP content type for the current response.

+     * @access private

+     */

+    function getHTTPContentType() {

+        if (count($this->responseAttachments) > 0) {

+            return $this->mimeContentType;

+        }

+        return parent::getHTTPContentType();

+    }

+

+    /**

+     * gets the HTTP content type charset for the current response.

+     * returns false for non-text content types.

+     *

+     * Note: getHTTPBody must be called before this.

+     *

+     * @return string the HTTP content type charset for the current response.

+     * @access private

+     */

+    function getHTTPContentTypeCharset() {

+        if (count($this->responseAttachments) > 0) {

+            return false;

+        }

+        return parent::getHTTPContentTypeCharset();

+    }

+

+    /**

+     * processes SOAP message received from client

+     *

+     * @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

+     * @access   private

+     */

     function parseRequest($headers, $data) {

-		$this->debug('Entering parseRequest() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);

-		$this->requestAttachments = array();

-		if (strstr($headers['content-type'], 'multipart/related')) {

-			$this->debug('Decode multipart/related');

-			$input = '';

-			foreach ($headers as $k => $v) {

-				$input .= "$k: $v\r\n";

-			}

-			$params['input'] = $input . "\r\n" . $data;

-			$params['include_bodies'] = true;

-			$params['decode_bodies'] = true;

-			$params['decode_headers'] = true;

-

-			$structure = Mail_mimeDecode::decode($params);

-

-			foreach ($structure->parts as $part) {

-				if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {

-					$this->debug('Have root part of type ' . $part->headers['content-type']);

-					$return = parent::parseRequest($part->headers, $part->body);

-				} else {

-					$this->debug('Have an attachment of type ' . $part->headers['content-type']);

-					$info['data'] = $part->body;

-					$info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';

-					$info['contenttype'] = $part->headers['content-type'];

-					$info['cid'] = $part->headers['content-id'];

-					$this->requestAttachments[] = $info;

-				}

-			}

-

-			if (isset($return)) {

-				return $return;

-			}

-

-			$this->setError('No root part found in multipart/related content');

-			return;

-		}

-		$this->debug('Not multipart/related');

-		return parent::parseRequest($headers, $data);

-	}

+        $this->debug('Entering parseRequest() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);

+        $this->requestAttachments = array();

+        if (strstr($headers['content-type'], 'multipart/related')) {

+            $this->debug('Decode multipart/related');

+            $input = '';

+            foreach ($headers as $k => $v) {

+                $input .= "$k: $v\r\n";

+            }

+            $params['input'] = $input . "\r\n" . $data;

+            $params['include_bodies'] = true;

+            $params['decode_bodies'] = true;

+            $params['decode_headers'] = true;

+

+            $structure = Mail_mimeDecode::decode($params);

+

+            foreach ($structure->parts as $part) {

+                if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {

+                    $this->debug('Have root part of type ' . $part->headers['content-type']);

+                    $return = parent::parseRequest($part->headers, $part->body);

+                } else {

+                    $this->debug('Have an attachment of type ' . $part->headers['content-type']);

+                    $info['data'] = $part->body;

+                    $info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';

+                    $info['contenttype'] = $part->headers['content-type'];

+                    $info['cid'] = $part->headers['content-id'];

+                    $this->requestAttachments[] = $info;

+                }

+            }

+

+            if (isset($return)) {

+                return $return;

+            }

+

+            $this->setError('No root part found in multipart/related content');

+            return;

+        }

+        $this->debug('Not multipart/related');

+        return parent::parseRequest($headers, $data);

+    }

 }

 

 /*

main/inc/lib/online.inc.php

Doc Comments +5 added lines

@@ -208,6 +208,8 @@ 
 }
 /**
  * Gives a list of people online now (and in the last $valid minutes)
+ * @param integer $from
+ * @param integer $time_limit
  * @return  array       For each line, a list of user IDs and login dates, or FALSE on error or empty results
  */
 function who_is_online($from, $number_of_items, $column = null, $direction = null, $time_limit = null, $friends = false)
@@ -424,6 +426,9 @@ 
 	}
 }
 
+/**
+ * @param integer $uid
+ */
 function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
 {
 	if (empty($coursecode)) {

Indentation +63 added lines, -63 removed lines

@@ -290,8 +290,8 @@ 
         }
     }
 
-	//This query will show all registered users. Only for dev purposes.
-	/*$query = "SELECT DISTINCT u.id as login_user_id, login_date FROM ".$track_online_table ."  e , $table_user u
+    //This query will show all registered users. Only for dev purposes.
+    /*$query = "SELECT DISTINCT u.id as login_user_id, login_date FROM ".$track_online_table ."  e , $table_user u
             GROUP by u.id
             ORDER BY $column $direction
             LIMIT $from, $number_of_items";*/
@@ -317,15 +317,15 @@ 
     } else {
         $time_limit = intval($time_limit);
     }
-	$track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
-	$friend_user_table = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
-	$table_user = Database::get_main_table(TABLE_MAIN_USER);
-	$online_time = time() - $time_limit * 60;
-	$current_date = api_get_utc_datetime($online_time);
-
-	if ($friends) {
-		// 	who friends from social network is online
-		$query = "SELECT DISTINCT count(login_user_id) as count
+    $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
+    $friend_user_table = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
+    $table_user = Database::get_main_table(TABLE_MAIN_USER);
+    $online_time = time() - $time_limit * 60;
+    $current_date = api_get_utc_datetime($online_time);
+
+    if ($friends) {
+        // 	who friends from social network is online
+        $query = "SELECT DISTINCT count(login_user_id) as count
 				  FROM $track_online_table INNER JOIN $friend_user_table
                   ON (friend_user_id = login_user_id)
 				  WHERE
@@ -333,20 +333,20 @@ 
 				        friend_user_id <> '".api_get_user_id()."' AND
 				        relation_type='".USER_RELATION_TYPE_FRIEND."' AND
 				        user_id = '".api_get_user_id()."' ";
-	} else {
-		// All users online
-		$query = "SELECT count(login_id) as count
+    } else {
+        // All users online
+        $query = "SELECT count(login_id) as count
                   FROM $track_online_table track INNER JOIN $table_user u
                   ON (u.id=track.login_user_id)
                   WHERE u.status != ".ANONYMOUS." AND login_date >= '$current_date'  ";
-	}
-
-	if (api_get_multiple_access_url()) {
-		$access_url_id = api_get_current_access_url_id();
-		if ($access_url_id != -1) {
-			if ($friends) {
-				// 	friends from social network is online
-				$query = "SELECT DISTINCT count(login_user_id) as count
+    }
+
+    if (api_get_multiple_access_url()) {
+        $access_url_id = api_get_current_access_url_id();
+        if ($access_url_id != -1) {
+            if ($friends) {
+                // 	friends from social network is online
+                $query = "SELECT DISTINCT count(login_user_id) as count
 							FROM $track_online_table track
 							INNER JOIN $friend_user_table ON (friend_user_id = login_user_id)
 							WHERE
@@ -354,29 +354,29 @@ 
 							    login_date >= '".$current_date."' AND
 							    friend_user_id <> '".api_get_user_id()."' AND
 							    relation_type='".USER_RELATION_TYPE_FRIEND."'  ";
-			} else {
-				// all users online
-				$query = "SELECT count(login_id) as count FROM $track_online_table  track
+            } else {
+                // all users online
+                $query = "SELECT count(login_id) as count FROM $track_online_table  track
                           INNER JOIN $table_user u ON (u.id=track.login_user_id)
 						  WHERE
 						    u.status != ".ANONYMOUS." AND
 						    track.access_url_id =  $access_url_id AND
 						    login_date >= '$current_date' ";
-			}
-		}
-	}
+            }
+        }
+    }
 
     // Dev purposes show all users online
     /*$table_user = Database::get_main_table(TABLE_MAIN_USER);
     $query = "SELECT count(*)  as count FROM ".$table_user;*/
 
-	$result = Database::query($query);
-	if (Database::num_rows($result) > 0) {
-		$row = Database::fetch_array($result);
-		return $row['count'];
-	} else {
-		return false;
-	}
+    $result = Database::query($query);
+    if (Database::num_rows($result) > 0) {
+        $row = Database::fetch_array($result);
+        return $row['count'];
+    } else {
+        return false;
+    }
 }
 
 
@@ -404,52 +404,52 @@ 
     $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
     $course_code = Database::escape_string($course_code);
     $courseInfo = api_get_course_info($course_code);
-	$courseId = $courseInfo['real_id'];
+    $courseId = $courseInfo['real_id'];
 
     $from = intval($from);
     $number_of_items = intval($number_of_items);
 
-	$query = "SELECT login_user_id, login_date FROM $track_online_table
+    $query = "SELECT login_user_id, login_date FROM $track_online_table
               WHERE login_user_id <> 2 AND c_id = $courseId AND login_date >= '$current_date'
               LIMIT $from, $number_of_items ";
 
-	$result = Database::query($query);
-	if ($result) {
-		$users_online = array();
+    $result = Database::query($query);
+    if ($result) {
+        $users_online = array();
 
-		while(list($login_user_id, $login_date) = Database::fetch_row($result)) {
+        while(list($login_user_id, $login_date) = Database::fetch_row($result)) {
             $users_online[] = $login_user_id;
-		}
-		return $users_online;
-	} else {
-		return false;
-	}
+        }
+        return $users_online;
+    } else {
+        return false;
+    }
 }
 
 function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
 {
-	if (empty($coursecode)) {
-		return false;
-	}
-	$track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
-	$time_limit = Database::escape_string($time_limit);
+    if (empty($coursecode)) {
+        return false;
+    }
+    $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
+    $time_limit = Database::escape_string($time_limit);
 
     $online_time = time() - $time_limit * 60;
     $current_date = api_get_utc_datetime($online_time);
-	$courseId = api_get_course_int_id($coursecode);
+    $courseId = api_get_course_int_id($coursecode);
 
-	if (empty($courseId)) {
-		return false;
-	}
+    if (empty($courseId)) {
+        return false;
+    }
 
-	$query = "SELECT count(login_user_id) as count
+    $query = "SELECT count(login_user_id) as count
               FROM $track_online_table
               WHERE login_user_id <> 2 AND c_id = $courseId AND login_date >= '$current_date' ";
-	$result = Database::query($query);
-	if (Database::num_rows($result) > 0) {
-		$row = Database::fetch_array($result);
-		return $row['count'];
-	} else {
-		return false;
-	}
+    $result = Database::query($query);
+    if (Database::num_rows($result) > 0) {
+        $row = Database::fetch_array($result);
+        return $row['count'];
+    } else {
+        return false;
+    }
 }

Spacing +15 added lines, -15 removed lines

@@ -32,17 +32,17 @@ 
 
         $login_date = api_get_utc_datetime();
         $access_url_id = 1;
-        if (api_get_multiple_access_url() && api_get_current_access_url_id()!=-1) {
+        if (api_get_multiple_access_url() && api_get_current_access_url_id() != -1) {
             $access_url_id = api_get_current_access_url_id();
         }
         $session_id = api_get_session_id();
         // if the $_course array exists this means we are in a course and we have to store this in the who's online table also
         // to have the x users in this course feature working
-        if (is_array($_course) && count($_course)>0 && !empty($_course['id'])) {
-            $query = "REPLACE INTO ".$online_table ." (login_id,login_user_id,login_date,user_ip, c_id, session_id, access_url_id)
+        if (is_array($_course) && count($_course) > 0 && !empty($_course['id'])) {
+            $query = "REPLACE INTO ".$online_table." (login_id,login_user_id,login_date,user_ip, c_id, session_id, access_url_id)
                       VALUES ($uid,$uid,'$login_date','$user_ip', '".$_course['real_id']."' , '$session_id' , '$access_url_id' )";
         } else {
-            $query = "REPLACE INTO ".$online_table ." (login_id,login_user_id,login_date,user_ip, c_id, session_id, access_url_id)
+            $query = "REPLACE INTO ".$online_table." (login_id,login_user_id,login_date,user_ip, c_id, session_id, access_url_id)
                       VALUES ($uid,$uid,'$login_date','$user_ip', 0, '$session_id', '$access_url_id')";
         }
         Database::query($query);
@@ -62,7 +62,7 @@ 
             $isFirstLogin = Session::read('first_user_login');
             if (empty($isFirstLogin)) {
                 $sql = "SELECT login_id FROM $table
-                        WHERE login_user_id = " . $userId . " LIMIT 1";
+                        WHERE login_user_id = ".$userId." LIMIT 1";
 
                 $result = Database::query($sql);
                 $loginData = array();
@@ -116,7 +116,7 @@ 
     		ORDER BY login_date DESC
     		LIMIT 0,1";
     $q_last_connection = Database::query($sql);
-    if (Database::num_rows($q_last_connection)>0) {
+    if (Database::num_rows($q_last_connection) > 0) {
         $i_id_last_connection = Database::result($q_last_connection, 0, "login_id");
     }
 
@@ -166,7 +166,7 @@ 
 {
     $online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
     $user_id = intval($user_id);
-    $query = "DELETE FROM " . $online_table . " WHERE login_user_id = $user_id";
+    $query = "DELETE FROM ".$online_table." WHERE login_user_id = $user_id";
     Database::query($query);
 }
 
@@ -182,7 +182,7 @@ 
     $access_url_id = api_get_current_access_url_id();
     $time_limit = api_get_setting('time_limit_whosonline');
 
-    $online_time = time() - $time_limit*60;
+    $online_time = time() - $time_limit * 60;
     $limit_date = api_get_utc_datetime($online_time);
     $user_id = intval($user_id);
 
@@ -239,7 +239,7 @@ 
     $current_date = api_get_utc_datetime($online_time);
     $track_online_table = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ONLINE);
     $friend_user_table = Database::get_main_table(TABLE_MAIN_USER_REL_USER);
-    $table_user	= Database::get_main_table(TABLE_MAIN_USER);
+    $table_user = Database::get_main_table(TABLE_MAIN_USER);
 
     if ($friends) {
         // 	who friends from social network is online
@@ -255,8 +255,8 @@ 
                   LIMIT $from, $number_of_items";
     } else {
         $query = "SELECT DISTINCT login_user_id, login_date
-                    FROM ".$track_online_table ." e
-                    INNER JOIN ".$table_user ." u ON (u.id = e.login_user_id)
+                    FROM ".$track_online_table." e
+                    INNER JOIN ".$table_user." u ON (u.id = e.login_user_id)
                   WHERE u.status != ".ANONYMOUS." AND login_date >= '".$current_date."'
                   ORDER BY $column $direction
                   LIMIT $from, $number_of_items";
@@ -279,8 +279,8 @@ 
             } else {
                 // all users online
                 $query = "SELECT login_user_id, login_date
-                          FROM ".$track_online_table ." track
-                          INNER JOIN ".$table_user ." u
+                          FROM ".$track_online_table." track
+                          INNER JOIN ".$table_user." u
                           ON (u.id=track.login_user_id)
                           WHERE u.status != ".ANONYMOUS." AND track.access_url_id =  $access_url_id AND
                                 login_date >= '".$current_date."'
@@ -417,7 +417,7 @@ 
 	if ($result) {
 		$users_online = array();
 
-		while(list($login_user_id, $login_date) = Database::fetch_row($result)) {
+		while (list($login_user_id, $login_date) = Database::fetch_row($result)) {
             $users_online[] = $login_user_id;
 		}
 		return $users_online;
@@ -426,7 +426,7 @@ 
 	}
 }
 
-function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
+function who_is_online_in_this_course_count($uid, $time_limit, $coursecode = null)
 {
 	if (empty($coursecode)) {
 		return false;

main/inc/lib/plugin.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -143,7 +143,7 @@ 
 
     /**
      * Returns the contents of the CSS defined by the plugin
-     * @return array
+     * @return string
      */
     public function get_css()
     {
@@ -161,7 +161,7 @@ 
 
     /**
      * Returns an HTML form (generated by FormValidator) of the plugin settings
-     * @return string FormValidator-generated form
+     * @return FormValidator FormValidator-generated form
      */
     public function get_settings_form()
     {
@@ -383,7 +383,7 @@ 
      * @param boolean $add_tool_link Whether to add a tool link or not
      * (some tools might just offer a configuration section and act on the backend)
      *
-     * @return boolean  False on error, null otherwise
+     * @return boolean|null  False on error, null otherwise
      */
     public function install_course_fields($courseId, $add_tool_link = true)
     {
@@ -491,7 +491,7 @@ 
      * tool on the course's homepage
      * @param int $courseId
      *
-     * @return void
+     * @return false|null
      */
     public function uninstall_course_fields($courseId)
     {
@@ -596,7 +596,7 @@ 
     * @param string   $tabName
     * @param string   $url
     *
-    * @return boolean
+    * @return false|string
     */
     public function addTab($tabName, $url)
     {

Indentation +7 added lines, -7 removed lines

@@ -591,13 +591,13 @@
 
     }
 
-   /**
-    * Add a tab to platform
-    * @param string   $tabName
-    * @param string   $url
-    *
-    * @return boolean
-    */
+    /**
+     * Add a tab to platform
+     * @param string   $tabName
+     * @param string   $url
+     *
+     * @return boolean
+     */
     public function addTab($tabName, $url)
     {
         $sql = "SELECT * FROM settings_current

Spacing +7 added lines, -7 removed lines

@@ -60,7 +60,7 @@ 
         $this->fields = $settings;
 
         global $language_files;
-        $language_files[] = 'plugin_' . $this->get_name();
+        $language_files[] = 'plugin_'.$this->get_name();
     }
 
     /**
@@ -268,7 +268,7 @@ 
     {
         $settings = $this->get_settings();
         foreach ($settings as $setting) {
-            if ($setting['variable'] == $this->get_name() . '_' . $name) {
+            if ($setting['variable'] == $this->get_name().'_'.$name) {
 
                 return $setting['selected_value'];
             }
@@ -404,7 +404,7 @@ 
         if (!empty($this->course_settings)) {
             foreach ($this->course_settings as $setting) {
                 $variable = $setting['name'];
-                $value ='';
+                $value = '';
                 if (isset($setting['init_value'])) {
                     $value = $setting['init_value'];
                 }
@@ -618,7 +618,7 @@ 
 
         // Avoid Tab Name Spaces
         $tabNameNoSpaces = preg_replace('/\s+/', '', $tabName);
-        $subkeytext = "Tabs" . $tabNameNoSpaces;
+        $subkeytext = "Tabs".$tabNameNoSpaces;
 
         // Check if it is already added
         $checkCondition = array(
@@ -637,7 +637,7 @@ 
         }
 
         // End Check
-        $subkey = 'custom_tab_' . $tabNum;
+        $subkey = 'custom_tab_'.$tabNum;
         $attributes = array(
             'variable' => 'show_tabs',
             'subkey' => $subkey,
@@ -655,7 +655,7 @@ 
 
         // Save the id
         $settings = $this->get_settings();
-        $setData = array (
+        $setData = array(
             'comment' => $subkey
         );
         $whereCondition = array(
@@ -696,7 +696,7 @@ 
                 $i = 1;
                 foreach ($tabs as $row) {
                     $attributes = array(
-                        'subkey' => 'custom_tab_' . $i
+                        'subkey' => 'custom_tab_'.$i
                     );
                     $this->updateTab($row['subkey'], $attributes);
                     $i++;

main/inc/lib/plugin.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -626,7 +626,7 @@
 
     /**
      * Get first SMS plugin name
-     * @return string|boolean
+     * @return string|false
      */
     public function getSMSPluginName()
     {

Indentation +9 added lines, -9 removed lines

@@ -173,9 +173,9 @@ 
     }
 
     /**
-    * @param string $pluginName
-    * @param int    $urlId
-    */
+     * @param string $pluginName
+     * @param int    $urlId
+     */
     public function uninstall($pluginName, $urlId = null)
     {
         if (empty($urlId)) {
@@ -252,12 +252,12 @@ 
     }
 
     /**
-    * @param string $region
-    * @param string $template
-    * @param bool   $forced
-    *
-    * @return null|string
-    */
+     * @param string $region
+     * @param string $template
+     * @param bool   $forced
+     *
+     * @return null|string
+     */
     public function load_region($region, $template, $forced = false)
     {
         if ($region == 'course_tool_plugin') {

Spacing +6 added lines, -6 removed lines

@@ -426,7 +426,7 @@ 
             // Extra options
             $plugin_settings = api_get_settings_params(
                 array(
-                    "subkey = ? AND category = ? AND type = ? " => array($plugin_name, 'Plugins','setting')
+                    "subkey = ? AND category = ? AND type = ? " => array($plugin_name, 'Plugins', 'setting')
                 )
             );
 
@@ -532,7 +532,7 @@ 
             if (!empty($obj->course_settings)) {
                 if (is_file(api_get_path(SYS_CODE_PATH).'img/icons/'.ICON_SIZE_SMALL.'/'.$plugin_name.'.png')) {
                     $icon = Display::return_icon(
-                        $plugin_name . '.png',
+                        $plugin_name.'.png',
                         Security::remove_XSS($pluginTitle),
                         '',
                         ICON_SIZE_SMALL
@@ -548,18 +548,18 @@ 
 
                 $form->addHtml('<div class="panel panel-default">');
                 $form->addHtml('
-                    <div class="panel-heading" role="tab" id="heading-' . $plugin_name . '-settings">
+                    <div class="panel-heading" role="tab" id="heading-' . $plugin_name.'-settings">
                         <h4 class="panel-title">
-                            <a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion" href="#collapse-' . $plugin_name . '-settings" aria-expanded="false" aria-controls="collapse-' . $plugin_name . '-settings">
+                            <a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion" href="#collapse-' . $plugin_name.'-settings" aria-expanded="false" aria-controls="collapse-'.$plugin_name.'-settings">
                 ');
-                $form->addHtml($icon . ' ' . $pluginTitle);
+                $form->addHtml($icon.' '.$pluginTitle);
                 $form->addHtml('
                             </a>
                         </h4>
                     </div>
                 ');
                 $form->addHtml('
-                    <div id="collapse-' . $plugin_name . '-settings" class="panel-collapse collapse" role="tabpanel" aria-labelledby="heading-' . $plugin_name . '-settings">
+                    <div id="collapse-' . $plugin_name.'-settings" class="panel-collapse collapse" role="tabpanel" aria-labelledby="heading-'.$plugin_name.'-settings">
                         <div class="panel-body">
                 ');
 

main/inc/lib/portfolio.class.php

Doc Comments +7 added lines, -3 removed lines

@@ -126,6 +126,7 @@ 
      * Returns a temporary url to download files and/or folders.
      *
      * @param string|array $ids
+     * @param string $tool
      * @return string
      */
     public static function download_url($ids, $tool)
@@ -293,7 +294,7 @@ 
     /**
      * The name of the porfolio where to send.
      *
-     * @return type
+     * @return string
      */
     function get_portfolio()
     {
@@ -391,7 +392,6 @@ 
      * Create a "send to portfolio" button
      *
      * @param string $tool          The name of the tool: document, work.
-     * @param int $c_id             The id of the course
      * @param int $id               The id of the object
      * @param array $attributes     Html attributes
      * @return \PortfolioShare
@@ -405,7 +405,7 @@ 
     /**
      * Returns the current secuirty token. Used to avoid see surfing attacks.
      *
-     * @return type
+     * @return string
      */
     static function security_token()
     {
@@ -420,6 +420,10 @@ 
     protected $attributes = array();
     protected $tool = '';
 
+    /**
+     * @param string $tool
+     * @param integer $id
+     */
     function __construct($tool, $id, $attributes = array())
     {
         $this->tool = $tool;

Spacing +6 added lines, -6 removed lines

@@ -482,14 +482,14 @@ 
         $attributes['z-index'] = 100000;
         $s = ' ';
         foreach ($attributes as $key => $value) {
-            $s .= $key . '="' . $value . '" ';
+            $s .= $key.'="'.$value.'" ';
         }
 
         $result = array();
-        $result[] = '<span ' . $s . ' >';
+        $result[] = '<span '.$s.' >';
         $result[] = '<span class="dropdown" >';
         $result[] = '<a href="#" data-toggle="dropdown" class="dropdown-toggle">';
-        $result[] = Display::return_icon('document_send.png', get_lang('Send'), array(), ICON_SIZE_SMALL) . '<b class="caret"></b>';
+        $result[] = Display::return_icon('document_send.png', get_lang('Send'), array(), ICON_SIZE_SMALL).'<b class="caret"></b>';
         $result[] = '</a>';
         $result[] = '<ul class="dropdown-menu">';
 
@@ -505,7 +505,7 @@ 
             $parameters[PortfolioController::PARAM_TOOL] = $tool;
             $url = api_get_path(WEB_CODE_PATH).'portfolio/share.php?';
             $result[] = '<li>';
-            $result[] = '<a href="' . $url . '">' . $portfolio->get_title() . '</a>';
+            $result[] = '<a href="'.$url.'">'.$portfolio->get_title().'</a>';
             $result[] = '</li>';
         }
         $result[] = '</ul>';
@@ -564,8 +564,8 @@ 
      */
     public function __construct($portfolio)
     {
-        $this->name = md5(__CLASS__) . '_' . $portfolio->get_name();
-        $this->title = $portfolio->get_title() ? $portfolio->get_title() : get_lang('SendTo') . ' ' . $portfolio->get_name();
+        $this->name = md5(__CLASS__).'_'.$portfolio->get_name();
+        $this->title = $portfolio->get_title() ? $portfolio->get_title() : get_lang('SendTo').' '.$portfolio->get_name();
         $this->portfolio = $portfolio;
     }
 

main/inc/lib/promotion.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -129,7 +129,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_status_list()
     {
@@ -272,7 +272,7 @@ 
     /**
      * @param int $id
      *
-     * @return bool
+     * @return null|false
      */
     public function delete($id)
     {

Spacing +8 added lines, -8 removed lines

@@ -63,7 +63,7 @@ 
                     case 'updated_at':
                         break;
                     case 'name':
-                        $val .= ' ' . get_lang('CopyLabelSuffix');
+                        $val .= ' '.get_lang('CopyLabelSuffix');
                         $new[$key] = $val;
                         break;
                     case 'created_at':
@@ -72,7 +72,7 @@ 
                         break;
                     case 'career_id':
                         if (!empty($career_id)) {
-                            $val = (int)$career_id;
+                            $val = (int) $career_id;
                         }
                         $new[$key] = $val;
                         break;
@@ -160,22 +160,22 @@ 
     {
         // Action links
         echo '<div class="actions" style="margin-bottom:20px">';
-        echo '<a href="career_dashboard.php">' . Display::return_icon('back.png',
-                get_lang('Back'), '', '32') . '</a>';
-        echo '<a href="' . api_get_self() . '?action=add">' .
+        echo '<a href="career_dashboard.php">'.Display::return_icon('back.png',
+                get_lang('Back'), '', '32').'</a>';
+        echo '<a href="'.api_get_self().'?action=add">'.
             Display::return_icon(
                 'new_promotion.png',
                 get_lang('Add'),
                 '',
                 '32'
-            ) . '</a>';
-        echo '<a href="' . api_get_path(WEB_CODE_PATH) . 'session/session_add.php">' .
+            ).'</a>';
+        echo '<a href="'.api_get_path(WEB_CODE_PATH).'session/session_add.php">'.
             Display::return_icon(
                 'new_session.png',
                 get_lang('AddSession'),
                 '',
                 '32'
-            ) . '</a>';
+            ).'</a>';
         echo '</div>';
         echo Display::grid_html('promotions');
     }

main/inc/lib/rights.lib.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 
 	// warning the goal of this function is to enforce rights managment in Chamilo
 	// thus default return value is always true
+
+	/**
+	 * @param string $handler
+	 */
 	public static function hasRight($handler) {
 		if (array_key_exists($handler, self::$rights_cache))
 			return self::$rights_cache[$handler];

Indentation +33 added lines, -33 removed lines

@@ -5,42 +5,42 @@
  * @deprecated Don't use this class
  */
 class Rights {
-	private static $rights_cache = array();
-	private static $rights = array (
-		'show_tabs:reports' =>
-			array (
-				'type' => 'const',
-				'const' => 'true' )
-		);
+    private static $rights_cache = array();
+    private static $rights = array (
+        'show_tabs:reports' =>
+            array (
+                'type' => 'const',
+                'const' => 'true' )
+        );
 
-	// warning the goal of this function is to enforce rights managment in Chamilo
-	// thus default return value is always true
-	public static function hasRight($handler) {
-		if (array_key_exists($handler, self::$rights_cache))
-			return self::$rights_cache[$handler];
+    // warning the goal of this function is to enforce rights managment in Chamilo
+    // thus default return value is always true
+    public static function hasRight($handler) {
+        if (array_key_exists($handler, self::$rights_cache))
+            return self::$rights_cache[$handler];
 
-		if (!array_key_exists($handler, self::$rights))
-			return true; // handler does not exists
+        if (!array_key_exists($handler, self::$rights))
+            return true; // handler does not exists
 
-		if (self::$rights[$handler]['type'] == 'sql') {
-			$result = Database::query(self::$rights[$handler]['sql']);
-			if (Database::num_rows($result) > 0)
-				$result = true;
-			else
-				$result = false;
-		} else if (self::$rights[$handler]['type'] == 'const')
-			$result = self::$rights[$handler]['const'];
-		else if (self::$rights[$handler]['type'] == 'func')
-			$result = self::$rights[$handler]['func']();
-		else // handler type not implemented
-			return true;
-		self::$rights_cache[$handler] = $result;
-		return $result;
-	}
+        if (self::$rights[$handler]['type'] == 'sql') {
+            $result = Database::query(self::$rights[$handler]['sql']);
+            if (Database::num_rows($result) > 0)
+                $result = true;
+            else
+                $result = false;
+        } else if (self::$rights[$handler]['type'] == 'const')
+            $result = self::$rights[$handler]['const'];
+        else if (self::$rights[$handler]['type'] == 'func')
+            $result = self::$rights[$handler]['func']();
+        else // handler type not implemented
+            return true;
+        self::$rights_cache[$handler] = $result;
+        return $result;
+    }
 
-	public static function hasRightClosePageWithError($handler) {
-		if (hasRight($handler) == false)
-			die("You are not allowed here"); //FIXME
-	}
+    public static function hasRightClosePageWithError($handler) {
+        if (hasRight($handler) == false)
+            die("You are not allowed here"); //FIXME
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -6,9 +6,9 @@
  */
 class Rights {
 	private static $rights_cache = array();
-	private static $rights = array (
+	private static $rights = array(
 		'show_tabs:reports' =>
-			array (
+			array(
 				'type' => 'const',
 				'const' => 'true' )
 		);

Braces +23 added lines, -15 removed lines

@@ -16,31 +16,39 @@
 	// warning the goal of this function is to enforce rights managment in Chamilo
 	// thus default return value is always true
 	public static function hasRight($handler) {
-		if (array_key_exists($handler, self::$rights_cache))
-			return self::$rights_cache[$handler];
+		if (array_key_exists($handler, self::$rights_cache)) {
+					return self::$rights_cache[$handler];
+		}
 
-		if (!array_key_exists($handler, self::$rights))
-			return true; // handler does not exists
+		if (!array_key_exists($handler, self::$rights)) {
+					return true;
+		}
+		// handler does not exists
 
 		if (self::$rights[$handler]['type'] == 'sql') {
 			$result = Database::query(self::$rights[$handler]['sql']);
-			if (Database::num_rows($result) > 0)
-				$result = true;
-			else
-				$result = false;
-		} else if (self::$rights[$handler]['type'] == 'const')
-			$result = self::$rights[$handler]['const'];
-		else if (self::$rights[$handler]['type'] == 'func')
-			$result = self::$rights[$handler]['func']();
-		else // handler type not implemented
+			if (Database::num_rows($result) > 0) {
+							$result = true;
+			} else {
+							$result = false;
+			}
+		} else if (self::$rights[$handler]['type'] == 'const') {
+					$result = self::$rights[$handler]['const'];
+		} else if (self::$rights[$handler]['type'] == 'func') {
+					$result = self::$rights[$handler]['func']();
+		} else {
+		    // handler type not implemented
 			return true;
+		}
 		self::$rights_cache[$handler] = $result;
 		return $result;
 	}
 
 	public static function hasRightClosePageWithError($handler) {
-		if (hasRight($handler) == false)
-			die("You are not allowed here"); //FIXME
+		if (hasRight($handler) == false) {
+					die("You are not allowed here");
+		}
+		//FIXME
 	}
 
 }

main/inc/lib/search/ChamiloIndexer.class.php

Doc Comments +4 added lines

@@ -71,6 +71,10 @@
 
     /**
      * Get the terms stored at database
+     * @param string $prefix
+     * @param string $course_code
+     * @param string $tool_id
+     * @param integer $ref_id
      * @return  array Array of terms
      */
     function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {

Spacing +5 added lines, -5 removed lines

@@ -7,7 +7,7 @@ 
 /**
  * code
  */
-require_once dirname(__FILE__) . '/../../global.inc.php';
+require_once dirname(__FILE__).'/../../global.inc.php';
 include_once 'xapian/XapianIndexer.class.php';
 
 /**
@@ -39,7 +39,7 @@ 
         if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0))
             return FALSE;
 
-        require_once api_get_path(LIBRARY_PATH) . 'search/xapian/XapianQuery.php';
+        require_once api_get_path(LIBRARY_PATH).'search/xapian/XapianQuery.php';
 
         // compare terms
         $doc = $this->get_document($search_did);
@@ -55,10 +55,10 @@ 
 
         // save it to search engine
         foreach ($missing_terms as $term) {
-            $this->add_term_to_doc($prefix . $term, $doc);
+            $this->add_term_to_doc($prefix.$term, $doc);
         }
         foreach ($deprecated_terms as $term) {
-            $this->remove_term_from_doc($prefix . $term, $doc);
+            $this->remove_term_from_doc($prefix.$term, $doc);
         }
 
         // don't do anything if no change
@@ -74,7 +74,7 @@ 
      * @return  array Array of terms
      */
     function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {
-        require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php';
+        require_once api_get_path(LIBRARY_PATH).'specific_fields_manager.lib.php';
         $terms = get_specific_field_values_list_by_prefix($prefix, $course_code, $tool_id, $ref_id);
         $prefix_terms = array();
         foreach ($terms as $term) {

Braces +6 added lines, -4 removed lines

@@ -36,8 +36,9 @@ 
         $stored_terms = $this->get_terms_on_db($prefix, $course_code, $tool_id, $ref_id_high_level);
 
         // don't do anything if no change, verify only at DB, not the search engine
-        if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0))
-            return FALSE;
+        if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0)) {
+                    return FALSE;
+        }
 
         require_once api_get_path(LIBRARY_PATH) . 'search/xapian/XapianQuery.php';
 
@@ -45,8 +46,9 @@ 
         $doc = $this->get_document($search_did);
         $xapian_terms = xapian_get_doc_terms($doc, $prefix);
         $xterms = array();
-        foreach ($xapian_terms as $xapian_term)
-            $xterms[] = substr($xapian_term['name'], 1);
+        foreach ($xapian_terms as $xapian_term) {
+                    $xterms[] = substr($xapian_term['name'], 1);
+        }
 
         $dterms = $terms;
 

main/inc/lib/search/ChamiloQuery.php

Doc Comments +4 added lines, -1 removed lines

@@ -23,6 +23,9 @@ 
     return chamilo_preprocess_results($results);
 }
 
+/**
+ * @param string $query_string
+ */
 function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
@@ -30,7 +33,7 @@ 
 /**
  * Wrapper for getting boolean queries
  *
- * @param   string    $query_string   The term string
+ * @param string $term
  */
 function chamilo_get_boolean_query($term) {
   return xapian_get_boolean_query($term);

Spacing +6 added lines, -6 removed lines

@@ -18,12 +18,12 @@ 
  * @param   array     extra           Extra queries to join with. Optional
  * @return  array
  */
-function chamilo_query_query($query_string, $offset=0, $length=10, $extra=NULL) {
+function chamilo_query_query($query_string, $offset = 0, $length = 10, $extra = NULL) {
     list($count, $results) = xapian_query($query_string, NULL, $offset, $length, $extra);
     return chamilo_preprocess_results($results);
 }
 
-function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
+function chamilo_query_simple_query($query_string, $offset = 0, $length = 10, $extra = NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
 
@@ -42,7 +42,7 @@ 
 function chamilo_preprocess_results($results) {
     // group by toolid
     $results_by_tool = array();
-    if (count($results)>0) {
+    if (count($results) > 0) {
 
 	    foreach ($results as $key => $row) {
 	        $results_by_tool[$row['toolid']][] = $row;
@@ -50,8 +50,8 @@ 
 
 	    $processed_results = array();
 	    foreach ($results_by_tool as $toolid => $rows) {
-	        $tool_processor_class = $toolid .'_processor';
-	        $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
+	        $tool_processor_class = $toolid.'_processor';
+	        $tool_processor_path = api_get_path(LIBRARY_PATH).'search/tool_processors/'.$tool_processor_class.'.class.php';
 	        if (file_exists($tool_processor_path)) {
 	            require_once($tool_processor_path);
 	            $tool_processor = new $tool_processor_class($rows);
@@ -71,6 +71,6 @@ 
  * @param string $op
  * @return XapianQuery query joined
  */
-function chamilo_join_queries($query1, $query2=NULL, $op='or') {
+function chamilo_join_queries($query1, $query2 = NULL, $op = 'or') {
 	return xapian_join_queries($query1, $query2, $op);
 }

Indentation +16 added lines, -16 removed lines

@@ -33,7 +33,7 @@ 
  * @param   string    $query_string   The term string
  */
 function chamilo_get_boolean_query($term) {
-  return xapian_get_boolean_query($term);
+    return xapian_get_boolean_query($term);
 }
 
 /**
@@ -44,22 +44,22 @@ 
     $results_by_tool = array();
     if (count($results)>0) {
 
-	    foreach ($results as $key => $row) {
-	        $results_by_tool[$row['toolid']][] = $row;
-	    }
+        foreach ($results as $key => $row) {
+            $results_by_tool[$row['toolid']][] = $row;
+        }
 
-	    $processed_results = array();
-	    foreach ($results_by_tool as $toolid => $rows) {
-	        $tool_processor_class = $toolid .'_processor';
-	        $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
-	        if (file_exists($tool_processor_path)) {
-	            require_once($tool_processor_path);
-	            $tool_processor = new $tool_processor_class($rows);
-	            $processed_results = array_merge($tool_processor->process(), $processed_results);
-	        }
-	    }
+        $processed_results = array();
+        foreach ($results_by_tool as $toolid => $rows) {
+            $tool_processor_class = $toolid .'_processor';
+            $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
+            if (file_exists($tool_processor_path)) {
+                require_once($tool_processor_path);
+                $tool_processor = new $tool_processor_class($rows);
+                $processed_results = array_merge($tool_processor->process(), $processed_results);
+            }
+        }
 
-	    return array(count($processed_results), $processed_results);
+        return array(count($processed_results), $processed_results);
     }
 }
 
@@ -72,5 +72,5 @@ 
  * @return XapianQuery query joined
  */
 function chamilo_join_queries($query1, $query2=NULL, $op='or') {
-	return xapian_join_queries($query1, $query2, $op);
+    return xapian_join_queries($query1, $query2, $op);
 }