chamilo / chamilo-lms

main/auth/cas/lib/CAS/PGTStorage/pgt-db.php

Doc Comments +4 added lines, -4 removed lines

@@ -62,7 +62,7 @@ 
   /**

    * This method returns the PEAR DB URL to use to connect to the database.

    *

-   * @return a PEAR DB URL

+   * @return string PEAR DB URL

    *

    * @private

    */

@@ -105,7 +105,7 @@ 
   /**

    * This method returns the name of the table where PGT's are stored.

    *

-   * @return the name of a table.

+   * @return string name of a table.

    *

    * @private

    */

@@ -122,7 +122,7 @@ 
    * This method returns an informational string giving the type of storage

    * used by the object (used for debugging purposes).

    *

-   * @return an informational string.

+   * @return string informational string.

    * @public

    */

   function getStorageType()

@@ -148,7 +148,7 @@ 
   /**

    * The class constructor, called by CASClient::SetPGTStorageDB().

    *

-   * @param $cas_parent the CASClient instance that creates the object.

+   * @param CASClient $cas_parent the CASClient instance that creates the object.

    * @param $user the user to access the data with

    * @param $password the user's password

    * @param $database_type the type of the database hosting the data

Spacing +9 added lines, -9 removed lines

@@ -57,7 +57,7 @@ 
    * @hideinitializer

    * @private

    */

-  var $_url='';

+  var $_url = '';

 

   /**

    * This method returns the PEAR DB URL to use to connect to the database.

@@ -159,18 +159,18 @@ 
    *

    * @public

    */

-  function PGTStorageDB($cas_parent,$user,$password,$database_type,$hostname,$port,$database,$table)

