chamilo / chamilo-lms

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;

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

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)
     {

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;

main/coursecopy/classes/CourseSelectForm.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,7 +13,7 @@ 
 {
 	/**
 	 * Display the form
-	 * @param array $hidden_fiels Hidden fields to add to the form.
+	 * @param array $hidden_fields Hidden fields to add to the form.
 	 * @param boolean the document array will be serialize. This is used in the course_copy.php file
 	 */
 	static function display_form($course, $hidden_fields = null, $avoid_serialize = false)
@@ -570,7 +570,7 @@ 
 
 	/**
 	 * Display the form session export
-	 * @param array $hidden_fiels Hidden fields to add to the form.
+	 * @param array $hidden_fields Hidden fields to add to the form.
 	 * @param boolean the document array will be serialize. This is used in the course_copy.php file
 	 */
 	 public static function display_form_session_export($list_course, $hidden_fields = null, $avoid_serialize = false)

Spacing +19 added lines, -19 removed lines

@@ -136,13 +136,13 @@ 
 
 		//get destination course title
 		if (!empty($hidden_fields['destination_course'])) {
-            $sessionTitle = !empty($hidden_fields['destination_session']) ? ' (' . api_get_session_name(
+            $sessionTitle = !empty($hidden_fields['destination_session']) ? ' ('.api_get_session_name(
                 $hidden_fields['destination_session']
-            ) . ')' : null;
+            ).')' : null;
 
             $course_infos = CourseManager::get_course_information($hidden_fields['destination_course']);
 			echo '<h3>';
-			echo get_lang('DestinationCourse').' : '.$course_infos['title'] . ' ('.$course_infos['code'].') '.$sessionTitle;
+			echo get_lang('DestinationCourse').' : '.$course_infos['title'].' ('.$course_infos['code'].') '.$sessionTitle;
 			echo '</h3>';
 		}
         echo '<script src="'.api_get_path(WEB_CODE_PATH).'inc/lib/javascript/upload.js" type="text/javascript"></script>';
@@ -298,7 +298,7 @@ 
 			/*Documents are avoided due the huge amount of memory that the serialize php function "eats"
 			(when there are directories with hundred/thousand of files) */
 			// this is a known issue of serialize
-			$course->resources['document']= null;
+			$course->resources['document'] = null;
 		}
 
 		echo '<input type="hidden" name="course" value="'.base64_encode(Course::serialize($course)).'"/>';
@@ -315,7 +315,7 @@ 
 		    Display::display_warning_message(get_lang('NoDataAvailable'));
 		} else {
     		if (!empty($hidden_fields['destination_session'])) {
-    			echo '<br /><button class="save" type="submit" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang("ConfirmYourChoice"),ENT_QUOTES, $charset))."'".')) return false;" >'.
+    			echo '<br /><button class="save" type="submit" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang("ConfirmYourChoice"), ENT_QUOTES, $charset))."'".')) return false;" >'.
                     get_lang('Ok').'</button>';
     		} else {
                 if ($recycleOption) {
@@ -339,7 +339,7 @@ 
      */
     static function display_hidden_quiz_questions($course)
     {
-		if(is_array($course->resources)){
+		if (is_array($course->resources)) {
 			foreach ($course->resources as $type => $resources) {
 				if (count($resources) > 0) {
 					switch ($type) {
@@ -359,10 +359,10 @@ 
      */
     static function display_hidden_scorm_directories($course)
     {
-        if (is_array($course->resources)){
+        if (is_array($course->resources)) {
 			foreach ($course->resources as $type => $resources) {
 				if (count($resources) > 0) {
-					switch($type) {
+					switch ($type) {
 						case RESOURCE_SCORM:
 							foreach ($resources as $id => $resource) {
 								echo '<input type="hidden" name="resource['.RESOURCE_SCORM.']['.$id.']" id="resource['.RESOURCE_SCORM.']['.$id.']" value="On" />';
@@ -408,7 +408,7 @@ 
 			if (is_array($resource)) {
 				$resource = array_keys($resource);
 
-				foreach	($resource as $resource_item) {
+				foreach ($resource as $resource_item) {
 
 					$condition_session = '';
 					if (!empty($session_id)) {
@@ -444,8 +444,8 @@ 
                                         tool = '".RESOURCE_DOCUMENT."' AND
                                         ref = $resource_item ";
                             $res = Database::query($sql);
-                            $all_properties = array ();
-                            while ($item_property = Database::fetch_array($res,'ASSOC')) {
+                            $all_properties = array();
+                            while ($item_property = Database::fetch_array($res, 'ASSOC')) {
                                 $all_properties[] = $item_property;
                             }
                             $course->resources[RESOURCE_DOCUMENT][$resource_item]->item_properties = $all_properties;
@@ -460,7 +460,7 @@ 
 
 				switch ($type) {
 					case RESOURCE_SURVEYQUESTION:
-						foreach($resources as $id => $obj) {
+						foreach ($resources as $id => $obj) {
 						    if (isset($_POST['resource'][RESOURCE_SURVEY]) &&
                                 is_array($_POST['resource'][RESOURCE_SURVEY]) &&
                                 !in_array($obj->survey_id, array_keys($_POST['resource'][RESOURCE_SURVEY]))
@@ -535,7 +535,7 @@ 
                                 ) {
 									foreach ($documents as $id_to_check => $post_value) {
 										$obj_to_check = $resources[$id_to_check];
-										$shared_path_part = substr($obj_to_check->path,0,strlen($obj->path));
+										$shared_path_part = substr($obj_to_check->path, 0, strlen($obj->path));
 										if ($id_to_check != $id && $obj->path == $shared_path_part) {
 											$_POST['resource'][RESOURCE_DOCUMENT][$id] = 1;
 											break;
@@ -549,7 +549,7 @@ 
 								$resource_is_used_elsewhere = $course->is_linked_resource($obj);
 								// check if document is in a quiz (audio/video)
 								if ($type == RESOURCE_DOCUMENT && $course->has_resources(RESOURCE_QUIZ)) {
-									foreach($course->resources[RESOURCE_QUIZ] as $quiz) {
+									foreach ($course->resources[RESOURCE_QUIZ] as $quiz) {
                                         $quiz = $quiz->obj;
 										if (isset($quiz->media) && $quiz->media == $id) {
 											$resource_is_used_elsewhere = true;
@@ -618,15 +618,15 @@ 
 		<?php
 
 		//get destination course title
-		if(!empty($hidden_fields['destination_course'])) {
+		if (!empty($hidden_fields['destination_course'])) {
              if (!empty($hidden_fields['destination_session'])) {
-                 $sessionTitle = ' (' . api_get_session_name($hidden_fields['destination_session']) . ')';
+                 $sessionTitle = ' ('.api_get_session_name($hidden_fields['destination_session']).')';
              } else {
                  $sessionTitle = null;
              }
             $course_infos = CourseManager::get_course_information($hidden_fields['destination_course']);
 			echo '<h3>';
-				echo get_lang('DestinationCourse') . ' : ' . $course_infos['title'] . $sessionTitle;
+				echo get_lang('DestinationCourse').' : '.$course_infos['title'].$sessionTitle;
 			echo '</h3>';
 		}
 
@@ -634,7 +634,7 @@ 
 		echo '<script type="text/javascript">var myUpload = new upload(1000);</script>';
 		echo '<form method="post" id="upload_form" name="course_select_form" onsubmit="myUpload.start(\'dynamic_div\',\''.api_get_path(WEB_CODE_PATH).'img/progress_bar.gif\',\''.get_lang('PleaseStandBy').'\',\'upload_form\')">';
 		echo '<input type="hidden" name="action" value="course_select_form"/>';
-		foreach ($list_course as $course){
+		foreach ($list_course as $course) {
 			foreach ($course->resources as $type => $resources) {
 				if (count($resources) > 0) {
 					echo '<img id="img_'.$course->code.'" src="../img/1.gif" onclick="javascript:exp('."'$course->code'".');" />';
@@ -662,7 +662,7 @@ 
 		if ($avoid_serialize) {
 			//Documents are avoided due the huge amount of memory that the serialize php function "eats" (when there are directories with hundred/thousand of files)
 			// this is a known issue of serialize
-			$course->resources['document']= null;
+			$course->resources['document'] = null;
 		}
 		echo '<input type="hidden" name="course" value="'.base64_encode(Course::serialize($course)).'"/>';
 		if (is_array($hidden_fields)) {

main/coursecopy/classes/DummyCourseCreator.class.php

Doc Comments +1 added lines

@@ -280,6 +280,7 @@
 	}
 	/**
 	 * Get dummy titles, descriptions and texts
+	 * @param string $type
 	 */
 	function get_dummy_content($type)
 	{

Spacing +55 added lines, -55 removed lines

@@ -42,7 +42,7 @@ 
 		$this->default_property['to_user_id'] = null;
 		$this->default_property['visibility'] = '1';
 		$this->default_property['start_visible'] = '0000-00-00 00:00:00';
-		$this->default_property['end_visible'] =  '0000-00-00 00:00:00';
+		$this->default_property['end_visible'] = '0000-00-00 00:00:00';
 
 		$course = api_get_course_info($course_code);
 		$this->course = new Course();
@@ -68,13 +68,13 @@ 
 		$course = api_get_course_info();
 		$course_doc_path = $this->course->backup_path.'/document/';
 		$number_of_documents = rand(10, 30);
-		$extensions = array ('html', 'doc');
+		$extensions = array('html', 'doc');
 		$directories = array();
 		$property = $this->default_property;
 		$property['lastedit_type'] = 'DocumentAdded';
 		$property['tool'] = TOOL_DOCUMENT;
 		$doc_id = 0;
-		for ($doc_id = 1; $doc_id < $number_of_documents; $doc_id ++)
+		for ($doc_id = 1; $doc_id < $number_of_documents; $doc_id++)
 		{
 			$path = '';
 			$doc_type = rand(0, count($extensions) - 1);
@@ -82,7 +82,7 @@ 
 			$filename = $this->get_dummy_content('title').'_'.$doc_id.'.'.$extension;
 			$content = $this->get_dummy_content('text');
 			$dirs = rand(0, 3);
-			for ($i = 0; $i < $dirs; $i ++)
+			for ($i = 0; $i < $dirs; $i++)
 			{
 				$path .= 'directory/';
 				$directories[$path] = 1;
@@ -97,14 +97,14 @@ 
 			fwrite($fp, $content);
 			fclose($fp);
 			$size = filesize($file);
-			$document = new Document($doc_id, '/'.$path.$filename,$this->get_dummy_content('description'),$this->get_dummy_content('title'), 'file', $size);
+			$document = new Document($doc_id, '/'.$path.$filename, $this->get_dummy_content('description'), $this->get_dummy_content('title'), 'file', $size);
 			$document->item_properties[] = $property;
 			$this->course->add_resource($document);
 		}
-		foreach($directories as $path => $flag)
+		foreach ($directories as $path => $flag)
 		{
-			$path = substr($path,0,strlen($path)-1);
-			$document = new Document($doc_id++,'/'.$path, $this->get_dummy_content('description'),$this->get_dummy_content('title'),'folder',0);
+			$path = substr($path, 0, strlen($path) - 1);
+			$document = new Document($doc_id++, '/'.$path, $this->get_dummy_content('description'), $this->get_dummy_content('title'), 'folder', 0);
 			$property['lastedit_type'] = 'FolderCreated';
 			$document->item_properties[] = $property;
 			$this->course->add_resource($document);
@@ -119,11 +119,11 @@ 
 		$property['lastedit_type'] = 'AnnouncementAdded';
 		$property['tool'] = TOOL_ANNOUNCEMENT;
 		$number_of_announcements = rand(10, 30);
-		for ($i = 0; $i < $number_of_announcements; $i ++)
+		for ($i = 0; $i < $number_of_announcements; $i++)
 		{
 			$time = mktime(rand(1, 24), rand(1, 60), 0, rand(1, 12), rand(1, 28), intval(date('Y')));
 			$date = date('Y-m-d', $time);
-			$announcement = new Announcement($i,$this->get_dummy_content('title'),$this->get_dummy_content('text'), $date,0);
+			$announcement = new Announcement($i, $this->get_dummy_content('title'), $this->get_dummy_content('text'), $date, 0);
 			$announcement->item_properties[] = $property;
 			$this->course->add_resource($announcement);
 		}
@@ -137,23 +137,23 @@ 
 		$property = $this->default_property;
 		$property['lastedit_type'] = 'AgendaAdded';
 		$property['tool'] = TOOL_CALENDAR_EVENT;
-		for ($i = 0; $i < $number_of_events; $i ++)
+		for ($i = 0; $i < $number_of_events; $i++)
 		{
-			$hour = rand(1,24);
-			$minute = rand(1,60);
-			$second = rand(1,60);
-			$day = rand(1,28);
-			$month = rand(1,12);
+			$hour = rand(1, 24);
+			$minute = rand(1, 60);
+			$second = rand(1, 60);
+			$day = rand(1, 28);
+			$month = rand(1, 12);
 			$year = intval(date('Y'));
-			$time = mktime($hour,$minute,$second,$month,$day,$year);
+			$time = mktime($hour, $minute, $second, $month, $day, $year);
 			$start_date = date('Y-m-d H:m:s', $time);
-			$hour = rand($hour,24);
-			$minute = rand($minute,60);
-			$second = rand($second,60);
-			$day = rand($day,28);
-			$month = rand($month,12);
+			$hour = rand($hour, 24);
+			$minute = rand($minute, 60);
+			$second = rand($second, 60);
+			$day = rand($day, 28);
+			$month = rand($month, 12);
 			$year = intval(date('Y'));
-			$time = mktime($hour,$minute,$second,$month,$day,$year);
+			$time = mktime($hour, $minute, $second, $month, $day, $year);
 			$end_date = date('Y-m-d H:m:s', $time);
 			$event = new CalendarEvent(
 				$i,
@@ -173,20 +173,20 @@ 
 	{
 		// create categorys
 		$number_of_categories = rand(5, 10);
-		for ($i = 0; $i < $number_of_categories; $i ++)
+		for ($i = 0; $i < $number_of_categories; $i++)
 		{
-			$linkcat = new LinkCategory($i, $this->get_dummy_content('title'), $this->get_dummy_content('description'),$i);
+			$linkcat = new LinkCategory($i, $this->get_dummy_content('title'), $this->get_dummy_content('description'), $i);
 			$this->course->add_resource($linkcat);
 		}
 		// create links
 		$number_of_links = rand(5, 50);
-		$on_homepage = rand(0,20) == 0 ? 1 : 0;
+		$on_homepage = rand(0, 20) == 0 ? 1 : 0;
 		$property = $this->default_property;
 		$property['lastedit_type'] = 'LinkAdded';
 		$property['tool'] = TOOL_LINK;
-		for ($i = 0; $i < $number_of_links; $i ++)
+		for ($i = 0; $i < $number_of_links; $i++)
 		{
-			$link = new Link($i, $this->get_dummy_content('title'), 'http://www.google.com/search?q='.$this->get_dummy_content('title'), $this->get_dummy_content('description'), rand(0, $number_of_categories -1),$on_homepage);
+			$link = new Link($i, $this->get_dummy_content('title'), 'http://www.google.com/search?q='.$this->get_dummy_content('title'), $this->get_dummy_content('description'), rand(0, $number_of_categories - 1), $on_homepage);
 			$link->item_properties[] = $property;
 			$this->course->add_resource($link);
 		}
@@ -200,18 +200,18 @@ 
 		$number_of_forums = rand(5, 50);
 		$number_of_topics = rand(30, 100);
 		$number_of_posts = rand(100, 1000);
-		$last_forum_post = array ();
-		$last_topic_post = array ();
+		$last_forum_post = array();
+		$last_topic_post = array();
 		// create categorys
 		$order = 1;
-		for ($i = 1; $i <= $number_of_categories; $i ++)
+		for ($i = 1; $i <= $number_of_categories; $i++)
 		{
 			$forumcat = new ForumCategory($i, $this->get_dummy_content('title'), $this->get_dummy_content('description'), $order, 0, 0);
 			$this->course->add_resource($forumcat);
 			$order++;
 		}
 		// create posts
-		for ($post_id = 1; $post_id <= $number_of_posts; $post_id ++)
+		for ($post_id = 1; $post_id <= $number_of_posts; $post_id++)
 		{
 			$topic_id = rand(1, $number_of_topics);
 			$last_topic_post[$topic_id] = $post_id;
@@ -219,7 +219,7 @@ 
 			$this->course->add_resource($post);
 		}
 		// create topics
-		for ($topic_id = 1; $topic_id <= $number_of_topics; $topic_id ++)
+		for ($topic_id = 1; $topic_id <= $number_of_topics; $topic_id++)
 		{
 			$forum_id = rand(1, $number_of_forums);
 			$last_forum_post[$forum_id] = $last_topic_post[$topic_id];
@@ -227,9 +227,9 @@ 
 			$this->course->add_resource($topic);
 		}
 		// create forums
-		for ($forum_id = 1; $forum_id <= $number_of_forums; $forum_id ++)
+		for ($forum_id = 1; $forum_id <= $number_of_forums; $forum_id++)
 		{
-			$forum = new Forum($forum_id, $this->get_dummy_content('title'),$this->get_dummy_content('description'), rand(1, $number_of_categories), $last_forum_post[$forum_id]);
+			$forum = new Forum($forum_id, $this->get_dummy_content('title'), $this->get_dummy_content('description'), rand(1, $number_of_categories), $last_forum_post[$forum_id]);
 			$this->course->add_resource($forum);
 		}
 	}
@@ -238,25 +238,25 @@ 
 	 */
 	function create_dummy_learnpaths()
 	{
-		$number_of_learnpaths = rand(3,5);
+		$number_of_learnpaths = rand(3, 5);
 		$global_item_id = 1;
-		for($i=1; $i<=$number_of_learnpaths;$i++)
+		for ($i = 1; $i <= $number_of_learnpaths; $i++)
 		{
 		$chapters = array();
-		$number_of_chapters = rand(1,6);
-		for($chapter_id = 1; $chapter_id <= $number_of_chapters; $chapter_id++)
+		$number_of_chapters = rand(1, 6);
+		for ($chapter_id = 1; $chapter_id <= $number_of_chapters; $chapter_id++)
 		{
 			$chapter['name'] = $this->get_dummy_content('title');
 			$chapter['description'] = $this->get_dummy_content('description');
 			$chapter['display_order'] = $chapter_id;
 			$chapter['items'] = array();
-			$number_of_items = rand(5,20);
-			for( $item_id = 1; $item_id<$number_of_items; $item_id++)
+			$number_of_items = rand(5, 20);
+			for ($item_id = 1; $item_id < $number_of_items; $item_id++)
 			{
-				$types = array(RESOURCE_ANNOUNCEMENT, RESOURCE_EVENT, RESOURCE_DOCUMENT,RESOURCE_LINK,RESOURCE_FORUM,RESOURCE_FORUMPOST,RESOURCE_FORUMTOPIC);
-				$type = $types[rand(0,count($types)-1)];
+				$types = array(RESOURCE_ANNOUNCEMENT, RESOURCE_EVENT, RESOURCE_DOCUMENT, RESOURCE_LINK, RESOURCE_FORUM, RESOURCE_FORUMPOST, RESOURCE_FORUMTOPIC);
+				$type = $types[rand(0, count($types) - 1)];
 				$resources = $this->course->resources[$type];
-				$resource = $resources[rand(0,count($resources)-1)];
+				$resource = $resources[rand(0, count($resources) - 1)];
 				$item = array();
 				$item['type'] = $resource->type;
 				$item['id'] = $resource->source_id;
@@ -264,17 +264,17 @@ 
 				$item['title'] = $this->get_dummy_content('title');
 				$item['description'] = $this->get_dummy_content('description');
 				$item['ref_id'] = $global_item_id;
-				if( rand(0,5) == 1 && $item_id > 1)
+				if (rand(0, 5) == 1 && $item_id > 1)
 				{
 					$item['prereq_type'] = 'i';
-					$item['prereq'] = rand($global_item_id - $item_id,$global_item_id-1);
+					$item['prereq'] = rand($global_item_id - $item_id, $global_item_id - 1);
 				}
 				$chapter['items'][] = $item;
 				$global_item_id++;
 			}
 			$chapters[] = $chapter;
 		}
-		$lp = new CourseCopyLearnpath($i,$this->get_dummy_content('title'),$this->get_dummy_content('description'),1,$chapters);
+		$lp = new CourseCopyLearnpath($i, $this->get_dummy_content('title'), $this->get_dummy_content('description'), 1, $chapters);
 		$this->course->add_resource($lp);
 		}
 	}
@@ -288,20 +288,20 @@ 
 		Aenean ac wisi non enim aliquam scelerisque. Praesent eget mi. Vestibulum volutpat pulvinar justo. Phasellus sapien ante, pharetra id, bibendum sed, porta non, purus. Maecenas leo velit, luctus quis, porta non, feugiat sit amet, sapien. Proin vitae augue ut massa adipiscing placerat. Morbi ac risus. Proin dapibus eros egestas quam. Fusce fermentum lobortis elit. Duis lectus tellus, convallis nec, lobortis vel, accumsan ut, nunc. Nunc est. Donec ullamcorper laoreet quam.
 		Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Suspendisse potenti. Mauris mi. Vivamus risus lacus, faucibus sit amet, sollicitudin a, blandit et, justo. In hendrerit. Sed imperdiet, eros at fringilla tempor, turpis augue semper enim, quis rhoncus nibh enim quis dui. Sed massa sapien, mattis et, laoreet sit amet, dignissim nec, urna. Integer laoreet quam quis lectus. Curabitur convallis gravida dui. Nam metus. Ut sit amet augue in nibh interdum scelerisque. Donec venenatis, lacus et pulvinar euismod, libero massa condimentum pede, commodo tristique nunc massa eu quam. Donec vulputate. Aenean in nibh. Phasellus porttitor. Donec molestie, sem ac porttitor vulputate, mauris dui egestas libero, ac lobortis dolor sem vel ligula. Nam vulputate pretium libero. Cras accumsan. Vivamus lacinia sapien sit amet elit.
 		Duis bibendum elementum justo. Duis posuere. Fusce nulla odio, posuere eget, condimentum nec, venenatis eu, elit. In hac habitasse platea dictumst. Aenean ac sem in enim imperdiet feugiat. Integer tincidunt lectus at elit. Integer magna lacus, vehicula quis, eleifend eget, suscipit vitae, leo. Nunc porta augue nec enim. Curabitur vehicula volutpat enim. Aliquam consequat. Vestibulum rhoncus tellus vitae erat. Integer est. Quisque fermentum leo nec odio. Suspendisse lobortis sollicitudin augue. Nullam urna mi, suscipit eu, sagittis laoreet, ultrices ac, sem. Aliquam enim tortor, hendrerit non, cursus a, tristique sit amet, sapien. Suspendisse potenti. Aenean semper placerat neque.';
-		switch($type)
+		switch ($type)
 		{
 		 case 'description':
-		 	$descriptions = explode(".",$dummy_text);
-		 	return $descriptions[rand(0,count($descriptions)-1)];
+		 	$descriptions = explode(".", $dummy_text);
+		 	return $descriptions[rand(0, count($descriptions) - 1)];
 		 	break;
 		 case 'title':
-		 	$dummy_text = str_replace(array("\n",'.',',',"\t"),array(' ','','',' '),$dummy_text);
-		 	$titles = explode(" ",$dummy_text);
-		 	return trim($titles[rand(0,count($titles)-1)]);
+		 	$dummy_text = str_replace(array("\n", '.', ',', "\t"), array(' ', '', '', ' '), $dummy_text);
+		 	$titles = explode(" ", $dummy_text);
+		 	return trim($titles[rand(0, count($titles) - 1)]);
 		 	break;
 		 case 'text':
-		 	$texts = explode("\n",$dummy_text);
-		 	return $texts[rand(0,count($texts)-1)];
+		 	$texts = explode("\n", $dummy_text);
+		 	return $texts[rand(0, count($texts) - 1)];
 		 	break;
 		}
 	}