chamilo / chamilo-lms

plugin/kannelsms/vendor/kannelsms_api.php

Doc Comments +5 added lines, -1 removed lines

@@ -138,6 +138,7 @@ 
   *
   * @param   string  key         Your Kannel API Key
   * @param   array   options     Optional parameters for sending SMS
+  * @param string $key
   * @author  Martin Steel
   */
   public function __construct($key, array $options = array()) {
@@ -471,6 +472,8 @@ 
   *
   * @param   string   method Kannel method to call (sms/credit)
   * @param   string   data   Content of HTTP POST
+  * @param string $method
+  * @param string $data
   *
   * @return  string          Response from Kannel
   * @author  Martin Steel
@@ -505,6 +508,7 @@ 
   *
   * @param   string url      URL to send to
   * @param   string data     Data to POST
+  * @param string $url
   * @return  string          Response returned by server
   * @author  Martin Steel
   */
@@ -631,7 +635,7 @@ 
    * Check if a number is a valid MSISDN
    *
    * @param string $val Value to check
-   * @return bool True if valid MSISDN
+   * @return integer True if valid MSISDN
    * @author James Inman
    * @since 1.3.0
    * @todo Take an optional country code and check that the number starts with it

Indentation +334 added lines, -334 removed lines

@@ -10,7 +10,7 @@ 
 */
 
 if ( !class_exists('KannelException') ) {
-  require_once('exception.php');
+    require_once('exception.php');
 }
 
 /**
@@ -21,130 +21,130 @@ 
 */
 class Kannel {
 
-  /*
+    /*
   * Version of this class
   */
-  const VERSION           = '1.3.1';
-
-  /**
-  * All Kannel API calls start with BASE_URL
-  * @author  Martin Steel
-  */
-  const API_BASE_URL      = 'api.kannelsms.com/xml/';
-
-  /**
-  * string to append to API_BASE_URL to check authentication
-  * @author  Martin Steel
-  */
-  const API_AUTH_METHOD   = 'authenticate';
-
-  /**
-  * string to append to API_BASE_URL for sending SMS
-  * @author  Martin Steel
-  */
-  const API_SMS_METHOD    = 'sms';
-
-  /**
-  * string to append to API_BASE_URL for checking message credit
-  * @author  Martin Steel
-  */
-  const API_CREDIT_METHOD = 'credit';
-
-  /**
-  * string to append to API_BASE_URL for checking account balance
-  * @author  Martin Steel
-  */
-  const API_BALANCE_METHOD = 'balance';
-
-  /** 
-  * Kannel API Key
-  * 
-  * @var string
-  * @author  Martin Steel
-  */
-  public $key;
-
-  /**
-  * Use SSL when making HTTP requests
-  *
-  * If this is not set, SSL will be used where PHP supports it
-  *
-  * @var bool
-  * @author  Martin Steel
-  */
-  public $ssl;
-
-  /**
-  * Proxy server hostname (Optional)
-  *
-  * @var string
-  * @author  Martin Steel
-  */
-  public $proxy_host;
-
-  /**
-  * Proxy server port (Optional)
-  *
-  * @var integer
-  * @author  Martin Steel
-  */
-  public $proxy_port;
-
-  /**
-  * From address used on text messages
-  *
-  * @var string (11 characters or 12 numbers)
-  * @author  Martin Steel
-  */
-  public $from;
-
-  /**
-  * Allow long SMS messages (Cost up to 3 credits)
-  *
-  * @var bool
-  * @author  Martin Steel
-  */
-  public $long;
-
-  /**
-  * Truncate message text if it is too long
-  *
-  * @var bool
-  * @author  Martin Steel
-  */
-  public $truncate;
-
-  /**
-  * Enables various logging of messages when true.
-  *
-  * @var bool
-  * @author  Martin Steel
-  */
-  public $log;
-
-  /**
-  * What Kannel should do if you send an invalid character
-  *
-  * Possible values:
-  *      'error'     - Return an error (Messasge is not sent)
-  *      'remove'    - Remove the invalid character(s)
-  *      'replace'   - Replace invalid characters where possible, remove others 
-  * @author  Martin Steel
-  */
-  public $invalid_char_action;
-
-  /**
-  * Create a new instance of the Kannel wrapper
-  *
-  * @param   string  key         Your Kannel API Key
-  * @param   array   options     Optional parameters for sending SMS
-  * @author  Martin Steel
-  */
-  public function __construct($key, array $options = array()) {
+    const VERSION           = '1.3.1';
+
+    /**
+     * All Kannel API calls start with BASE_URL
+     * @author  Martin Steel
+     */
+    const API_BASE_URL      = 'api.kannelsms.com/xml/';
+
+    /**
+     * string to append to API_BASE_URL to check authentication
+     * @author  Martin Steel
+     */
+    const API_AUTH_METHOD   = 'authenticate';
+
+    /**
+     * string to append to API_BASE_URL for sending SMS
+     * @author  Martin Steel
+     */
+    const API_SMS_METHOD    = 'sms';
+
+    /**
+     * string to append to API_BASE_URL for checking message credit
+     * @author  Martin Steel
+     */
+    const API_CREDIT_METHOD = 'credit';
+
+    /**
+     * string to append to API_BASE_URL for checking account balance
+     * @author  Martin Steel
+     */
+    const API_BALANCE_METHOD = 'balance';
+
+    /** 
+     * Kannel API Key
+     * 
+     * @var string
+     * @author  Martin Steel
+     */
+    public $key;
+
+    /**
+     * Use SSL when making HTTP requests
+     *
+     * If this is not set, SSL will be used where PHP supports it
+     *
+     * @var bool
+     * @author  Martin Steel
+     */
+    public $ssl;
+
+    /**
+     * Proxy server hostname (Optional)
+     *
+     * @var string
+     * @author  Martin Steel
+     */
+    public $proxy_host;
+
+    /**
+     * Proxy server port (Optional)
+     *
+     * @var integer
+     * @author  Martin Steel
+     */
+    public $proxy_port;
+
+    /**
+     * From address used on text messages
+     *
+     * @var string (11 characters or 12 numbers)
+     * @author  Martin Steel
+     */
+    public $from;
+
+    /**
+     * Allow long SMS messages (Cost up to 3 credits)
+     *
+     * @var bool
+     * @author  Martin Steel
+     */
+    public $long;
+
+    /**
+     * Truncate message text if it is too long
+     *
+     * @var bool
+     * @author  Martin Steel
+     */
+    public $truncate;
+
+    /**
+     * Enables various logging of messages when true.
+     *
+     * @var bool
+     * @author  Martin Steel
+     */
+    public $log;
+
+    /**
+     * What Kannel should do if you send an invalid character
+     *
+     * Possible values:
+     *      'error'     - Return an error (Messasge is not sent)
+     *      'remove'    - Remove the invalid character(s)
+     *      'replace'   - Replace invalid characters where possible, remove others 
+     * @author  Martin Steel
+     */
+    public $invalid_char_action;
+
+    /**
+     * Create a new instance of the Kannel wrapper
+     *
+     * @param   string  key         Your Kannel API Key
+     * @param   array   options     Optional parameters for sending SMS
+     * @author  Martin Steel
+     */
+    public function __construct($key, array $options = array()) {
     if (empty($key)) {
-      throw new KannelException("Key can't be blank");
+        throw new KannelException("Key can't be blank");
     } else {
-      $this->key = $key;
+        $this->key = $key;
     }
         
     $this->ssl                  = (array_key_exists('ssl', $options)) ? $options['ssl'] : null;
@@ -155,22 +155,22 @@ 
     $this->truncate             = (array_key_exists('truncate', $options)) ? $options['truncate'] : null;
     $this->invalid_char_action  = (array_key_exists('invalid_char_action', $options)) ? $options['invalid_char_action'] : null;
     $this->log                  = (array_key_exists('log', $options)) ? $options['log'] : false;
-  }
+    }
 
-  /**
-  * Send some text messages
-  * 
-  *
-  * @author  Martin Steel
-  */
-  public function send(array $sms) {
+    /**
+     * Send some text messages
+     * 
+     *
+     * @author  Martin Steel
+     */
+    public function send(array $sms) {
     if (!is_array($sms)) {
-      throw new KannelException("sms parameter must be an array");
+        throw new KannelException("sms parameter must be an array");
     }
     $single_message = $this->is_assoc($sms);
 
     if ($single_message) {
-      $sms = array($sms);
+        $sms = array($sms);
     }
 
     $req_doc = new \DOMDocument('1.0', 'UTF-8');
@@ -182,70 +182,70 @@ 
     $root->appendChild($user_node);
 
     for ($i = 0; $i < count($sms); $i++) {
-      $single = $sms[$i];
+        $single = $sms[$i];
 
-      $sms_node = $req_doc->createElement('SMS');
+        $sms_node = $req_doc->createElement('SMS');
            
-      // Phone number
-      $sms_node->appendChild($req_doc->createElement('To', $single['to'])); 
+        // Phone number
+        $sms_node->appendChild($req_doc->createElement('To', $single['to'])); 
             
-      // Message text
-      $content_node = $req_doc->createElement('Content');
-      $content_node->appendChild($req_doc->createTextNode($single['message']));
-      $sms_node->appendChild($content_node);
+        // Message text
+        $content_node = $req_doc->createElement('Content');
+        $content_node->appendChild($req_doc->createTextNode($single['message']));
+        $sms_node->appendChild($content_node);
 
-      // From
-      if (array_key_exists('from', $single) || isset($this->from)) {
+        // From
+        if (array_key_exists('from', $single) || isset($this->from)) {
         $from_node = $req_doc->createElement('From');
         $from_node->appendChild($req_doc->createTextNode(array_key_exists('from', $single) ? $single['from'] : $this->from));
         $sms_node->appendChild($from_node);
-      }
+        }
 
-      // Client ID
-      if (array_key_exists('client_id', $single)) {
+        // Client ID
+        if (array_key_exists('client_id', $single)) {
         $client_id_node = $req_doc->createElement('ClientID');
         $client_id_node->appendChild($req_doc->createTextNode($single['client_id']));
         $sms_node->appendChild($client_id_node);
-      }
+        }
 
-      // Long
-      if (array_key_exists('long', $single) || isset($this->long)) {
+        // Long
+        if (array_key_exists('long', $single) || isset($this->long)) {
         $long = array_key_exists('long', $single) ? $single['long'] : $this->long;
         $long_node = $req_doc->createElement('Long');
         $long_node->appendChild($req_doc->createTextNode($long ? 1 : 0));
         $sms_node->appendChild($long_node);
-      }
+        }
 
-      // Truncate
-      if (array_key_exists('truncate', $single) || isset($this->truncate)) {
+        // Truncate
+        if (array_key_exists('truncate', $single) || isset($this->truncate)) {
         $truncate = array_key_exists('truncate', $single) ? $single['truncate'] : $this->truncate;
         $trunc_node = $req_doc->createElement('Truncate');
         $trunc_node->appendChild($req_doc->createTextNode($truncate ? 1 : 0));
         $sms_node->appendChild($trunc_node);
-      }
+        }
 
-      // Invalid Char Action
-      if (array_key_exists('invalid_char_action', $single) || isset($this->invalid_char_action)) {
+        // Invalid Char Action
+        if (array_key_exists('invalid_char_action', $single) || isset($this->invalid_char_action)) {
         $action = array_key_exists('invalid_char_action', $single) ? $single['invalid_char_action'] : $this->invalid_char_action;
         switch (strtolower($action)) {
-          case 'error':
+            case 'error':
           $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 1));
-          break;
-          case 'remove':
+            break;
+            case 'remove':
           $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 2));
-          break;
-          case 'replace':
+            break;
+            case 'replace':
           $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 3));
+            break;
+            default:
           break;
-          default:
-          break;
         }
-      }
+        }
 