+  function PGTStorageDB($cas_parent, $user, $password, $database_type, $hostname, $port, $database, $table)

     {

       phpCAS::traceBegin();

 

       // call the ancestor's constructor

       $this->PGTStorage($cas_parent);

 

-      if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;

-      if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;

-      if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;

-      if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;

-      if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;

+      if (empty($database_type)) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;

+      if (empty($hostname)) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;

+      if ($port == 0) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;

+      if (empty($database)) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;

+      if (empty($table)) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;

 

       // build and store the PEAR DB URL

       $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$hostname.':'.$port.'/'.$database;

@@ -192,7 +192,7 @@ 
     {

       phpCAS::traceBegin();

       // if the storage has already been initialized, return immediatly

-      if ( $this->isInitialized() )

+      if ($this->isInitialized())

 		return;

       // call the ancestor's method (mark as initialized)

       parent::init();

@@ -205,7 +205,7 @@ 
 

       // try to connect to the database

       $this->_link = DB::connect($this->getURL());

-      if ( DB::isError($this->_link) ) {

+      if (DB::isError($this->_link)) {

 	phpCAS::error('could not connect to database ('.DB::errorMessage($this->_link).')');

       }

       var_dump($this->_link);

Braces +18 added lines, -7 removed lines

@@ -166,11 +166,21 @@ 
       // call the ancestor's constructor

       $this->PGTStorage($cas_parent);

 

-      if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;

-      if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;

-      if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;

-      if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;

-      if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;

+      if ( empty($database_type) ) {
+          $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;
+      }
+      if ( empty($hostname) ) {
+          $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;
+      }
+      if ( $port==0 ) {
+          $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;
+      }
+      if ( empty($database) ) {
+          $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;
+      }
+      if ( empty($table) ) {
+          $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;
+      }
 

       // build and store the PEAR DB URL

       $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$hostname.':'.$port.'/'.$database;

@@ -192,8 +202,9 @@ 
     {

       phpCAS::traceBegin();

       // if the storage has already been initialized, return immediatly

-      if ( $this->isInitialized() )

-		return;

+      if ( $this->isInitialized() ) {
+      		return;
+      }
       // call the ancestor's method (mark as initialized)

       parent::init();

       

Indentation +140 added lines, -140 removed lines

@@ -45,175 +45,175 @@
 

 class PGTStorageDB extends PGTStorage

 {

-  /** 

-   * @addtogroup internalPGTStorageDB

-   * @{ 

-   */

-

-  /**

-   * a string representing a PEAR DB URL to connect to the database. Written by

-   * PGTStorageDB::PGTStorageDB(), read by getURL().

-   *

-   * @hideinitializer

-   * @private

-   */

-  var $_url='';

-

-  /**

-   * This method returns the PEAR DB URL to use to connect to the database.

-   *

-   * @return a PEAR DB URL

-   *

-   * @private

-   */

-  function getURL()

+    /** 

+     * @addtogroup internalPGTStorageDB

+     * @{ 

+     */

+

+    /**

+     * a string representing a PEAR DB URL to connect to the database. Written by

+     * PGTStorageDB::PGTStorageDB(), read by getURL().

+     *

+     * @hideinitializer

+     * @private

+     */

+    var $_url='';

+

+    /**

+     * This method returns the PEAR DB URL to use to connect to the database.

+     *

+     * @return a PEAR DB URL

+     *

+     * @private

+     */

+    function getURL()

     {

-      return $this->_url;

+        return $this->_url;

     }

 

-  /**

-   * The handle of the connection to the database where PGT's are stored. Written by

-   * PGTStorageDB::init(), read by getLink().

-   *

-   * @hideinitializer

-   * @private

-   */

-  var $_link = null;

-

-  /**

-   * This method returns the handle of the connection to the database where PGT's are 

-   * stored.

-   *

-   * @return a handle of connection.

-   *

-   * @private

-   */

-  function getLink()

+    /**

+     * The handle of the connection to the database where PGT's are stored. Written by

+     * PGTStorageDB::init(), read by getLink().

+     *

+     * @hideinitializer

+     * @private

+     */

+    var $_link = null;

+

+    /**

+     * This method returns the handle of the connection to the database where PGT's are 

+     * stored.

+     *

+     * @return a handle of connection.

+     *

+     * @private

+     */

+    function getLink()

     {

-      return $this->_link;

+        return $this->_link;

     }

 

-  /**

-   * The name of the table where PGT's are stored. Written by 

-   * PGTStorageDB::PGTStorageDB(), read by getTable().

-   *

-   * @hideinitializer

-   * @private

-   */

-  var $_table = '';

-

-  /**

-   * This method returns the name of the table where PGT's are stored.

-   *

-   * @return the name of a table.

-   *

-   * @private

-   */

-  function getTable()

+    /**

+     * The name of the table where PGT's are stored. Written by 

+     * PGTStorageDB::PGTStorageDB(), read by getTable().

+     *

+     * @hideinitializer

+     * @private

+     */

+    var $_table = '';

+

+    /**

+     * This method returns the name of the table where PGT's are stored.

+     *

+     * @return the name of a table.

+     *

+     * @private

+     */

+    function getTable()

     {

-      return $this->_table;

+        return $this->_table;

     }

 

-  // ########################################################################

-  //  DEBUGGING

-  // ########################################################################

+    // ########################################################################

+    //  DEBUGGING

+    // ########################################################################

   

-  /**

-   * This method returns an informational string giving the type of storage

-   * used by the object (used for debugging purposes).

-   *

-   * @return an informational string.

-   * @public

-   */

-  function getStorageType()

+    /**

+     * This method returns an informational string giving the type of storage

+     * used by the object (used for debugging purposes).

+     *

+     * @return an informational string.

+     * @public

+     */

+    function getStorageType()

     {

-      return "database";

+        return "database";

     }

 

-  /**

-   * This method returns an informational string giving informations on the

-   * parameters of the storage.(used for debugging purposes).

-   *

-   * @public

-   */

-  function getStorageInfo()

+    /**

+     * This method returns an informational string giving informations on the

+     * parameters of the storage.(used for debugging purposes).

+     *

+     * @public

+     */

+    function getStorageInfo()

     {

-      return 'url=`'.$this->getURL().'\', table=`'.$this->getTable().'\'';

+        return 'url=`'.$this->getURL().'\', table=`'.$this->getTable().'\'';

     }

 

-  // ########################################################################

-  //  CONSTRUCTOR

-  // ########################################################################

+    // ########################################################################

+    //  CONSTRUCTOR

+    // ########################################################################

   

-  /**

-   * The class constructor, called by CASClient::SetPGTStorageDB().

-   *

-   * @param $cas_parent the CASClient instance that creates the object.

-   * @param $user the user to access the data with

-   * @param $password the user's password

-   * @param $database_type the type of the database hosting the data

-   * @param $hostname the server hosting the database

-   * @param $port the port the server is listening on

-   * @param $database the name of the database

-   * @param $table the name of the table storing the data

-   *

-   * @public

-   */

-  function PGTStorageDB($cas_parent,$user,$password,$database_type,$hostname,$port,$database,$table)

+    /**

+     * The class constructor, called by CASClient::SetPGTStorageDB().

+     *

+     * @param $cas_parent the CASClient instance that creates the object.

+     * @param $user the user to access the data with

+     * @param $password the user's password

+     * @param $database_type the type of the database hosting the data

+     * @param $hostname the server hosting the database

+     * @param $port the port the server is listening on

+     * @param $database the name of the database

+     * @param $table the name of the table storing the data

+     *

+     * @public

+     */

+    function PGTStorageDB($cas_parent,$user,$password,$database_type,$hostname,$port,$database,$table)

     {

-      phpCAS::traceBegin();

+        phpCAS::traceBegin();

 

-      // call the ancestor's constructor

-      $this->PGTStorage($cas_parent);

+        // call the ancestor's constructor

+        $this->PGTStorage($cas_parent);

 

-      if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;

-      if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;

-      if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;

-      if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;

-      if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;

+        if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE;

+        if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME;

+        if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT;

+        if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE;

+        if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE;

 

-      // build and store the PEAR DB URL

-      $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$hostname.':'.$port.'/'.$database;

+        // build and store the PEAR DB URL

+        $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$hostname.':'.$port.'/'.$database;

 

-      // XXX should use setURL and setTable

-      phpCAS::traceEnd();

+        // XXX should use setURL and setTable

+        phpCAS::traceEnd();

     }

   

-  // ########################################################################

-  //  INITIALIZATION

-  // ########################################################################

+    // ########################################################################

+    //  INITIALIZATION

+    // ########################################################################

   

-  /**

-   * This method is used to initialize the storage. Halts on error.

-   *

-   * @public

-   */

-  function init()

+    /**

+     * This method is used to initialize the storage. Halts on error.

+     *

+     * @public

+     */

+    function init()

     {

-      phpCAS::traceBegin();

-      // if the storage has already been initialized, return immediatly

-      if ( $this->isInitialized() )

-		return;

-      // call the ancestor's method (mark as initialized)

-      parent::init();

+        phpCAS::traceBegin();

+        // if the storage has already been initialized, return immediatly

+        if ( $this->isInitialized() )

+        return;

+        // call the ancestor's method (mark as initialized)

+        parent::init();

       

-	  //include phpDB library (the test was introduced in release 0.4.8 for 

-	  //the integration into Tikiwiki).

-	  if (!class_exists('DB')) {

-		include_once('DB.php');

-	  }

-

-      // try to connect to the database

-      $this->_link = DB::connect($this->getURL());

-      if ( DB::isError($this->_link) ) {

-	    phpCAS::error('could not connect to database ('.DB::errorMessage($this->_link).')');

-      }

-      // Dump into trace

-      var_dump($this->_link);

-      phpCAS::traceBEnd();

+        //include phpDB library (the test was introduced in release 0.4.8 for 

+        //the integration into Tikiwiki).

+        if (!class_exists('DB')) {

+        include_once('DB.php');

+        }

+

+        // try to connect to the database

+        $this->_link = DB::connect($this->getURL());

+        if ( DB::isError($this->_link) ) {

+        phpCAS::error('could not connect to database ('.DB::errorMessage($this->_link).')');

+        }

+        // Dump into trace

+        var_dump($this->_link);

+        phpCAS::traceBEnd();

     }

 

-  /** @} */

+    /** @} */

 }

 

 ?>
\ No newline at end of file

main/auth/cas/lib/CAS/PGTStorage/pgt-file.php

Doc Comments +7 added lines, -7 removed lines

@@ -98,7 +98,7 @@ 
    * This method returns an informational string giving the type of storage

    * used by the object (used for debugging purposes).

    *

-   * @return an informational string.

+   * @return string informational string.

    * @public

    */

   function getStorageType()

@@ -110,7 +110,7 @@ 
    * This method returns an informational string giving informations on the

    * parameters of the storage.(used for debugging purposes).

    *

-   * @return an informational string.

+   * @return string informational string.

    * @public

    */

   function getStorageInfo()

@@ -125,9 +125,9 @@ 
   /**

    * The class constructor, called by CASClient::SetPGTStorageFile().

    *

-   * @param $cas_parent the CASClient instance that creates the object.

-   * @param $format the format used to store the PGT's (`plain' and `xml' allowed).

-   * @param $path the path where the PGT's should be stored

+   * @param CASClient $cas_parent the CASClient instance that creates the object.

+   * @param string $format the format used to store the PGT's (`plain' and `xml' allowed).

+   * @param string $path the path where the PGT's should be stored

    *

    * @public

    */

@@ -202,7 +202,7 @@ 
    *

    * @param $pgt_iou the PGT iou.

    *

-   * @return a filename

+   * @return string filename

    * @private

    */

   function getPGTIouFilename($pgt_iou)

@@ -243,7 +243,7 @@ 
    *

    * @param $pgt_iou the PGT iou

    *

-   * @return the corresponding PGT, or FALSE on error

+   * @return false|string corresponding PGT, or FALSE on error

    *

    * @public

    */

Switch Indentation +6 added lines, -6 removed lines

@@ -163,12 +163,12 @@
       $this->_path = $path;

       // check the format and store it

       switch ($format) {

-      case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:

-      case CAS_PGT_STORAGE_FILE_FORMAT_XML:

-	$this->_format = $format;

-	break;

-      default:

-	phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');

+          case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:

+          case CAS_PGT_STORAGE_FILE_FORMAT_XML:

+	    $this->_format = $format;

+	    break;

+          default:

+	    phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');

       }

       phpCAS::traceEnd();      

     }

Spacing +13 added lines, -13 removed lines

@@ -131,17 +131,17 @@ 
    *

    * @public

    */

-  function PGTStorageFile($cas_parent,$format,$path)

+  function PGTStorageFile($cas_parent, $format, $path)

     {

       phpCAS::traceBegin();

       // call the ancestor's constructor

       $this->PGTStorage($cas_parent);

 

-      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;

-      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;

+      if (empty($format)) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;

+      if (empty($path)) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;

 

       // check that the path is an absolute path

-      if (getenv("OS")=="Windows_NT"){

+      if (getenv("OS") == "Windows_NT") {

       	

       	 if (!preg_match('`^[a-zA-Z]:`', $path)) {

 	     	phpCAS::error('an absolute path is needed for PGT storage to file');

@@ -151,13 +151,13 @@ 
       else

       {

       

-      	if ( $path[0] != '/' ) {

+      	if ($path[0] != '/') {

 			phpCAS::error('an absolute path is needed for PGT storage to file');

       	}

 

       	// store the path (with a leading and trailing '/')      

-      	$path = preg_replace('|[/]*$|','/',$path);

-      	$path = preg_replace('|^[/]*|','/',$path);

+      	$path = preg_replace('|[/]*$|', '/', $path);

+      	$path = preg_replace('|^[/]*|', '/', $path);

       }

       

       $this->_path = $path;

@@ -186,7 +186,7 @@ 
     {

       phpCAS::traceBegin();

       // if the storage has already been initialized, return immediatly

-      if ( $this->isInitialized() )

+      if ($this->isInitialized())

 	return;

       // call the ancestor's method (mark as initialized)

       parent::init();

@@ -222,12 +222,12 @@ 
    *

    * @public

    */

-  function write($pgt,$pgt_iou)

+  function write($pgt, $pgt_iou)

     {

       phpCAS::traceBegin();

       $fname = $this->getPGTIouFilename($pgt_iou);

-      if ( $f=fopen($fname,"w") ) {

-	if ( fputs($f,$pgt) === FALSE ) {

+      if ($f = fopen($fname, "w")) {

+	if (fputs($f, $pgt) === FALSE) {

 	  phpCAS::error('could not write PGT to `'.$fname.'\'');

 	}

 	fclose($f);

@@ -252,10 +252,10 @@ 
       phpCAS::traceBegin();

       $pgt = FALSE;

       $fname = $this->getPGTIouFilename($pgt_iou);

-      if ( !($f=fopen($fname,"r")) ) {

+      if (!($f = fopen($fname, "r"))) {

 	phpCAS::trace('could not open `'.$fname.'\'');

       } else {

-	if ( ($pgt=fgets($f)) === FALSE ) {

+	if (($pgt = fgets($f)) === FALSE) {

 	  phpCAS::trace('could not read PGT from `'.$fname.'\'');

 	} 

 	fclose($f);

Braces +10 added lines, -6 removed lines

@@ -137,8 +137,12 @@ 
       // call the ancestor's constructor

       $this->PGTStorage($cas_parent);

 

-      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;

-      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;

+      if (empty($format) ) {
+          $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;
+      }
+      if (empty($path) ) {
+          $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
+      }
 

       // check that the path is an absolute path

       if (getenv("OS")=="Windows_NT"){

@@ -147,8 +151,7 @@ 
 	     	phpCAS::error('an absolute path is needed for PGT storage to file');

       	}

       	

-      }

-      else

+      } else

       {

       

       	if ( $path[0] != '/' ) {

@@ -186,8 +189,9 @@ 
     {

       phpCAS::traceBegin();

       // if the storage has already been initialized, return immediatly

-      if ( $this->isInitialized() )

-	return;

+      if ( $this->isInitialized() ) {
+      	return;
+      }
       // call the ancestor's method (mark as initialized)

       parent::init();

       phpCAS::traceEnd();      

Indentation +181 added lines, -181 removed lines

@@ -44,231 +44,231 @@
 

 class PGTStorageFile extends PGTStorage

 {

-  /** 

-   * @addtogroup internalPGTStorageFile 

-   * @{ 

-   */

+    /** 

+     * @addtogroup internalPGTStorageFile 

+     * @{ 

+     */

 

-  /**

-   * a string telling where PGT's should be stored on the filesystem. Written by

-   * PGTStorageFile::PGTStorageFile(), read by getPath().

-   *

-   * @private

-   */

-  var $_path;

+    /**

+     * a string telling where PGT's should be stored on the filesystem. Written by

+     * PGTStorageFile::PGTStorageFile(), read by getPath().

+     *

+     * @private

+     */

+    var $_path;

 

-  /**

-   * This method returns the name of the directory where PGT's should be stored 

-   * on the filesystem.

-   *

-   * @return the name of a directory (with leading and trailing '/')

-   *

-   * @private

-   */

-  function getPath()

+    /**

+     * This method returns the name of the directory where PGT's should be stored 

+     * on the filesystem.

+     *

+     * @return the name of a directory (with leading and trailing '/')

+     *

+     * @private

+     */

+    function getPath()

     {

-      return $this->_path;

+        return $this->_path;

     }

 

-  /**

-   * a string telling the format to use to store PGT's (plain or xml). Written by

-   * PGTStorageFile::PGTStorageFile(), read by getFormat().

-   *

-   * @private

-   */

-  var $_format;

+    /**

+     * a string telling the format to use to store PGT's (plain or xml). Written by

+     * PGTStorageFile::PGTStorageFile(), read by getFormat().

+     *

+     * @private

+     */

+    var $_format;

 

-  /**

-   * This method returns the format to use when storing PGT's on the filesystem.

-   *

-   * @return a string corresponding to the format used (plain or xml).

-   *

-   * @private

-   */

-  function getFormat()

+    /**

+     * This method returns the format to use when storing PGT's on the filesystem.

+     *

+     * @return a string corresponding to the format used (plain or xml).

+     *

+     * @private

+     */

+    function getFormat()

     {

-      return $this->_format;

+        return $this->_format;

     }

 

-  // ########################################################################

-  //  DEBUGGING

-  // ########################################################################

+    // ########################################################################

+    //  DEBUGGING

+    // ########################################################################

   

-  /**

-   * This method returns an informational string giving the type of storage

-   * used by the object (used for debugging purposes).

-   *

-   * @return an informational string.

-   * @public

-   */

-  function getStorageType()

+    /**

+     * This method returns an informational string giving the type of storage

+     * used by the object (used for debugging purposes).

+     *

+     * @return an informational string.

+     * @public

+     */

+    function getStorageType()

     {

-      return "file";

+        return "file";

     }

 

-  /**

-   * This method returns an informational string giving informations on the

-   * parameters of the storage.(used for debugging purposes).

-   *

-   * @return an informational string.

-   * @public

-   */

-  function getStorageInfo()

+    /**

+     * This method returns an informational string giving informations on the

+     * parameters of the storage.(used for debugging purposes).

+     *

+     * @return an informational string.

+     * @public

+     */

+    function getStorageInfo()

     {

-      return 'path=`'.$this->getPath().'\', format=`'.$this->getFormat().'\'';

+        return 'path=`'.$this->getPath().'\', format=`'.$this->getFormat().'\'';

     }

 

-  // ########################################################################

-  //  CONSTRUCTOR

-  // ########################################################################

+    // ########################################################################

+    //  CONSTRUCTOR

+    // ########################################################################

   

-  /**

-   * The class constructor, called by CASClient::SetPGTStorageFile().

-   *

-   * @param $cas_parent the CASClient instance that creates the object.

-   * @param $format the format used to store the PGT's (`plain' and `xml' allowed).

-   * @param $path the path where the PGT's should be stored

-   *

-   * @public

-   */

-  function PGTStorageFile($cas_parent,$format,$path)

+    /**

+     * The class constructor, called by CASClient::SetPGTStorageFile().

+     *

+     * @param $cas_parent the CASClient instance that creates the object.

+     * @param $format the format used to store the PGT's (`plain' and `xml' allowed).

+     * @param $path the path where the PGT's should be stored

+     *

+     * @public

+     */

+    function PGTStorageFile($cas_parent,$format,$path)

     {

-      phpCAS::traceBegin();

-      // call the ancestor's constructor

-      $this->PGTStorage($cas_parent);

+        phpCAS::traceBegin();

+        // call the ancestor's constructor

+        $this->PGTStorage($cas_parent);

 

-      if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;

-      if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;

+        if (empty($format) ) $format = CAS_PGT_STORAGE_FILE_DEFAULT_FORMAT;

+        if (empty($path) ) $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;

 

-      // check that the path is an absolute path

-      if (getenv("OS")=="Windows_NT"){

+        // check that the path is an absolute path

+        if (getenv("OS")=="Windows_NT"){

       	

-      	 if (!preg_match('`^[a-zA-Z]:`', $path)) {

-	     	phpCAS::error('an absolute path is needed for PGT storage to file');

-      	}

+            if (!preg_match('`^[a-zA-Z]:`', $path)) {

+                phpCAS::error('an absolute path is needed for PGT storage to file');

+            }

       	

-      }

-      else

-      {

+        }

+        else

+        {

       

-      	if ( $path[0] != '/' ) {

-			phpCAS::error('an absolute path is needed for PGT storage to file');

-      	}

+            if ( $path[0] != '/' ) {

+            phpCAS::error('an absolute path is needed for PGT storage to file');

+            }

 

-      	// store the path (with a leading and trailing '/')      

-      	$path = preg_replace('|[/]*$|','/',$path);

-      	$path = preg_replace('|^[/]*|','/',$path);

-      }

+            // store the path (with a leading and trailing '/')      

+            $path = preg_replace('|[/]*$|','/',$path);

+            $path = preg_replace('|^[/]*|','/',$path);

+        }

       

-      $this->_path = $path;

-      // check the format and store it

-      switch ($format) {

-      case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:

+        $this->_path = $path;

+        // check the format and store it

+        switch ($format) {

+        case CAS_PGT_STORAGE_FILE_FORMAT_PLAIN:

       case CAS_PGT_STORAGE_FILE_FORMAT_XML:

-	$this->_format = $format;

-	break;

-      default:

-	phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');

-      }

-      phpCAS::traceEnd();      

+    $this->_format = $format;

+    break;

+        default:

+    phpCAS::error('unknown PGT file storage format (`'.CAS_PGT_STORAGE_FILE_FORMAT_PLAIN.'\' and `'.CAS_PGT_STORAGE_FILE_FORMAT_XML.'\' allowed)');

+        }

+        phpCAS::traceEnd();      

     }

 

-  // ########################################################################

-  //  INITIALIZATION

-  // ########################################################################

+    // ########################################################################

+    //  INITIALIZATION

+    // ########################################################################

   

-  /**

-   * This method is used to initialize the storage. Halts on error.

-   *

-   * @public

-   */

-  function init()

+    /**

+     * This method is used to initialize the storage. Halts on error.

+     *

+     * @public

+     */

+    function init()

     {

-      phpCAS::traceBegin();

-      // if the storage has already been initialized, return immediatly

-      if ( $this->isInitialized() )

-	return;

-      // call the ancestor's method (mark as initialized)

-      parent::init();

-      phpCAS::traceEnd();      

+        phpCAS::traceBegin();

+        // if the storage has already been initialized, return immediatly

+        if ( $this->isInitialized() )

+    return;

+        // call the ancestor's method (mark as initialized)

+        parent::init();

+        phpCAS::traceEnd();      

     }

 

-  // ########################################################################

-  //  PGT I/O

-  // ########################################################################

+    // ########################################################################

+    //  PGT I/O

+    // ########################################################################

 

-  /**

-   * This method returns the filename corresponding to a PGT Iou.

-   *

-   * @param $pgt_iou the PGT iou.

-   *

-   * @return a filename

-   * @private

-   */

-  function getPGTIouFilename($pgt_iou)

+    /**

+     * This method returns the filename corresponding to a PGT Iou.

+     *

+     * @param $pgt_iou the PGT iou.

+     *

+     * @return a filename

+     * @private

+     */

+    function getPGTIouFilename($pgt_iou)

     {

-      phpCAS::traceBegin();

-      $filename = $this->getPath().$pgt_iou.'.'.$this->getFormat();

-      phpCAS::traceEnd($filename);

-      return $filename;

+        phpCAS::traceBegin();

+        $filename = $this->getPath().$pgt_iou.'.'.$this->getFormat();

+        phpCAS::traceEnd($filename);

+        return $filename;

     }

   

-  /**

-   * This method stores a PGT and its corresponding PGT Iou into a file. Echoes a

-   * warning on error.

-   *

-   * @param $pgt the PGT

-   * @param $pgt_iou the PGT iou

-   *

-   * @public

-   */

-  function write($pgt,$pgt_iou)

+    /**

+     * This method stores a PGT and its corresponding PGT Iou into a file. Echoes a

+     * warning on error.

+     *

+     * @param $pgt the PGT

+     * @param $pgt_iou the PGT iou

+     *

+     * @public

+     */

+    function write($pgt,$pgt_iou)

     {

-      phpCAS::traceBegin();

-      $fname = $this->getPGTIouFilename($pgt_iou);

-      if ( $f=fopen($fname,"w") ) {

-	if ( fputs($f,$pgt) === FALSE ) {

-	  phpCAS::error('could not write PGT to `'.$fname.'\'');

-	}

-	fclose($f);

-      } else {

-	phpCAS::error('could not open `'.$fname.'\'');

-      }

-      phpCAS::traceEnd();      

+        phpCAS::traceBegin();

+        $fname = $this->getPGTIouFilename($pgt_iou);

+        if ( $f=fopen($fname,"w") ) {

+    if ( fputs($f,$pgt) === FALSE ) {

+        phpCAS::error('could not write PGT to `'.$fname.'\'');

+    }

+    fclose($f);

+        } else {

+    phpCAS::error('could not open `'.$fname.'\'');

+        }

+        phpCAS::traceEnd();      

     }

 

-  /**

-   * This method reads a PGT corresponding to a PGT Iou and deletes the 

-   * corresponding file.

-   *

-   * @param $pgt_iou the PGT iou

-   *

-   * @return the corresponding PGT, or FALSE on error

-   *

-   * @public

-   */

-  function read($pgt_iou)

+    /**

+     * This method reads a PGT corresponding to a PGT Iou and deletes the 

+     * corresponding file.

+     *

+     * @param $pgt_iou the PGT iou

+     *

+     * @return the corresponding PGT, or FALSE on error

+     *

+     * @public

+     */

+    function read($pgt_iou)

     {

-      phpCAS::traceBegin();

-      $pgt = FALSE;

-      $fname = $this->getPGTIouFilename($pgt_iou);

-      if ( !($f=fopen($fname,"r")) ) {

-	phpCAS::trace('could not open `'.$fname.'\'');

-      } else {

-	if ( ($pgt=fgets($f)) === FALSE ) {

-	  phpCAS::trace('could not read PGT from `'.$fname.'\'');

-	} 

-	fclose($f);

-      }

+        phpCAS::traceBegin();

+        $pgt = FALSE;

+        $fname = $this->getPGTIouFilename($pgt_iou);

+        if ( !($f=fopen($fname,"r")) ) {

+    phpCAS::trace('could not open `'.$fname.'\'');

+        } else {

+    if ( ($pgt=fgets($f)) === FALSE ) {

+        phpCAS::trace('could not read PGT from `'.$fname.'\'');

+    } 

+    fclose($f);

+        }

 

-      // delete the PGT file

-      @unlink($fname);

+        // delete the PGT file

+        @unlink($fname);

 

-      phpCAS::traceEnd($pgt);

-      return $pgt;

+        phpCAS::traceEnd($pgt);

+        return $pgt;

     }

   

-  /** @} */

+    /** @} */

   

 }

 

main/auth/cas/lib/CAS/PGTStorage/pgt-main.php

Doc Comments +2 added lines, -2 removed lines

@@ -126,7 +126,7 @@ 
   /**

    * This method returns an error message set by PGTStorage::setErrorMessage().

    *

-   * @return an error message when set by PGTStorage::setErrorMessage(), FALSE

+   * @return boolean error message when set by PGTStorage::setErrorMessage(), FALSE

    * otherwise.

    *

    * @public

@@ -153,7 +153,7 @@ 
   /**

    * This method tells if the storage has already been intialized.

    *

-   * @return a boolean

+   * @return boolean boolean

    *

    * @protected

    */

Indentation +131 added lines, -131 removed lines

@@ -44,167 +44,167 @@
 

 class PGTStorage

 {

-  /** 

-   * @addtogroup internalPGTStorage

-   * @{ 

-   */

-

-  // ########################################################################

-  //  CONSTRUCTOR

-  // ########################################################################

+    /** 

+     * @addtogroup internalPGTStorage

+     * @{ 

+     */

+

+    // ########################################################################

+    //  CONSTRUCTOR

+    // ########################################################################

   

-  /**

-   * The constructor of the class, should be called only by inherited classes.

-   *

-   * @param $cas_parent the CASclient instance that creates the current object.

-   *

-   * @protected

-   */

-  function PGTStorage($cas_parent)

+    /**

+     * The constructor of the class, should be called only by inherited classes.

+     *

+     * @param $cas_parent the CASclient instance that creates the current object.

+     *

+     * @protected

+     */

+    function PGTStorage($cas_parent)

     {

-      phpCAS::traceBegin();

-      if ( !$cas_parent->isProxy() ) {

-	phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 

-      }

-      phpCAS::traceEnd();

+        phpCAS::traceBegin();

+        if ( !$cas_parent->isProxy() ) {

+    phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 

+        }

+        phpCAS::traceEnd();

     }

 

-  // ########################################################################

-  //  DEBUGGING

-  // ########################################################################

+    // ########################################################################

+    //  DEBUGGING

+    // ########################################################################

   

-  /**

-   * This virtual method returns an informational string giving the type of storage

-   * used by the object (used for debugging purposes).

-   *

-   * @public

-   */

-  function getStorageType()

+    /**

+     * This virtual method returns an informational string giving the type of storage

+     * used by the object (used for debugging purposes).

+     *

+     * @public

+     */

+    function getStorageType()

     {

-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

     }

 

-  /**

-   * This virtual method returns an informational string giving informations on the

-   * parameters of the storage.(used for debugging purposes).

-   *

-   * @public

-   */

-  function getStorageInfo()

+    /**

+     * This virtual method returns an informational string giving informations on the

+     * parameters of the storage.(used for debugging purposes).

+     *

+     * @public

+     */

+    function getStorageInfo()

     {

-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

     }

 

-  // ########################################################################

-  //  ERROR HANDLING

-  // ########################################################################

+    // ########################################################################

+    //  ERROR HANDLING

+    // ########################################################################

   

-  /**

-   * string used to store an error message. Written by PGTStorage::setErrorMessage(),

-   * read by PGTStorage::getErrorMessage().

-   *

-   * @hideinitializer

-   * @private

-   * @deprecated not used.

-   */

-  var $_error_message=FALSE;

-

-  /**

-   * This method sets en error message, which can be read later by 

-   * PGTStorage::getErrorMessage().

-   *

-   * @param $error_message an error message

-   *

-   * @protected

-   * @deprecated not used.

-   */

-  function setErrorMessage($error_message)

+    /**

+     * string used to store an error message. Written by PGTStorage::setErrorMessage(),

+     * read by PGTStorage::getErrorMessage().

+     *

+     * @hideinitializer

+     * @private

+     * @deprecated not used.

+     */

+    var $_error_message=FALSE;

+

+    /**

+     * This method sets en error message, which can be read later by 

+     * PGTStorage::getErrorMessage().

+     *

+     * @param $error_message an error message

+     *

+     * @protected

+     * @deprecated not used.

+     */

+    function setErrorMessage($error_message)

     {

-      $this->_error_message = $error_message;

+        $this->_error_message = $error_message;

     }

 

-  /**

-   * This method returns an error message set by PGTStorage::setErrorMessage().

-   *

-   * @return an error message when set by PGTStorage::setErrorMessage(), FALSE

-   * otherwise.

-   *

-   * @public

-   * @deprecated not used.

-   */

-  function getErrorMessage()

+    /**

+     * This method returns an error message set by PGTStorage::setErrorMessage().

+     *

+     * @return an error message when set by PGTStorage::setErrorMessage(), FALSE

+     * otherwise.

+     *

+     * @public

+     * @deprecated not used.

+     */

+    function getErrorMessage()

     {

-      return $this->_error_message;

+        return $this->_error_message;

     }

 

-  // ########################################################################

-  //  INITIALIZATION

-  // ########################################################################

-

-  /**

-   * a boolean telling if the storage has already been initialized. Written by 

-   * PGTStorage::init(), read by PGTStorage::isInitialized().

-   *

-   * @hideinitializer

-   * @private

-   */

-  var $_initialized = FALSE;

-

-  /**

-   * This method tells if the storage has already been intialized.

-   *

-   * @return a boolean

-   *

-   * @protected

-   */

-  function isInitialized()

+    // ########################################################################

+    //  INITIALIZATION

+    // ########################################################################

+

+    /**

+     * a boolean telling if the storage has already been initialized. Written by 

+     * PGTStorage::init(), read by PGTStorage::isInitialized().

+     *

+     * @hideinitializer

+     * @private

+     */

+    var $_initialized = FALSE;

+

+    /**

+     * This method tells if the storage has already been intialized.

+     *

+     * @return a boolean

+     *

+     * @protected

+     */

+    function isInitialized()

     {

-      return $this->_initialized;

+        return $this->_initialized;

     }

 

-  /**

-   * This virtual method initializes the object.

-   *

-   * @protected

-   */

-  function init()

+    /**

+     * This virtual method initializes the object.

+     *

+     * @protected

+     */

+    function init()

     {

-      $this->_initialized = TRUE;

+        $this->_initialized = TRUE;

     }

 

-  // ########################################################################

-  //  PGT I/O

-  // ########################################################################

-

-  /**

-   * This virtual method stores a PGT and its corresponding PGT Iuo.

-   * @note Should never be called.

-   *

-   * @param $pgt the PGT

-   * @param $pgt_iou the PGT iou

-   *

-   * @protected

-   */

-  function write($pgt,$pgt_iou)

+    // ########################################################################

+    //  PGT I/O

+    // ########################################################################

+

+    /**

+     * This virtual method stores a PGT and its corresponding PGT Iuo.

+     * @note Should never be called.

+     *

+     * @param $pgt the PGT

+     * @param $pgt_iou the PGT iou

+     *

+     * @protected

+     */

+    function write($pgt,$pgt_iou)

     {

-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

     }

 

-  /**

-   * This virtual method reads a PGT corresponding to a PGT Iou and deletes

-   * the corresponding storage entry.

-   * @note Should never be called.

-   *

-   * @param $pgt_iou the PGT iou

-   *

-   * @protected

-   */

-  function read($pgt_iou)

+    /**

+     * This virtual method reads a PGT corresponding to a PGT Iou and deletes

+     * the corresponding storage entry.

+     * @note Should never be called.

+     *

+     * @param $pgt_iou the PGT iou

+     *

+     * @protected

+     */

+    function read($pgt_iou)

     {

-      phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

+        phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

     }

 

-  /** @} */

+    /** @} */

   

 } 

 

Spacing +3 added lines, -3 removed lines

@@ -63,7 +63,7 @@ 
   function PGTStorage($cas_parent)

     {

       phpCAS::traceBegin();

-      if ( !$cas_parent->isProxy() ) {

+      if (!$cas_parent->isProxy()) {

 	phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy'); 

       }

       phpCAS::traceEnd();

@@ -107,7 +107,7 @@ 
    * @private

    * @deprecated not used.

    */

-  var $_error_message=FALSE;

+  var $_error_message = FALSE;

 

   /**

    * This method sets en error message, which can be read later by 

@@ -185,7 +185,7 @@ 
    *

    * @protected

    */

-  function write($pgt,$pgt_iou)

+  function write($pgt, $pgt_iou)

     {

       phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called'); 

     }

main/auth/courses_controller.php

Doc Comments +2 added lines, -1 removed lines

@@ -33,6 +33,7 @@ 
      * render to courses_list view
      * @param string   	action
      * @param string    confirmation message(optional)
+     * @param string $action
      */
     public function courses_list($action, $message = '')
     {
@@ -79,7 +80,7 @@ 
     /**
      * It's used for listing courses with categories,
      * render to courses_categories view
-     * @param $action
+     * @param string $action
      * @param string $category_code
      * @param string $message
      * @param string $error

Spacing +17 added lines, -18 removed lines

@@ -61,7 +61,7 @@ 
      * @param string   $message confirmation message(optional)
      * @param string   $error error message(optional)
      */
-    public function categories_list($action, $message='', $error='')
+    public function categories_list($action, $message = '', $error = '')
     {
         $data = array();
         $data['user_course_categories'] = $this->model->get_user_course_categories();
@@ -116,7 +116,7 @@ 
 
         // we need only the course codes as these will be used to match against the courses of the category
         if ($user_courses != '') {
-            foreach($user_courses as $key => $value) {
+            foreach ($user_courses as $key => $value) {
                 $user_coursecodes[] = $value['code'];
             }
         }
@@ -385,13 +385,13 @@ 
                     $html .= '</strong>';
                 } else {
                     if (!empty($categoryCourses)) {
-                        $html .= '<a href="' . getCourseCategoryUrl(
+                        $html .= '<a href="'.getCourseCategoryUrl(
                                 1,
                                 $limit['length'],
                                 $categoryCode,
                                 $hiddenLinks,
                                 $action
-                            ) . '">';
+                            ).'">';
                         $html .= "$categoryName ($categoryCourses)";
                         $html .= '</a>';
                     } else {
@@ -412,13 +412,13 @@ 
                         if ($code == $subCategory1Code) {
                             $html .= "<strong>$subCategory1Name ($subCategory1Courses)</strong>";
                         } else {
-                            $html .= '<a href="' . getCourseCategoryUrl(
+                            $html .= '<a href="'.getCourseCategoryUrl(
                                     1,
                                     $limit['length'],
                                     $categoryCode,
                                     $hiddenLinks,
                                     $action
-                                ) . '">';
+                                ).'">';
                             $html .= "$subCategory1Name ($subCategory1Courses)";
                             $html .= '</a>';
                         }
@@ -436,13 +436,13 @@ 
                                 if ($code == $subCategory2Code) {
                                     $html .= "<strong>$subCategory2Name ($subCategory2Courses)</strong>";
                                 } else {
-                                    $html .= '<a href="' . getCourseCategoryUrl(
+                                    $html .= '<a href="'.getCourseCategoryUrl(
                                             1,
                                             $limit['length'],
                                             $categoryCode,
                                             $hiddenLinks,
                                             $action
-                                        ) . '">';
+                                        ).'">';
                                     $html .= "$subCategory2Name ($subCategory2Courses)";
                                     $html .= '</a>';
                                 }
@@ -460,13 +460,13 @@ 
                                         if ($code == $subCategory3Code) {
                                             $html .= "<strong>$subCategory3Name ($subCategory3Courses)</strong>";
                                         } else {
-                                            $html .= '<a href="' . getCourseCategoryUrl(
+                                            $html .= '<a href="'.getCourseCategoryUrl(
                                                     1,
                                                     $limit['length'],
                                                     $categoryCode,
                                                     $hiddenLinks,
                                                     $action
-                                                ) . '">';
+                                                ).'">';
                                             $html .= "$subCategory3Name ($subCategory3Courses)";
                                             $html .= '</a>';
                                         }
@@ -593,7 +593,7 @@ 
         $icon = '<em class="fa fa-smile-o"></em>';
 
         return Display::div(
-            $icon . ' ' . get_lang("AlreadyRegisteredToSession"),
+            $icon.' '.get_lang("AlreadyRegisteredToSession"),
             array('class' => 'info-catalog')
         );
     }
@@ -605,7 +605,7 @@ 
      */
     public function getSessionIcon($sessionName)
     {
-        return Display::return_icon('window_list.png', $sessionName, null,ICON_SIZE_MEDIUM);
+        return Display::return_icon('window_list.png', $sessionName, null, ICON_SIZE_MEDIUM);
     }
 
     /**
@@ -626,8 +626,7 @@ 
         $pageTotal = intval(ceil(intval($countSessions) / $limit['length']));
         // Do NOT show pagination if only one page or less
         $cataloguePagination = $pageTotal > 1 ?
-            getCataloguePagination($limit['current'], $limit['length'], $pageTotal) :
-            '';
+            getCataloguePagination($limit['current'], $limit['length'], $pageTotal) : '';
         $sessionsBlocks = $this->getFormatedSessionsBlock($sessions);
 
         // Get session list catalogue URL
@@ -638,13 +637,13 @@ 
         $tpl = new Template();
         $tpl->assign('show_courses', CoursesAndSessionsCatalog::showCourses());
         $tpl->assign('show_sessions', CoursesAndSessionsCatalog::showSessions());
-        $tpl->assign('show_tutor', (api_get_setting('show_session_coach')==='true' ? true : false));
+        $tpl->assign('show_tutor', (api_get_setting('show_session_coach') === 'true' ? true : false));
         $tpl->assign('course_url', $courseUrl);
         $tpl->assign('catalog_pagination', $cataloguePagination);
         $tpl->assign('hidden_links', $hiddenLinks);
         $tpl->assign('search_token', Security::get_token());
         $tpl->assign('search_date', $date);
-        $tpl->assign('web_session_courses_ajax_url', api_get_path(WEB_AJAX_PATH) . 'course.ajax.php');
+        $tpl->assign('web_session_courses_ajax_url', api_get_path(WEB_AJAX_PATH).'course.ajax.php');
         $tpl->assign('sessions', $sessionsBlocks);
         $tpl->assign('already_subscribed_label', $this->getAlreadyRegisteredInSessionLabel());
 
@@ -671,7 +670,7 @@ 
 
         $tpl->assign('show_courses', CoursesAndSessionsCatalog::showCourses());
         $tpl->assign('show_sessions', CoursesAndSessionsCatalog::showSessions());
-        $tpl->assign('show_tutor', (api_get_setting('show_session_coach')==='true' ? true : false));
+        $tpl->assign('show_tutor', (api_get_setting('show_session_coach') === 'true' ? true : false));
         $tpl->assign('course_url', $courseUrl);
         $tpl->assign('already_subscribed_label', $this->getAlreadyRegisteredInSessionLabel());
         $tpl->assign('hidden_links', $hiddenLinks);
@@ -702,7 +701,7 @@ 
         $tpl = new Template();
         $tpl->assign('show_courses', CoursesAndSessionsCatalog::showCourses());
         $tpl->assign('show_sessions', CoursesAndSessionsCatalog::showSessions());
-        $tpl->assign('show_tutor', (api_get_setting('show_session_coach')==='true' ? true : false));
+        $tpl->assign('show_tutor', (api_get_setting('show_session_coach') === 'true' ? true : false));
         $tpl->assign('course_url', $courseUrl);
         $tpl->assign('already_subscribed_label', $this->getAlreadyRegisteredInSessionLabel());
         $tpl->assign('hidden_links', $hiddenLinks);

main/auth/external_login/facebook-php-sdk/src/Facebook/Entities/AccessToken.php

Doc Comments +4 added lines, -3 removed lines

@@ -62,6 +62,7 @@ 
    * @param string $accessToken
    * @param int $expiresAt
    * @param string|null machineId
+   * @param string $machineId
    */
   public function __construct($accessToken, $expiresAt = 0, $machineId = null)
   {
@@ -97,7 +98,7 @@ 
   /**
    * Getter for machineId.
    *
-   * @return string|null
+   * @return string
    */
   public function getMachineId()
   {
@@ -191,11 +192,11 @@ 
   /**
    * Get a valid code from an access token.
    *
-   * @param AccessToken|string $accessToken
+   * @param AccessToken $accessToken
    * @param string|null $appId
    * @param string|null $appSecret
    *
-   * @return AccessToken
+   * @return string
    */
   public static function getCodeFromAccessToken($accessToken, $appId = null, $appSecret = null)
   {

Indentation +245 added lines, -245 removed lines

@@ -35,119 +35,119 @@ 
 class AccessToken
 {
 
-  /**
-   * The access token.
-   *
-   * @var string
-   */
-  protected $accessToken;
-
-  /**
-   * A unique ID to identify a client.
-   *
-   * @var string
-   */
-  protected $machineId;
-
-  /**
-   * Date when token expires.
-   *
-   * @var \DateTime|null
-   */
-  protected $expiresAt;
-
-  /**
-   * Create a new access token entity.
-   *
-   * @param string $accessToken
-   * @param int $expiresAt
-   * @param string|null machineId
-   */
-  public function __construct($accessToken, $expiresAt = 0, $machineId = null)
-  {
+    /**
+     * The access token.
+     *
+     * @var string
+     */
+    protected $accessToken;
+
+    /**
+     * A unique ID to identify a client.
+     *
+     * @var string
+     */
+    protected $machineId;
+
+    /**
+     * Date when token expires.
+     *
+     * @var \DateTime|null
+     */
+    protected $expiresAt;
+
+    /**
+     * Create a new access token entity.
+     *
+     * @param string $accessToken
+     * @param int $expiresAt
+     * @param string|null machineId
+     */
+    public function __construct($accessToken, $expiresAt = 0, $machineId = null)
+    {
     $this->accessToken = $accessToken;
     if ($expiresAt) {
-      $this->setExpiresAtFromTimeStamp($expiresAt);
+        $this->setExpiresAtFromTimeStamp($expiresAt);
     }
     $this->machineId = $machineId;
-  }
-
-  /**
-   * Setter for expires_at.
-   *
-   * @param int $timeStamp
-   */
-  protected function setExpiresAtFromTimeStamp($timeStamp)
-  {
+    }
+
+    /**
+     * Setter for expires_at.
+     *
+     * @param int $timeStamp
+     */
+    protected function setExpiresAtFromTimeStamp($timeStamp)
+    {
     $dt = new \DateTime();
     $dt->setTimestamp($timeStamp);
     $this->expiresAt = $dt;
-  }
-
-  /**
-   * Getter for expiresAt.
-   *
-   * @return \DateTime|null
-   */
-  public function getExpiresAt()
-  {
+    }
+
+    /**
+     * Getter for expiresAt.
+     *
+     * @return \DateTime|null
+     */
+    public function getExpiresAt()
+    {
     return $this->expiresAt;
-  }
-
-  /**
-   * Getter for machineId.
-   *
-   * @return string|null
-   */
-  public function getMachineId()
-  {
+    }
+
+    /**
+     * Getter for machineId.
+     *
+     * @return string|null
+     */
+    public function getMachineId()
+    {
     return $this->machineId;
-  }
-
-  /**
-   * Determines whether or not this is a long-lived token.
-   *
-   * @return bool
-   */
-  public function isLongLived()
-  {
+    }
+
+    /**
+     * Determines whether or not this is a long-lived token.
+     *
+     * @return bool
+     */
+    public function isLongLived()
+    {
     if ($this->expiresAt) {
-      return $this->expiresAt->getTimestamp() > time() + (60 * 60 * 2);
+        return $this->expiresAt->getTimestamp() > time() + (60 * 60 * 2);
     }
     return false;
-  }
-
-  /**
-   * Checks the validity of the access token.
-   *
-   * @param string|null $appId Application ID to use
-   * @param string|null $appSecret App secret value to use
-   * @param string|null $machineId
-   *
-   * @return boolean
-   */
-  public function isValid($appId = null, $appSecret = null, $machineId = null)
-  {
+    }
+
+    /**
+     * Checks the validity of the access token.
+     *
+     * @param string|null $appId Application ID to use
+     * @param string|null $appSecret App secret value to use
+     * @param string|null $machineId
+     *
+     * @return boolean
+     */
+    public function isValid($appId = null, $appSecret = null, $machineId = null)
+    {
     $accessTokenInfo = $this->getInfo($appId, $appSecret);
     $machineId = $machineId ?: $this->machineId;
     return static::validateAccessToken($accessTokenInfo, $appId, $machineId);
-  }
-
-  /**
-   * Ensures the provided GraphSessionInfo object is valid,
-   *   throwing an exception if not.  Ensures the appId matches,
-   *   that the machineId matches if it's being used,
-   *   that the token is valid and has not expired.
-   *
-   * @param GraphSessionInfo $tokenInfo
-   * @param string|null $appId Application ID to use
-   * @param string|null $machineId
-   *
-   * @return boolean
-   */
-  public static function validateAccessToken(GraphSessionInfo $tokenInfo,
-                                             $appId = null, $machineId = null)
-  {
+    }
+
+    /**
+     * Ensures the provided GraphSessionInfo object is valid,
+     *   throwing an exception if not.  Ensures the appId matches,
+     *   that the machineId matches if it's being used,
+     *   that the token is valid and has not expired.
+     *
+     * @param GraphSessionInfo $tokenInfo
+     * @param string|null $appId Application ID to use
+     * @param string|null $machineId
+     *
+     * @return boolean
+     */
+    public static function validateAccessToken(GraphSessionInfo $tokenInfo,
+                                                $appId = null, $machineId = null)
+    {
     $targetAppId = FacebookSession::_getTargetAppId($appId);
 
     $appIdIsValid = $tokenInfo->getAppId() == $targetAppId;
@@ -156,90 +156,90 @@ 
 
     // Not all access tokens return an expiration. E.g. an app access token.
     if ($tokenInfo->getExpiresAt() instanceof \DateTime) {
-      $accessTokenIsStillAlive = $tokenInfo->getExpiresAt()->getTimestamp() >= time();
+        $accessTokenIsStillAlive = $tokenInfo->getExpiresAt()->getTimestamp() >= time();
     } else {
-      $accessTokenIsStillAlive = true;
+        $accessTokenIsStillAlive = true;
     }
 
     return $appIdIsValid && $machineIdIsValid && $accessTokenIsValid && $accessTokenIsStillAlive;
-  }
-
-  /**
-   * Get a valid access token from a code.
-   *
-   * @param string $code
-   * @param string|null $appId
-   * @param string|null $appSecret
-   * @param string|null $machineId
-   *
-   * @return AccessToken
-   */
-  public static function getAccessTokenFromCode($code, $appId = null, $appSecret = null, $machineId = null)
-  {
+    }
+
+    /**
+     * Get a valid access token from a code.
+     *
+     * @param string $code
+     * @param string|null $appId
+     * @param string|null $appSecret
+     * @param string|null $machineId
+     *
+     * @return AccessToken
+     */
+    public static function getAccessTokenFromCode($code, $appId = null, $appSecret = null, $machineId = null)
+    {
     $params = array(
-      'code' => $code,
-      'redirect_uri' => '',
+        'code' => $code,
+        'redirect_uri' => '',
     );
 
     if ($machineId) {
-      $params['machine_id'] = $machineId;
+        $params['machine_id'] = $machineId;
     }
 
     return static::requestAccessToken($params, $appId, $appSecret);
-  }
-
-  /**
-   * Get a valid code from an access token.
-   *
-   * @param AccessToken|string $accessToken
-   * @param string|null $appId
-   * @param string|null $appSecret
-   *
-   * @return AccessToken
-   */
-  public static function getCodeFromAccessToken($accessToken, $appId = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Get a valid code from an access token.
+     *
+     * @param AccessToken|string $accessToken
+     * @param string|null $appId
+     * @param string|null $appSecret
+     *
+     * @return AccessToken
+     */
+    public static function getCodeFromAccessToken($accessToken, $appId = null, $appSecret = null)
+    {
     $accessToken = (string) $accessToken;
 
     $params = array(
-      'access_token' => $accessToken,
-      'redirect_uri' => '',
+        'access_token' => $accessToken,
+        'redirect_uri' => '',
     );
 
     return static::requestCode($params, $appId, $appSecret);
-  }
-
-  /**
-   * Exchanges a short lived access token with a long lived access token.
-   *
-   * @param string|null $appId
-   * @param string|null $appSecret
-   *
-   * @return AccessToken
-   */
-  public function extend($appId = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Exchanges a short lived access token with a long lived access token.
+     *
+     * @param string|null $appId
+     * @param string|null $appSecret
+     *
+     * @return AccessToken
+     */
+    public function extend($appId = null, $appSecret = null)
+    {
     $params = array(
-      'grant_type' => 'fb_exchange_token',
-      'fb_exchange_token' => $this->accessToken,
+        'grant_type' => 'fb_exchange_token',
+        'fb_exchange_token' => $this->accessToken,
     );
 
     return static::requestAccessToken($params, $appId, $appSecret);
-  }
-
-  /**
-   * Request an access token based on a set of params.
-   *
-   * @param array $params
-   * @param string|null $appId
-   * @param string|null $appSecret
-   *
-   * @return AccessToken
-   *
-   * @throws FacebookRequestException
-   */
-  public static function requestAccessToken(array $params, $appId = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Request an access token based on a set of params.
+     *
+     * @param array $params
+     * @param string|null $appId
+     * @param string|null $appSecret
+     *
+     * @return AccessToken
+     *
+     * @throws FacebookRequestException
+     */
+    public static function requestAccessToken(array $params, $appId = null, $appSecret = null)
+    {
     $response = static::request('/oauth/access_token', $params, $appId, $appSecret);
     $data = $response->getResponse();
 
@@ -248,133 +248,133 @@ 
      * @see https://github.com/facebook/facebook-php-sdk-v4/issues/36
      */
     if (is_array($data)) {
-      if (isset($data['access_token'])) {
+        if (isset($data['access_token'])) {
         $expiresAt = isset($data['expires']) ? time() + $data['expires'] : 0;
         return new static($data['access_token'], $expiresAt);
-      }
+        }
     } elseif($data instanceof \stdClass) {
-      if (isset($data->access_token)) {
+        if (isset($data->access_token)) {
         $expiresAt = isset($data->expires_in) ? time() + $data->expires_in : 0;
         $machineId = isset($data->machine_id) ? (string) $data->machine_id : null;
         return new static((string) $data->access_token, $expiresAt, $machineId);
-      }
+        }
     }
 
     throw FacebookRequestException::create(
-      $response->getRawResponse(),
-      $data,
-      401
+        $response->getRawResponse(),
+        $data,
+        401
     );
-  }
-
-  /**
-   * Request a code from a long lived access token.
-   *
-   * @param array $params
-   * @param string|null $appId
-   * @param string|null $appSecret
-   *
-   * @return string
-   *
-   * @throws FacebookRequestException
-   */
-  public static function requestCode(array $params, $appId = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Request a code from a long lived access token.
+     *
+     * @param array $params
+     * @param string|null $appId
+     * @param string|null $appSecret
+     *
+     * @return string
+     *
+     * @throws FacebookRequestException
+     */
+    public static function requestCode(array $params, $appId = null, $appSecret = null)
+    {
     $response = static::request('/oauth/client_code', $params, $appId, $appSecret);
     $data = $response->getResponse();
 
     if (isset($data->code)) {
-      return (string) $data->code;
+        return (string) $data->code;
     }
 
     throw FacebookRequestException::create(
-      $response->getRawResponse(),
-      $data,
-      401
+        $response->getRawResponse(),
+        $data,
+        401
     );
-  }
-
-  /**
-   * Send a request to Graph with an app access token.
-   *
-   * @param string $endpoint
-   * @param array $params
-   * @param string|null $appId
-   * @param string|null $appSecret
-   *
-   * @return \Facebook\FacebookResponse
-   *
-   * @throws FacebookRequestException
-   */
-  protected static function request($endpoint, array $params, $appId = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Send a request to Graph with an app access token.
+     *
+     * @param string $endpoint
+     * @param array $params
+     * @param string|null $appId
+     * @param string|null $appSecret
+     *
+     * @return \Facebook\FacebookResponse
+     *
+     * @throws FacebookRequestException
+     */
+    protected static function request($endpoint, array $params, $appId = null, $appSecret = null)
+    {
     $targetAppId = FacebookSession::_getTargetAppId($appId);
     $targetAppSecret = FacebookSession::_getTargetAppSecret($appSecret);
 
     if (!isset($params['client_id'])) {
-      $params['client_id'] = $targetAppId;
+        $params['client_id'] = $targetAppId;
     }
     if (!isset($params['client_secret'])) {
-      $params['client_secret'] = $targetAppSecret;
+        $params['client_secret'] = $targetAppSecret;
     }
 
     // The response for this endpoint is not JSON, so it must be handled
     //   differently, not as a GraphObject.
     $request = new FacebookRequest(
-      FacebookSession::newAppSession($targetAppId, $targetAppSecret),
-      'GET',
-      $endpoint,
-      $params
+        FacebookSession::newAppSession($targetAppId, $targetAppSecret),
+        'GET',
+        $endpoint,
+        $params
     );
     return $request->execute();
-  }
-
-  /**
-   * Get more info about an access token.
-   *
-   * @param string|null $appId
-   * @param string|null $appSecret
-   *
-   * @return GraphSessionInfo
-   */
-  public function getInfo($appId = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Get more info about an access token.
+     *
+     * @param string|null $appId
+     * @param string|null $appSecret
+     *
+     * @return GraphSessionInfo
+     */
+    public function getInfo($appId = null, $appSecret = null)
+    {
     $params = array('input_token' => $this->accessToken);
 
     $request = new FacebookRequest(
-      FacebookSession::newAppSession($appId, $appSecret),
-      'GET',
-      '/debug_token',
-      $params
+        FacebookSession::newAppSession($appId, $appSecret),
+        'GET',
+        '/debug_token',
+        $params
     );
     $response = $request->execute()->getGraphObject(GraphSessionInfo::className());
 
     // Update the data on this token
     if ($response->getExpiresAt()) {
-      $this->expiresAt = $response->getExpiresAt();
+        $this->expiresAt = $response->getExpiresAt();
     }
 
     return $response;
-  }
-
-  /**
-   * Returns the access token as a string.
-   *
-   * @return string
-   */
-  public function __toString()
-  {
+    }
+
+    /**
+     * Returns the access token as a string.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
     return $this->accessToken;
-  }
-
-  /**
-   * Returns true if the access token is an app session token.
-   *
-   * @return bool
-   */
-  public function isAppSession()
-  {
+    }
+
+    /**
+     * Returns true if the access token is an app session token.
+     *
+     * @return bool
+     */
+    public function isAppSession()
+    {
     return strpos($this->accessToken, "|") !== false;
-  }
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
         $expiresAt = isset($data['expires']) ? time() + $data['expires'] : 0;
         return new static($data['access_token'], $expiresAt);
       }
-    } elseif($data instanceof \stdClass) {
+    } elseif ($data instanceof \stdClass) {
       if (isset($data->access_token)) {
         $expiresAt = isset($data->expires_in) ? time() + $data->expires_in : 0;
         $machineId = isset($data->machine_id) ? (string) $data->machine_id : null;

main/auth/external_login/facebook-php-sdk/src/Facebook/Entities/SignedRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,7 +63,7 @@ 
   /**
    * Returns the raw signed request data.
    *
-   * @return string|null
+   * @return string
    */
   public function getRawSignedRequest()
   {
@@ -84,7 +84,7 @@ 
    * Returns a property from the signed request data if available.
    *
    * @param string $key
-   * @param mixed|null $default
+   * @param integer $default
    *
    * @return mixed|null
    */

Indentation +255 added lines, -255 removed lines

@@ -33,99 +33,99 @@ 
 class SignedRequest
 {
 
-  /**
-   * @var string
-   */
-  public $rawSignedRequest;
-
-  /**
-   * @var array
-   */
-  public $payload;
-
-  /**
-   * Instantiate a new SignedRequest entity.
-   *
-   * @param string|null $rawSignedRequest The raw signed request.
-   * @param string|null $state random string to prevent CSRF.
-   * @param string|null $appSecret
-   */
-  public function __construct($rawSignedRequest = null, $state = null, $appSecret = null)
-  {
+    /**
+     * @var string
+     */
+    public $rawSignedRequest;
+
+    /**
+     * @var array
+     */
+    public $payload;
+
+    /**
+     * Instantiate a new SignedRequest entity.
+     *
+     * @param string|null $rawSignedRequest The raw signed request.
+     * @param string|null $state random string to prevent CSRF.
+     * @param string|null $appSecret
+     */
+    public function __construct($rawSignedRequest = null, $state = null, $appSecret = null)
+    {
     if (!$rawSignedRequest) {
-      return;
+        return;
     }
 
     $this->rawSignedRequest = $rawSignedRequest;
     $this->payload = static::parse($rawSignedRequest, $state, $appSecret);
-  }
-
-  /**
-   * Returns the raw signed request data.
-   *
-   * @return string|null
-   */
-  public function getRawSignedRequest()
-  {
+    }
+
+    /**
+     * Returns the raw signed request data.
+     *
+     * @return string|null
+     */
+    public function getRawSignedRequest()
+    {
     return $this->rawSignedRequest;
-  }
-
-  /**
-   * Returns the parsed signed request data.
-   *
-   * @return array|null
-   */
-  public function getPayload()
-  {
+    }
+
+    /**
+     * Returns the parsed signed request data.
+     *
+     * @return array|null
+     */
+    public function getPayload()
+    {
     return $this->payload;
-  }
-
-  /**
-   * Returns a property from the signed request data if available.
-   *
-   * @param string $key
-   * @param mixed|null $default
-   *
-   * @return mixed|null
-   */
-  public function get($key, $default = null)
-  {
+    }
+
+    /**
+     * Returns a property from the signed request data if available.
+     *
+     * @param string $key
+     * @param mixed|null $default
+     *
+     * @return mixed|null
+     */
+    public function get($key, $default = null)
+    {
     if (isset($this->payload[$key])) {
-      return $this->payload[$key];
+        return $this->payload[$key];
     }
     return $default;
-  }
-
-  /**
-   * Returns user_id from signed request data if available.
-   *
-   * @return string|null
-   */
-  public function getUserId()
-  {
+    }
+
+    /**
+     * Returns user_id from signed request data if available.
+     *
+     * @return string|null
+     */
+    public function getUserId()
+    {
     return $this->get('user_id');
-  }
-
-  /**
-   * Checks for OAuth data in the payload.
-   *
-   * @return boolean
-   */
-  public function hasOAuthData()
-  {
+    }
+
+    /**
+     * Checks for OAuth data in the payload.
+     *
+     * @return boolean
+     */
+    public function hasOAuthData()
+    {
     return isset($this->payload['oauth_token']) || isset($this->payload['code']);
-  }
-
-  /**
-   * Creates a signed request from an array of data.
-   *
-   * @param array $payload
-   * @param string|null $appSecret
-   *
-   * @return string
-   */
-  public static function make(array $payload, $appSecret = null)
-  {
+    }
+
+    /**
+     * Creates a signed request from an array of data.
+     *
+     * @param array $payload
+     * @param string|null $appSecret
+     *
+     * @return string
+     */
+    public static function make(array $payload, $appSecret = null)
+    {
     $payload['algorithm'] = 'HMAC-SHA256';
     $payload['issued_at'] = time();
     $encodedPayload = static::base64UrlEncode(json_encode($payload));
@@ -134,20 +134,20 @@ 
     $encodedSig = static::base64UrlEncode($hashedSig);
 
     return $encodedSig.'.'.$encodedPayload;
-  }
-
-  /**
-   * Validates and decodes a signed request and returns
-   * the payload as an array.
-   *
-   * @param string $signedRequest
-   * @param string|null $state
-   * @param string|null $appSecret
-   *
-   * @return array
-   */
-  public static function parse($signedRequest, $state = null, $appSecret = null)
-  {
+    }
+
+    /**
+     * Validates and decodes a signed request and returns
+     * the payload as an array.
+     *
+     * @param string $signedRequest
+     * @param string|null $state
+     * @param string|null $appSecret
+     *
+     * @return array
+     */
+    public static function parse($signedRequest, $state = null, $appSecret = null)
+    {
     list($encodedSig, $encodedPayload) = static::split($signedRequest);
 
     // Signature validation
@@ -159,228 +159,228 @@ 
     $data = static::decodePayload($encodedPayload);
     static::validateAlgorithm($data);
     if ($state) {
-      static::validateCsrf($data, $state);
+        static::validateCsrf($data, $state);
     }
 
     return $data;
-  }
-
-  /**
-   * Validates the format of a signed request.
-   *
-   * @param string $signedRequest
-   *
-   * @throws FacebookSDKException
-   */
-  public static function validateFormat($signedRequest)
-  {
+    }
+
+    /**
+     * Validates the format of a signed request.
+     *
+     * @param string $signedRequest
+     *
+     * @throws FacebookSDKException
+     */
+    public static function validateFormat($signedRequest)
+    {
     if (strpos($signedRequest, '.') !== false) {
-      return;
+        return;
     }
 
     throw new FacebookSDKException(
-      'Malformed signed request.', 606
+        'Malformed signed request.', 606
     );
-  }
-
-  /**
-   * Decodes a raw valid signed request.
-   *
-   * @param string $signedRequest
-   *
-   * @returns array
-   */
-  public static function split($signedRequest)
-  {
+    }
+
+    /**
+     * Decodes a raw valid signed request.
+     *
+     * @param string $signedRequest
+     *
+     * @returns array
+     */
+    public static function split($signedRequest)
+    {
     static::validateFormat($signedRequest);
 
     return explode('.', $signedRequest, 2);
-  }
-
-  /**
-   * Decodes the raw signature from a signed request.
-   *
-   * @param string $encodedSig
-   *
-   * @returns string
-   *
-   * @throws FacebookSDKException
-   */
-  public static function decodeSignature($encodedSig)
-  {
+    }
+
+    /**
+     * Decodes the raw signature from a signed request.
+     *
+     * @param string $encodedSig
+     *
+     * @returns string
+     *
+     * @throws FacebookSDKException
+     */
+    public static function decodeSignature($encodedSig)
+    {
     $sig = static::base64UrlDecode($encodedSig);
 
     if ($sig) {
-      return $sig;
+        return $sig;
     }
 
     throw new FacebookSDKException(
-      'Signed request has malformed encoded signature data.', 607
+        'Signed request has malformed encoded signature data.', 607
     );
-  }
-
-  /**
-   * Decodes the raw payload from a signed request.
-   *
-   * @param string $encodedPayload
-   *
-   * @returns array
-   *
-   * @throws FacebookSDKException
-   */
-  public static function decodePayload($encodedPayload)
-  {
+    }
+
+    /**
+     * Decodes the raw payload from a signed request.
+     *
+     * @param string $encodedPayload
+     *
+     * @returns array
+     *
+     * @throws FacebookSDKException
+     */
+    public static function decodePayload($encodedPayload)
+    {
     $payload = static::base64UrlDecode($encodedPayload);
 
     if ($payload) {
-      $payload = json_decode($payload, true);
+        $payload = json_decode($payload, true);
     }
 
     if (is_array($payload)) {
-      return $payload;
+        return $payload;
     }
 
     throw new FacebookSDKException(
-      'Signed request has malformed encoded payload data.', 607
+        'Signed request has malformed encoded payload data.', 607
     );
-  }
-
-  /**
-   * Validates the algorithm used in a signed request.
-   *
-   * @param array $data
-   *
-   * @throws FacebookSDKException
-   */
-  public static function validateAlgorithm(array $data)
-  {
+    }
+
+    /**
+     * Validates the algorithm used in a signed request.
+     *
+     * @param array $data
+     *
+     * @throws FacebookSDKException
+     */
+    public static function validateAlgorithm(array $data)
+    {
     if (isset($data['algorithm']) && $data['algorithm'] === 'HMAC-SHA256') {
-      return;
+        return;
     }
 
     throw new FacebookSDKException(
-      'Signed request is using the wrong algorithm.', 605
+        'Signed request is using the wrong algorithm.', 605
     );
-  }
-
-  /**
-   * Hashes the signature used in a signed request.
-   *
-   * @param string $encodedData
-   * @param string|null $appSecret
-   *
-   * @return string
-   *
-   * @throws FacebookSDKException
-   */
-  public static function hashSignature($encodedData, $appSecret = null)
-  {
+    }
+
+    /**
+     * Hashes the signature used in a signed request.
+     *
+     * @param string $encodedData
+     * @param string|null $appSecret
+     *
+     * @return string
+     *
+     * @throws FacebookSDKException
+     */
+    public static function hashSignature($encodedData, $appSecret = null)
+    {
     $hashedSig = hash_hmac(
-      'sha256', $encodedData, FacebookSession::_getTargetAppSecret($appSecret), $raw_output = true
+        'sha256', $encodedData, FacebookSession::_getTargetAppSecret($appSecret), $raw_output = true
     );
 
     if ($hashedSig) {
-      return $hashedSig;
+        return $hashedSig;
     }
 
     throw new FacebookSDKException(
-      'Unable to hash signature from encoded payload data.', 602
+        'Unable to hash signature from encoded payload data.', 602
     );
-  }
-
-  /**
-   * Validates the signature used in a signed request.
-   *
-   * @param string $hashedSig
-   * @param string $sig
-   *
-   * @throws FacebookSDKException
-   */
-  public static function validateSignature($hashedSig, $sig)
-  {
+    }
+
+    /**
+     * Validates the signature used in a signed request.
+     *
+     * @param string $hashedSig
+     * @param string $sig
+     *
+     * @throws FacebookSDKException
+     */
+    public static function validateSignature($hashedSig, $sig)
+    {
     if (mb_strlen($hashedSig) === mb_strlen($sig)) {
-      $validate = 0;
-      for ($i = 0; $i < mb_strlen($sig); $i++) {
+        $validate = 0;
+        for ($i = 0; $i < mb_strlen($sig); $i++) {
         $validate |= ord($hashedSig[$i]) ^ ord($sig[$i]);
-      }
-      if ($validate === 0) {
+        }
+        if ($validate === 0) {
         return;
-      }
+        }
     }
 
     throw new FacebookSDKException(
-      'Signed request has an invalid signature.', 602
+        'Signed request has an invalid signature.', 602
     );
-  }
-
-  /**
-   * Validates a signed request against CSRF.
-   *
-   * @param array $data
-   * @param string $state
-   *
-   * @throws FacebookSDKException
-   */
-  public static function validateCsrf(array $data, $state)
-  {
+    }
+
+    /**
+     * Validates a signed request against CSRF.
+     *
+     * @param array $data
+     * @param string $state
+     *
+     * @throws FacebookSDKException
+     */
+    public static function validateCsrf(array $data, $state)
+    {
     if (isset($data['state']) && $data['state'] === $state) {
-      return;
+        return;
     }
 
     throw new FacebookSDKException(
-      'Signed request did not pass CSRF validation.', 604
+        'Signed request did not pass CSRF validation.', 604
     );
-  }
-
-  /**
-   * Base64 decoding which replaces characters:
-   *   + instead of -
-   *   / instead of _
-   * @link http://en.wikipedia.org/wiki/Base64#URL_applications
-   *
-   * @param string $input base64 url encoded input
-   *
-   * @return string decoded string
-   */
-  public static function base64UrlDecode($input)
-  {
+    }
+
+    /**
+     * Base64 decoding which replaces characters:
+     *   + instead of -
+     *   / instead of _
+     * @link http://en.wikipedia.org/wiki/Base64#URL_applications
+     *
+     * @param string $input base64 url encoded input
+     *
+     * @return string decoded string
+     */
+    public static function base64UrlDecode($input)
+    {
     $urlDecodedBase64 = strtr($input, '-_', '+/');
     static::validateBase64($urlDecodedBase64);
     return base64_decode($urlDecodedBase64);
-  }
-
-  /**
-   * Base64 encoding which replaces characters:
-   *   + instead of -
-   *   / instead of _
-   * @link http://en.wikipedia.org/wiki/Base64#URL_applications
-   *
-   * @param string $input string to encode
-   *
-   * @return string base64 url encoded input
-   */
-  public static function base64UrlEncode($input)
-  {
+    }
+
+    /**
+     * Base64 encoding which replaces characters:
+     *   + instead of -
+     *   / instead of _
+     * @link http://en.wikipedia.org/wiki/Base64#URL_applications
+     *
+     * @param string $input string to encode
+     *
+     * @return string base64 url encoded input
+     */
+    public static function base64UrlEncode($input)
+    {
     return strtr(base64_encode($input), '+/', '-_');
-  }
-
-  /**
-   * Validates a base64 string.
-   *
-   * @param string $input base64 value to validate
-   *
-   * @throws FacebookSDKException
-   */
-  public static function validateBase64($input)
-  {
+    }
+
+    /**
+     * Validates a base64 string.
+     *
+     * @param string $input base64 value to validate
+     *
+     * @throws FacebookSDKException
+     */
+    public static function validateBase64($input)
+    {
     $pattern = '/^[a-zA-Z0-9\/\r\n+]*={0,2}$/';
     if (preg_match($pattern, $input)) {
-      return;
+        return;
     }
 
     throw new FacebookSDKException(
-      'Signed request contains malformed base64 encoding.', 608
+        'Signed request contains malformed base64 encoding.', 608
     );
-  }
+    }
 
 }

main/auth/external_login/facebook.inc.php

Unused Use Statements -6 removed lines

@@ -18,14 +18,8 @@
 use Facebook\FacebookSession;
 use Facebook\FacebookRedirectLoginHelper;
 use Facebook\FacebookRequest;
-use Facebook\FacebookResponse;
 use Facebook\FacebookSDKException;
 use Facebook\FacebookRequestException;
-use Facebook\FacebookAuthorizationException;
-use Facebook\GraphObject;
-use Facebook\Entities\AccessToken;
-use Facebook\HttpClients\FacebookCurlHttpClient;
-use Facebook\HttpClients\FacebookHttpable;
 
 require_once dirname(__FILE__) . '/functions.inc.php';
 

Indentation +10 added lines, -10 removed lines

@@ -1,15 +1,15 @@
 <?php
 /**
- * Licence: GPL
- * Please contact CBlue regarding any licences issues.
- * Author: noel@cblue.be
- *  Copyright: CBlue SPRL, 20XX
- *
- * External login module : FACEBOOK
- *
- * This files provides the facebookConnect()  and facebook_get_url functions
- * Please edit the facebook.conf.php file to adapt it to your fb application parameter
- */
+     * Licence: GPL
+     * Please contact CBlue regarding any licences issues.
+     * Author: noel@cblue.be
+     *  Copyright: CBlue SPRL, 20XX
+     *
+     * External login module : FACEBOOK
+     *
+     * This files provides the facebookConnect()  and facebook_get_url functions
+     * Please edit the facebook.conf.php file to adapt it to your fb application parameter
+     */
 
 require_once dirname(__FILE__) . '/../../inc/global.inc.php';
 require_once dirname(__FILE__) . '/facebook.init.php';

Spacing +8 added lines, -8 removed lines

@@ -11,9 +11,9 @@ 
  * Please edit the facebook.conf.php file to adapt it to your fb application parameter
  */
 
-require_once dirname(__FILE__) . '/../../inc/global.inc.php';
-require_once dirname(__FILE__) . '/facebook.init.php';
-require_once dirname(__FILE__) . '/facebook-php-sdk/autoload.php';
+require_once dirname(__FILE__).'/../../inc/global.inc.php';
+require_once dirname(__FILE__).'/facebook.init.php';
+require_once dirname(__FILE__).'/facebook-php-sdk/autoload.php';
 
 use Facebook\FacebookSession;
 use Facebook\FacebookRedirectLoginHelper;
@@ -27,7 +27,7 @@ 
 use Facebook\HttpClients\FacebookCurlHttpClient;
 use Facebook\HttpClients\FacebookHttpable;
 
-require_once dirname(__FILE__) . '/functions.inc.php';
+require_once dirname(__FILE__).'/functions.inc.php';
 
 // dont rename $facebook_config to $facebookConfig otherwise get a "Facebook\\FacebookSDKException"
 FacebookSession::setDefaultApplication($facebook_config['appId'], $facebook_config['secret']);
@@ -57,7 +57,7 @@ 
             $locale = $graphObject->getProperty('locale');
             $language = facebookPluginGetLanguage($locale);
             if (!$language) {
-                $language='en_US';
+                $language = 'en_US';
             }
 
             //Checks if user already exists in chamilo
@@ -85,7 +85,7 @@ 
                     $_user['user_id'] = $chamilo_uid;
                     $_user['uidReset'] = true;
                     $_SESSION['_user'] = $_user;
-                    header('Location:' . api_get_path(WEB_PATH));
+                    header('Location:'.api_get_path(WEB_PATH));
                     exit();
                 } else {
                     return false;
@@ -98,7 +98,7 @@ 
                 $_user['user_id'] = $chamilo_uid;
                 $_user['uidReset'] = true;
                 $_SESSION['_user'] = $_user;
-                header('Location:' . api_get_path(WEB_PATH));
+                header('Location:'.api_get_path(WEB_PATH));
                 exit();
             }
         }
@@ -117,7 +117,7 @@ 
 {
     global $facebook_config;
     $helper = new FacebookRedirectLoginHelper($facebook_config['return_url']);
-    $loginUrl =   $helper->getLoginUrl(
+    $loginUrl = $helper->getLoginUrl(
         array('scope' => 'email')
     );
 

main/auth/external_login/functions.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
  *      - language
  *      - courses : string of all courses code separated by '|'
  *      - admin : boolean
- * @return boolean
+ * @return boolean|null
  * @author ndiechburg <noel@cblue.be>
  * */
 function external_update_user($new_user) {

Spacing +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
     //Those are the mandatory fields for user creation.
     //See external_add_user function for all the fields you can have.
     $table = USERINFO_TABLE;
-    $sql = "SELECT * from $table where username='" . Database::escape_string($login) . "'";
+    $sql = "SELECT * from $table where username='".Database::escape_string($login)."'";
     $result = Database::query($sql);
 
     if (Database::num_rows($result) == 0) { //false password

Braces +37 added lines, -24 removed lines

@@ -95,30 +95,43 @@
  * */
 function external_add_user($u) {
     //Setting default
-    if (empty($u['password']))
-        $u['password'] = null;
-    if (empty($u['status']))
-        $u['status'] = 5;
-    if (!isset($u['official_code']))
-        $u['official_code'] = '';
-    if (!isset($u['language']))
-        $u['language'] = '';
-    if (!isset($u['phone']))
-        $u['phone'] = '';
-    if (!isset($u['picture_uri']))
-        $u['picture_uri'] = '';
-    if (!isset($u['auth_source']))
-        $u['auth_source'] = PLATFORM_AUTH_SOURCE;
-    if (!isset($u['expiration_date']))
-        $u['expiration_date'] = '0000-00-00 00:00:00';
-    if (!isset($u['active']))
-        $u['active'] = 1;
-    if (!isset($u['hr_dept_id']))
-        $u['hr_dept_id'] = 0; //id of responsible HR
-    if (!isset($u['extra']))
-        $u['extra'] = null;
-    if (!isset($u['encrypt_method']))
-        $u['encrypt_method'] = '';
+    if (empty($u['password'])) {
+            $u['password'] = null;
+    }
+    if (empty($u['status'])) {
+            $u['status'] = 5;
+    }
+    if (!isset($u['official_code'])) {
+            $u['official_code'] = '';
+    }
+    if (!isset($u['language'])) {
+            $u['language'] = '';
+    }
+    if (!isset($u['phone'])) {
+            $u['phone'] = '';
+    }
+    if (!isset($u['picture_uri'])) {
+            $u['picture_uri'] = '';
+    }
+    if (!isset($u['auth_source'])) {
+            $u['auth_source'] = PLATFORM_AUTH_SOURCE;
+    }
+    if (!isset($u['expiration_date'])) {
+            $u['expiration_date'] = '0000-00-00 00:00:00';
+    }
+    if (!isset($u['active'])) {
+            $u['active'] = 1;
+    }
+    if (!isset($u['hr_dept_id'])) {
+            $u['hr_dept_id'] = 0;
+    }
+    //id of responsible HR
+    if (!isset($u['extra'])) {
+            $u['extra'] = null;
+    }
+    if (!isset($u['encrypt_method'])) {
+            $u['encrypt_method'] = '';
+    }
 
     $chamilo_uid = UserManager::create_user($u['firstname'], $u['lastname'], $u['status'], $u['email'], $u['username'], $u['password'], $u['official_code'], $u['language'], $u['phone'], $u['picture_uri'], $u['auth_source'], $u['expiration_date'], $u['active'], $u['hr_dept_id'], $u['extra'], $u['encrypt_method']);
     return $chamilo_uid;

main/auth/external_login/ldap.inc.php

Doc Comments +3 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
 /**
  * Establishes a connection to the LDAP server and sets the protocol version
  *
- * @return resource ldap link identifier or false
+ * @return boolean ldap link identifier or false
  * @author ndiechburg <noel@cblue.be>
  * */
 function extldap_connect()
@@ -77,6 +77,7 @@ 
 /**
  * Authenticate user on external ldap server and return user ldap entry if that succeeds
  *
+ * @param string $password
  * @return mixed false if user cannot authenticate on ldap, user ldap entry if tha succeeds
  * @author ndiechburg <noel@cblue.be>
  * Modified by hubert.borderiou@grenet.fr
@@ -237,7 +238,7 @@ 
 
 /**
  * Imports all LDAP users into Chamilo
- * @return bool false on error, true otherwise
+ * @return false|null false on error, true otherwise
  */
 function extldap_import_all_users()
 {

Spacing +1 added lines, -1 removed lines

@@ -303,7 +303,7 @@
 
     // TODO the password, if encrypted at the source, will be encrypted twice, which makes it useless. Try to fix that.
     $passwordKey = isset($extldap_user_correspondance['password']) ? $extldap_user_correspondance['password'] : 'userPassword';
-    $password        = $data[$passwordKey][0];
+    $password = $data[$passwordKey][0];
 
     // To ease management, we add the step-year (etape-annee) code
     //$official_code = $etape."-".$annee;