chamilo / chamilo-lms

plugin/openmeetings/lib/openmeetings_gateway.php

Doc Comments +5 added lines

@@ -36,6 +36,11 @@
     private $_pass;
     private $_url;
 
+    /**
+     * @param string $host
+     * @param string $user
+     * @param string $pass
+     */
     public function __construct($host, $user, $pass)
     {
         $this->_user = urlencode($user);

Spacing +86 added lines, -86 removed lines

@@ -47,8 +47,8 @@ 
         $this->rest = new OpenMeetingsRestService();
         $err = $this->rest->getError();
         if ($err) {
-            error_log('Constructor error: ' . $err);
-            error_log('Debug: ' . $this->rest->getDebug());;
+            error_log('Constructor error: '.$err);
+            error_log('Debug: '.$this->rest->getDebug()); ;
             exit();
         }
     }
@@ -59,7 +59,7 @@ 
      */
     public function getRestUrl($name)
     {
-        return $this->getUrl() . "/services/" . $name . "/";
+        return $this->getUrl()."/services/".$name."/";
     }
 
     /**
@@ -89,30 +89,30 @@ 
     public function loginUser()
     {
         $returnValue = 0;
-        $response = $this->rest->call($this->getRestUrl("UserService") . "getSession", "session_id");
+        $response = $this->rest->call($this->getRestUrl("UserService")."getSession", "session_id");
 
         if ($this->rest->getError()) {
             error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($response, 1));
         } else {
             $err = $this->rest->getError();
             if ($err) {
-                error_log('Error: ' . $err);
+                error_log('Error: '.$err);
             } else {
                 //error_log('getSession returned '.$response. ' - Storing as sessionId');
                 $this->sessionId = $response;
 
                 $url = $this->getRestUrl("UserService")
                         . "loginUser?"
-                        . "SID=" . $this->sessionId
-                        . "&username=" . $this->_user
-                        . "&userpass=" . $this->_pass;
+                        . "SID=".$this->sessionId
+                        . "&username=".$this->_user
+                        . "&userpass=".$this->_pass;
                 $result = $this->rest->call($url);
                 if ($this->rest->getError()) {
                     error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result, 1));
                 } else {
                     $err = $this->rest->getError();
                     if ($err) {
-                        error_log('Error '. $err);
+                        error_log('Error '.$err);
                     } else {
                         $returnValue = $result;
                     }
@@ -135,8 +135,8 @@ 
     {
         $err = $this->rest->getError();
         if ($err) {
-            error_log('Constructor error: ' . $err);
-            error_log('Debug: ' . $this->rest->getDebug());
+            error_log('Constructor error: '.$err);
+            error_log('Debug: '.$this->rest->getDebug());
             exit();
         }
 
@@ -146,17 +146,17 @@ 
         }
 
         $url = $this->getRestUrl($this->getRestUrl("RoomService")
-                . "updateRoomWithModeration?SID=" . $this->sessionId
-                . "&room_id=" . $room->room_id
-                . "&name=" . urlencode($room->name)
-                . "&roomtypes_id=" . $room->roomtypes_id
-                . "&comment=" . $room->comment
-                . "&numberOfPartizipants=" . $room->numberOfPartizipants
+                . "updateRoomWithModeration?SID=".$this->sessionId
+                . "&room_id=".$room->room_id
+                . "&name=".urlencode($room->name)
+                . "&roomtypes_id=".$room->roomtypes_id
+                . "&comment=".$room->comment
+                . "&numberOfPartizipants=".$room->numberOfPartizipants
                 . "&ispublic=false"
                 . "&appointment=false"
                 . "&isDemoRoom=false"
                 . "&demoTime=0"
-                . "&isModeratedRoom=" . $this->var_to_str($isModeratedRoom));
+                . "&isModeratedRoom=".$this->var_to_str($isModeratedRoom));
         //error_log($url);
         $result = $this->rest->call($url);
 
@@ -165,14 +165,14 @@ 
         } else {
             $err = $this->rest->getError();
             if ($err) {
-                error_log('Error: ' . $err);
+                error_log('Error: '.$err);
             } else {
                 // echo '<h2>Result</h2><pre>'; print_r($result["return"]); echo '</pre>';
                 //error_log('Room updated successfully '.print_r($result,1));
                 return $result;
             }
         }
-        return - 1;
+        return -1;
     }
 
     /**
@@ -188,13 +188,13 @@ 
     {
         $result = $this->rest->call($this->getRestUrl("UserService")
                 . 'setUserObjectAndGenerateRecordingHashByURL?'
-                . 'SID=' . $this->sessionId
-                . '&username=' . urlencode($username)
-                . '&firstname=' . urlencode($firstname)
-                . '&lastname=' . urlencode($lastname)
-                . '&externalUserId=' . $userId
-                . '&externalUserType=' . urlencode($systemType)
-                . '&recording_id=' . $recording_id, 'return');
+                . 'SID='.$this->sessionId
+                . '&username='.urlencode($username)
+                . '&firstname='.urlencode($firstname)
+                . '&lastname='.urlencode($lastname)
+                . '&externalUserId='.$userId
+                . '&externalUserType='.urlencode($systemType)
+                . '&recording_id='.$recording_id, 'return');
 
         if ($result->fault) {
             error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result, 1));
@@ -206,7 +206,7 @@ 
                 return $result;
             }
         }
-        return - 1;
+        return -1;
     }
 
     /**
@@ -226,28 +226,28 @@ 
     {
         $err = $this->rest->getError();
         if ($err) {
-            error_log('Constructor error: ' . $err);
-            error_log('Debug: ' . $this->rest->getDebug());;
+            error_log('Constructor error: '.$err);
+            error_log('Debug: '.$this->rest->getDebug()); ;
             exit();
         }
 
         $result = $this->rest->call($this->getRestUrl("UserService")
                 . "setUserObjectAndGenerateRoomHashByURLAndRecFlag?"
-                . "SID=" . $this->sessionId
-                . "&username=" . urlencode($username)
-                . "&firstname=" . urlencode($firstname)
-                . "&lastname=" . urlencode($lastname)
-                . "&profilePictureUrl=" . urlencode($profilePictureUrl)
-                . "&email=" . urlencode($email)
-                . "&externalUserId=" . urlencode($userId)
-                . "&externalUserType=" . urlencode($systemType)
-                . "&room_id=" . urlencode($room_id)
-                . "&becomeModeratorAsInt=" . $becomeModerator
+                . "SID=".$this->sessionId
+                . "&username=".urlencode($username)
+                . "&firstname=".urlencode($firstname)
+                . "&lastname=".urlencode($lastname)
+                . "&profilePictureUrl=".urlencode($profilePictureUrl)
+                . "&email=".urlencode($email)
+                . "&externalUserId=".urlencode($userId)
+                . "&externalUserType=".urlencode($systemType)
+                . "&room_id=".urlencode($room_id)
+                . "&becomeModeratorAsInt=".$becomeModerator
                 . "&showAudioVideoTestAsInt=1"
-                . "&allowRecording=" . $this->var_to_str($allowRecording));
+                . "&allowRecording=".$this->var_to_str($allowRecording));
 
         if ($result->fault) {
-            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result,1));
+            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result, 1));
         } else {
             $err = $this->rest->getError();
             if ($err) {
@@ -257,7 +257,7 @@ 
                 return $result;
             }
         }
-        return - 1;
+        return -1;
     }
 
     /**
@@ -268,15 +268,15 @@ 
     {
         $err = $this->rest->getError();
         if ($err) {
-            error_log('Constructor error: ' . $err);
-            error_log('Debug: ' . $this->rest->getDebug());
+            error_log('Constructor error: '.$err);
+            error_log('Debug: '.$this->rest->getDebug());
             exit();
         }
         $url = $this->getRestUrl("RoomService")."deleteRoom?SID=".$this->sessionId."&rooms_id=".$openmeetings->room_id;
         $result = $this->rest->call($url);
 
         if ($result->fault) {
-            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result,1));
+            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result, 1));
         } else {
             $err = $this->rest->getError();
             if ($err) {
@@ -287,7 +287,7 @@ 
                 return $result;
             }
         }
-        return - 1;
+        return -1;
     }
 
     /**
@@ -297,20 +297,20 @@ 
     {
         $result = $this->rest->call($this->getRestUrl("UserService")
                 . "setUserObjectAndGenerateRoomHash?"
-                . "SID=" . $this->sessionId
-                . "&username=" . urlencode($username)
-                . "&firstname=" . urlencode($firstname)
-                . "&lastname=" . urlencode($lastname)
-                . "&profilePictureUrl=" . urlencode($profilePictureUrl)
-                . "&email=" . urlencode($email)
-                . "&externalUserId=" . urlencode($externalUserId)
-                . "&externalUserType=" . urlencode($externalUserType)
-                . "&room_id=" . $room_id
-                . "&becomeModeratorAsInt=" . $becomeModeratorAsInt
-                . "&showAudioVideoTestAsInt=" . $showAudioVideoTestAsInt);
+                . "SID=".$this->sessionId
+                . "&username=".urlencode($username)
+                . "&firstname=".urlencode($firstname)
+                . "&lastname=".urlencode($lastname)
+                . "&profilePictureUrl=".urlencode($profilePictureUrl)
+                . "&email=".urlencode($email)
+                . "&externalUserId=".urlencode($externalUserId)
+                . "&externalUserType=".urlencode($externalUserType)
+                . "&room_id=".$room_id
+                . "&becomeModeratorAsInt=".$becomeModeratorAsInt
+                . "&showAudioVideoTestAsInt=".$showAudioVideoTestAsInt);
 
         if ($result->getError()) {
-            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result,1));
+            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result, 1));
         } else {
             $err = $this->rest->getError();
             if ($err) {
@@ -320,7 +320,7 @@ 
                 return $result;
             }
         }
-        return - 1;
+        return -1;
     }
 
     /**
@@ -338,29 +338,29 @@ 
         }
         $url = $this->getRestUrl("RoomService")
                 . $service.'?'
-                . 'SID=' . $room->SID
-                . '&name=' . $room->name
-                . '&roomtypes_id=' . $room->roomtypes_id
-                . '&comment='. $room->comment
-                . '&numberOfPartizipants=' . $room->numberOfPartizipants
-                . '&ispublic=' . $this->var_to_str($room->ispublic)
-                . '&appointment=' . $this->var_to_str($room->appointment)
-                . '&isDemoRoom=' . $this->var_to_str($room->isDemoRoom)
-                . '&demoTime=' . $room->demoTime
-                . '&isModeratedRoom=' . $this->var_to_str($room->isModeratedRoom)
-                . '&externalRoomType=' . $room->externalRoomType;
+                . 'SID='.$room->SID
+                . '&name='.$room->name
+                . '&roomtypes_id='.$room->roomtypes_id
+                . '&comment='.$room->comment
+                . '&numberOfPartizipants='.$room->numberOfPartizipants
+                . '&ispublic='.$this->var_to_str($room->ispublic)
+                . '&appointment='.$this->var_to_str($room->appointment)
+                . '&isDemoRoom='.$this->var_to_str($room->isDemoRoom)
+                . '&demoTime='.$room->demoTime
+                . '&isModeratedRoom='.$this->var_to_str($room->isModeratedRoom)
+                . '&externalRoomType='.$room->externalRoomType;
         if ($room->allowRecording) {
-            $url .= '&allowUserQuestions=' . $this->var_to_str($room->allowUserQuestions)
-                 . '&isAudioOnly=' . $this->var_to_str($room->isAudioOnly)
-                 . '&waitForRecording=' . $this->var_to_str($room->waitForRecording)
-                 . '&allowRecording=' . $this->var_to_str($room->allowRecording);
+            $url .= '&allowUserQuestions='.$this->var_to_str($room->allowUserQuestions)
+                 . '&isAudioOnly='.$this->var_to_str($room->isAudioOnly)
+                 . '&waitForRecording='.$this->var_to_str($room->waitForRecording)
+                 . '&allowRecording='.$this->var_to_str($room->allowRecording);
         } elseif ($room->isAudioOnly) {
-            $url .= '&isAudioOnly=' . $this->var_to_str($room->isAudioOnly);
+            $url .= '&isAudioOnly='.$this->var_to_str($room->isAudioOnly);
         }
         $result = $this->rest->call($url);
 
         if ($this->rest->fault) {
-            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result,1));
+            error_log('Fault (Expect - The request contains an invalid SOAP body) '.print_r($result, 1));
         } else {
             $err = $this->rest->getError();
             if ($err) {
@@ -385,7 +385,7 @@ 
             return false;
         }
 
-        $url = $this->getRestUrl("RoomService") . "getRoomsWithCurrentUsersByListAndType?SID=" . $this->sessionId
+        $url = $this->getRestUrl("RoomService")."getRoomsWithCurrentUsersByListAndType?SID=".$this->sessionId
             . "&start=1&max=1000&orderby=name&asc=true&externalRoomType=chamilolms";
         //$url = $this->getRestUrl("RoomService")
         //    . "getRoomTypes?"
@@ -396,7 +396,7 @@ 
         $rooms = array();
         foreach ($result as $room) {
             //error_log(__FILE__.'+'.__LINE__.': one room found on remote: '.print_r($room,1));
-            if ($room['externalRoomType'] == $type && count($room['currentusers']) > 0 ) {
+            if ($room['externalRoomType'] == $type && count($room['currentusers']) > 0) {
                 $rooms[] = $room;
             }
         }
@@ -418,7 +418,7 @@ 
 
         $url = $this->getRestUrl("RoomService")
             . "getRoomById?"
-            . "SID=" . $this->sessionId
+            . "SID=".$this->sessionId
             . "&rooms_id=".$roomId;
         //error_log(__FILE__.'+'.__LINE__.' Calling WS: '.$url);
         $result = $this->rest->call($url, "return");
@@ -432,8 +432,8 @@ 
     {
         $url = $this->getRestUrl("RoomService")
             . "getFlvRecordingByExternalRoomType?"
-            . "SID=" . $this->sessionId
-            . "&externalRoomType=" . urlencode($this->config["moduleKey"]);
+            . "SID=".$this->sessionId
+            . "&externalRoomType=".urlencode($this->config["moduleKey"]);
 
         $result = $this->rest->call($url, "return");
 
@@ -449,8 +449,8 @@ 
     {
         $url = $this->getRestUrl("RoomService")
             . "getFlvRecordingByRoomId?"
-            . "SID=" . $this->sessionId
-            . "&roomId=" . urlencode($id);
+            . "SID=".$this->sessionId
+            . "&roomId=".urlencode($id);
 
         $result = $this->rest->call($url, "return");
 
@@ -464,8 +464,8 @@ 
     {
         $url = $this->getRestUrl("RoomService")
             . "getFlvRecordingByExternalUserId?"
-            . "SID=" . $this->sessionId
-            . "&externalUserId=" . $id;
+            . "SID=".$this->sessionId
+            . "&externalUserId=".$id;
 
         $result = $this->rest->call($url, "return");
 

Indentation +3 added lines, -3 removed lines

@@ -351,9 +351,9 @@
                 . '&externalRoomType=' . $room->externalRoomType;
         if ($room->allowRecording) {
             $url .= '&allowUserQuestions=' . $this->var_to_str($room->allowUserQuestions)
-                 . '&isAudioOnly=' . $this->var_to_str($room->isAudioOnly)
-                 . '&waitForRecording=' . $this->var_to_str($room->waitForRecording)
-                 . '&allowRecording=' . $this->var_to_str($room->allowRecording);
+                    . '&isAudioOnly=' . $this->var_to_str($room->isAudioOnly)
+                    . '&waitForRecording=' . $this->var_to_str($room->waitForRecording)
+                    . '&allowRecording=' . $this->var_to_str($room->allowRecording);
         } elseif ($room->isAudioOnly) {
             $url .= '&isAudioOnly=' . $this->var_to_str($room->isAudioOnly);
         }

plugin/openmeetings/lib/openmeetings_rest_service.php

Doc Comments +6 added lines

@@ -27,6 +27,9 @@ 
  */
 class OpenMeetingsRestService
 {
+    /**
+     * @param string $request
+     */
     function call($request, $returnAttribute = "return")
     {
         // This will allow you to view errors in the browser
@@ -121,6 +124,9 @@ 
             
     }
 
+    /**
+     * @param DOMDocument $node
+     */
     function getArray($node)
     {
         if (is_null($node) || !is_object($node)) {

Spacing +13 added lines, -13 removed lines

@@ -40,31 +40,31 @@ 
         // $request
         
         // Initialize the session by passing the request as a parameter
-        $session = curl_init ( $request );
+        $session = curl_init($request);
         
         // Set curl options by passing session and flags
         // CURLOPT_HEADER allows us to receive the HTTP header
-        curl_setopt ( $session, CURLOPT_HEADER, true );
+        curl_setopt($session, CURLOPT_HEADER, true);
         
         // CURLOPT_RETURNTRANSFER will return the response
-        curl_setopt ( $session, CURLOPT_RETURNTRANSFER, true );
+        curl_setopt($session, CURLOPT_RETURNTRANSFER, true);
         
         // Make the request
-        $response = curl_exec ( $session );
+        $response = curl_exec($session);
         
         // Close the curl session
-        curl_close ( $session );
+        curl_close($session);
         
         // Confirm that the request was transmitted to the OpenMeetings! Image Search Service
-        if (! $response) {
-            die ( "Request OpenMeetings! OpenMeetings Service failed and no response was returned in ".__CLASS__.'::'.__FUNCTION__.'()' );
+        if (!$response) {
+            die ("Request OpenMeetings! OpenMeetings Service failed and no response was returned in ".__CLASS__.'::'.__FUNCTION__.'()');
         }
         
         // Create an array to store the HTTP response codes
-        $status_code = array ();
+        $status_code = array();
         
         // Use regular expressions to extract the code from the header
-        preg_match ( '/\d\d\d/', $response, $status_code );
+        preg_match('/\d\d\d/', $response, $status_code);
         $bt = debug_backtrace();
         $caller = array_shift($bt);
         $extra = ' (from '.$caller['file'].' at line '.$caller['line'].') ';
@@ -74,24 +74,24 @@ 
                 // Success
                 break;
             case 503 :
-                error_log( 'Your call to OpenMeetings Web Services '.$extra.' failed and returned an HTTP status of 503.
+                error_log('Your call to OpenMeetings Web Services '.$extra.' failed and returned an HTTP status of 503.
                                  That means: Service unavailable. An internal problem prevented us from returning data to you.' );
                 return false;
                 break;
             case 403 :
-                error_log( 'Your call to OpenMeetings Web Services '.$extra.' failed and returned an HTTP status of 403.
+                error_log('Your call to OpenMeetings Web Services '.$extra.' failed and returned an HTTP status of 403.
                                  That means: Forbidden. You do not have permission to access this resource, or are over your rate limit.' );
                 return false;
                 break;
             case 400 :
                 // You may want to fall through here and read the specific XML error
-                error_log( 'Your call to OpenMeetings Web Services '.$extra.' failed and returned an HTTP status of 400.
+                error_log('Your call to OpenMeetings Web Services '.$extra.' failed and returned an HTTP status of 400.
                                  That means:  Bad request. The parameters passed to the service did not match as expected.   
                                  The exact error is returned in the XML response.' );
                 return false;
                 break;
             default :
-                error_log( 'Your call to OpenMeetings Web Services '.$extra.' returned an unexpected HTTP status of: ' . $status_code [0] . " Request " . $request );
+                error_log('Your call to OpenMeetings Web Services '.$extra.' returned an unexpected HTTP status of: '.$status_code [0]." Request ".$request);
                 return false;
         }
         

plugin/pens/lib/pens/pens_exception.php

Doc Comments +1 added lines

@@ -79,6 +79,7 @@
 	 * 
 	 * @param int Exception code
 	 * @param string Message to display
+	 * @param integer $code
 	 * @return PENSException Exception created
 	 */
 	public function __construct($code, $message = null) {

Spacing +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 	 * Sets the message based on the code
 	 */
 	protected function setMessageBasedOnCode() {
-		if(empty($this->message) && !empty(self::$_code_to_messages[$this->code])) {
+		if (empty($this->message) && !empty(self::$_code_to_messages[$this->code])) {
 			$this->message = self::$_code_to_messages[$this->code];
 		}
 	}

Indentation +55 added lines, -55 removed lines

@@ -37,62 +37,62 @@
  */
 class PENSException extends Exception {
 
-	/**
-	 * Array that provides an association between exception codes and messages
-	 * @var array
-	 */
-	protected static $_code_to_messages = array(
-		1101 => "Unable to parse PENS command",
-		1201 => "Attempt to pass an invalid argument",
-		1301 => "Unable to retrieve package",
-		1302 => "Unable to retrieve package via HTTPS",
-		1304 => "Unable to retrieve package via FTP",
-		1306 => "Unable to retrieve package via FTPS",
-		1310 => "Unable to retrieve package at specified URL due to error in URL or lack of response from URL",
-		1312 => "Unable to retrieve package at specified URL due to error with access credential for package URL",
-		1320 => "Expiration date is non-null and in an improper format",
-		1322 => "Current time indicates expiry date has passed",
-		1420 => "PENS version not supported",
-		1421 => "Command not supported",
-		1430 => "Package type not supported",
-		// The following error code is not specified in the PENS specification and was added in this implementation
-		1431 => "Package format not supported",
-		1432 => "Internal package error",
-		1440 => "Insufficient host space/storage available",
-		1500 => "Unable to communicate with provided acknowledgement URL",
-		1510 => "Unsupported acknowledgement protocol",
-		1520 => "Unsupported alert protocol",
-		2001 => "PENS version invalid or not specified",
-		2002 => "PENS command invalid or not specified",
-		2003 => "package-type invalid or not specified",
-		2004 => "package-type-version invalid or not specified",
-		2005 => "package-format invalid or not specified",
-		2007 => "package-id invalid or not specified",
-		2008 => "package-url invalid or not specified",
-		2009 => "package-url-expiry date invalid or not specified",
-		2010 => "client submitting package invalid or not specified",
-		2011 => "receipt url invalid or not specified"
-	);
+    /**
+     * Array that provides an association between exception codes and messages
+     * @var array
+     */
+    protected static $_code_to_messages = array(
+        1101 => "Unable to parse PENS command",
+        1201 => "Attempt to pass an invalid argument",
+        1301 => "Unable to retrieve package",
+        1302 => "Unable to retrieve package via HTTPS",
+        1304 => "Unable to retrieve package via FTP",
+        1306 => "Unable to retrieve package via FTPS",
+        1310 => "Unable to retrieve package at specified URL due to error in URL or lack of response from URL",
+        1312 => "Unable to retrieve package at specified URL due to error with access credential for package URL",
+        1320 => "Expiration date is non-null and in an improper format",
+        1322 => "Current time indicates expiry date has passed",
+        1420 => "PENS version not supported",
+        1421 => "Command not supported",
+        1430 => "Package type not supported",
+        // The following error code is not specified in the PENS specification and was added in this implementation
+        1431 => "Package format not supported",
+        1432 => "Internal package error",
+        1440 => "Insufficient host space/storage available",
+        1500 => "Unable to communicate with provided acknowledgement URL",
+        1510 => "Unsupported acknowledgement protocol",
+        1520 => "Unsupported alert protocol",
+        2001 => "PENS version invalid or not specified",
+        2002 => "PENS command invalid or not specified",
+        2003 => "package-type invalid or not specified",
+        2004 => "package-type-version invalid or not specified",
+        2005 => "package-format invalid or not specified",
+        2007 => "package-id invalid or not specified",
+        2008 => "package-url invalid or not specified",
+        2009 => "package-url-expiry date invalid or not specified",
+        2010 => "client submitting package invalid or not specified",
+        2011 => "receipt url invalid or not specified"
+    );
 	
-	/**
-	 * Redefines the constructor so that code is the first argument
-	 * 
-	 * @param int Exception code
-	 * @param string Message to display
-	 * @return PENSException Exception created
-	 */
-	public function __construct($code, $message = null) {
-		parent::__construct($message, $code);
-		$this->setMessageBasedOnCode();
-	}
+    /**
+     * Redefines the constructor so that code is the first argument
+     * 
+     * @param int Exception code
+     * @param string Message to display
+     * @return PENSException Exception created
+     */
+    public function __construct($code, $message = null) {
+        parent::__construct($message, $code);
+        $this->setMessageBasedOnCode();
+    }
 	
-	/**
-	 * Sets the message based on the code
-	 */
-	protected function setMessageBasedOnCode() {
-		if(empty($this->message) && !empty(self::$_code_to_messages[$this->code])) {
-			$this->message = self::$_code_to_messages[$this->code];
-		}
-	}
+    /**
+     * Sets the message based on the code
+     */
+    protected function setMessageBasedOnCode() {
+        if(empty($this->message) && !empty(self::$_code_to_messages[$this->code])) {
+            $this->message = self::$_code_to_messages[$this->code];
+        }
+    }
 	
 }

plugin/pens/lib/pens/pens_server.php

Doc Comments +3 added lines

@@ -236,6 +236,7 @@ 
 	 * @param PENSRequest Original collect request
 	 * @param PENSResponse Reponse to send in the receipt or the alert
 	 * @param string Mode (alert | receipt)
+	 * @param string $mode
 	 * @return PENSResponse Response
 	 */
 	protected function sendAlertOrReceipt($request, $response, $mode) {
@@ -283,6 +284,7 @@ 
 	 * 
 	 * @param PENSRequest Original collect request
 	 * @param PENSResponse Response to send in the receipt
+	 * @param PENSResponse $receipt
 	 * @return PENSResponse Response
 	 */
 	protected function sendReceipt($request, $receipt) {
@@ -294,6 +296,7 @@ 
 	 * 
 	 * @param PENSRequest Original collect request
 	 * @param string Path to the package on the hard drive
+	 * @param string $path_to_package
 	 */
 	protected function processPackage($request, $path_to_package) {
 		return $this->_package_handler->processPackage($request, $path_to_package);

Indentation +260 added lines, -260 removed lines

@@ -16,15 +16,15 @@ 
  * along with php-pens.  If not, see <http://www.gnu.org/licenses/>.
  */
  
- /**
- * PENSServer
- * 
- * Provides the PENSServer class
- * 
- * @package PENS
- * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
- * @licence http://www.gnu.org/licenses/gpl.txt
- */
+    /**
+     * PENSServer
+     * 
+     * Provides the PENSServer class
+     * 
+     * @package PENS
+     * @author Guillaume Viguier-Just <guillaume@viguierjust.com>
+     * @licence http://www.gnu.org/licenses/gpl.txt
+     */
 
 require_once __DIR__ . '/pens_controller.php';
 require_once __DIR__ . '/pens_package_handler.php';
@@ -42,272 +42,272 @@ 
  */
 class PENSServer extends PENSController {
 
-	/**
-	 * Instance of the PENSServer
-	 * @var PENSServer
-	 */
-	private static $_instance;
+    /**
+     * Instance of the PENSServer
+     * @var PENSServer
+     */
+    private static $_instance;
 	
-	/**
-	 * Package handler
-	 * @var PENSPackageHandler
-	 */
-	protected $_package_handler = null;
+    /**
+     * Package handler
+     * @var PENSPackageHandler
+     */
+    protected $_package_handler = null;
 	
-	/**
-	 * Private constructor
-	 */
-	private function __construct() {
-	}
+    /**
+     * Private constructor
+     */
+    private function __construct() {
+    }
 	
-	/**
-	 * Singleton method
-	 */
-	public static function singleton() {
-		if(!isset(self::$_instance)) {
-			$c = __CLASS__;
-			self::$_instance = new $c;
-		}
-		return self::$_instance;
-	}
+    /**
+     * Singleton method
+     */
+    public static function singleton() {
+        if(!isset(self::$_instance)) {
+            $c = __CLASS__;
+            self::$_instance = new $c;
+        }
+        return self::$_instance;
+    }
 	
-	/**
-	 * Prevent users to clone the instance
-	 */
-	public function __clone() {
-		trigger_error('Clone is not allowed', E_USER_ERROR);
-	}
+    /**
+     * Prevent users to clone the instance
+     */
+    public function __clone() {
+        trigger_error('Clone is not allowed', E_USER_ERROR);
+    }
 	
-	public function getPackageHandler() {
-		return $this->_package_handler;
-	}
+    public function getPackageHandler() {
+        return $this->_package_handler;
+    }
 	
-	/**
-	 * Sets the package handler. Does nothing if the argument is not an instance of PENSPackageHandler
-	 * 
-	 * @param PENSPackageHandler Package handler
-	 */
-	public function setPackageHandler($package_handler) {
-		if($package_handler instanceof PENSPackageHandler) {
-			$this->_package_handler = $package_handler;
-		}
-	}
+    /**
+     * Sets the package handler. Does nothing if the argument is not an instance of PENSPackageHandler
+     * 
+     * @param PENSPackageHandler Package handler
+     */
+    public function setPackageHandler($package_handler) {
+        if($package_handler instanceof PENSPackageHandler) {
+            $this->_package_handler = $package_handler;
+        }
+    }
 	
-	/**
-	 * Receives a collect request and treats it
-	 */
-	public function receiveCollect() {
-		$request = null;
-		try {
-			// First, try to parse the request
-			$request = $this->parseRequest();
-			if($request->getCommand() == "collect") {
-				if(isset($_REQUEST['process'])) {
-					// Collect the package and process it
-					$receipt = null;
-					$path_to_package = null;
-					try {
-						// Collect the package
-						$path_to_package = $this->collectPackage($request);
-						$receipt = new PENSResponse(0, "package successfully collected");
-					} catch(PENSException $e) {
-						$receipt = new PENSResponse($e);
-					}
-					// Send receipt
-					$response = $this->sendReceipt($request, $receipt);
-					if(!is_null($response) && !is_null($path_to_package)) {
-						if($response->getError() === 0) {
-							// Process package
-							$this->processPackage($request, $path_to_package);
-						}
-						unlink($path_to_package);
-					}
-				} else {
-					// Then, send a success response to the client
-					$this->sendResponse(new PENSResponse(0, "collect command received and understood"));
-					// Send a request to process the package: fake multithreading
-					$params = $_REQUEST;
-					$params['process'] = 1;
-					$scheme = "http";
-					if(!empty($_SERVER['HTTPS'])) {
-						$scheme = "https";
-					}
-					$ch = curl_init();
-					curl_setopt($ch, CURLOPT_URL, $scheme."://".$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']);
-					curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
-					curl_setopt($ch, CURLOPT_TIMEOUT, 1);
-					curl_exec($ch);
-					curl_close($ch);
-				}
-			}
+    /**
+     * Receives a collect request and treats it
+     */
+    public function receiveCollect() {
+        $request = null;
+        try {
+            // First, try to parse the request
+            $request = $this->parseRequest();
+            if($request->getCommand() == "collect") {
+                if(isset($_REQUEST['process'])) {
+                    // Collect the package and process it
+                    $receipt = null;
+                    $path_to_package = null;
+                    try {
+                        // Collect the package
+                        $path_to_package = $this->collectPackage($request);
+                        $receipt = new PENSResponse(0, "package successfully collected");
+                    } catch(PENSException $e) {
+                        $receipt = new PENSResponse($e);
+                    }
+                    // Send receipt
+                    $response = $this->sendReceipt($request, $receipt);
+                    if(!is_null($response) && !is_null($path_to_package)) {
+                        if($response->getError() === 0) {
+                            // Process package
+                            $this->processPackage($request, $path_to_package);
+                        }
+                        unlink($path_to_package);
+                    }
+                } else {
+                    // Then, send a success response to the client
+                    $this->sendResponse(new PENSResponse(0, "collect command received and understood"));
+                    // Send a request to process the package: fake multithreading
+                    $params = $_REQUEST;
+                    $params['process'] = 1;
+                    $scheme = "http";
+                    if(!empty($_SERVER['HTTPS'])) {
+                        $scheme = "https";
+                    }
+                    $ch = curl_init();
+                    curl_setopt($ch, CURLOPT_URL, $scheme."://".$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']);
+                    curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
+                    curl_setopt($ch, CURLOPT_TIMEOUT, 1);
+                    curl_exec($ch);
+                    curl_close($ch);
+                }
+            }
 				
-		} catch(PENSException $e) {
-			// If we could not parse the request, send the error back to the client
-			$this->sendResponse(new PENSResponse($e));
-		}
-	}
+        } catch(PENSException $e) {
+            // If we could not parse the request, send the error back to the client
+            $this->sendResponse(new PENSResponse($e));
+        }
+    }
 	
-	/**
-	 * Collects the package onto the local server
-	 * 
-	 * @param PENSRequest request
-	 * @return string Path to the package on the hard drive
-	 * @throws PENSException if an exception occured
-	 */
-	protected function collectPackage($request) {
-		$supported_package_types = $this->_package_handler->getSupportedPackageTypes();
-		if(!in_array($request->getPackageType(), $supported_package_types)) {
-			throw new PENSException(1430);
-		}
-		$supported_package_formats = $this->_package_handler->getSupportedPackageFormats();
-		if(!in_array($request->getPackageFormat(), $supported_package_formats)) {
-			throw new PENSException(1431);
-		}
-		if(!$this->isExpiryDateValid($request->getPackageUrlExpiry())) {
-			throw new PENSException(1322);
-		}
+    /**
+     * Collects the package onto the local server
+     * 
+     * @param PENSRequest request
+     * @return string Path to the package on the hard drive
+     * @throws PENSException if an exception occured
+     */
+    protected function collectPackage($request) {
+        $supported_package_types = $this->_package_handler->getSupportedPackageTypes();
+        if(!in_array($request->getPackageType(), $supported_package_types)) {
+            throw new PENSException(1430);
+        }
+        $supported_package_formats = $this->_package_handler->getSupportedPackageFormats();
+        if(!in_array($request->getPackageFormat(), $supported_package_formats)) {
+            throw new PENSException(1431);
+        }
+        if(!$this->isExpiryDateValid($request->getPackageUrlExpiry())) {
+            throw new PENSException(1322);
+        }
 		
-		// Try to download the package in the temporary directory
-		$tmp = null;
-		if(function_exists("sys_get_temp_dir")) {
-			$tmp = sys_get_temp_dir();
-		} else {
-			$tmp = "/tmp";
-		}
-		$path_to_file = $tmp."/".$request->getFilename();
-		$fp = fopen($path_to_file, 'w');
-		$ch = curl_init();
-		curl_setopt($ch, CURLOPT_URL, $request->getPackageUrl());
-		curl_setopt($ch, CURLOPT_HEADER, false);	
-		curl_setopt($ch, CURLOPT_FILE, $fp);
-		if(!is_null($request->getPackageUrlUserId())) {
-			curl_setopt($ch, CURLOPT_USERPWD, $request->getPackageUrlUserId().":".$request->getPackageUrlPassword());
-		}
-		if(curl_exec($ch) === false) {
-			$errno = curl_errno($ch);
-			curl_close($ch);
-			// Error occured. Throw an exception
-			switch($errno) {
-				case CURLE_UNSUPPORTED_PROTOCOL:
-					throw new PENSException(1301);
-					break;
-				case CURLE_URL_MALFORMAT:
-				case CURLE_COULDNT_RESOLVE_PROXY:
-				case CURLE_COULDNT_RESOLVE_HOST:
-				case CURLE_COULDNT_CONNECT:
-				case CURLE_OPERATION_TIMEOUT:
-				case CURLE_REMOTE_FILE_NOT_FOUND:
-					throw new PENSException(1310);
-					break;
-				case CURLE_REMOTE_ACCESS_DENIED:
-					throw new PENSException(1312);
-					break;
-				default:
-					throw new PENSException(1301);
-					break;
-			}
-			return null;
+        // Try to download the package in the temporary directory
+        $tmp = null;
+        if(function_exists("sys_get_temp_dir")) {
+            $tmp = sys_get_temp_dir();
+        } else {
+            $tmp = "/tmp";
+        }
+        $path_to_file = $tmp."/".$request->getFilename();
+        $fp = fopen($path_to_file, 'w');
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $request->getPackageUrl());
+        curl_setopt($ch, CURLOPT_HEADER, false);	
+        curl_setopt($ch, CURLOPT_FILE, $fp);
+        if(!is_null($request->getPackageUrlUserId())) {
+            curl_setopt($ch, CURLOPT_USERPWD, $request->getPackageUrlUserId().":".$request->getPackageUrlPassword());
+        }
+        if(curl_exec($ch) === false) {
+            $errno = curl_errno($ch);
+            curl_close($ch);
+            // Error occured. Throw an exception
+            switch($errno) {
+                case CURLE_UNSUPPORTED_PROTOCOL:
+                    throw new PENSException(1301);
+                    break;
+                case CURLE_URL_MALFORMAT:
+                case CURLE_COULDNT_RESOLVE_PROXY:
+                case CURLE_COULDNT_RESOLVE_HOST:
+                case CURLE_COULDNT_CONNECT:
+                case CURLE_OPERATION_TIMEOUT:
+                case CURLE_REMOTE_FILE_NOT_FOUND:
+                    throw new PENSException(1310);
+                    break;
+                case CURLE_REMOTE_ACCESS_DENIED:
+                    throw new PENSException(1312);
+                    break;
+                default:
+                    throw new PENSException(1301);
+                    break;
+            }
+            return null;
 				
-		} else {
-			curl_close($ch);
-			return $path_to_file;
-		}
-	}
+        } else {
+            curl_close($ch);
+            return $path_to_file;
+        }
+    }
 	
-	/**
-	 * Verifies that the package url is not expired
-	 * 
-	 * @param DateTime DateTime object to verify against current time
-	 */
-	protected function isExpiryDateValid($expiry) {
-		date_default_timezone_set('UTC');
-		$current_time = time();
-		$expiry_time = strtotime($expiry->format(DateTime::ISO8601));
-		if($current_time > $expiry_time) {
-			return false;
-		} else {
-			return true;
-		}
-	}
+    /**
+     * Verifies that the package url is not expired
+     * 
+     * @param DateTime DateTime object to verify against current time
+     */
+    protected function isExpiryDateValid($expiry) {
+        date_default_timezone_set('UTC');
+        $current_time = time();
+        $expiry_time = strtotime($expiry->format(DateTime::ISO8601));
+        if($current_time > $expiry_time) {
+            return false;
+        } else {
+            return true;
+        }
+    }
 	
-	/**
-	 * Sends an alert or a receipt. Called by sendReceipt and sendAlert
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param PENSResponse Reponse to send in the receipt or the alert
-	 * @param string Mode (alert | receipt)
-	 * @return PENSResponse Response
-	 */
-	protected function sendAlertOrReceipt($request, $response, $mode) {
-		if($mode == "alert") {
-			$url = $request->getAlerts();
-		} else {
-			$url = $request->getReceipt();
-		}
-		if(!empty($url)) {
-			$url_components = parse_url($url);
-			$scheme = $url_components["scheme"];
-			if($scheme == "mailto") {
-				$to = $url_components["path"];
-				if($mode == "alert") {
-					$subject = "PENS Alert for ".$request->getPackageId();
-				} else {
-					$subject = "PENS Receipt for ".$request->getPackageId();
-				}
-				$message = $response->__toString();
-				mail($to, $subject, $message);
-				return new PENSResponse(0, "");
-			} else if($scheme == "http" || $scheme == "https") {
-				if($mode == "alert") {
-					$params = array_merge($request->getSendAlertArray(), $response->getArray());
-				} else {
-					$params = array_merge($request->getSendReceiptArray(), $response->getArray());
-				}
-				$ch = curl_init($url);
-				curl_setopt($ch, CURLOPT_POST, true);
-				curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
-				curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-				$data = curl_exec($ch);
-				curl_close($ch);
-				if($data === false) {
-					return null;
-				} else {
-					return new PENSResponse($data);
-				}
-			}
-		}
-	}
+    /**
+     * Sends an alert or a receipt. Called by sendReceipt and sendAlert
+     * 
+     * @param PENSRequest Original collect request
+     * @param PENSResponse Reponse to send in the receipt or the alert
+     * @param string Mode (alert | receipt)
+     * @return PENSResponse Response
+     */
+    protected function sendAlertOrReceipt($request, $response, $mode) {
+        if($mode == "alert") {
+            $url = $request->getAlerts();
+        } else {
+            $url = $request->getReceipt();
+        }
+        if(!empty($url)) {
+            $url_components = parse_url($url);
+            $scheme = $url_components["scheme"];
+            if($scheme == "mailto") {
+                $to = $url_components["path"];
+                if($mode == "alert") {
+                    $subject = "PENS Alert for ".$request->getPackageId();
+                } else {
+                    $subject = "PENS Receipt for ".$request->getPackageId();
+                }
+                $message = $response->__toString();
+                mail($to, $subject, $message);
+                return new PENSResponse(0, "");
+            } else if($scheme == "http" || $scheme == "https") {
+                if($mode == "alert") {
+                    $params = array_merge($request->getSendAlertArray(), $response->getArray());
+                } else {
+                    $params = array_merge($request->getSendReceiptArray(), $response->getArray());
+                }
+                $ch = curl_init($url);
+                curl_setopt($ch, CURLOPT_POST, true);
+                curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
+                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+                $data = curl_exec($ch);
+                curl_close($ch);
+                if($data === false) {
+                    return null;
+                } else {
+                    return new PENSResponse($data);
+                }
+            }
+        }
+    }
 	
-	/**
-	 * Sends a receipt. Returns a PENSResponse in case of success, null if a problem occured
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param PENSResponse Response to send in the receipt
-	 * @return PENSResponse Response
-	 */
-	protected function sendReceipt($request, $receipt) {
-		return $this->sendAlertOrReceipt($request, $receipt, "receipt");
-	}
+    /**
+     * Sends a receipt. Returns a PENSResponse in case of success, null if a problem occured
+     * 
+     * @param PENSRequest Original collect request
+     * @param PENSResponse Response to send in the receipt
+     * @return PENSResponse Response
+     */
+    protected function sendReceipt($request, $receipt) {
+        return $this->sendAlertOrReceipt($request, $receipt, "receipt");
+    }
 	
-	/**
-	 * Processes the package using the handler provided
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param string Path to the package on the hard drive
-	 */
-	protected function processPackage($request, $path_to_package) {
-		return $this->_package_handler->processPackage($request, $path_to_package);
-	}
+    /**
+     * Processes the package using the handler provided
+     * 
+     * @param PENSRequest Original collect request
+     * @param string Path to the package on the hard drive
+     */
+    protected function processPackage($request, $path_to_package) {
+        return $this->_package_handler->processPackage($request, $path_to_package);
+    }
 	
-	/**
-	 * Sends an alert to the client. Returns a PENSResponse in case of success, null if a problem occured
-	 * 
-	 * @param PENSRequest Original collect request
-	 * @param PENSResponse Response to send in the alert
-	 * @return PENSResponse Response
-	 */
-	public function sendAlert($request, $alert) {
-		return $this->sendAlertOrReceipt($request, $alert, "alert");
-	}
+    /**
+     * Sends an alert to the client. Returns a PENSResponse in case of success, null if a problem occured
+     * 
+     * @param PENSRequest Original collect request
+     * @param PENSResponse Response to send in the alert
+     * @return PENSResponse Response
+     */
+    public function sendAlert($request, $alert) {
+        return $this->sendAlertOrReceipt($request, $alert, "alert");
+    }
 	
 }

Spacing +28 added lines, -28 removed lines

@@ -26,10 +26,10 @@ 
  * @licence http://www.gnu.org/licenses/gpl.txt
  */
 
-require_once __DIR__ . '/pens_controller.php';
-require_once __DIR__ . '/pens_package_handler.php';
-require_once __DIR__ . '/pens_exception.php';
-require_once __DIR__ . '/pens_response.php';
+require_once __DIR__.'/pens_controller.php';
+require_once __DIR__.'/pens_package_handler.php';
+require_once __DIR__.'/pens_exception.php';
+require_once __DIR__.'/pens_response.php';
 
 /**
  * PENSServer
@@ -64,7 +64,7 @@ 
 	 * Singleton method
 	 */
 	public static function singleton() {
-		if(!isset(self::$_instance)) {
+		if (!isset(self::$_instance)) {
 			$c = __CLASS__;
 			self::$_instance = new $c;
 		}
@@ -88,7 +88,7 @@ 
 	 * @param PENSPackageHandler Package handler
 	 */
 	public function setPackageHandler($package_handler) {
-		if($package_handler instanceof PENSPackageHandler) {
+		if ($package_handler instanceof PENSPackageHandler) {
 			$this->_package_handler = $package_handler;
 		}
 	}
@@ -101,8 +101,8 @@ 
 		try {
 			// First, try to parse the request
 			$request = $this->parseRequest();
-			if($request->getCommand() == "collect") {
-				if(isset($_REQUEST['process'])) {
+			if ($request->getCommand() == "collect") {
+				if (isset($_REQUEST['process'])) {
 					// Collect the package and process it
 					$receipt = null;
 					$path_to_package = null;
@@ -110,13 +110,13 @@ 
 						// Collect the package
 						$path_to_package = $this->collectPackage($request);
 						$receipt = new PENSResponse(0, "package successfully collected");
-					} catch(PENSException $e) {
+					} catch (PENSException $e) {
 						$receipt = new PENSResponse($e);
 					}
 					// Send receipt
 					$response = $this->sendReceipt($request, $receipt);
-					if(!is_null($response) && !is_null($path_to_package)) {
-						if($response->getError() === 0) {
+					if (!is_null($response) && !is_null($path_to_package)) {
+						if ($response->getError() === 0) {
 							// Process package
 							$this->processPackage($request, $path_to_package);
 						}
@@ -129,7 +129,7 @@ 
 					$params = $_REQUEST;
 					$params['process'] = 1;
 					$scheme = "http";
-					if(!empty($_SERVER['HTTPS'])) {
+					if (!empty($_SERVER['HTTPS'])) {
 						$scheme = "https";
 					}
 					$ch = curl_init();
@@ -141,7 +141,7 @@ 
 				}
 			}
 				
-		} catch(PENSException $e) {
+		} catch (PENSException $e) {
 			// If we could not parse the request, send the error back to the client
 			$this->sendResponse(new PENSResponse($e));
 		}
@@ -156,20 +156,20 @@ 
 	 */
 	protected function collectPackage($request) {
 		$supported_package_types = $this->_package_handler->getSupportedPackageTypes();
-		if(!in_array($request->getPackageType(), $supported_package_types)) {
+		if (!in_array($request->getPackageType(), $supported_package_types)) {
 			throw new PENSException(1430);
 		}
 		$supported_package_formats = $this->_package_handler->getSupportedPackageFormats();
-		if(!in_array($request->getPackageFormat(), $supported_package_formats)) {
+		if (!in_array($request->getPackageFormat(), $supported_package_formats)) {
 			throw new PENSException(1431);
 		}
-		if(!$this->isExpiryDateValid($request->getPackageUrlExpiry())) {
+		if (!$this->isExpiryDateValid($request->getPackageUrlExpiry())) {
 			throw new PENSException(1322);
 		}
 		
 		// Try to download the package in the temporary directory
 		$tmp = null;
-		if(function_exists("sys_get_temp_dir")) {
+		if (function_exists("sys_get_temp_dir")) {
 			$tmp = sys_get_temp_dir();
 		} else {
 			$tmp = "/tmp";
@@ -180,14 +180,14 @@ 
 		curl_setopt($ch, CURLOPT_URL, $request->getPackageUrl());
 		curl_setopt($ch, CURLOPT_HEADER, false);	
 		curl_setopt($ch, CURLOPT_FILE, $fp);
-		if(!is_null($request->getPackageUrlUserId())) {
+		if (!is_null($request->getPackageUrlUserId())) {
 			curl_setopt($ch, CURLOPT_USERPWD, $request->getPackageUrlUserId().":".$request->getPackageUrlPassword());
 		}
-		if(curl_exec($ch) === false) {
+		if (curl_exec($ch) === false) {
 			$errno = curl_errno($ch);
 			curl_close($ch);
 			// Error occured. Throw an exception
-			switch($errno) {
+			switch ($errno) {
 				case CURLE_UNSUPPORTED_PROTOCOL:
 					throw new PENSException(1301);
 					break;
@@ -223,7 +223,7 @@ 
 		date_default_timezone_set('UTC');
 		$current_time = time();
 		$expiry_time = strtotime($expiry->format(DateTime::ISO8601));
-		if($current_time > $expiry_time) {
+		if ($current_time > $expiry_time) {
 			return false;
 		} else {
 			return true;
@@ -239,17 +239,17 @@ 
 	 * @return PENSResponse Response
 	 */
 	protected function sendAlertOrReceipt($request, $response, $mode) {
-		if($mode == "alert") {
+		if ($mode == "alert") {
 			$url = $request->getAlerts();
 		} else {
 			$url = $request->getReceipt();
 		}
-		if(!empty($url)) {
+		if (!empty($url)) {
 			$url_components = parse_url($url);
 			$scheme = $url_components["scheme"];
-			if($scheme == "mailto") {
+			if ($scheme == "mailto") {
 				$to = $url_components["path"];
-				if($mode == "alert") {
+				if ($mode == "alert") {
 					$subject = "PENS Alert for ".$request->getPackageId();
 				} else {
 					$subject = "PENS Receipt for ".$request->getPackageId();
@@ -257,8 +257,8 @@ 
 				$message = $response->__toString();
 				mail($to, $subject, $message);
 				return new PENSResponse(0, "");
-			} else if($scheme == "http" || $scheme == "https") {
-				if($mode == "alert") {
+			} else if ($scheme == "http" || $scheme == "https") {
+				if ($mode == "alert") {
 					$params = array_merge($request->getSendAlertArray(), $response->getArray());
 				} else {
 					$params = array_merge($request->getSendReceiptArray(), $response->getArray());
@@ -269,7 +269,7 @@ 
 				curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 				$data = curl_exec($ch);
 				curl_close($ch);
-				if($data === false) {
+				if ($data === false) {
 					return null;
 				} else {
 					return new PENSResponse($data);

plugin/pens/lib/tests/test_pens_request.php

Doc Comments +5 added lines

@@ -76,6 +76,11 @@
 		return PENSRequestFactory::createPENSRequest($myargs);
 	}
 	
+	/**
+	 * @param string $key
+	 * @param string|null $value
+	 * @param integer $code
+	 */
 	public function exceptionTestForValue($key, $value, $code) {
 		try {
 			$myargs = $this->args;

Indentation +163 added lines, -163 removed lines

@@ -44,170 +44,170 @@
  */
 class TestPENSRequest extends UnitTestCase {
 	
-	/**
-	 * Valid arguments to be used for tests
-	 * 
-	 * @var array
-	 */
-	private $args = null;
-	
-	public function setUp() {
-		$this->args = array(
-			"pens-version" => "1.0.0",
-			"command" => "collect",
-			"package-type" => "aicc-pkg",
-			"package-type-version" => "1.0",
-			"package-format" => "zip",
-			"package-id" => "http://myurl.com/12345",
-			"package-url" => "http://myurl.com/mypackage.zip",
-			"package-url-expiry" => "2006-04-01T06:51:29Z",
-			"client" => "Authorware7",
-			"receipt" => "mailto:name@domain.com",
-			"package-url-user-id" => "guillaumev",
-			"package-url-account" => "toto",
-			"package-url-password" => "12345",
-			"system-user-id" => "guillaumev",
-			"system-password" => "12345",
-			"alerts" => "http://myurl.com/alerts",
-			"vendor-data" => "here are my data");
-	}
-	
-	public function createObject($myargs) {
-		return PENSRequestFactory::createPENSRequest($myargs);
-	}
-	
-	public function exceptionTestForValue($key, $value, $code) {
-		try {
-			$myargs = $this->args;
-			if($value === null) {
-				unset($myargs[$key]);
-			} else {
-				$myargs[$key] = $value;
-			}
-			$object = $this->createObject($myargs);
-			$this->fail();
-		} catch(PENSException $e) {
-			$this->assertEqual($e->getCode(), $code);
-		}
-	}
-	
-	public function testPensVersionInvalid() {
-		$this->exceptionTestForValue("pens-version", "0.8.0", 2001);
-	}
-	
-	public function testPensVersionNull() {
-		$this->exceptionTestForValue("pens-version", null, 2001);
-	}
-	
-	
-	public function testCommandInvalid() {
-		$this->exceptionTestForValue("command", "testing", 2002);
-	}
-	
-	public function testCommandNull() {
-		$this->exceptionTestForValue("command", null, 2002);
-	}
-	
-	public function testPackageTypeInvalid() {
-		$this->exceptionTestForValue("package-type", "testing", 2003);
-	}
-	
-	public function testPackageTypeNull() {
-		$this->exceptionTestForValue("package-type", null, 2003);
-	}
-	
-	public function testPackageTypeVersionNull() {
-		$this->exceptionTestForValue("package-type-version", null, 2004);
-	}
-	
-	public function testPackageFormatInvalid() {
-		$this->exceptionTestForValue("package-format", "testing", 2005);
-	}
-	
-	public function testPackageFormatNull() {
-		$this->exceptionTestForValue("package-format", null, 2005);
-	}
-	
-	public function testPackageIdInvalid() {
-		$this->exceptionTestForValue("package-id", "testing", 2007);
-	}
-	
-	public function testPackageIdNull() {
-		$this->exceptionTestForValue("package-id", null, 2007);
-	}
-	
-	public function testPackageUrlInvalid() {
-		$this->exceptionTestForValue("package-url", "testing", 2008);
-	}
-	
-	public function testPackageUrlInvalid2() {
-		$this->exceptionTestForValue("package-url", "http://myurl.com/mypackage", 2008);
-	}
-	
-	public function testPackageUrlNull() {
-		$this->exceptionTestForValue("package-url", null, 2008);
-	}
-	
-	public function testPackageUrlExpiryNull() {
-		$this->exceptionTestForValue("package-url-expiry", null, 2009);
-	}
-	
-	public function testPackageUrlExpiryInvalid() {
-		$this->exceptionTestForValue("package-url-expiry", "testing", 2009);
-	}
-	
-	public function testClientNull() {
-		$this->exceptionTestForValue("client", null, 2010);
-	}
-	
-	public function testReceiptNull() {
-		$this->exceptionTestForValue("receipt", null, 2011);
-	}
-	
-	public function testReceiptInvalid() {
-		$this->exceptionTestForValue("receipt", "testing", 2011);
-	}
-	
-	public function testAlertsInvalid() {
-		$this->exceptionTestForValue("alerts", "testing", 1201);
-	}
-	
-	public function testReceiptValid() {
-		try {
-			$myargs = $this->args;
-			$myargs["receipt"] = "mailto:name@domain.com,name2@domain.com";
-			$object = $this->createObject($myargs);
-			$this->pass();
-		} catch(PENSException $e) {
-			$this->fail();
-		}
-	}
-	
-	public function testValid() {
-		try {
-			$object = $this->createObject($this->args);
-			$this->assertIsA($object, "PENSRequestCollect");
-			$this->assertEqual($object->getPensVersion(), "1.0.0");
-			$this->assertEqual($object->getPackageType(), "aicc-pkg");
-			$this->assertEqual($object->getPackageTypeVersion(), "1.0");
-			$this->assertEqual($object->getPackageFormat(), "zip");
-			$this->assertEqual($object->getPackageId(), "http://myurl.com/12345");
-			$this->assertEqual($object->getPackageUrl(), "http://myurl.com/mypackage.zip");
-			$this->assertIsA($object->getPackageUrlExpiry(), "DateTime");
-			$this->assertEqual($object->getClient(), "Authorware7");
-			$this->assertEqual($object->getReceipt(), "mailto:name@domain.com");
-			$this->assertEqual($object->getPackageUrlUserId(), "guillaumev");
-			$this->assertEqual($object->getPackageUrlAccount(), "toto");
-			$this->assertEqual($object->getPackageUrlPassword(), "12345");
-			$this->assertEqual($object->getSystemUserId(), "guillaumev");
-			$this->assertEqual($object->getSystemPassword(), "12345");
-			$this->assertEqual($object->getAlerts(), "http://myurl.com/alerts");
-			$this->assertEqual($object->getVendorData(), "here are my data");
+    /**
+     * Valid arguments to be used for tests
+     * 
+     * @var array
+     */
+    private $args = null;
+	
+    public function setUp() {
+        $this->args = array(
+            "pens-version" => "1.0.0",
+            "command" => "collect",
+            "package-type" => "aicc-pkg",
+            "package-type-version" => "1.0",
+            "package-format" => "zip",
+            "package-id" => "http://myurl.com/12345",
+            "package-url" => "http://myurl.com/mypackage.zip",
+            "package-url-expiry" => "2006-04-01T06:51:29Z",
+            "client" => "Authorware7",
+            "receipt" => "mailto:name@domain.com",
+            "package-url-user-id" => "guillaumev",
+            "package-url-account" => "toto",
+            "package-url-password" => "12345",
+            "system-user-id" => "guillaumev",
+            "system-password" => "12345",
+            "alerts" => "http://myurl.com/alerts",
+            "vendor-data" => "here are my data");
+    }
+	
+    public function createObject($myargs) {
+        return PENSRequestFactory::createPENSRequest($myargs);
+    }
+	
+    public function exceptionTestForValue($key, $value, $code) {
+        try {
+            $myargs = $this->args;
+            if($value === null) {
+                unset($myargs[$key]);
+            } else {
+                $myargs[$key] = $value;
+            }
+            $object = $this->createObject($myargs);
+            $this->fail();
+        } catch(PENSException $e) {
+            $this->assertEqual($e->getCode(), $code);
+        }
+    }
+	
+    public function testPensVersionInvalid() {
+        $this->exceptionTestForValue("pens-version", "0.8.0", 2001);
+    }
+	
+    public function testPensVersionNull() {
+        $this->exceptionTestForValue("pens-version", null, 2001);
+    }
+	
+	
+    public function testCommandInvalid() {
+        $this->exceptionTestForValue("command", "testing", 2002);
+    }
+	
+    public function testCommandNull() {
+        $this->exceptionTestForValue("command", null, 2002);
+    }
+	
+    public function testPackageTypeInvalid() {
+        $this->exceptionTestForValue("package-type", "testing", 2003);
+    }
+	
+    public function testPackageTypeNull() {
+        $this->exceptionTestForValue("package-type", null, 2003);
+    }
+	
+    public function testPackageTypeVersionNull() {
+        $this->exceptionTestForValue("package-type-version", null, 2004);
+    }
+	
+    public function testPackageFormatInvalid() {
+        $this->exceptionTestForValue("package-format", "testing", 2005);
+    }
+	
+    public function testPackageFormatNull() {
+        $this->exceptionTestForValue("package-format", null, 2005);
+    }
+	
+    public function testPackageIdInvalid() {
+        $this->exceptionTestForValue("package-id", "testing", 2007);
+    }
+	
+    public function testPackageIdNull() {
+        $this->exceptionTestForValue("package-id", null, 2007);
+    }
+	
+    public function testPackageUrlInvalid() {
+        $this->exceptionTestForValue("package-url", "testing", 2008);
+    }
+	
+    public function testPackageUrlInvalid2() {
+        $this->exceptionTestForValue("package-url", "http://myurl.com/mypackage", 2008);
+    }
+	
+    public function testPackageUrlNull() {
+        $this->exceptionTestForValue("package-url", null, 2008);
+    }
+	
+    public function testPackageUrlExpiryNull() {
+        $this->exceptionTestForValue("package-url-expiry", null, 2009);
+    }
+	
+    public function testPackageUrlExpiryInvalid() {
+        $this->exceptionTestForValue("package-url-expiry", "testing", 2009);
+    }
+	
+    public function testClientNull() {
+        $this->exceptionTestForValue("client", null, 2010);
+    }
+	
+    public function testReceiptNull() {
+        $this->exceptionTestForValue("receipt", null, 2011);
+    }
+	
+    public function testReceiptInvalid() {
+        $this->exceptionTestForValue("receipt", "testing", 2011);
+    }
+	
+    public function testAlertsInvalid() {
+        $this->exceptionTestForValue("alerts", "testing", 1201);
+    }
+	
+    public function testReceiptValid() {
+        try {
+            $myargs = $this->args;
+            $myargs["receipt"] = "mailto:name@domain.com,name2@domain.com";
+            $object = $this->createObject($myargs);
+            $this->pass();
+        } catch(PENSException $e) {
+            $this->fail();
+        }
+    }
+	
+    public function testValid() {
+        try {
+            $object = $this->createObject($this->args);
+            $this->assertIsA($object, "PENSRequestCollect");
+            $this->assertEqual($object->getPensVersion(), "1.0.0");
+            $this->assertEqual($object->getPackageType(), "aicc-pkg");
+            $this->assertEqual($object->getPackageTypeVersion(), "1.0");
+            $this->assertEqual($object->getPackageFormat(), "zip");
+            $this->assertEqual($object->getPackageId(), "http://myurl.com/12345");
+            $this->assertEqual($object->getPackageUrl(), "http://myurl.com/mypackage.zip");
+            $this->assertIsA($object->getPackageUrlExpiry(), "DateTime");
+            $this->assertEqual($object->getClient(), "Authorware7");
+            $this->assertEqual($object->getReceipt(), "mailto:name@domain.com");
+            $this->assertEqual($object->getPackageUrlUserId(), "guillaumev");
+            $this->assertEqual($object->getPackageUrlAccount(), "toto");
+            $this->assertEqual($object->getPackageUrlPassword(), "12345");
+            $this->assertEqual($object->getSystemUserId(), "guillaumev");
+            $this->assertEqual($object->getSystemPassword(), "12345");
+            $this->assertEqual($object->getAlerts(), "http://myurl.com/alerts");
+            $this->assertEqual($object->getVendorData(), "here are my data");
 			
-		} catch(PENSException $e) {
-			$this->fail();
-		}
-	}
+        } catch(PENSException $e) {
+            $this->fail();
+        }
+    }
 	
 	
 }

Spacing +4 added lines, -4 removed lines

@@ -79,14 +79,14 @@ 
 	public function exceptionTestForValue($key, $value, $code) {
 		try {
 			$myargs = $this->args;
-			if($value === null) {
+			if ($value === null) {
 				unset($myargs[$key]);
 			} else {
 				$myargs[$key] = $value;
 			}
 			$object = $this->createObject($myargs);
 			$this->fail();
-		} catch(PENSException $e) {
+		} catch (PENSException $e) {
 			$this->assertEqual($e->getCode(), $code);
 		}
 	}
@@ -178,7 +178,7 @@ 
 			$myargs["receipt"] = "mailto:name@domain.com,name2@domain.com";
 			$object = $this->createObject($myargs);
 			$this->pass();
-		} catch(PENSException $e) {
+		} catch (PENSException $e) {
 			$this->fail();
 		}
 	}
@@ -204,7 +204,7 @@ 
 			$this->assertEqual($object->getAlerts(), "http://myurl.com/alerts");
 			$this->assertEqual($object->getVendorData(), "here are my data");
 			
-		} catch(PENSException $e) {
+		} catch (PENSException $e) {
 			$this->fail();
 		}
 	}

plugin/search_course/lib/register_course_widget.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -57,7 +57,7 @@ 
     /**
      * Handle the subscribe action.
      *
-     * @return bool
+     * @return null|boolean
      */
     function action_subscribe_user()
     {
@@ -151,7 +151,7 @@ 
 
     /**
      *
-     * @param type $course_code
+     * @param string $course_code
      * @return type
      */
     function retrieve_course($course_code)

plugin/search_course/lib/search_course_widget.class.php

Doc Comments +8 added lines

@@ -40,11 +40,19 @@
         return isset($_GET[$key]) ? $_GET[$key] : $default;
     }
 
+    /**
+     * @param string $key
+     *
+     * @return string
+     */
     public static function server($key, $default = '')
     {
         return isset($_SERVER[$key]) ? $_SERVER[$key] : $default;
     }
 
+    /**
+     * @param string $name
+     */
     public static function get_lang($name)
     {
         return SearchCoursePlugin::create()->get_lang($name);

Spacing +13 added lines, -13 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-require_once dirname(__FILE__) . '/register_course_widget.class.php';
+require_once dirname(__FILE__).'/register_course_widget.class.php';
 
 /**
  * Search course widget.
@@ -60,12 +60,12 @@ 
         $url = self::server('REQUEST_URI');
         $url = explode('?', $url);
         $url = reset($url);
-        $url = self::server('SERVER_NAME') . $url;
+        $url = self::server('SERVER_NAME').$url;
 
         $root = api_get_path('WEB_PATH');
         $root = str_replace('https://', '', $root);
         $root = str_replace('http://', '', $root);
-        $index_url = $root . 'index.php';
+        $index_url = $root.'index.php';
 
         return $url == $index_url || $url == $root;
     }
@@ -80,12 +80,12 @@ 
         $url = self::server('REQUEST_URI');
         $url = explode('?', $url);
         $url = reset($url);
-        $url = self::server('SERVER_NAME') . $url;
+        $url = self::server('SERVER_NAME').$url;
 
         $root = api_get_path('WEB_PATH');
         $root = str_replace('https://', '', $root);
         $root = str_replace('http://', '', $root);
-        $index_url = $root . 'user_portal.php';
+        $index_url = $root.'user_portal.php';
 
         return $url == $index_url || $url == $root;
     }
@@ -153,8 +153,8 @@ 
             $parameters[self::PARAM_ACTION] = $action;
         }
         $parameters = implode('&', $parameters);
-        $parameters = $parameters ? '?' . $parameters : '';
-        return $self . $parameters;
+        $parameters = $parameters ? '?'.$parameters : '';
+        return $self.$parameters;
     }
 
     /**
@@ -241,8 +241,8 @@ 
             $details = implode(' - ', $details);
             $title = $course['title'];
 
-            $href = api_get_path(WEB_COURSE_PATH).$course['code'] .'/index.php';
-            echo '<tr><td><b><a href="' . $href . '">' . "$title</a></b><br/>$details</td><td>";
+            $href = api_get_path(WEB_COURSE_PATH).$course['code'].'/index.php';
+            echo '<tr><td><b><a href="'.$href.'">'."$title</a></b><br/>$details</td><td>";
             if (!api_is_anonymous()) {
                 if ($course['registration_code']) {
                     Display::display_icon(
@@ -336,13 +336,13 @@ 
 
         if (api_is_anonymous())
         {
-            $course_fiter = 'visibility = ' . COURSE_VISIBILITY_OPEN_WORLD;
+            $course_fiter = 'visibility = '.COURSE_VISIBILITY_OPEN_WORLD;
         }
         else
         {
-            $course_fiter = 'visibility = ' . COURSE_VISIBILITY_OPEN_WORLD . ' OR ';
-            $course_fiter .= 'visibility = ' . COURSE_VISIBILITY_OPEN_PLATFORM . ' OR ';
-            $course_fiter .= '(visibility = ' . COURSE_VISIBILITY_REGISTERED . ' AND subscribe = 1)';
+            $course_fiter = 'visibility = '.COURSE_VISIBILITY_OPEN_WORLD.' OR ';
+            $course_fiter .= 'visibility = '.COURSE_VISIBILITY_OPEN_PLATFORM.' OR ';
+            $course_fiter .= '(visibility = '.COURSE_VISIBILITY_REGISTERED.' AND subscribe = 1)';
         }
 
         $sql = <<<EOT

Braces +3 added lines, -6 removed lines

@@ -123,8 +123,7 @@ 
         if ($has_content)
         {
             echo '<div class="list">';
-        }
-        else
+        } else
         {
             echo '<div>';
         }
@@ -132,8 +131,7 @@ 
         if (RegisterCourseWidget::factory()->run())
         {
             $result = true;
-        }
-        else
+        } else
         {
             $result = $this->action_display();
         }
@@ -337,8 +335,7 @@ 
         if (api_is_anonymous())
         {
             $course_fiter = 'visibility = ' . COURSE_VISIBILITY_OPEN_WORLD;
-        }
-        else
+        } else
         {
             $course_fiter = 'visibility = ' . COURSE_VISIBILITY_OPEN_WORLD . ' OR ';
             $course_fiter .= 'visibility = ' . COURSE_VISIBILITY_OPEN_PLATFORM . ' OR ';

plugin/ticket/src/ticket.class.php

Doc Comments +9 added lines, -9 removed lines

@@ -57,7 +57,7 @@ 
      * @param $category_id
      * @param $course_id
      * @param $project_id
-     * @param $other_area
+     * @param integer $other_area
      * @param $email
      * @param $subject
      * @param $content
@@ -240,8 +240,8 @@ 
 
     /**
      * Assign ticket to admin
-     * @param $ticket_id
-     * @param $user_id
+     * @param string $ticket_id
+     * @param integer $user_id
      */
     public static function assign_ticket_user($ticket_id, $user_id)
     {
@@ -294,9 +294,9 @@ 
 
     /**
      * Insert message between Users and Admins
-     * @param $ticket_id
-     * @param $subject
-     * @param $content
+     * @param string $ticket_id
+     * @param string $subject
+     * @param string $content
      * @param $file_attachments
      * @param $user_id
      * @param string $status
@@ -402,9 +402,9 @@ 
     /**
      * Attachment files when a message is sent
      * @param $file_attach
-     * @param $ticket_id
-     * @param $message_id
-     * @param $message_attch_id
+     * @param integer $ticket_id
+     * @param integer $message_id
+     * @param integer $message_attch_id
      * @return array
      */
     public static function save_message_attachment_file(

Spacing +60 added lines, -60 removed lines

@@ -42,7 +42,7 @@ 
     public static function get_all_tickets_status()
     {
         $table_support_status = Database::get_main_table(TABLE_TICKET_STATUS);
-        $sql = "SELECT * FROM " . $table_support_status;
+        $sql = "SELECT * FROM ".$table_support_status;
         $result = Database::query($sql);
         $types = array();
         while ($row = Database::fetch_assoc($result)) {
@@ -157,7 +157,7 @@ 
         }
 
         if ($ticket_id != 0) {
-            $ticket_code = "A" . str_pad(
+            $ticket_code = "A".str_pad(
                 (int) $ticket_id, 11, "0", STR_PAD_LEFT
             );
             $sql_update_code = "UPDATE $table_support_tickets
@@ -175,24 +175,24 @@ 
                     $user = api_get_user_info($request_user);
                     $helpDeskMessage = '<table>
                                             <tr>
-                                                <td width="100px"><b>' . get_lang('User') . '</b></td>
-                                                <td width="400px">' . $user['firstname']. ' ' . $user['lastname'] . '</td>
+                                                <td width="100px"><b>' . get_lang('User').'</b></td>
+                                                <td width="400px">' . $user['firstname'].' '.$user['lastname'].'</td>
                                             </tr>
                                             <tr>
-                                                <td width="100px"><b>' . get_lang('Username') . '</b></td>
-                                                <td width="400px">' . $user['username'] . '</td>
+                                                <td width="100px"><b>' . get_lang('Username').'</b></td>
+                                                <td width="400px">' . $user['username'].'</td>
                                             </tr>
                                             <tr>
-                                                <td width="100px"><b>' . get_lang('Date') . '</b></td>
-                                                <td width="400px">' . api_convert_and_format_date($now, DATE_TIME_FORMAT_LONG) . '</td>
+                                                <td width="100px"><b>' . get_lang('Date').'</b></td>
+                                                <td width="400px">' . api_convert_and_format_date($now, DATE_TIME_FORMAT_LONG).'</td>
                                             </tr>
                                             <tr>
-                                                <td width="100px"><b>' . get_lang('Topic') . '</b></td>
-                                                <td width="400px">' . $subject . '</td>
+                                                <td width="100px"><b>' . get_lang('Topic').'</b></td>
+                                                <td width="400px">' . $subject.'</td>
                                             </tr>
                                             <tr>
-                                                <td width="100px"><b>' . get_lang('Description') . '</b></td>
-                                                <td width="400px">' . $content . '</td>
+                                                <td width="100px"><b>' . get_lang('Description').'</b></td>
+                                                <td width="400px">' . $content.'</td>
                                             </tr>
                                         </table>';
 
@@ -274,7 +274,7 @@ 
             if ($insert_id != $user_id) {
                 $info = api_get_user_info($user_id);
                 $sender = api_get_user_info($insert_id);
-                $href = api_get_path(WEB_PLUGIN_PATH) . PLUGIN_NAME . '/src/ticket_details.php?ticket_id=' . $ticket_id;
+                $href = api_get_path(WEB_PLUGIN_PATH).PLUGIN_NAME.'/src/ticket_details.php?ticket_id='.$ticket_id;
                 $message = sprintf($plugin->get_lang('TicketAssignedMsg'), $info['complete_name'], $href, $ticket_id);
                 $mailTitle = sprintf($plugin->get_lang('TicketAssignX'), $ticket_id);
                 api_mail_html(
@@ -319,10 +319,10 @@ 
         $table_support_tickets = Database::get_main_table(TABLE_TICKET_TICKET);
         $table_support_message_attachments = Database::get_main_table(TABLE_TICKET_MESSAGE_ATTACHMENTS);
         if ($sendConfirmation) {
-            $form = '<form action="ticket_details.php?ticket_id=' . $ticket_id . '" id="confirmticket" method="POST" >
-                         <p>' . $plugin->get_lang('TicketWasThisAnswerSatisfying') . '</p>
-                         <button name="response" id="responseyes" value="1">' . get_lang('Yes') . '</button>
-                         <button name="response" id="responseno" value="0">' . get_lang('No') . '</button>
+            $form = '<form action="ticket_details.php?ticket_id='.$ticket_id.'" id="confirmticket" method="POST" >
+                         <p>' . $plugin->get_lang('TicketWasThisAnswerSatisfying').'</p>
+                         <button name="response" id="responseyes" value="1">' . get_lang('Yes').'</button>
+                         <button name="response" id="responseno" value="0">' . get_lang('No').'</button>
                      </form>';
             $content .= $form;
             Database::query(
@@ -353,11 +353,11 @@ 
             '$message_id',
             '$subject',
             '$content',
-            '" . Database::escape_string($_SERVER['REMOTE_ADDR']) . "',
+            '".Database::escape_string($_SERVER['REMOTE_ADDR'])."',
             '$user_id',
-            '" . $now . "',
+            '".$now."',
             '$user_id',
-            '" . $now . "',
+            '".$now."',
             '$status'
         )";
         Database::query($sql_insert_message);
@@ -428,11 +428,11 @@ 
         } else {
             $new_file_name = uniqid('');
             $path_attachment = api_get_path(SYS_ARCHIVE_PATH);
-            $path_message_attach = $path_attachment . 'plugin_ticket_messageattch/';
+            $path_message_attach = $path_attachment.'plugin_ticket_messageattch/';
             if (!file_exists($path_message_attach)) {
                 @mkdir($path_message_attach, api_get_permissions_for_new_directories(), true);
             }
-            $new_path = $path_message_attach . $new_file_name;
+            $new_path = $path_message_attach.$new_file_name;
             if (is_uploaded_file($file_attach['tmp_name'])) {
                 @copy($file_attach['tmp_name'], $new_path);
             }
@@ -455,7 +455,7 @@ 
                     '$ticket_id',
                     '$message_id',
                     '$message_attch_id',
-                    '" . $file_attach['size'] . "',
+                    '".$file_attach['size']."',
                     '$user_id',
                     '$now',
                     '$user_id',
@@ -464,7 +464,7 @@ 
             Database::query($sql);
 
             return array(
-                'path' => $path_message_attach . $safe_new_file_name,
+                'path' => $path_message_attach.$safe_new_file_name,
                 'filename' => $safe_file_name
             );
         }
@@ -689,14 +689,14 @@ 
             $result_unread = Database::query($sql_unread);
             $unread = Database::fetch_object($result_unread)->unread;
             $userInfo = api_get_user_info($row['user_id']);
-            $hrefUser = $webPath . 'main/admin/user_information.php?user_id=' . $row['user_id'];
+            $hrefUser = $webPath.'main/admin/user_information.php?user_id='.$row['user_id'];
             $name = "<a href='$hrefUser'> {$userInfo['username']} </a>";
             $actions = "";
 
             if ($row['responsible'] != 0) {
                 $row['responsible'] = api_get_user_info($row['responsible']);
                 if (!empty($row['responsible'])) {
-                    $hrefResp = $webPath . 'main/admin/user_information.php?user_id=' . $row['responsible']['user_id'];
+                    $hrefResp = $webPath.'main/admin/user_information.php?user_id='.$row['responsible']['user_id'];
                     $row['responsible'] = "<a href='$hrefResp'> {$row['responsible']['username']} </a>";
                 } else {
                     $row['responsible'] = get_lang('UnknownUser');
@@ -704,9 +704,9 @@ 
 
             } else {
                 if ($row['status_id'] != 'REE') {
-                    $row['responsible'] = '<span style="color:#ff0000;">' . $plugin->get_lang('ToBeAssigned') . '</span>';
+                    $row['responsible'] = '<span style="color:#ff0000;">'.$plugin->get_lang('ToBeAssigned').'</span>';
                 } else {
-                    $row['responsible'] = '<span style="color:#00ff00;">' . get_lang('MessageResent') . '</span>';
+                    $row['responsible'] = '<span style="color:#00ff00;">'.get_lang('MessageResent').'</span>';
                 }
             }
 
@@ -727,17 +727,17 @@ 
             $row['col1'] = api_get_local_time($row['col1']);
             $row['col2'] = api_get_local_time($row['col2']);
             if ($isAdmin) {
-                $actions .= '<a href="ticket_details.php?ticket_id=' . $row['col0'] . '">' . Display::return_icon(
+                $actions .= '<a href="ticket_details.php?ticket_id='.$row['col0'].'">'.Display::return_icon(
                                 'synthese_view.gif', get_lang('Info')
-                        ) . '</a>&nbsp;&nbsp;';
+                        ).'</a>&nbsp;&nbsp;';
                 if ($row['priority_id'] == 'HGH' && $row['status_id'] != 'CLS') {
-                    $actions .= '<img src="' . $webCodePath . 'img/exclamation.png" border="0" />';
+                    $actions .= '<img src="'.$webCodePath.'img/exclamation.png" border="0" />';
                 }
                 $row['col0'] = Display::return_icon(
                                 $img_source, get_lang('Info')
-                        ) . '<a href="ticket_details.php?ticket_id=' . $row['col0'] . '">' . $row['ticket_code'] . '</a>';
+                        ).'<a href="ticket_details.php?ticket_id='.$row['col0'].'">'.$row['ticket_code'].'</a>';
                 if ($row['col7'] == 'PENDIENTE') {
-                    $row['col7'] = '<span style="color: #f00; font-weight:bold;">' . $row['col7'] . '</span>';
+                    $row['col7'] = '<span style="color: #f00; font-weight:bold;">'.$row['col7'].'</span>';
                 }
 
                 $ticket = array(
@@ -754,22 +754,22 @@ 
                 );
             } else {
                 $actions = "";
-                $actions .= '<a href="ticket_details.php?ticket_id=' . $row['col0'] . '">' . Display::return_icon(
+                $actions .= '<a href="ticket_details.php?ticket_id='.$row['col0'].'">'.Display::return_icon(
                                 'synthese_view.gif', get_lang('Info')
-                        ) . '</a>&nbsp;&nbsp;';
+                        ).'</a>&nbsp;&nbsp;';
                 $row['col0'] = Display::return_icon(
                                 $img_source, get_lang('Info')
-                        ) . '<a href="ticket_details.php?ticket_id=' . $row['col0'] . '">' . $row['ticket_code'] . '</a>';
+                        ).'<a href="ticket_details.php?ticket_id='.$row['col0'].'">'.$row['ticket_code'].'</a>';
                 $now = api_strtotime(api_get_utc_datetime());
                 $last_edit_date = api_strtotime($row['sys_lastedit_datetime']);
                 $dif = $now - $last_edit_date;
 
                 if ($dif > 172800 && $row['priority_id'] == 'NRM' && $row['status_id'] != 'CLS') {
-                    $actions .= '<a href="myticket.php?ticket_id=' . $row['ticket_id'] . '&amp;action=alert">
-                                 <img src="' . Display::returnIconPath('exclamation.png') . '" border="0" /></a>';
+                    $actions .= '<a href="myticket.php?ticket_id='.$row['ticket_id'].'&amp;action=alert">
+                                 <img src="' . Display::returnIconPath('exclamation.png').'" border="0" /></a>';
                 }
                 if ($row['priority_id'] == 'HGH') {
-                    $actions .= '<img src="' . Display::returnIconPath('admin_star.png') . '" border="0" />';
+                    $actions .= '<img src="'.Display::returnIconPath('admin_star.png').'" border="0" />';
                 }
                 $ticket = array(
                     $row['col0'],
@@ -781,14 +781,14 @@ 
                 );
             }
             if ($unread > 0) {
-                $ticket['0'] = $ticket['0'] . '&nbsp;&nbsp;(' . $unread . ')<a href="ticket_details.php?ticket_id=' . $row['ticket_id'] . '">
-                                <img src="' . Display::returnIconPath('message_new.png') . '" border="0" title="' . $unread . ' ' . get_lang('Messages') . '"/>
+                $ticket['0'] = $ticket['0'].'&nbsp;&nbsp;('.$unread.')<a href="ticket_details.php?ticket_id='.$row['ticket_id'].'">
+                                <img src="' . Display::returnIconPath('message_new.png').'" border="0" title="'.$unread.' '.get_lang('Messages').'"/>
                                 </a>';
             }
             if ($isAdmin) {
-                $ticket['0'] .= '&nbsp;&nbsp;<a  href="javascript:void(0)" onclick="load_history_ticket(\'div_' . $row['ticket_id'] . '\',' . $row['ticket_id'] . ')">
-					<img onclick="load_course_list(\'div_' . $row['ticket_id'] . '\',' . $row['ticket_id'] . ')" onmouseover="clear_course_list (\'div_' . $row['ticket_id'] . '\')" src="' . Display::returnIconPath('history.gif') . '" title="' . get_lang('Historial') . '" alt="' . get_lang('Historial') . '"/>
-					<div class="blackboard_hide" id="div_' . $row['ticket_id'] . '">&nbsp;&nbsp;</div>
+                $ticket['0'] .= '&nbsp;&nbsp;<a  href="javascript:void(0)" onclick="load_history_ticket(\'div_'.$row['ticket_id'].'\','.$row['ticket_id'].')">
+					<img onclick="load_course_list(\'div_' . $row['ticket_id'].'\','.$row['ticket_id'].')" onmouseover="clear_course_list (\'div_'.$row['ticket_id'].'\')" src="'.Display::returnIconPath('history.gif').'" title="'.get_lang('Historial').'" alt="'.get_lang('Historial').'"/>
+					<div class="blackboard_hide" id="div_' . $row['ticket_id'].'">&nbsp;&nbsp;</div>
 					</a>&nbsp;&nbsp;';
             }
             $tickets[] = $ticket;
@@ -1026,8 +1026,8 @@ 
                     }
                 }
                 $userInfo = api_get_user_info($row['request_user']);
-                $row['user_url'] = '<a href="' . api_get_path(WEB_PATH) . 'main/admin/user_information.php?user_id=' . $row['request_user'] . '">
-                ' . api_get_person_name($userInfo['firstname'], $userInfo['lastname']) . '</a>';
+                $row['user_url'] = '<a href="'.api_get_path(WEB_PATH).'main/admin/user_information.php?user_id='.$row['request_user'].'">
+                ' . api_get_person_name($userInfo['firstname'], $userInfo['lastname']).'</a>';
                 $ticket['usuario'] = $userInfo;
                 $ticket['ticket'] = $row;
             }
@@ -1044,10 +1044,10 @@ 
             while ($row = Database::fetch_assoc($result)) {
                 $message = $row;
                 $completeName = api_get_person_name($row['firstname'], $row['lastname']);
-                $href = $webPath . 'main/admin/user_information.php?user_id=' . $row['user_id'];
+                $href = $webPath.'main/admin/user_information.php?user_id='.$row['user_id'];
                 //Check if user is an admin
                 $sql_admin = "SELECT user_id FROM $admin_table
-		              WHERE user_id = '" . intval($message['user_id']) . "'
+		              WHERE user_id = '".intval($message['user_id'])."'
                               LIMIT 1";
                 $result_admin = Database::query($sql_admin);
                 $message['admin'] = false;
@@ -1059,12 +1059,12 @@ 
                 $sql = "SELECT *
                         FROM $table_support_message_attachments
                         WHERE
-                            message_id = " . $row['message_id'] . " AND
+                            message_id = ".$row['message_id']." AND
                             ticket_id= '$ticket_id'  ";
                 $result_attach = Database::query($sql);
                 while ($row2 = Database::fetch_assoc($result_attach)) {
-                    $archiveURL = $archiveURL = $webPath . "plugin/" . PLUGIN_NAME . '/src/download.php?ticket_id=' . $ticket_id . '&file=';
-                    $row2['attachment_link'] = $attach_icon . '&nbsp;<a href="' . $archiveURL . $row2['path'] . '&title=' . $row2['filename'] . '">' . $row2['filename'] . '</a>&nbsp;(' . $row2['size'] . ')';
+                    $archiveURL = $archiveURL = $webPath."plugin/".PLUGIN_NAME.'/src/download.php?ticket_id='.$ticket_id.'&file=';
+                    $row2['attachment_link'] = $attach_icon.'&nbsp;<a href="'.$archiveURL.$row2['path'].'&title='.$row2['filename'].'">'.$row2['filename'].'</a>&nbsp;('.$row2['size'].')';
                     $message['atachments'][] = $row2;
                 }
                 $ticket['messages'][] = $message;
@@ -1088,9 +1088,9 @@ 
         );
         $table_support_tickets = Database::get_main_table(TABLE_TICKET_TICKET);
         $now = api_get_utc_datetime();
-        $sql = "UPDATE " . $table_support_messages . "
-                SET status = 'LEI', sys_lastedit_user_id ='" . api_get_user_id() . "',
-                sys_lastedit_datetime ='" . $now . "'
+        $sql = "UPDATE ".$table_support_messages."
+                SET status = 'LEI', sys_lastedit_user_id ='" . api_get_user_id()."',
+                sys_lastedit_datetime ='" . $now."'
                 WHERE ticket_id ='$ticket_id' ";
 
         if (api_is_platform_admin()) {
@@ -1189,10 +1189,10 @@ 
         $user_id = intval($user_id);
 
         $now = api_get_utc_datetime();
-        $sql = "UPDATE " . $table_support_tickets . " SET
+        $sql = "UPDATE ".$table_support_tickets." SET
                 status_id = '$status_id',
                 sys_lastedit_user_id ='$user_id',
-                sys_lastedit_datetime ='" . $now . "'
+                sys_lastedit_datetime ='".$now."'
                 WHERE ticket_id ='$ticket_id'";
         $result = Database::query($sql);
 
@@ -1277,7 +1277,7 @@ 
         $sql = "UPDATE $table_support_tickets SET
                     status_id = 'CLS',
                     sys_lastedit_user_id ='$user_id',
-                    sys_lastedit_datetime ='" . $now . "',
+                    sys_lastedit_datetime ='".$now."',
                     end_date ='$now'
                 WHERE ticket_id ='$ticket_id'";
         Database::query($sql);
@@ -1334,8 +1334,8 @@ 
             $row['assigned_date'] = api_convert_and_format_date(
                 api_get_local_time($row['assigned_date']), '%d/%m/%y-%H:%M:%S', _api_get_timezone()
             );
-            $row['assignuser'] = ($row['user_id'] != 0) ? ('<a href="' . $webpath . 'main/admin/user_information.php?user_id=' . $row['user_id'] . '"  target="_blank">' . $assignuser['username'] . '</a>') : get_lang('Unassign');
-            $row['insertuser'] = '<a href="' . $webpath . 'main/admin/user_information.php?user_id=' . $row['sys_insert_user_id'] . '"  target="_blank">' . $insertuser['username'] . '</a>';
+            $row['assignuser'] = ($row['user_id'] != 0) ? ('<a href="'.$webpath.'main/admin/user_information.php?user_id='.$row['user_id'].'"  target="_blank">'.$assignuser['username'].'</a>') : get_lang('Unassign');
+            $row['insertuser'] = '<a href="'.$webpath.'main/admin/user_information.php?user_id='.$row['sys_insert_user_id'].'"  target="_blank">'.$insertuser['username'].'</a>';
             $history[] = $row;
         }
         return $history;
@@ -1531,7 +1531,7 @@ 
         while ($row = Database::fetch_assoc($result)) {
             if ($row['responsable'] != 0) {
                 $row['responsable'] = api_get_user_info($row['responsable']);
-                $row['responsable'] = $row['responsable']['firstname'] . ' ' . $row['responsable']['lastname'];
+                $row['responsable'] = $row['responsable']['firstname'].' '.$row['responsable']['lastname'];
             }
             $row['sys_insert_datetime'] = api_format_date(
                     $row['sys_insert_datetime'], '%d/%m/%y - %I:%M:%S %p'

plugin/ticket/src/ticket_plugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
     /**
      * Set the result
      * @staticvar null $result
-     * @return type
+     * @return TicketPlugin
      */
     static function create()
     {

Spacing +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
     public function install()
     {
         // Create database tables and insert a Tab
-        require_once api_get_path(SYS_PLUGIN_PATH) . PLUGIN_NAME . '/database.php';
+        require_once api_get_path(SYS_PLUGIN_PATH).PLUGIN_NAME.'/database.php';
 
     }
 
@@ -84,7 +84,7 @@ 
         $rsTab = $this->deleteTab($plugSetting['comment']);
 
         if ($rsTab) {
-            echo "<script>location.href = '" . $_SERVER['REQUEST_URI'] . "';</script>";
+            echo "<script>location.href = '".$_SERVER['REQUEST_URI']."';</script>";
         }
     }
 }