-      // Wrapper ID
-      $sms_node->appendChild($req_doc->createElement('WrapperID', $i));
+        // Wrapper ID
+        $sms_node->appendChild($req_doc->createElement('WrapperID', $i));
 
-      $root->appendChild($sms_node);
+        $root->appendChild($sms_node);
     }
 
     $req_xml = $req_doc->saveXML();
@@ -259,12 +259,12 @@ 
     $err_desc = null;
 
     foreach($resp_doc->documentElement->childNodes AS $doc_child) {
-      switch(strtolower($doc_child->nodeName)) {
+        switch(strtolower($doc_child->nodeName)) {
         case 'sms_resp':
         $resp = array();
         $wrapper_id = null;
         foreach($doc_child->childNodes AS $resp_node) {
-          switch(strtolower($resp_node->nodeName)) {
+            switch(strtolower($resp_node->nodeName)) {
             case 'messageid':
             $resp['id'] = $resp_node->nodeValue;
             break;
@@ -277,13 +277,13 @@ 
             case 'wrapperid':
             $wrapper_id = $resp_node->nodeValue;
             break;
-          }
+            }
         }
         if( array_key_exists('error_code', $resp ) ) 
         {
-          $resp['success'] = 0;
+            $resp['success'] = 0;
         } else {
-          $resp['success'] = 1;
+            $resp['success'] = 1;
         }
         $resp['sms'] = $sms[$wrapper_id];
         array_push($response, $resp);
@@ -294,28 +294,28 @@ 
         case 'errdesc':
         $err_desc = $doc_child->nodeValue;
         break;
-      }
+        }
     }
 
     if (isset($err_no)) {
-      throw new KannelException($err_desc, $err_no);
+        throw new KannelException($err_desc, $err_no);
     }
         
     if ($single_message) {
-      return $response[0];
+        return $response[0];
     } else {
-      return $response;
+        return $response;
     }
