chamilo / chamilo-lms

main/auth/shibboleth/app/model/shibboleth_store.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
     /**
      *
-     * @return ShibbolethData 
+     * @return ShibbolethStore 
      */
     public static function instance()
     {

Braces +2 added lines, -4 removed lines

@@ -168,12 +168,10 @@
                 if (empty($result))
                 {
                     $result = $default;
-                }
-                else if (count($result) == 1)
+                } else if (count($result) == 1)
                 {
                     $result = reset($result);
-                }
-                else
+                } else
                 {
                     $result = $result;
                 }

main/auth/shibboleth/app/model/user.class.php

Doc Comments +3 added lines

@@ -56,6 +56,9 @@
         return $this->get(array('shibb_unique_id' => $id));
     }
     
+    /**
+     * @param string $id
+     */
     public function shibboleth_id_exists($id)
     {
         return $this->exist(array('shibb_unique_id' => $id));

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 
 namespace Shibboleth;
 
-require_once dirname(__FILE__) . '/scaffold/user.class.php';
+require_once dirname(__FILE__).'/scaffold/user.class.php';
 
 /**
  * A Chamilo user. Model for the User table.

main/auth/shibboleth/app/shibboleth.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -128,7 +128,7 @@ 
 
     /**
      *
-     * @param ShibbolethUser $user
+     * @param ShibbolethUser $shibb_user
      */
     public static function save($shibb_user)
     {
@@ -230,6 +230,7 @@ 
      * Sends an email to the Chamilo and Shibboleth administrators in the name
      * of the logged-in user.
      *
+     * @param string $subject
      */
     public static function email_admin($subject, $message)
     {

Spacing +2 added lines, -2 removed lines

@@ -78,14 +78,14 @@
 
     public static function sys_path()
     {
-        $path = dirname(__FILE__) . '/../';
+        $path = dirname(__FILE__).'/../';
         return $path;
     }
 
     public static function url($path = '')
     {
         $result = api_get_path('WEB_PATH');
-        $result .= '/main/auth/shibboleth/' . $path;
+        $result .= '/main/auth/shibboleth/'.$path;
         return $result;
     }
 

main/auth/shibboleth/db/shibboleth_upgrade.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
      * Creates the 'shibb_unique_id' field in the table 'user' of the main Chamilo database if it doesn't exist yet
      *
      * @author Nicolas Rod
-     * @return void
+     * @return false|null
      */
     public static function create_shibb_unique_id_field_if_missing()
     {

main/auth/shibboleth/lib/store.class.php

Doc Comments +3 added lines

@@ -346,6 +346,9 @@
         return $result;
     }
 
+    /**
+     * @param string $sql
+     */
     protected function execute($sql)
     {
         return Database::query($sql, null, __FILE__);

Spacing +3 added lines, -3 removed lines

@@ -246,9 +246,9 @@ 
 
         $db_name = $this->get_db_name($object);
         $sql = "INSERT INTO `{$db_name}`.`{$this->table_name}` ";
-        $sql .= ' (' . join(', ', $keys) . ') ';
+        $sql .= ' ('.join(', ', $keys).') ';
         $sql .= 'VALUES';
-        $sql .= ' (' . join(', ', $values) . ') ';
+        $sql .= ' ('.join(', ', $values).') ';
 
         $result = $this->execute($sql);
         if ($result)
@@ -295,7 +295,7 @@ 
         $items = array();
         foreach ($args as $key => $val)
         {
-            $items[] = $key . ' = ' . $this->format_value($val);
+            $items[] = $key.' = '.$this->format_value($val);
         }
         return implode(' AND ', $items);
     }

Braces +8 added lines, -16 removed lines

@@ -107,8 +107,7 @@ 
         if ($this->is_new($object))
         {
             $result = $this->insert($object);
-        }
-        else
+        } else
         {
             $result = $this->update($object);
         }
@@ -257,8 +256,7 @@ 
             $object->{$this->id_name} = $id;
             $object->{db_name} = $db_name;
             return $id;
-        }
-        else
+        } else
         {
             return false;
         }
@@ -278,16 +276,13 @@ 
                     return '';
                 }
                 $args = array($this->pk_name, $arg);
-            }
-            else if (is_string($arg))
+            } else if (is_string($arg))
             {
                 return $arg;
-            }
-            else if (is_array($arg))
+            } else if (is_array($arg))
             {
                 $args = $arg;
-            }
-            else
+            } else
             {
                 return $arg;
             }
