chamilo / chamilo-lms

app/Migrations/AbstractMigrationChamilo.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
     }
 
     /**
-     * @param $variable
+     * @param string $variable
      * @return mixed
      */
     public function getConfigurationValue($variable)

main/admin/settings.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -907,7 +907,7 @@ 
  * display the edit and delete icons in the sortable table
  *
  * @param integer $id the id of the template
- * @return html code for the link to edit and delete the template
+ * @return string code for the link to edit and delete the template
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version August 2008
@@ -923,7 +923,7 @@ 
  * Display the image of the template in the sortable table
  *
  * @param string $image the image
- * @return html code for the image
+ * @return string code for the image
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version August 2008
@@ -1120,7 +1120,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */

main/admin/sub_language_add.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
  * @param   string  ISO code (fr_FR, ...)
  * @param   int     Whether the sublanguage is published (0=unpublished, 1=published)
  * @param   int     ID del idioma padre
- * @return  int     New sub language ID or false on error
+ * @return  false|string     New sub language ID or false on error
  */
 function add_sub_language ($original_name,$english_name,$isocode,$sublanguage_available,$parent_id) {
     $tbl_admin_languages    = Database :: get_main_table(TABLE_MAIN_LANGUAGE);

main/admin/user_update_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 /**
  * Update users from the imported data
  * @param   array   $users List of users
- * @return  void
+ * @return  false|null
  * @uses global variable $inserted_in_course, which returns the list of courses the user was inserted in
  */
 

Indentation +2 added lines, -2 removed lines

@@ -60,8 +60,8 @@
                     $user['error'] = get_lang('UserNameNotAvailable');
                     $errors[] = $user;
                 }
-             }
-          }
+                }
+            }
 
         // 3. Check status.
         if (isset($user['Status']) && !api_status_exists($user['Status'])) {

main/attendance/attendance_controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -206,7 +206,7 @@
 
     /**
      * Restores an attendance entry and fallback to attendances rendering
-     * @param int	$attendanceId
+     * @param int	$attendance_id
      */
     public function attendance_restore($attendance_id)
     {

Indentation +5 added lines, -5 removed lines

@@ -636,11 +636,11 @@
             }
             $formToDisplay = $form->returnForm();
         } else {
-           if (!empty($sessionId)) {
-               $sessionInfo = api_get_session_info($sessionId);
-               $startDate = $sessionInfo['access_start_date'];
-               $endDate = $sessionInfo['access_end_date'];
-           }
+            if (!empty($sessionId)) {
+                $sessionInfo = api_get_session_info($sessionId);
+                $startDate = $sessionInfo['access_start_date'];
+                $endDate = $sessionInfo['access_end_date'];
+            }
         }
 
         $attendance = new Attendance();

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

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

    */

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'); 

     }

 

-  /** @} */

+    /** @} */

   

 } 

 

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