-  }
-
-  /**
-  * Check how many SMS credits you have available
-  *
-  * @return  integer   SMS credits remaining
-  * @deprecated Use checkBalance() instead
-  * @author  Martin Steel
-  */
-  public function checkCredit() {
+    }
+
+    /**
+     * Check how many SMS credits you have available
+     *
+     * @return  integer   SMS credits remaining
+     * @deprecated Use checkBalance() instead
+     * @author  Martin Steel
+     */
+    public function checkCredit() {
     // Create XML doc for request
     $req_doc = new \DOMDocument('1.0', 'UTF-8');
     $root = $req_doc->createElement('Credit');
@@ -336,7 +336,7 @@ 
     $err_desc = null;
         
     foreach ($resp_doc->documentElement->childNodes AS $doc_child) {
-      switch ($doc_child->nodeName) {
+        switch ($doc_child->nodeName) {
         case "Credit":
         $credit = $doc_child->nodeValue;
         break;
@@ -348,22 +348,22 @@ 
         break;
         default:
         break;
-      }
+        }
     }
 
     if (isset($err_no)) {
-      throw new KannelException($err_desc, $err_no);
+        throw new KannelException($err_desc, $err_no);
     }
     return $credit;
-  }
+    }
 
-  /**
-  * Check your account balance
-  *
-  * @return  array   Array of account balance: 
-  * @author  Martin Steel
-  */
-  public function checkBalance() {
+    /**
+     * Check your account balance
+     *
+     * @return  array   Array of account balance: 
+     * @author  Martin Steel
+     */
+    public function checkBalance() {
     // Create XML doc for request
     $req_doc = new \DOMDocument('1.0', 'UTF-8');
     $root = $req_doc->createElement('Balance');
@@ -384,20 +384,20 @@ 
     $err_desc = null;
         
     foreach ($resp_doc->documentElement->childNodes as $doc_child) {
-      switch ($doc_child->nodeName) {
+        switch ($doc_child->nodeName) {
         case "Balance":
         $balance = number_format(floatval($doc_child->nodeValue), 2);
         break;
         case "Currency":
         foreach ($doc_child->childNodes as $resp_node) {
-          switch ($resp_node->tagName) {
+            switch ($resp_node->tagName) {
             case "Symbol":
             $symbol = $resp_node->nodeValue; 
             break;
             case "Code":
             $code = $resp_node->nodeValue; 
             break;
-          }
+            }
         }
         break;
         case "ErrNo":
@@ -408,23 +408,23 @@ 
         break;
         default:
         break;
-      }
+        }
     }
 
     if (isset($err_no)) {
-      throw new KannelException($err_desc, $err_no);
+        throw new KannelException($err_desc, $err_no);
     }
         
     return array( 'symbol' => $symbol, 'balance' => $balance, 'code' => $code );
-  }
+    }
 