@@ -309,17 +304,14 @@ 
         if (is_bool($var))
         {
             return $value ? '1' : '0';
-        }
-        else if (is_numeric($value))
+        } else if (is_numeric($value))
         {
             return empty($value) ? '0' : $value;
-        }
-        else if (is_string($value))
+        } else if (is_string($value))
         {
             $value = mysql_escape_string($value);
             return "'$value'";
-        }
-        else
+        } else
         {
             return $value;
         }

main/auth/sso/sso.Drupal.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 
     /**
      * Validates the received active connection data with the database
-     * @return	bool	Return the loginFailed variable value to local.inc.php
+     * @return	null|false	Return the loginFailed variable value to local.inc.php
      */
     public function check_user()
     {

Spacing +11 added lines, -11 removed lines

@@ -22,11 +22,11 @@ 
  */
 class ssoDrupal
 {
-    public $protocol;   // 'http://',
-    public $domain;     // 'localhost/project/drupal',
-    public $auth_uri;   // '/?q=user',
+    public $protocol; // 'http://',
+    public $domain; // 'localhost/project/drupal',
+    public $auth_uri; // '/?q=user',
     public $deauth_uri; // '/?q=logout',
-    public $referer;    // http://my.chamilo.com/main/auth/profile.php
+    public $referer; // http://my.chamilo.com/main/auth/profile.php
 
     /**
      * Instanciates the object, initializing all relevant URL strings
@@ -123,9 +123,9 @@ 
                     && ($sso['username'] == $uData['username'])) {
 
                     //Check if the account is active (not locked)
-                    if ($uData['active']=='1') {
+                    if ($uData['active'] == '1') {
                         // check if the expiration date has not been reached
-                        if (empty($uData['expiration_date']) OR $uData['expiration_date'] > date('Y-m-d H:i:s') OR $uData['expiration_date']=='0000-00-00 00:00:00') {
+                        if (empty($uData['expiration_date']) OR $uData['expiration_date'] > date('Y-m-d H:i:s') OR $uData['expiration_date'] == '0000-00-00 00:00:00') {
 
                             //If Multiple URL is enabled
                             if (api_get_multiple_access_url()) {
@@ -158,11 +158,11 @@ 
                                             // the user credentials are OK, which
                                             // should be protection enough
                                             // against evil URL spoofing...
-                                            $sso_target = api_get_path(WEB_PATH) . base64_decode($sso['ruri']);
+                                            $sso_target = api_get_path(WEB_PATH).base64_decode($sso['ruri']);
                                         } else {
-                                            $sso_target = isset($sso['target']) ? $sso['target'] : api_get_path(WEB_PATH) . 'index.php';
+                                            $sso_target = isset($sso['target']) ? $sso['target'] : api_get_path(WEB_PATH).'index.php';
                                         }
-                                        header('Location: '. $sso_target);
+                                        header('Location: '.$sso_target);
                                         exit;
                                     } else {
                                         // user does not have permission for this site
@@ -279,12 +279,12 @@ 
         // If this is an administrator, allow him to make some changes in
         // the Chamilo profile
         if ($asAdmin && api_is_platform_admin(true)) {
-            return api_get_path(WEB_CODE_PATH) . "admin/user_edit.php?user_id=$userId";
+            return api_get_path(WEB_CODE_PATH)."admin/user_edit.php?user_id=$userId";
         }
         // If the user doesn't match a Drupal user, give the normal profile
         // link
         if ($drupalUserIdData === false) {
-            return api_get_path(WEB_CODE_PATH) . 'auth/profile.php';
+            return api_get_path(WEB_CODE_PATH).'auth/profile.php';
         }
         // In all other cases, generate a link to the Drupal profile edition
         $drupalUserId = $drupalUserIdData['value'];

main/coursecopy/classes/Course.class.php

Doc Comments +2 added lines

@@ -327,6 +327,7 @@ 
 
     /**
     * Serialize the course with the best serializer available
+    * @return string
     */
     public static function serialize($course)
     {
@@ -339,6 +340,7 @@ 
 
     /**
     * Unserialize the course with the best serializer available
+    * @param string $course
     */
     public static function unserialize($course)
     {

Indentation +4 added lines, -4 removed lines

@@ -326,8 +326,8 @@ 
     }
 
     /**
-    * Serialize the course with the best serializer available
-    */
+     * Serialize the course with the best serializer available
+     */
     public static function serialize($course)
     {
         if (extension_loaded('igbinary')) {
@@ -338,8 +338,8 @@ 
     }
 
     /**
-    * Unserialize the course with the best serializer available
-    */
+     * Unserialize the course with the best serializer available
+     */
     public static function unserialize($course)
     {
         if (extension_loaded('igbinary')) {

Spacing +7 added lines, -7 removed lines

@@ -40,10 +40,10 @@ 
             if (is_array($resources)) {
                 foreach ($resources as $resource) {
                     Coursecopy\Resource::setClassType($resource);
-                    if ($resource->links_to($resource_to_check) ) {
+                    if ($resource->links_to($resource_to_check)) {
                         return true;
                     }
-                    if ($type == RESOURCE_LEARNPATH && get_class($resource)=='CourseCopyLearnpath') {
+                    if ($type == RESOURCE_LEARNPATH && get_class($resource) == 'CourseCopyLearnpath') {
                         if ($resource->has_item($resource_to_check)) {
                             return true;
                         }
@@ -70,7 +70,7 @@ 
      */
     public function has_resources($resource_type = null)
     {
-        if( $resource_type != null) {
+        if ($resource_type != null) {
             return isset($this->resources[$resource_type]) && is_array($this->resources[$resource_type]) && (count(
                     $this->resources[$resource_type]
                 ) > 0);
@@ -177,12 +177,12 @@ 
                             $description = $resource->content;
                             break;
                         case RESOURCE_THEMATIC:
-                            $title 			= $resource->title;
-                            $description 	= $resource->content;
+                            $title = $resource->title;
+                            $description = $resource->content;
                             break;
                         case RESOURCE_ATTENDANCE:
-                            $title 			= $resource->params['name'];
-                            $description 	= $resource->params['description'];
+                            $title = $resource->params['name'];
+                            $description = $resource->params['description'];
                             break;
                         case RESOURCE_WORK:
                             $title = $resource->title;

main/coursecopy/classes/CourseArchiver.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function import_uploaded_file($file)
     {

Spacing +35 added lines, -35 removed lines

@@ -23,9 +23,9 @@ 
             while (($file = readdir($handle)) !== false) {
                 if ($file != "." && $file != ".." &&
                     strpos($file, 'CourseArchiver_') === 0 &&
-                    is_dir($dir . '/' . $file)
+                    is_dir($dir.'/'.$file)
                 ) {
-                    rmdirr($dir . '/' . $file);
+                    rmdirr($dir.'/'.$file);
                 }
             }
             closedir($handle);
@@ -43,48 +43,48 @@ 
         CourseArchiver::clean_backup_dir();
 
         // Create a temp directory
-        $tmp_dir_name = 'CourseArchiver_' . api_get_unique_id();
-        $backup_dir = api_get_path(SYS_ARCHIVE_PATH) . $tmp_dir_name . '/';
+        $tmp_dir_name = 'CourseArchiver_'.api_get_unique_id();
+        $backup_dir = api_get_path(SYS_ARCHIVE_PATH).$tmp_dir_name.'/';
 
         // All course-information will be stored in course_info.dat
-        $course_info_file = $backup_dir . 'course_info.dat';
+        $course_info_file = $backup_dir.'course_info.dat';
         $zip_dir = api_get_path(SYS_ARCHIVE_PATH);
         $user = api_get_user_info();
         $date = new DateTime(api_get_local_time());
-        $zip_file = $user['user_id'] . '_' . $course->code . '_' . $date->format('Ymd-His') . '.zip';
+        $zip_file = $user['user_id'].'_'.$course->code.'_'.$date->format('Ymd-His').'.zip';
         $php_errormsg = '';
         $res = @mkdir($backup_dir, $perm_dirs);
         if ($res === false) {
             //TODO set and handle an error message telling the user to review the permissions on the archive directory
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini') . ' - This error, occuring because your archive directory will not let this script write data into it, will prevent courses backups to be created', 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini').' - This error, occuring because your archive directory will not let this script write data into it, will prevent courses backups to be created', 0);
         }
         // Write the course-object to the file
         $fp = @fopen($course_info_file, 'w');
         if ($fp === false) {
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
         }
 
         $res = @fwrite($fp, base64_encode(serialize($course)));
         if ($res === false) {
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
         }
 
         $res = @fclose($fp);
         if ($res === false) {
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
         }
 
         // Copy all documents to the temp-dir
         if (isset($course->resources[RESOURCE_DOCUMENT]) && is_array($course->resources[RESOURCE_DOCUMENT])) {
             foreach ($course->resources[RESOURCE_DOCUMENT] as $document) {
                 if ($document->file_type == DOCUMENT) {
-                    $doc_dir = $backup_dir . $document->path;
+                    $doc_dir = $backup_dir.$document->path;
                     @mkdir(dirname($doc_dir), $perm_dirs, true);
-                    if (file_exists($course->path . $document->path)) {
-                        copy($course->path . $document->path, $doc_dir);
+                    if (file_exists($course->path.$document->path)) {
+                        copy($course->path.$document->path, $doc_dir);
                     }
                 } else {
-                    @mkdir($backup_dir . $document->path, $perm_dirs, true);
+                    @mkdir($backup_dir.$document->path, $perm_dirs, true);
                 }
             }
         }
@@ -92,49 +92,49 @@ 
         // Copy all scorm documents to the temp-dir
         if (isset($course->resources[RESOURCE_SCORM]) && is_array($course->resources[RESOURCE_SCORM])) {
             foreach ($course->resources[RESOURCE_SCORM] as $document) {
-                $doc_dir = dirname($backup_dir . $document->path);
+                $doc_dir = dirname($backup_dir.$document->path);
                 @mkdir($doc_dir, $perm_dirs, true);
-                copyDirTo($course->path . $document->path, $doc_dir, false);
+                copyDirTo($course->path.$document->path, $doc_dir, false);
             }
         }
 
         // Copy calendar attachments.
 
         if (isset($course->resources[RESOURCE_EVENT]) && is_array($course->resources[RESOURCE_EVENT])) {
-            $doc_dir = dirname($backup_dir . '/upload/calendar/');
+            $doc_dir = dirname($backup_dir.'/upload/calendar/');
             @mkdir($doc_dir, $perm_dirs, true);
-            copyDirTo($course->path . 'upload/calendar/', $doc_dir, false);
+            copyDirTo($course->path.'upload/calendar/', $doc_dir, false);
         }
 
         // Copy Learning path author image.
         if (isset($course->resources[RESOURCE_LEARNPATH]) && is_array($course->resources[RESOURCE_LEARNPATH])) {
-            $doc_dir = dirname($backup_dir . '/upload/learning_path/');
+            $doc_dir = dirname($backup_dir.'/upload/learning_path/');
             @mkdir($doc_dir, $perm_dirs, true);
-            copyDirTo($course->path . 'upload/learning_path/', $doc_dir, false);
+            copyDirTo($course->path.'upload/learning_path/', $doc_dir, false);
         }
 
         // Copy announcements attachments.
         if (isset($course->resources[RESOURCE_ANNOUNCEMENT]) && is_array($course->resources[RESOURCE_ANNOUNCEMENT])) {
-            $doc_dir = dirname($backup_dir . '/upload/announcements/');
+            $doc_dir = dirname($backup_dir.'/upload/announcements/');
             @mkdir($doc_dir, $perm_dirs, true);
-            copyDirTo($course->path . 'upload/announcements/', $doc_dir, false);
+            copyDirTo($course->path.'upload/announcements/', $doc_dir, false);
         }
 
         // Copy work folders (only folders)
         if (isset($course->resources[RESOURCE_WORK]) && is_array($course->resources[RESOURCE_WORK])) {
-            $doc_dir = dirname($backup_dir . '/upload/work/');
+            $doc_dir = dirname($backup_dir.'/upload/work/');
             @mkdir($doc_dir, $perm_dirs, true);
             // @todo: adjust to only create subdirs, but not copy files
-            copyDirTo($course->path . 'upload/work/', $doc_dir, false);
+            copyDirTo($course->path.'upload/work/', $doc_dir, false);
         }
 
         // Zip the course-contents
-        $zip = new PclZip($zip_dir . $zip_file);
-        $zip->create($zip_dir . $tmp_dir_name, PCLZIP_OPT_REMOVE_PATH, $zip_dir . $tmp_dir_name . '/');
+        $zip = new PclZip($zip_dir.$zip_file);
+        $zip->create($zip_dir.$tmp_dir_name, PCLZIP_OPT_REMOVE_PATH, $zip_dir.$tmp_dir_name.'/');
         //$zip->deleteByIndex(0);
         // Remove the temp-dir.
         rmdirr($backup_dir);
-        return '' . $zip_file;
+        return ''.$zip_file;
     }
 
     /**
@@ -145,7 +145,7 @@ 
     {
         global $dateTimeFormatLong;
         $backup_files = array();
-        $dirname = api_get_path(SYS_ARCHIVE_PATH) . '';
+        $dirname = api_get_path(SYS_ARCHIVE_PATH).'';
         if ($dir = opendir($dirname)) {
             while (($file = readdir($dir)) !== false) {
                 $file_parts = explode('_', $file);
@@ -156,7 +156,7 @@ 
                     $date = $file_parts[0];
                     $ext = isset($file_parts[1]) ? $file_parts[1] : null;
                     if ($ext == 'zip' && ($user_id != null && $owner_id == $user_id || $user_id == null)) {
-                        $date = substr($date, 0, 4) . '-' . substr($date, 4, 2) . '-' . substr($date, 6, 2) . ' ' . substr($date, 9, 2) . ':' . substr($date, 11, 2) . ':' . substr($date, 13, 2);
+                        $date = substr($date, 0, 4).'-'.substr($date, 4, 2).'-'.substr($date, 6, 2).' '.substr($date, 9, 2).':'.substr($date, 11, 2).':'.substr($date, 13, 2);
                         $backup_files[] = array(
                             'file' => $file,
                             'date' => $date,
@@ -177,7 +177,7 @@ 
      */
     public static function import_uploaded_file($file)
     {
-        $new_filename = uniqid('') . '.zip';
+        $new_filename = uniqid('').'.zip';
         $new_dir = api_get_path(SYS_ARCHIVE_PATH);
         if (is_dir($new_dir) && is_writable($new_dir)) {
             move_uploaded_file($file, api_get_path(SYS_ARCHIVE_PATH).$new_filename);
@@ -200,17 +200,17 @@ 
     {
         CourseArchiver::clean_backup_dir();
         // Create a temp directory
-        $tmp_dir_name = 'CourseArchiver_' . uniqid('');
-        $unzip_dir = api_get_path(SYS_ARCHIVE_PATH) . '' . $tmp_dir_name;
+        $tmp_dir_name = 'CourseArchiver_'.uniqid('');
+        $unzip_dir = api_get_path(SYS_ARCHIVE_PATH).''.$tmp_dir_name;
         @mkdir($unzip_dir, api_get_permissions_for_new_directories(), true);
-        @copy(api_get_path(SYS_ARCHIVE_PATH) . '' . $filename, $unzip_dir . '/backup.zip');
+        @copy(api_get_path(SYS_ARCHIVE_PATH).''.$filename, $unzip_dir.'/backup.zip');
         // unzip the archive
-        $zip = new PclZip($unzip_dir . '/backup.zip');
+        $zip = new PclZip($unzip_dir.'/backup.zip');
         @chdir($unzip_dir);
         $zip->extract(PCLZIP_OPT_TEMP_FILE_ON);
         // remove the archive-file
         if ($delete) {
-            @unlink(api_get_path(SYS_ARCHIVE_PATH) . '' . $filename);
+            @unlink(api_get_path(SYS_ARCHIVE_PATH).''.$filename);
         }
         // read the course
         if (!is_file('course_info.dat')) {

main/coursecopy/classes/CourseBuilder.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
     }
 
     /**
-     * @param array $array
+     * @param string[] $array
      */
     public function set_tools_to_build($array)
     {
@@ -123,7 +123,7 @@ 
      * @param string   $courseCode
      * @param bool     true if you want to get the elements that exists in the course and
      *                 in the session, (session_id = 0 or session_id = X)
-     * @return object The course object structure
+     * @return Course The course object structure
      */
     public function build(
         $session_id = 0,

Spacing +2 added lines, -2 removed lines

@@ -595,7 +595,7 @@ 
         $table_doc = Database:: get_course_table(TABLE_DOCUMENT);
 
         if (!empty($courseId) && !empty($session_id)) {
-            $session_id  = intval($session_id);
+            $session_id = intval($session_id);
             if ($with_base_content) {
                 $session_condition = api_get_session_condition(
                     $session_id,
@@ -804,7 +804,7 @@ 
                 'title' => get_lang('OrphanQuestions', ''),
                 'type' => 2
             );
-            $newQuiz = new Quiz((object)$obj);
+            $newQuiz = new Quiz((object) $obj);
             if (!empty($orphanQuestionIds)) {
                 foreach ($orphanQuestionIds as $index => $orphanId) {
                     $order = $index + 1;