-  /**
-  * Check whether the API Key is valid
-  *
-  * @return  bool    True indicates a valid key
-  * @author  Martin Steel
-  */
-  public function checkKey() {
+    /**
+     * Check whether the API Key is valid
+     *
+     * @return  bool    True indicates a valid key
+     * @author  Martin Steel
+     */
+    public function checkKey() {
     // Create XML doc for request
     $req_doc = new \DOMDocument('1.0', 'UTF-8');
     $root = $req_doc->createElement('Authenticate');
@@ -445,7 +445,7 @@ 
     $err_desc = null;
 
     foreach ($resp_doc->documentElement->childNodes AS $doc_child) {
-      switch ($doc_child->nodeName) {
+        switch ($doc_child->nodeName) {
         case "CustID":
         $cust_id = $doc_child->nodeValue;
         break;
@@ -457,33 +457,33 @@ 
         break;
         default:
         break;
-      }
+        }
     }
 
     if (isset($err_no)) {
-      throw new KannelException($err_desc, $err_no);
+        throw new KannelException($err_desc, $err_no);
     }
     return isset($cust_id);   
-  }
-
-  /**
-  * Make an HTTP POST to Kannel
-  *
-  * @param   string   method Kannel method to call (sms/credit)
-  * @param   string   data   Content of HTTP POST
-  *
-  * @return  string          Response from Kannel
-  * @author  Martin Steel
-  */
-  protected function postToKannel($method, $data) {
+    }
+
+    /**
+     * Make an HTTP POST to Kannel
+     *
+     * @param   string   method Kannel method to call (sms/credit)
+     * @param   string   data   Content of HTTP POST
+     *
+     * @return  string          Response from Kannel
+     * @author  Martin Steel
+     */
+    protected function postToKannel($method, $data) {
     if ($this->log) {
-      $this->logXML("API $method Request XML", $data);
+        $this->logXML("API $method Request XML", $data);
     }
     
     if( isset( $this->ssl ) ) {
-      $ssl = $this->ssl;
+        $ssl = $this->ssl;
     } else {
-      $ssl = $this->sslSupport();
+        $ssl = $this->sslSupport();
     }
 
     $url = $ssl ? 'https://' : 'http://';
@@ -492,152 +492,152 @@ 
     $response = $this->xmlPost($url, $data);
 
     if ($this->log) {
-      $this->logXML("API $method Response XML", $response);
+        $this->logXML("API $method Response XML", $response);
     }
 
     return $response;
-  }
-
-  /**
-  * Make a HTTP POST
-  *
-  * cURL will be used if available, otherwise tries the PHP stream functions
-  *
-  * @param   string url      URL to send to
-  * @param   string data     Data to POST
-  * @return  string          Response returned by server
-  * @author  Martin Steel
-  */
-  protected function xmlPost($url, $data) {
+    }
+
+    /**
+     * Make a HTTP POST
+     *
+     * cURL will be used if available, otherwise tries the PHP stream functions
+     *
+     * @param   string url      URL to send to
+     * @param   string data     Data to POST
+     * @return  string          Response returned by server
+     * @author  Martin Steel
+     */
+    protected function xmlPost($url, $data) {
     if(extension_loaded('curl')) {
-      $ch = curl_init($url);
-      curl_setopt($ch, CURLOPT_POST, 1);
-      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-      curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml"));
-      curl_setopt($ch, CURLOPT_USERAGENT, 'Kannel PHP Wrapper/1.0' . self::VERSION);
-      curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
-      if (isset($this->proxy_host) && isset($this->proxy_port)) {
+        $ch = curl_init($url);
+        curl_setopt($ch, CURLOPT_POST, 1);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml"));
+        curl_setopt($ch, CURLOPT_USERAGENT, 'Kannel PHP Wrapper/1.0' . self::VERSION);
+        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
+        if (isset($this->proxy_host) && isset($this->proxy_port)) {
         curl_setopt($ch, CURLOPT_PROXY, $this->proxy_host);
         curl_setopt($ch, CURLOPT_PROXYPORT, $this->proxy_port);
-      }
+        }
 
-      $response = curl_exec($ch);
-      $info = curl_getinfo($ch);
+        $response = curl_exec($ch);
+        $info = curl_getinfo($ch);
 
-      if ($response === false || $info['http_code'] != 200) {
+        if ($response === false || $info['http_code'] != 200) {
         throw new \Exception('HTTP Error calling Kannel API - HTTP Status: ' . $info['http_code'] . ' - cURL Erorr: ' . curl_error($ch));
-      } elseif (curl_errno($ch) > 0) {
+        } elseif (curl_errno($ch) > 0) {
         throw new \Exception('HTTP Error calling Kannel API - cURL Error: ' . curl_error($ch));
-      }
+        }
 
-      curl_close($ch);
+        curl_close($ch);
 
-      return $response;
+        return $response;
     } elseif (function_exists('stream_get_contents')) {
-      // Enable error Track Errors
-      $track = ini_get('track_errors');
-      ini_set('track_errors',true);
+        // Enable error Track Errors
+        $track = ini_get('track_errors');
+        ini_set('track_errors',true);
 
-      $params = array('http' => array(
-      'method'  => 'POST',
-      'header'  => "Content-Type: text/xml\r\nUser-Agent: mediaburst PHP Wrapper/" . self::VERSION . "\r\n",
-      'content' => $data
-      ));
+        $params = array('http' => array(
+        'method'  => 'POST',
+        'header'  => "Content-Type: text/xml\r\nUser-Agent: mediaburst PHP Wrapper/" . self::VERSION . "\r\n",
+        'content' => $data
+        ));
 
-      if (isset($this->proxy_host) && isset($this->proxy_port)) {
+        if (isset($this->proxy_host) && isset($this->proxy_port)) {
         $params['http']['proxy'] = 'tcp://'.$this->proxy_host . ':' . $this->proxy_port;
         $params['http']['request_fulluri'] = True;
-      }
+        }
 
-      $ctx = stream_context_create($params);
-      $fp = @fopen($url, 'rb', false, $ctx);
-      if (!$fp) {
+        $ctx = stream_context_create($params);
+        $fp = @fopen($url, 'rb', false, $ctx);
+        if (!$fp) {
         ini_set('track_errors',$track);
         throw new \Exception("HTTP Error calling Kannel API - fopen Error: $php_errormsg");
-      }
-      $response = @stream_get_contents($fp);
-      if ($response === false) {
+        }
+        $response = @stream_get_contents($fp);
+        if ($response === false) {
         ini_set('track_errors',$track);
         throw new \Exception("HTTP Error calling Kannel API - stream Error: $php_errormsg");
-      }
-      ini_set('track_errors',$track);
-      return $response;
+        }
+        ini_set('track_errors',$track);
+        return $response;
     } else {
-      throw new \Exception("Kannel requires PHP5 with cURL or HTTP stream support");
+        throw new \Exception("Kannel requires PHP5 with cURL or HTTP stream support");
     }
-  }
-
-  /**
-  * Does the server/HTTP wrapper support SSL
-  *
-  * This is a best guess effort, some servers have weird setups where even
-  * though cURL is compiled with SSL support is still fails to make
-  * any requests.
-  *
-  * @return bool     True if SSL is supported
-  * @author  Martin Steel
-  */
-  protected function sslSupport() {
+    }
+
+    /**
+     * Does the server/HTTP wrapper support SSL
+     *
+     * This is a best guess effort, some servers have weird setups where even
+     * though cURL is compiled with SSL support is still fails to make
+     * any requests.
+     *
+     * @return bool     True if SSL is supported
+     * @author  Martin Steel
+     */
+    protected function sslSupport() {
     $ssl = false;
     // See if PHP is compiled with cURL
     if (extension_loaded('curl')) {
-      $version = curl_version();
-      $ssl = ($version['features'] & CURL_VERSION_SSL) ? true : false;
+        $version = curl_version();
+        $ssl = ($version['features'] & CURL_VERSION_SSL) ? true : false;
     } elseif (extension_loaded('openssl')) {
-      $ssl = true;
+        $ssl = true;
     }
     return $ssl;
-  }
-
-  /**
-  * Log some XML, tidily if possible, in the PHP error log
-  *
-  * @param   string  log_msg The log message to prepend to the XML
-  * @param   string  xml     An XML formatted string
-  *
-  * @return  void
-  * @author  Martin Steel
-  */
-  protected function logXML($log_msg, $xml) {
+    }
+
+    /**
+     * Log some XML, tidily if possible, in the PHP error log
+     *
+     * @param   string  log_msg The log message to prepend to the XML
+     * @param   string  xml     An XML formatted string
+     *
+     * @return  void
+     * @author  Martin Steel
+     */
+    protected function logXML($log_msg, $xml) {
     // Tidy if possible
     if (class_exists('tidy')) {
-      $tidy = new \tidy;
-      $config = array(
-      'indent'     => true,
-      'input-xml'  => true,
-      'output-xml' => true,
-      'wrap'       => 200
-      );
-      $tidy->parseString($xml, $config, 'utf8');
-      $tidy->cleanRepair();
-      $xml = $tidy;
+        $tidy = new \tidy;
+        $config = array(
+        'indent'     => true,
+        'input-xml'  => true,
+        'output-xml' => true,
+        'wrap'       => 200
+        );
+        $tidy->parseString($xml, $config, 'utf8');
+        $tidy->cleanRepair();
+        $xml = $tidy;
     }
     // Output
     error_log("Kannel $log_msg: $xml");
-  }
-
-  /**
-  * Check if an array is associative
-  *
-  * @param   array $array Array to check
-  * @return  bool
-  * @author  Martin Steel
-  */
-  protected function is_assoc($array) {
+    }
+
+    /**
+     * Check if an array is associative
+     *
+     * @param   array $array Array to check
+     * @return  bool
+     * @author  Martin Steel
+     */
+    protected function is_assoc($array) {
     return (bool)count(array_filter(array_keys($array), 'is_string'));
-  }
+    }
   
-  /**
-   * Check if a number is a valid MSISDN
-   *
-   * @param string $val Value to check
-   * @return bool True if valid MSISDN
-   * @author James Inman
-   * @since 1.3.0
-   * @todo Take an optional country code and check that the number starts with it
-   */
-  public static function is_valid_msisdn($val) {
+    /**
+     * Check if a number is a valid MSISDN
+     *
+     * @param string $val Value to check
+     * @return bool True if valid MSISDN
+     * @author James Inman
+     * @since 1.3.0
+     * @todo Take an optional country code and check that the number starts with it
+     */
+    public static function is_valid_msisdn($val) {
     return preg_match( '/^[1-9][0-9]{7,12}$/', $val );
-  }
+    }
 
 }

Spacing +25 added lines, -25 removed lines

@@ -9,7 +9,7 @@ 
 * @version     1.3.0
 */
 
-if ( !class_exists('KannelException') ) {
+if (!class_exists('KannelException')) {
   require_once('exception.php');
 }
 
@@ -24,25 +24,25 @@ 
   /*
   * Version of this class
   */
-  const VERSION           = '1.3.1';
+  const VERSION = '1.3.1';
 
   /**
   * All Kannel API calls start with BASE_URL
   * @author  Martin Steel
   */
-  const API_BASE_URL      = 'api.kannelsms.com/xml/';
+  const API_BASE_URL = 'api.kannelsms.com/xml/';
 
   /**
   * string to append to API_BASE_URL to check authentication
   * @author  Martin Steel
   */
-  const API_AUTH_METHOD   = 'authenticate';
+  const API_AUTH_METHOD = 'authenticate';
 
   /**
   * string to append to API_BASE_URL for sending SMS
   * @author  Martin Steel
   */
-  const API_SMS_METHOD    = 'sms';
+  const API_SMS_METHOD = 'sms';
 
   /**
   * string to append to API_BASE_URL for checking message credit
@@ -258,13 +258,13 @@ 
     $err_no = null;
     $err_desc = null;
 
-    foreach($resp_doc->documentElement->childNodes AS $doc_child) {
-      switch(strtolower($doc_child->nodeName)) {
+    foreach ($resp_doc->documentElement->childNodes AS $doc_child) {
+      switch (strtolower($doc_child->nodeName)) {
         case 'sms_resp':
         $resp = array();
         $wrapper_id = null;
-        foreach($doc_child->childNodes AS $resp_node) {
-          switch(strtolower($resp_node->nodeName)) {
+        foreach ($doc_child->childNodes AS $resp_node) {
+          switch (strtolower($resp_node->nodeName)) {
             case 'messageid':
             $resp['id'] = $resp_node->nodeValue;
             break;
@@ -279,7 +279,7 @@ 
             break;
           }
         }
-        if( array_key_exists('error_code', $resp ) ) 
+        if (array_key_exists('error_code', $resp)) 
         {
           $resp['success'] = 0;
         } else {
@@ -415,7 +415,7 @@ 
       throw new KannelException($err_desc, $err_no);
     }
         
-    return array( 'symbol' => $symbol, 'balance' => $balance, 'code' => $code );
+    return array('symbol' => $symbol, 'balance' => $balance, 'code' => $code);
   }
 
   /**
@@ -480,14 +480,14 @@ 
       $this->logXML("API $method Request XML", $data);
     }
     
-    if( isset( $this->ssl ) ) {
+    if (isset($this->ssl)) {
       $ssl = $this->ssl;
     } else {
       $ssl = $this->sslSupport();
     }
 
     $url = $ssl ? 'https://' : 'http://';
-    $url .= self::API_BASE_URL . $method;
+    $url .= self::API_BASE_URL.$method;
 
     $response = $this->xmlPost($url, $data);
 
@@ -509,12 +509,12 @@ 
   * @author  Martin Steel
   */
   protected function xmlPost($url, $data) {
-    if(extension_loaded('curl')) {
+    if (extension_loaded('curl')) {
       $ch = curl_init($url);
       curl_setopt($ch, CURLOPT_POST, 1);
       curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
       curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml"));
-      curl_setopt($ch, CURLOPT_USERAGENT, 'Kannel PHP Wrapper/1.0' . self::VERSION);
+      curl_setopt($ch, CURLOPT_USERAGENT, 'Kannel PHP Wrapper/1.0'.self::VERSION);
       curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
       if (isset($this->proxy_host) && isset($this->proxy_port)) {
         curl_setopt($ch, CURLOPT_PROXY, $this->proxy_host);
@@ -525,9 +525,9 @@ 
       $info = curl_getinfo($ch);
 
       if ($response === false || $info['http_code'] != 200) {
-        throw new \Exception('HTTP Error calling Kannel API - HTTP Status: ' . $info['http_code'] . ' - cURL Erorr: ' . curl_error($ch));
+        throw new \Exception('HTTP Error calling Kannel API - HTTP Status: '.$info['http_code'].' - cURL Erorr: '.curl_error($ch));
       } elseif (curl_errno($ch) > 0) {
-        throw new \Exception('HTTP Error calling Kannel API - cURL Error: ' . curl_error($ch));
+        throw new \Exception('HTTP Error calling Kannel API - cURL Error: '.curl_error($ch));
       }
 
       curl_close($ch);
@@ -536,31 +536,31 @@ 
     } elseif (function_exists('stream_get_contents')) {
       // Enable error Track Errors
       $track = ini_get('track_errors');
-      ini_set('track_errors',true);
+      ini_set('track_errors', true);
 
       $params = array('http' => array(
       'method'  => 'POST',
-      'header'  => "Content-Type: text/xml\r\nUser-Agent: mediaburst PHP Wrapper/" . self::VERSION . "\r\n",
+      'header'  => "Content-Type: text/xml\r\nUser-Agent: mediaburst PHP Wrapper/".self::VERSION."\r\n",
       'content' => $data
       ));
 
       if (isset($this->proxy_host) && isset($this->proxy_port)) {
-        $params['http']['proxy'] = 'tcp://'.$this->proxy_host . ':' . $this->proxy_port;
+        $params['http']['proxy'] = 'tcp://'.$this->proxy_host.':'.$this->proxy_port;
         $params['http']['request_fulluri'] = True;
       }
 
       $ctx = stream_context_create($params);
       $fp = @fopen($url, 'rb', false, $ctx);
       if (!$fp) {
-        ini_set('track_errors',$track);
+        ini_set('track_errors', $track);
         throw new \Exception("HTTP Error calling Kannel API - fopen Error: $php_errormsg");
       }
       $response = @stream_get_contents($fp);
       if ($response === false) {
-        ini_set('track_errors',$track);
+        ini_set('track_errors', $track);
         throw new \Exception("HTTP Error calling Kannel API - stream Error: $php_errormsg");
       }
-      ini_set('track_errors',$track);
+      ini_set('track_errors', $track);
       return $response;
     } else {
       throw new \Exception("Kannel requires PHP5 with cURL or HTTP stream support");
@@ -624,7 +624,7 @@ 
   * @author  Martin Steel
   */
   protected function is_assoc($array) {
-    return (bool)count(array_filter(array_keys($array), 'is_string'));
+    return (bool) count(array_filter(array_keys($array), 'is_string'));
   }
   
   /**
@@ -637,7 +637,7 @@ 
    * @todo Take an optional country code and check that the number starts with it
    */
   public static function is_valid_msisdn($val) {
-    return preg_match( '/^[1-9][0-9]{7,12}$/', $val );
+    return preg_match('/^[1-9][0-9]{7,12}$/', $val);
   }
 
 }

plugin/openmeetings/lib/openmeetings.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -213,7 +213,8 @@
     /**
      * Returns a meeting "join" URL
      * @param string The name of the meeting (usually the course code)
-     * @return mixed The URL to join the meeting, or false on error
+     * @param false|string $meetingId
+     * @return false|null The URL to join the meeting, or false on error
      * @todo implement moderator pass
      * @assert ('') === false
      * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false

Spacing +10 added lines, -10 removed lines

@@ -49,9 +49,9 @@ 
         $om_user   = $plugin->get('user');
         $om_pass   = $plugin->get('pass');
         $accessUrl = api_get_access_url($_configuration['access_url']);
-        $this->externalType = substr($accessUrl['url'], strpos($accessUrl['url'], '://')+3, -1);
+        $this->externalType = substr($accessUrl['url'], strpos($accessUrl['url'], '://') + 3, -1);
         if (strcmp($this->externalType, 'localhost') == 0) {
-            $this->externalType = substr(api_get_path(WEB_PATH), strpos(api_get_path(WEB_PATH), '://')+3, -1);
+            $this->externalType = substr(api_get_path(WEB_PATH), strpos(api_get_path(WEB_PATH), '://') + 3, -1);
         }
         $this->externalType = 'chamilolms.'.$this->externalType;
         $this->table = \Database::get_main_table('plugin_openmeetings');
@@ -161,7 +161,7 @@ 
             // This fills the following attributes: status, name, comment, chamiloCourseId, chamiloSessionId
             $room = new Room();
             $room->loadRoomId($meetingData['room_id']);
-            $roomArray = (array)$room;
+            $roomArray = (array) $room;
             $roomArray['SID'] = $this->sessionId;
             $roomId = $this->gateway->updateRoomWithModeration($room);
             if ($roomId != $meetingData['room_id']) {
@@ -176,7 +176,7 @@ 
             $room->SID = $this->sessionId;
             $room->name = $this->roomName;
             //$room->roomtypes_id = $room->roomtypes_id;
-            $room->comment = urlencode(get_lang('Course').': ' . $params['meeting_name'] . ' - '.$_configuration['software_name']);
+            $room->comment = urlencode(get_lang('Course').': '.$params['meeting_name'].' - '.$_configuration['software_name']);
             //$room->numberOfPartizipants = $room->numberOfPartizipants;
             $room->ispublic = $room->getString('isPublic', 'false');
             //$room->appointment = $room->getString('appointment');
@@ -200,7 +200,7 @@ 
             $params['room_id'] = $roomId;
             $params['c_id'] = api_get_course_int_id();
             $params['session_id'] = api_get_session_id();
-            $params['record'] = ($room->allowRecording?1:0);
+            $params['record'] = ($room->allowRecording ? 1 : 0);
 
             $id = \Database::insert($this->table, $params);
 
@@ -238,7 +238,7 @@ 
         }
         $params = array('room_id' => $meetingData['room_id']);
         $returnVal = $this->setUserObjectAndGenerateRoomHashByURLAndRecFlag($params);
-        $iframe = $this->url . "/?" ."secureHash=" . $returnVal;
+        $iframe = $this->url."/?"."secureHash=".$returnVal;
         printf("<iframe src='%s' width='%s' height = '%s' />", $iframe, "100%", 640);
     }
 
@@ -346,7 +346,7 @@ 
         $userId = $_SESSION['_user']['user_id'];
         $systemType = 'Chamilo';
         $room_id = $params['room_id'];
-        $becomeModerator = ( $this->isTeacher() ? 1 : 0 );
+        $becomeModerator = ($this->isTeacher() ? 1 : 0);
         $allowRecording = 1; //Provisional
 
         $urlWsdl = $this->url."/services/UserService?wsdl";
@@ -420,7 +420,7 @@ 
                 error_log(__FILE__.'+'.__LINE__.' Meetings found: '.print_r($meetingDb, 1));
                 $remoteMeeting = array();
                 $meetingDb['created_at'] = api_get_local_time($meetingDb['created_at']);
-                $meetingDb['closed_at'] = (!empty($meetingDb['closed_at']) ? api_get_local_time($meetingDb['closed_at']):'');
+                $meetingDb['closed_at'] = (!empty($meetingDb['closed_at']) ? api_get_local_time($meetingDb['closed_at']) : '');
                 // Fixed value for now
                 $meetingDb['participantCount'] = 40;
                 $rec = $this->gateway->getFlvRecordingByRoomId($meetingDb['room_id']);
@@ -436,7 +436,7 @@ 
                         \Display::url('[.avi]', $link2, array('target' => '_blank'));
 
                 }
-                $item['show_links']  = implode('<br />', $links);
+                $item['show_links'] = implode('<br />', $links);
 
                 // The following code is currently commented because the web service
                 // says this is not allowed by the SOAP user.
@@ -486,7 +486,7 @@ 
                 $remoteMeeting = $current_room;
                 */
 
-                if (empty( $remoteMeeting )) {
+                if (empty($remoteMeeting)) {
                 /*
                     error_log(__FILE__.'+'.__LINE__.' Empty remote Meeting for now');
                     if ($meetingDb['status'] == 1 && $this->isTeacher()) {

Indentation +6 added lines, -6 removed lines

@@ -126,7 +126,7 @@ 
             return false;
         }
     }
-    */
+     */
 
     /*
      * Creating a Room for the meeting
@@ -256,10 +256,10 @@ 
         return true;
     }
 
-     /**
-     * Gets the password for a specific meeting for the current user
-     * @return string A moderator password if user is teacher, or the course code otherwise
-     */
+        /**
+         * Gets the password for a specific meeting for the current user
+         * @return string A moderator password if user is teacher, or the course code otherwise
+         */
     public function getMeetingUserPassword()
     {
         if ($this->isTeacher()) {
@@ -538,7 +538,7 @@ 
     //
     //            }
     //
-                 //$item['created_at'] = api_convert_and_format_date($meetingDb['created_at']);
+                    //$item['created_at'] = api_convert_and_format_date($meetingDb['created_at']);
     //            //created_at
     //
     //            $item['publish_url'] = api_get_self().'?action=publish&id='.$meetingDb['id'];

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/openmeetings/lib/room.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
     /**
      * Gets a string from a boolean attribute
      * @param string $attribute Name of the attribute
-     * @param mixed  $voidReturn What to return if the value is not defined
+     * @param string  $voidReturn What to return if the value is not defined
      * @return string The boolean value expressed as string ('true' or 'false')
      */
     public function getString($attribute, $voidReturn = false)

Spacing +3 added lines, -3 removed lines

@@ -49,9 +49,9 @@ 
         global $_configuration;
         $this->name = 'C'.api_get_real_course_id().'-'.api_get_session_id();
         $accessUrl = api_get_access_url($_configuration['access_url']);
-        $this->externalRoomType = substr($accessUrl['url'], strpos($accessUrl['url'],'://')+3,-1);
+        $this->externalRoomType = substr($accessUrl['url'], strpos($accessUrl['url'], '://') + 3, -1);
         if (strcmp($this->externalRoomType, 'localhost') == 0) {
-            $this->externalRoomType = substr(api_get_path(WEB_PATH), strpos(api_get_path(WEB_PATH),'://')+3, -1);
+            $this->externalRoomType = substr(api_get_path(WEB_PATH), strpos(api_get_path(WEB_PATH), '://') + 3, -1);
         }
         $this->externalRoomType = 'chamilolms.'.$this->externalRoomType;
     }
@@ -110,6 +110,6 @@ 
         if (!isset($this->$attribute)) {
             return $voidReturn;
         }
-        return $this->$attribute?'true':'false';
+        return $this->$attribute ? 'true' : '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)