chamilo / chamilo-lms

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

main/exercice/oral_expression.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     function return_header($feedback_type = null, $counter = null, $score = null)
     {

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     function createAnswersForm($form)
     {
 
-        $form -> addElement('text','weighting', get_lang('Weighting'), array('class' => 'span1'));
+        $form -> addElement('text', 'weighting', get_lang('Weighting'), array('class' => 'span1'));
         global $text, $class;
         // setting the save button here and not in the question class.php
         $form->addButtonSave($text, 'submitQuestion');

main/gradebook/lib/be/learnpathlink.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 
 	/**
 	 * Get the progress of this learnpath. Only the last attempt are taken into account.
-	 * @param $stud_id student id (default: all students who have results - then the average is returned)
+	 * @param integer $stud_id student id (default: all students who have results - then the average is returned)
 	 * @return	array (score, max) if student is given
 	 * 			array (sum of scores, number of scores) otherwise
 	 * 			or null if no scores available

Spacing +10 added lines, -10 removed lines

@@ -43,9 +43,9 @@ 
 
 		$result = Database::query($sql);
 
-		$cats=array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
+		$cats = array();
+		while ($data = Database::fetch_array($result)) {
+			$cats[] = array($data['id'], $data['name']);
 		}
 
 		return $cats;
@@ -72,8 +72,8 @@ 
 		$result = Database::query($sql);
 
 		$cats = array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
+		while ($data = Database::fetch_array($result)) {
+			$cats[] = array($data['id'], $data['name']);
 		}
 
 		return $cats;
@@ -89,7 +89,7 @@ 
 		$sql = "SELECT count(id) AS number FROM $tbl_stats
 				WHERE c_id = ".$this->course_id." AND lp_id = ".$this->get_ref_id();
 		$result = Database::query($sql);
-		$number = Database::fetch_array($result,'NUM');
+		$number = Database::fetch_array($result, 'NUM');
 		return ($number[0] != 0);
 	}
 
@@ -121,12 +121,12 @@ 
 		// for 1 student
 		if (isset($stud_id)) {
 			if ($data = Database::fetch_array($scores)) {
-				return array ($data['progress'], 100);
+				return array($data['progress'], 100);
 			} else
 				return null;
 		} else {
 			// all students -> get average
-			$students = array();  // user list, needed to make sure we only
+			$students = array(); // user list, needed to make sure we only
 			// take first attempts into account
 			$rescount = 0;
 			$sum = 0;
@@ -154,7 +154,7 @@ 
 						return array($bestResult, 100);
 						break;
 					case 'average':
-						return array($sumResult/$rescount, 100);
+						return array($sumResult / $rescount, 100);
 						break;
 					case 'ranking':
 						return AbstractLink::getCurrentUserRanking($stud_id, $students);
@@ -207,7 +207,7 @@ 
 		$sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
 		$result = Database::query($sql);
-		$number = Database::fetch_row($result,'NUM');
+		$number = Database::fetch_row($result, 'NUM');
 		return ($number[0] != 0);
 	}
 

main/gradebook/lib/fe/gradebooktable.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
      * @param array $evals
      * @param array $links
      * @param null $addparams
+     * @param boolean $showTeacherView
+     * @param integer $userId
      */
     public function __construct(
         $currentcat,
@@ -895,7 +897,7 @@ 
 
     /**
      * @param $item
-     * @return mixed
+     * @return string|null
      */
     private function build_course_code($item)
     {

Spacing +42 added lines, -42 removed lines

@@ -71,7 +71,7 @@ 
             $this->set_additional_parameters($addparams);
         }
 
-        $column= 0;
+        $column = 0;
         if ($this->teacherView) {
             if ($this->exportToPdf == false) {
                 $this->set_header($column++, '', '', 'width="25px"');
@@ -283,13 +283,13 @@ 
                 $main_categories[$item->get_id()]['name'] = $item->get_name();
             } else {
                 $name = $this->build_name_link($item, $type);
-                $row[] = $invisibility_span_open.$name. $invisibility_span_close;
+                $row[] = $invisibility_span_open.$name.$invisibility_span_close;
                 $main_categories[$item->get_id()]['name'] = $name;
             }
 
             $this->dataForGraph['categories'][] = $item->get_name();
 
-            $main_categories[$item->get_id()]['weight']= $item->get_weight();
+            $main_categories[$item->get_id()]['weight'] = $item->get_weight();
             $total_categories_weight += $item->get_weight();
 
             // Description.
@@ -309,9 +309,9 @@ 
             );
 
             if ($this->teacherView) {
-                $row[] = $invisibility_span_open .Display::tag('p', $weight, array('class' => 'score')).$invisibility_span_close;
+                $row[] = $invisibility_span_open.Display::tag('p', $weight, array('class' => 'score')).$invisibility_span_close;
             } else {
-                $row[] = $invisibility_span_open .$weight.$invisibility_span_close;
+                $row[] = $invisibility_span_open.$weight.$invisibility_span_close;
             }
 
             $category_weight = $item->get_weight();
@@ -337,7 +337,7 @@ 
 
                 if (!empty($score[1])) {
                     $completeScore = $scoredisplay->display_score($score, SCORE_DIV_PERCENT);
-                    $score = $score[0]/$score[1]*$item->get_weight();
+                    $score = $score[0] / $score[1] * $item->get_weight();
                     $score = $scoredisplay->display_score(array($score, null), SCORE_SIMPLE);
                     $scoreToDisplay = Display::tip($score, $completeScore);
                 } else {
@@ -373,7 +373,7 @@ 
                     $totalResultAverageValue = strip_tags($scoredisplay->display_score($totalResult, SCORE_AVERAGE));
                     $this->dataForGraph['my_result'][] = (float) str_replace('%', '', $totalResultAverageValue);
                     $totalAverageValue = strip_tags($scoredisplay->display_score($totalAverage, SCORE_AVERAGE));
-                    $this->dataForGraph['average'][] =  (float) str_replace('%', '', $totalAverageValue);
+                    $this->dataForGraph['average'][] = (float) str_replace('%', '', $totalAverageValue);
                     // Ranking
                     $row[] = $ranking;
                     // Best
@@ -456,7 +456,7 @@ 
                         $row[] = $this->build_type_column($item, array('style' => 'padding-left:5px'));
 
                         // Name.
-                        $row[] = $invisibility_span_open."     ".$this->build_name_link($item, $type) . $invisibility_span_close;
+                        $row[] = $invisibility_span_open."     ".$this->build_name_link($item, $type).$invisibility_span_close;
 
                         // Description.
                         if ($this->exportToPdf == false) {
@@ -494,7 +494,7 @@ 
                             // Students get the results and certificates columns
                             $eval_n_links = array_merge($alleval, $alllink);
 
-                            if (count($eval_n_links)> 0) {
+                            if (count($eval_n_links) > 0) {
                                 $value_data = isset($data[4]) ? $data[4] : null;
 
                                 if (!is_null($value_data)) {
@@ -593,7 +593,7 @@ 
                 $row = array(
                     null,
                     null,
-                    '<strong>' . get_lang('Total') . '</strong>',
+                    '<strong>'.get_lang('Total').'</strong>',
                     null,
                     $total
                 );
@@ -663,7 +663,7 @@ 
                 if ($this->exportToPdf) {
                     $row = array(
                         null,
-                        '<h3>' . get_lang('Total') . '</h3>',
+                        '<h3>'.get_lang('Total').'</h3>',
                         $main_weight,
                         $totalResult,
                         $totalRanking,
@@ -673,7 +673,7 @@ 
                 } else {
                     $row = array(
                         null,
-                        '<h3>' . get_lang('Total') . '</h3>',
+                        '<h3>'.get_lang('Total').'</h3>',
                         null,
                         $main_weight,
                         $totalResult,
@@ -688,7 +688,7 @@ 
         }
 
         // Warning messages
-        $view = isset($_GET['view']) ? $_GET['view']: null;
+        $view = isset($_GET['view']) ? $_GET['view'] : null;
 
         if ($this->teacherView) {
             if (isset($_GET['selectcat']) &&
@@ -701,14 +701,14 @@ 
                 $weight_category = intval($this->build_weight($category[0]));
 
                 $course_code = $this->build_course_code($category[0]);
-                $weight_total_links  = round($weight_total_links);
+                $weight_total_links = round($weight_total_links);
 
                 if ($weight_total_links > $weight_category ||
                     $weight_total_links < $weight_category ||
                     $weight_total_links > $weight_category
                 ) {
                     $warning_message = sprintf(get_lang('TotalWeightMustBeX'), $weight_category);
-                    $modify_icons  = '<a href="gradebook_edit_cat.php?editcat='.$id_cat.'&cidReq='.$course_code.'&id_session='.api_get_session_id().'">'.
+                    $modify_icons = '<a href="gradebook_edit_cat.php?editcat='.$id_cat.'&cidReq='.$course_code.'&id_session='.api_get_session_id().'">'.
                         Display::return_icon('edit.png', $warning_message, array(), ICON_SIZE_SMALL).'</a>';
                     $warning_message .= $modify_icons;
                     Display::display_warning_message($warning_message, false);
@@ -721,7 +721,7 @@ 
                 );
 
                 if (!empty($content_html)) {
-                    $new_content = explode('</head>',$content_html['content']);
+                    $new_content = explode('</head>', $content_html['content']);
                 }
 
                 if (empty($new_content[0])) {
@@ -755,7 +755,7 @@ 
                     is_array($course_codes)
                 ) {
                     $warning_message = '';
-                    for ($x = 0; $x<count($weight_categories);$x++) {
+                    for ($x = 0; $x < count($weight_categories); $x++) {
                         $weight_category = intval($weight_categories[$x]);
                         $certificate_min_score = intval($certificate_min_scores[$x]);
                         $course_code = $course_codes[$x];
@@ -763,12 +763,12 @@ 
                         if (empty($certificate_min_score) ||
                             ($certificate_min_score > $weight_category)
                         ) {
-                            $warning_message .= $course_code .'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
+                            $warning_message .= $course_code.'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
                         }
                     }
 
                     if (!empty($warning_message)) {
-                        Display::display_warning_message($warning_message,false);
+                        Display::display_warning_message($warning_message, false);
                     }
                 }
             }
@@ -812,15 +812,15 @@ 
             $pChart->Antialias = FALSE;
 
             /* Add a border to the picture */
-            $pChart->drawRectangle(0,0,$xSize-10,$ySize-10,array("R"=>0,"G"=>0,"B"=>0));
+            $pChart->drawRectangle(0, 0, $xSize - 10, $ySize - 10, array("R"=>0, "G"=>0, "B"=>0));
 
-            $pChart->drawText(10,16,get_lang('Results'),array("FontSize"=>11,"Align"=>TEXT_ALIGN_BOTTOMLEFT));
+            $pChart->drawText(10, 16, get_lang('Results'), array("FontSize"=>11, "Align"=>TEXT_ALIGN_BOTTOMLEFT));
 
-            $pChart->setGraphArea(50, 30, $xSize-50, $ySize-50);
+            $pChart->setGraphArea(50, 30, $xSize - 50, $ySize - 50);
 
             $pChart->setFontProperties(
                 array(
-                    'FontName' => api_get_path(SYS_FONTS_PATH) . 'opensans/OpenSans-Regular.ttf',
+                    'FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf',
                     'FontSize' => 10,
                 )
             );
@@ -840,7 +840,7 @@ 
 
             /* Draw the line chart */
             $pChart->drawLineChart();
-            $pChart->drawPlotChart(array("DisplayValues"=>TRUE,"PlotBorder"=>TRUE,"BorderSize"=>2,"Surrounding"=>-60,"BorderAlpha"=>80));
+            $pChart->drawPlotChart(array("DisplayValues"=>TRUE, "PlotBorder"=>TRUE, "BorderSize"=>2, "Surrounding"=>-60, "BorderAlpha"=>80));
 
             /* Write the chart legend */
             $pChart->drawLegend(
@@ -860,13 +860,13 @@ 
             $chartHash = $myCache->getHash($dataSet);
 
             $myCache->writeToCache($chartHash, $pChart);
-            $imgSysPath = api_get_path(SYS_ARCHIVE_PATH) . $chartHash;
+            $imgSysPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash;
             $myCache->saveFromCache($chartHash, $imgSysPath);
-            $imgWebPath = api_get_path(WEB_ARCHIVE_PATH) . $chartHash;
+            $imgWebPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash;
 
             if (file_exists($imgSysPath)) {
                 $result = '<div id="contentArea" style="text-align: center;" >';
-                $result .= '<img src="' . $imgWebPath.'" >';
+                $result .= '<img src="'.$imgWebPath.'" >';
                 $result .= '</div>';
                 return $result;
             }
@@ -911,13 +911,13 @@ 
         switch ($item->get_item_type()) {
             // category
             case 'C' :
-                return 'CATE' . $item->get_id();
+                return 'CATE'.$item->get_id();
             // evaluation
             case 'E' :
-                return 'EVAL' . $item->get_id();
+                return 'EVAL'.$item->get_id();
             // link
             case 'L' :
-                return 'LINK' . $item->get_id();
+                return 'LINK'.$item->get_id();
         }
     }
 
@@ -945,20 +945,20 @@ 
         switch ($item->get_item_type()) {
             // category
             case 'C' :
-                $prms_uri='?selectcat=' . $item->get_id() . '&amp;view='.$view;
+                $prms_uri = '?selectcat='.$item->get_id().'&amp;view='.$view;
 
                 if (isset($_GET['isStudentView'])) {
-                    if ( isset($is_student) || ( isset($_SESSION['studentview']) && $_SESSION['studentview']=='studentview') ) {
-                        $prms_uri=$prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
+                    if (isset($is_student) || (isset($_SESSION['studentview']) && $_SESSION['studentview'] == 'studentview')) {
+                        $prms_uri = $prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
                     }
                 }
 
                 $cat = new Category();
-                $show_message=$cat->show_message_resource_delete($item->get_course_code());
+                $show_message = $cat->show_message_resource_delete($item->get_course_code());
                 return '&nbsp;<a href="'.Security::remove_XSS($_SESSION['gradebook_dest']).$prms_uri.'">'
                 . $item->get_name()
                 . '</a>'
-                . ($item->is_course() ? ' &nbsp;[' . $item->get_course_code() . ']'.$show_message : '');
+                . ($item->is_course() ? ' &nbsp;['.$item->get_course_code().']'.$show_message : '');
                 // evaluation
             case 'E' :
                 $cat = new Category();
@@ -966,10 +966,10 @@ 
                 $show_message = $cat->show_message_resource_delete($course_id);
 
                 // course/platform admin can go to the view_results page
-                if (api_is_allowed_to_edit() && $show_message===false) {
+                if (api_is_allowed_to_edit() && $show_message === false) {
                     if ($item->get_type() == 'presence') {
                         return '&nbsp;'
-                        . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
+                        . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval='.$item->get_id().'">'
                         . $item->get_name()
                         . '</a>';
                     } else {
@@ -978,20 +978,20 @@ 
                             $extra = '';
                         }
                         return '&nbsp;'
-                        . '<a href="gradebook_view_result.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                        . '<a href="gradebook_view_result.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                         . $item->get_name()
                         . '</a>&nbsp;'.$extra;
                     }
-                } elseif (ScoreDisplay :: instance()->is_custom() && $show_message===false) {
+                } elseif (ScoreDisplay :: instance()->is_custom() && $show_message === false) {
                     // students can go to the statistics page (if custom display enabled)
                     return '&nbsp;'
-                    . '<a href="gradebook_statistics.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                    . '<a href="gradebook_statistics.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                     . $item->get_name()
                     . '</a>';
 
                 } elseif ($show_message === false && !api_is_allowed_to_edit() && !ScoreDisplay :: instance()->is_custom()) {
                     return '&nbsp;'
-                    . '<a href="gradebook_statistics.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                    . '<a href="gradebook_statistics.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                     . $item->get_name()
                     . '</a>';
                 } else {
@@ -1006,7 +1006,7 @@ 
                 $url = $item->get_link();
 
                 if (isset($url) && $show_message === false) {
-                    $text = '&nbsp;<a href="' . $item->get_link() . '">'
+                    $text = '&nbsp;<a href="'.$item->get_link().'">'
                         . $item->get_name()
                         . '</a>';
                 } else {

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * Get actual array data
+	 * @param integer $count
 	 * @return array 2-dimensional array - each array contains the elements:
 	 * 0: eval/link object
 	 * 1: item name
@@ -285,7 +286,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
 	/**
 	 * @param $coursecode
-	 * @return mixed
+	 * @return string
 	 */
 	private function get_course_name_from_code_cached($coursecode)
 	{

Spacing +25 added lines, -25 removed lines

@@ -50,9 +50,9 @@ 
 
         }
         if (count($result) == 0) {
-            $evals_filtered=$evals;
+            $evals_filtered = $evals;
         } else {
-            $evals_filtered=$evals_filtered_copy;
+            $evals_filtered = $evals_filtered_copy;
         }
         $this->items = array_merge($evals_filtered, $links);
 
@@ -85,7 +85,7 @@ 
 	{
 		// do some checks on count, redefine if invalid value
 		if (!isset($count)) {
-			$count = count ($this->items) - $start;
+			$count = count($this->items) - $start;
 		}
 		if ($count < 0) {
 			$count = 0;
@@ -104,20 +104,20 @@ 
 		} elseif ($sorting & self :: UDG_SORT_AVERAGE) {
 			// if user sorts on average scores, first calculate them and cache them
 			foreach ($allitems as $item) {
-				$this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
+				$this->avgcache[$item->get_item_type().$item->get_id()] = $item->calc_score();
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_average'));
 		} elseif ($sorting & self :: UDG_SORT_SCORE) {
 			// if user sorts on student's scores, first calculate them and cache them
 			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_score'));
 		} elseif ($sorting & self :: UDG_SORT_MASK) {
 			// if user sorts on student's masks, first calculate scores and cache them
 			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
@@ -132,7 +132,7 @@ 
 		// fill score cache if not done yet
 		if (!isset ($this->scorecache)) {
 			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 
@@ -141,7 +141,7 @@ 
 		$scoredisplay = ScoreDisplay :: instance();
 		$data = array();
 		foreach ($visibleitems as $item) {
-			$row = array ();
+			$row = array();
 			$row[] = $item;
 			$row[] = $item->get_name();
 			$row[] = $this->build_course_name($item);
@@ -163,7 +163,7 @@ 
 	function sort_by_type($item1, $item2)
 	{
 		if ($item1->get_item_type() == $item2->get_item_type()) {
-			return $this->sort_by_name($item1,$item2);
+			return $this->sort_by_name($item1, $item2);
 		} else {
 			return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
 		}
@@ -203,7 +203,7 @@ 
 	 */
 	function sort_by_name($item1, $item2)
 	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
+		return api_strnatcmp($item1->get_name(), $item2->get_name());
 	}
 
 	/**
@@ -213,8 +213,8 @@ 
 	 */
 	function sort_by_average($item1, $item2)
 	{
-		$score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->avgcache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->avgcache[$item2->get_item_type().$item2->get_id()];
 
 		return $this->compare_scores($score1, $score2);
 	}
@@ -226,8 +226,8 @@ 
 	 */
 	function sort_by_score($item1, $item2)
 	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->scorecache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->scorecache[$item2->get_item_type().$item2->get_id()];
 
 		return $this->compare_scores($score1, $score2);
 	}
@@ -239,8 +239,8 @@ 
 	 */
 	function sort_by_mask($item1, $item2)
 	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->scorecache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->scorecache[$item2->get_item_type().$item2->get_id()];
 
 		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
 	}
@@ -256,10 +256,10 @@ 
 			return (isset($score2) ? 1 : 0);
 		} elseif (!isset($score2)) {
 			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+		} elseif (($score1[0] / $score1[1]) == ($score2[0] / $score2[1])) {
 			return 0;
 		} else {
-			return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+			return (($score1[0] / $score1[1]) < ($score2[0] / $score2[1]) ? -1 : 1);
 		}
 	}
 
@@ -291,7 +291,7 @@ 
 	private function build_average_column($item, $ignore_score_color)
 	{
 		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+			$avgscore = $this->avgcache[$item->get_item_type().$item->get_id()];
 		} else {
 			$avgscore = $item->calc_score();
 		}
@@ -311,7 +311,7 @@ 
 	 */
 	private function build_result_column($item, $ignore_score_color)
 	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+		$studscore = $this->scorecache[$item->get_item_type().$item->get_id()];
 		$scoredisplay = ScoreDisplay :: instance();
 		$displaytype = SCORE_DIV_PERCENT;
 		if ($ignore_score_color) {
@@ -328,7 +328,7 @@ 
 	 */
 	private function build_mask_column($item, $ignore_score_color)
 	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+		$studscore = $this->scorecache[$item->get_item_type().$item->get_id()];
 		$scoredisplay = ScoreDisplay :: instance();
 		$displaytype = SCORE_DIV_PERCENT;
 		if ($ignore_score_color) {
@@ -362,12 +362,12 @@ 
 		if (isset ($this->categorycache)
 			&& isset ($this->categorycache[$category_id])) {
 			return $this->categorycache[$category_id];
-		}else {
+		} else {
 			$cat = Category::load($category_id);
-			if (isset($cat)){
+			if (isset($cat)) {
 				$this->categorycache[$category_id] = $cat[0];
 				return $cat[0];
-			}else
+			} else
 				return null;
 		}
 	}
@@ -379,7 +379,7 @@ 
 	private function get_category_name_to_display($cat)
 	{
 		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null) {
 				return '';
 			} else {
 				return $cat->get_name();

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

Spacing +73 added lines, -73 removed lines

@@ -216,8 +216,8 @@ 
                             announcement.id = '$announcement_id' AND
                             toolitemproperties.tool='announcement' AND
                             (
-                                toolitemproperties.to_user_id='" . api_get_user_id() . "' OR
-                                toolitemproperties.to_group_id IN ('0', '" . implode("', '", $group_list) . "') OR
+                                toolitemproperties.to_user_id='".api_get_user_id()."' OR
+                                toolitemproperties.to_group_id IN ('0', '" . implode("', '", $group_list)."') OR
                                 toolitemproperties.to_group_id IS NULL
                             ) AND
                             toolitemproperties.visibility='1' AND
@@ -246,13 +246,13 @@ 
             $title = $result['title'];
             $content = $result['content'];
             $html .= "<table height=\"100\" width=\"100%\" cellpadding=\"5\" cellspacing=\"0\" class=\"data_table\">";
-            $html .= "<tr><td><h2>" . $title . "</h2></td></tr>";
+            $html .= "<tr><td><h2>".$title."</h2></td></tr>";
 
             if (api_is_allowed_to_edit(false, true) ||
                 (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
             ) {
-                $modify_icons = "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&action=modify&id=" . $announcement_id . "\">" .
-                    Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL) . "</a>";
+                $modify_icons = "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=modify&id=".$announcement_id."\">".
+                    Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
                 if ($result['visibility'] == 1) {
                     $image_visibility = "visible";
                     $alt_visibility = get_lang('Hide');
@@ -262,12 +262,12 @@ 
                 }
                 global $stok;
 
-                $modify_icons .= "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&origin=" . (!empty($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '') . "&action=showhide&id=" . $announcement_id . "&sec_token=" . $stok . "\">" .
-                    Display::return_icon($image_visibility . '.png', $alt_visibility, '', ICON_SIZE_SMALL) . "</a>";
+                $modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&origin=".(!empty($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '')."&action=showhide&id=".$announcement_id."&sec_token=".$stok."\">".
+                    Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
 
                 if (api_is_allowed_to_edit(false, true)) {
-                    $modify_icons .= "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&action=delete&id=" . $announcement_id . "&sec_token=" . $stok . "\" onclick=\"javascript:if(!confirm('" . addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset)) . "')) return false;\">" .
-                        Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL) .
+                    $modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=delete&id=".$announcement_id."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset))."')) return false;\">".
+                        Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
                         "</a>";
                 }
                 $html .= "<tr><th style='text-align:right'>$modify_icons</th></tr>";
@@ -276,7 +276,7 @@ 
             $content = self::parse_content($result['to_user_id'], $content, api_get_course_id(), api_get_session_id());
 
             $html .= "<tr><td>$content</td></tr>";
-            $html .= "<tr><td class=\"announcements_datum\">" . get_lang('LastUpdateDate') . " : " . api_convert_and_format_date($result['insert_date'], DATE_TIME_FORMAT_LONG) . "</td></tr>";
+            $html .= "<tr><td class=\"announcements_datum\">".get_lang('LastUpdateDate')." : ".api_convert_and_format_date($result['insert_date'], DATE_TIME_FORMAT_LONG)."</td></tr>";
 
             // User or group icon
             $sent_to_icon = '';
@@ -288,7 +288,7 @@ 
                 $sent_to_form = self::sent_to_form($sent_to);
                 $html .= Display::tag(
                     'td',
-                    get_lang('SentTo') . ' : ' . $sent_to_form,
+                    get_lang('SentTo').' : '.$sent_to_form,
                     array('class' => 'announcements_datum')
                 );
             }
@@ -298,15 +298,15 @@ 
                 $html .= "<tr><td>";
                 $realname = $attachment_list['path'];
                 $user_filename = $attachment_list['filename'];
-                $full_file_name = 'download.php?'.api_get_cidreq().'&file=' . $realname;
+                $full_file_name = 'download.php?'.api_get_cidreq().'&file='.$realname;
                 $html .= '<br/>';
                 $html .= Display::return_icon('attachment.gif', get_lang('Attachment'));
-                $html .= '<a href="' . $full_file_name . ' "> ' . $user_filename . ' </a>';
-                $html .= ' - <span class="forum_attach_comment" >' . $attachment_list['comment'] . '</span>';
+                $html .= '<a href="'.$full_file_name.' "> '.$user_filename.' </a>';
+                $html .= ' - <span class="forum_attach_comment" >'.$attachment_list['comment'].'</span>';
                 if (api_is_allowed_to_edit(false, true)) {
                     $html .= Display::url(
                         Display::return_icon('delete.png', get_lang('Delete'), '', 16),
-                        api_get_self() . "?" . api_get_cidreq() . "&action=delete_attachment&id_attach=" . $attachment_list['id'] . "&sec_token=" . $stok
+                        api_get_self()."?".api_get_cidreq()."&action=delete_attachment&id_attach=".$attachment_list['id']."&sec_token=".$stok
                     );
                 }
                 $html .= '</td></tr>';
@@ -334,7 +334,7 @@ 
         $order = 0;
         if (Database::num_rows($res_max)) {
             $row_max = Database::fetch_array($res_max);
-            $order = intval($row_max[0])+1;
+            $order = intval($row_max[0]) + 1;
         }
 
         return $order;
@@ -754,8 +754,8 @@ 
             $result = array();
             if ($num_rows > 0) {
                 while ($myrow = Database::fetch_array($rs)) {
-                    $content.= '<strong>' . $myrow['title'] . '</strong><br /><br />';
-                    $content.= $myrow['content'];
+                    $content .= '<strong>'.$myrow['title'].'</strong><br /><br />';
+                    $content .= $myrow['content'];
                     $i++;
                 }
                 $result['content'] = $content;
@@ -786,7 +786,7 @@ 
         echo "<table id=\"recipient_list\" >";
         echo '<tr>';
         echo '<td>';
-        echo '<label><input type="checkbox" id="send_to_all_users">'.get_lang('SendToAllUsers') . "</label>";
+        echo '<label><input type="checkbox" id="send_to_all_users">'.get_lang('SendToAllUsers')."</label>";
         echo "</td>";
         echo '</tr>';
         echo '<tr>';
@@ -794,7 +794,7 @@ 
 
         // the form containing all the groups and all the users of the course
         echo '<td>';
-        echo "<strong>" . get_lang('Users') . "</strong><br />";
+        echo "<strong>".get_lang('Users')."</strong><br />";
 
         self::construct_not_selected_select_form($groupList, $userList, $to_already_selected);
         echo "</td>";
@@ -809,7 +809,7 @@ 
         echo "<td>";
 
         // the form containing the selected groups and users
-        echo "<strong>" . get_lang('DestinationUsers') . "</strong><br />";
+        echo "<strong>".get_lang('DestinationUsers')."</strong><br />";
         self::construct_selected_select_form($groupList, $userList, $to_already_selected);
         echo "</td>";
         echo "</tr>";
@@ -827,8 +827,8 @@ 
         echo "<select id=\"not_selected_form\" name=\"not_selected_form[]\" size=5 style=\"width:200px\" multiple>";
         $group_users = GroupManager::getStudentsAndTutors($group_id);
         foreach ($group_users as $user) {
-            echo '<option value="' . $user['user_id'] . '" title="' . sprintf(get_lang('LoginX'), $user['username']) . '" >' .
-                api_get_person_name($user['firstname'], $user['lastname']) .
+            echo '<option value="'.$user['user_id'].'" title="'.sprintf(get_lang('LoginX'), $user['username']).'" >'.
+                api_get_person_name($user['firstname'], $user['lastname']).
                 '</option>';
         }
         echo '</select>';
@@ -866,12 +866,12 @@ 
         if (!empty($groupList)) {
             foreach ($groupList as $this_group) {
                 if (is_array($to_already_selected)) {
-                    if (!in_array("GROUP:" . $this_group['id'], $to_already_selected)) {
+                    if (!in_array("GROUP:".$this_group['id'], $to_already_selected)) {
                         // $to_already_selected is the array containing the groups (and users) that are already selected
-                        $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser') ;
-                        $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled" ;
-                        echo "<option $user_disabled value=\"GROUP:" . $this_group['id'] . "\">",
-                        "G: ", $this_group['name'], " - " . $this_group['userNb'] . " " . $user_label .
+                        $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser');
+                        $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled";
+                        echo "<option $user_disabled value=\"GROUP:".$this_group['id']."\">",
+                        "G: ", $this_group['name'], " - ".$this_group['userNb']." ".$user_label.
                             "</option>";
                     }
                 }
@@ -885,15 +885,15 @@ 
         if (!empty($userList)) {
             foreach ($userList as $user) {
                 if (is_array($to_already_selected)) {
-                    if (!in_array("USER:" . $user['user_id'], $to_already_selected)) {
+                    if (!in_array("USER:".$user['user_id'], $to_already_selected)) {
                         // $to_already_selected is the array containing the users (and groups) that are already selected
-                        echo "<option value=\"USER:" . $user['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $user['username']) . "'>",
+                        echo "<option value=\"USER:".$user['user_id']."\" title='".sprintf(get_lang('LoginX'), $user['username'])."'>",
                         "", api_get_person_name($user['firstname'], $user['lastname']),
                         "</option>";
 
                         if (isset($user['drh_list']) && !empty($user['drh_list'])) {
                             foreach ($user['drh_list'] as $drh) {
-                                echo "<option value=\"USER:" . $drh['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $drh['username']) . "'>&nbsp;&nbsp;&nbsp;&nbsp;",
+                                echo "<option value=\"USER:".$drh['user_id']."\" title='".sprintf(get_lang('LoginX'), $drh['username'])."'>&nbsp;&nbsp;&nbsp;&nbsp;",
                                 "", api_get_person_name($drh['firstname'], $drh['lastname']),
                                 "</option>";
                             }
@@ -925,16 +925,16 @@ 
             foreach ($to_already_selected as $groupuser) {
                 list($type, $id) = explode(":", $groupuser);
                 if ($type == "GROUP") {
-                    echo "<option value=\"" . $groupuser . "\">G: " . $ref_array_groups[$id]['name'] . "</option>";
+                    echo "<option value=\"".$groupuser."\">G: ".$ref_array_groups[$id]['name']."</option>";
                 } else {
                     foreach ($ref_array_users as $key => $value) {
                         if ($value['user_id'] == $id) {
-                            echo "<option value=\"" . $groupuser . "\" title='" . sprintf(get_lang('LoginX'), $value['username']) . "'>" .
-                                api_get_person_name($value['firstname'], $value['lastname']) . "</option>";
+                            echo "<option value=\"".$groupuser."\" title='".sprintf(get_lang('LoginX'), $value['username'])."'>".
+                                api_get_person_name($value['firstname'], $value['lastname'])."</option>";
 
                             if (isset($value['drh_list']) && !empty($value['drh_list'])) {
                                 foreach ($value['drh_list'] as $drh) {
-                                    echo "<option value=\"USER:" . $drh['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $drh['username']) . "'>&nbsp;&nbsp;&nbsp;&nbsp;",
+                                    echo "<option value=\"USER:".$drh['user_id']."\" title='".sprintf(get_lang('LoginX'), $drh['username'])."'>&nbsp;&nbsp;&nbsp;&nbsp;",
                                     "", api_get_person_name($drh['firstname'], $drh['lastname']),
                                     "</option>";
                                 }
@@ -950,17 +950,17 @@ 
                 if (is_array($ref_array_groups)) {
                     foreach ($ref_array_groups as $this_group) {
                         //api_display_normal_message("group " . $thisGroup[id] . $thisGroup[name]);
-                        if (!is_array($to_already_selected) || !in_array("GROUP:" . $this_group['id'], $to_already_selected)) { // $to_already_selected is the array containing the groups (and users) that are already selected
-                            echo "<option value=\"GROUP:" . $this_group['id'] . "\">",
-                            "G: ", $this_group['name'], " &ndash; " . $this_group['userNb'] . " " . get_lang('Users') .
+                        if (!is_array($to_already_selected) || !in_array("GROUP:".$this_group['id'], $to_already_selected)) { // $to_already_selected is the array containing the groups (and users) that are already selected
+                            echo "<option value=\"GROUP:".$this_group['id']."\">",
+                            "G: ", $this_group['name'], " &ndash; ".$this_group['userNb']." ".get_lang('Users').
                                 "</option>";
                         }
                     }
                 }
                 // adding the individual users to the select form
                 foreach ($ref_array_users as $this_user) {
-                    if (!is_array($to_already_selected) || !in_array("USER:" . $this_user['user_id'], $to_already_selected)) { // $to_already_selected is the array containing the users (and groups) that are already selected
-                        echo "<option value=\"USER:", $this_user['user_id'], "\"  title='" . sprintf(get_lang('LoginX'), $this_user['username']) . "'>",
+                    if (!is_array($to_already_selected) || !in_array("USER:".$this_user['user_id'], $to_already_selected)) { // $to_already_selected is the array containing the users (and groups) that are already selected
+                        echo "<option value=\"USER:", $this_user['user_id'], "\"  title='".sprintf(get_lang('LoginX'), $this_user['username'])."'>",
                         "", api_get_person_name($this_user['firstname'], $this_user['lastname']),
                         "</option>";
                     }
@@ -1073,14 +1073,14 @@ 
             switch ($to_group) {
                 // it was send to one specific user
                 case null:
-                    $to[] = "USER:" . $row['to_user_id'];
+                    $to[] = "USER:".$row['to_user_id'];
                     break;
                 // it was sent to everyone
                 case 0:
                     return "everyone";
                     break;
                 default:
-                    $to[] = "GROUP:" . $row['to_group_id'];
+                    $to[] = "GROUP:".$row['to_group_id'];
             }
         }
         return $to;
@@ -1161,10 +1161,10 @@ 
                 $sent_to_array['groups'][0] !== 0
             ) {
                 $group_id = $sent_to_array['groups'][0];
-                $output[] = "&nbsp;" . $group_names[$group_id]['name'];
+                $output[] = "&nbsp;".$group_names[$group_id]['name'];
             }
             if (empty($sent_to_array['groups']) and empty($sent_to_array['users'])) {
-                $output[] = "&nbsp;" . get_lang('Everybody');
+                $output[] = "&nbsp;".get_lang('Everybody');
             }
         }
 
@@ -1199,7 +1199,7 @@ 
 
         $sql = "SELECT to_group_id, to_user_id
                 FROM $tbl_item_property
-                WHERE c_id = $course_id AND tool = '$tool' AND ref=" . $id;
+                WHERE c_id = $course_id AND tool = '$tool' AND ref=".$id;
         $result = Database::query($sql);
 
         while ($row = Database::fetch_array($result)) {
@@ -1238,8 +1238,8 @@ 
         $announcement_id = intval($announcement_id);
         $course_id = api_get_course_int_id();
         $row = array();
-        $sql = 'SELECT id, path, filename, comment FROM ' . $tbl_announcement_attachment . '
-				WHERE c_id = ' . $course_id . ' AND announcement_id = ' . $announcement_id . '';
+        $sql = 'SELECT id, path, filename, comment FROM '.$tbl_announcement_attachment.'
+				WHERE c_id = ' . $course_id.' AND announcement_id = '.$announcement_id.'';
         $result = Database::query($sql);
         if (Database::num_rows($result) != 0) {
             $row = Database::fetch_array($result, 'ASSOC');
@@ -1264,9 +1264,9 @@ 
 
         if (is_array($file) && $file['error'] == 0) {
             // TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
-            $courseDir = $_course['path'] . '/upload/announcements';
+            $courseDir = $_course['path'].'/upload/announcements';
             $sys_course_path = api_get_path(SYS_COURSE_PATH);
-            $updir = $sys_course_path . $courseDir;
+            $updir = $sys_course_path.$courseDir;
 
             // Try to add an extension to the file if it hasn't one
             $new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
@@ -1278,7 +1278,7 @@ 
                 Display :: display_error_message(get_lang('UplUnableToSaveFileFilteredExtension'));
             } else {
                 $new_file_name = uniqid('');
-                $new_path = $updir . '/' . $new_file_name;
+                $new_path = $updir.'/'.$new_file_name;
                 move_uploaded_file($file['tmp_name'], $new_path);
 
                 $params = [
@@ -1319,9 +1319,9 @@ 
 
         if (is_array($file) && $file['error'] == 0) {
             // TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
-            $courseDir = $_course['path'] . '/upload/announcements';
+            $courseDir = $_course['path'].'/upload/announcements';
             $sys_course_path = api_get_path(SYS_COURSE_PATH);
-            $updir = $sys_course_path . $courseDir;
+            $updir = $sys_course_path.$courseDir;
 
             // Try to add an extension to the file if it hasn't one
             $new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
@@ -1333,13 +1333,13 @@ 
                 Display :: display_error_message(get_lang('UplUnableToSaveFileFilteredExtension'));
             } else {
                 $new_file_name = uniqid('');
-                $new_path = $updir . '/' . $new_file_name;
+                $new_path = $updir.'/'.$new_file_name;
                 @move_uploaded_file($file['tmp_name'], $new_path);
                 $safe_file_comment = Database::escape_string($file_comment);
                 $safe_file_name = Database::escape_string($file_name);
                 $safe_new_file_name = Database::escape_string($new_file_name);
                 $id_attach = intval($id_attach);
-                $sql = "UPDATE $tbl_announcement_attachment SET filename = '$safe_file_name', comment = '$safe_file_comment', path = '$safe_new_file_name', size ='" . intval($file['size']) . "'
+                $sql = "UPDATE $tbl_announcement_attachment SET filename = '$safe_file_name', comment = '$safe_file_comment', path = '$safe_new_file_name', size ='".intval($file['size'])."'
 					 	WHERE c_id = $course_id AND id = '$id_attach'";
                 $result = Database::query($sql);
                 if ($result === false) {
@@ -1441,7 +1441,7 @@ 
 
             //if (!empty($user_id)) {
             if (0) {
-                if (is_array($group_memberships) && count($group_memberships) > 0 ) {
+                if (is_array($group_memberships) && count($group_memberships) > 0) {
                     $sql = "SELECT $select
                             FROM $tbl_announcement announcement, $tbl_item_property ip
                             WHERE
@@ -1652,8 +1652,8 @@ 
                 $attachment_list = AnnouncementManager::get_attachment($myrow['id']);
 
                 $attachment_icon = '';
-                if (count($attachment_list)>0) {
-                    $attachment_icon = ' '.Display::return_icon('attachment.gif',get_lang('Attachment'));
+                if (count($attachment_list) > 0) {
+                    $attachment_icon = ' '.Display::return_icon('attachment.gif', get_lang('Attachment'));
                 }
 
                 /* TITLE */
@@ -1672,16 +1672,16 @@ 
                     || (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
                 ) {
                     $modify_icons = "<a href=\"".$actionUrl."&action=modify&id=".$myrow['id']."\">".
-                        Display::return_icon('edit.png', get_lang('Edit'),'',ICON_SIZE_SMALL)."</a>";
-                    if ($myrow['visibility']==1) {
-                        $image_visibility="visible";
-                        $alt_visibility=get_lang('Hide');
+                        Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
+                    if ($myrow['visibility'] == 1) {
+                        $image_visibility = "visible";
+                        $alt_visibility = get_lang('Hide');
                     } else {
-                        $image_visibility="invisible";
-                        $alt_visibility=get_lang('Visible');
+                        $image_visibility = "invisible";
+                        $alt_visibility = get_lang('Visible');
                     }
-                    $modify_icons .=  "<a href=\"".$actionUrl."&origin=".$origin."&action=showhide&id=".$myrow['id']."&sec_token=".$stok."\">".
-                        Display::return_icon($image_visibility.'.png', $alt_visibility,'',ICON_SIZE_SMALL)."</a>";
+                    $modify_icons .= "<a href=\"".$actionUrl."&origin=".$origin."&action=showhide&id=".$myrow['id']."&sec_token=".$stok."\">".
+                        Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
 
                     // DISPLAY MOVE UP COMMAND only if it is not the top announcement
                     if ($iterator != 1) {
@@ -1696,12 +1696,12 @@ 
                     } else {
                         $modify_icons .= Display::return_icon('down_na.gif', get_lang('Down'));
                     }
-                    if (api_is_allowed_to_edit(false,true)) {
-                        $modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$myrow['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'),ENT_QUOTES,api_get_system_encoding()))."')) return false;\">".
-                            Display::return_icon('delete.png', get_lang('Delete'),'',ICON_SIZE_SMALL).
+                    if (api_is_allowed_to_edit(false, true)) {
+                        $modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$myrow['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, api_get_system_encoding()))."')) return false;\">".
+                            Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
                             "</a>";
                     }
-                    $iterator ++;
+                    $iterator++;
                 } else {
                     $modify_icons = Display::url(
                         Display::return_icon('default.png'),
@@ -1731,7 +1731,7 @@ 
     public static function getNumberAnnouncements()
     {
         // Maximum title messages to display
-        $maximum 	= '12';
+        $maximum = '12';
         // Database Table Definitions
         $tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
         $tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
@@ -1742,7 +1742,7 @@ 
         $userId = api_get_user_id();
         $condition_session = api_get_session_condition($session_id, true, true, 'announcement.session_id');
 
-        if (api_is_allowed_to_edit(false,true))  {
+        if (api_is_allowed_to_edit(false, true)) {
             // check teacher status
             if (empty($_GET['origin']) or $_GET['origin'] !== 'learnpath') {
 
@@ -1805,7 +1805,7 @@ 
                 }
 
                 // the user is member of several groups => display personal announcements AND his group announcements AND the general announcements
-                if (is_array($group_memberships) && count($group_memberships)>0) {
+                if (is_array($group_memberships) && count($group_memberships) > 0) {
                     $sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
                     FROM $tbl_announcement announcement, $tbl_item_property ip
                     WHERE
@@ -1855,7 +1855,7 @@ 
                         }
 
                         // the user is not identiefied => show only the general announcements
-                        $sql="SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
+                        $sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
                                 FROM $tbl_announcement announcement, $tbl_item_property ip
                                 WHERE
                                     announcement.c_id = $course_id AND

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -213,7 +213,7 @@ 
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */
@@ -650,7 +650,7 @@ 
      * @param array $all_tools_list List of tools as returned by get_tools_category()
      * @param bool  $rows
      *
-     * @return void
+     * @return string
      */
     public static function show_tools_category($all_tools_list, $rows = false)
     {
@@ -1194,6 +1194,7 @@ 
 
     /**
      * Show a toolbar with shortcuts to the course tool
+     * @param integer $orientation
      */
     public static function show_navigation_tool_shortcuts($orientation = SHORTCUTS_HORIZONTAL)
     {

Spacing +4 added lines, -4 removed lines

@@ -351,7 +351,7 @@ 
                         array(),
                         null,
                         ICON_SIZE_MEDIUM
-                    ) . '&nbsp;' . $tool_name . '</a>';
+                    ).'&nbsp;'.$tool_name.'</a>';
 
                 // This part displays the links to hide or remove a tool.
                 // These links are only visible by the course manager.
@@ -678,7 +678,7 @@ 
         $session_id = api_get_session_id();
         $is_platform_admin = api_is_platform_admin();
 
-        if ($session_id == 0 ) {
+        if ($session_id == 0) {
             $is_allowed_to_edit = api_is_allowed_to_edit(null, true) && api_is_course_admin();
         } else {
             $is_allowed_to_edit = api_is_allowed_to_edit(null, true) && !api_is_coach();
@@ -1255,7 +1255,7 @@ 
             return array();
         }
 
-        $table  = Database::get_course_table(TABLE_TOOL_LIST);
+        $table = Database::get_course_table(TABLE_TOOL_LIST);
         $sql = "SELECT * FROM $table
                 WHERE category in ('authoring','interaction')
                 AND c_id = $courseId
@@ -1361,7 +1361,7 @@ 
             $temp = new Image($path);
             $r = $temp->convert2bw();
             $ext = pathinfo($path, PATHINFO_EXTENSION);
-            $bwPath = substr($path,0,-(strlen($ext)+1)) . '_na.' . $ext;
+            $bwPath = substr($path, 0, -(strlen($ext) + 1)).'_na.'.$ext;
 
             if ($r === false) {
                 error_log('Conversion to B&W of '.$path.' failed in '.__FILE__.' at line '.__LINE__);

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {

Spacing +27 added lines, -27 removed lines

@@ -15,7 +15,7 @@ 
 {
     const STATUS_OK = 1;
     const STATUS_WARNING = 2;
-    const STATUS_ERROR 	= 3;
+    const STATUS_ERROR = 3;
     const STATUS_INFORMATION = 4;
 
     /**
@@ -44,21 +44,21 @@ 
                 $html .= '<li>';
             }
             $params['section'] = $section;
-            $html .='<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
+            $html .= '<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
         }
 
         $html .= '</ul><div class="tab-pane">';
 
-        $data = call_user_func(array($this, 'get_' . $current_section . '_data'));
+        $data = call_user_func(array($this, 'get_'.$current_section.'_data'));
         echo $html;
         $table = new SortableTableFromArray($data, 1, 100);
 
-        $table->set_header(0,'', false);
-        $table->set_header(1,get_lang('Section'), false);
-        $table->set_header(2,get_lang('Setting'), false);
-        $table->set_header(3,get_lang('Current'), false);
-        $table->set_header(4,get_lang('Expected'), false);
-        $table->set_header(5,get_lang('Comment'), false);
+        $table->set_header(0, '', false);
+        $table->set_header(1, get_lang('Section'), false);
+        $table->set_header(2, get_lang('Setting'), false);
+        $table->set_header(3, get_lang('Current'), false);
+        $table->set_header(4, get_lang('Expected'), false);
+        $table->set_header(5, get_lang('Comment'), false);
 
         $table->display();
         echo '</div></div>';
@@ -72,11 +72,11 @@ 
     {
         $array = array();
         $writable_folders = array(
-            api_get_path(SYS_APP_PATH) .'cache',
+            api_get_path(SYS_APP_PATH).'cache',
             api_get_path(SYS_COURSE_PATH),
-            api_get_path(SYS_APP_PATH) .'home',
-            api_get_path(SYS_APP_PATH) .'upload/users/',
-            api_get_path(SYS_PATH) .'main/default_course_document/images/',
+            api_get_path(SYS_APP_PATH).'home',
+            api_get_path(SYS_APP_PATH).'upload/users/',
+            api_get_path(SYS_PATH).'main/default_course_document/images/',
         );
 
         foreach ($writable_folders as $index => $folder) {
@@ -99,7 +99,7 @@ 
         $array[] = $this->build_setting(
             $status,
             '[FILES]',
-            get_lang('DirectoryExists') . ': /install',
+            get_lang('DirectoryExists').': /install',
             'http://be2.php.net/file_exists',
             $exists,
             0,
@@ -129,7 +129,7 @@ 
                     $message2 .= get_lang('SpaceUsedOnSystemCannotBeMeasuredOnWindows');
                 } else {
                     $dir = api_get_path(SYS_PATH);
-                    $du = exec('du -sh ' . $dir, $err);
+                    $du = exec('du -sh '.$dir, $err);
                     list($size, $none) = explode("\t", $du);
                     $limit = $_configuration[$access_url_id]['hosting_limit_disk_space'];
                     $message2 .= sprintf(get_lang('TotalSpaceUsedByPortalXLimitIsYMB'), $size, $limit);
@@ -216,33 +216,33 @@ 
         $array[] = $this->build_setting($status, '[INI]', 'default_charset', 'http://www.php.net/manual/en/ini.core.php#ini.default-charset', $setting, $req_setting, null, get_lang('DefaultCharsetInfo'));
 
         $setting = ini_get('max_execution_time');
-        $req_setting = '300 (' . get_lang('Minimum') . ')';
+        $req_setting = '300 ('.get_lang('Minimum').')';
         $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'max_execution_time', 'http://www.php.net/manual/en/ini.core.php#ini.max-execution-time', $setting, $req_setting, null, get_lang('MaxExecutionTimeInfo'));
 
         $setting = ini_get('max_input_time');
-        $req_setting = '300 (' . get_lang('Minimum') . ')';
+        $req_setting = '300 ('.get_lang('Minimum').')';
         $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'max_input_time', 'http://www.php.net/manual/en/ini.core.php#ini.max-input-time', $setting, $req_setting, null, get_lang('MaxInputTimeInfo'));
 
         $setting = ini_get('memory_limit');
         $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
+        if ((float) $setting >= REQUIRED_MIN_MEMORY_LIMIT)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'memory_limit', 'http://www.php.net/manual/en/ini.core.php#ini.memory-limit', $setting, $req_setting, null, get_lang('MemoryLimitInfo'));
 
         $setting = ini_get('post_max_size');
         $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
+        if ((float) $setting >= REQUIRED_MIN_POST_MAX_SIZE)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'post_max_size', 'http://www.php.net/manual/en/ini.core.php#ini.post-max-size', $setting, $req_setting, null, get_lang('PostMaxSizeInfo'));
 
         $setting = ini_get('upload_max_filesize');
         $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
+        if ((float) $setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'upload_max_filesize', 'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize', $setting, $req_setting, null, get_lang('UploadMaxFilesizeInfo'));
 
@@ -256,7 +256,7 @@ 
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[SESSION]', 'session.gc_maxlifetime', 'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime', $setting, $req_setting, null, get_lang('SessionGCMaxLifetimeInfo'));
 
-        if (api_check_browscap()){$setting = true;}else{$setting=false;}
+        if (api_check_browscap()) {$setting = true; } else {$setting = false; }
         $req_setting = true;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'browscap', 'http://www.php.net/manual/en/misc.configuration.php#ini.browscap', $setting, $req_setting, 'on_off', get_lang('BrowscapInfo'));
@@ -312,7 +312,7 @@ 
 
             $loaded = extension_loaded($extension);
             $status = $loaded ? self :: STATUS_OK : self :: STATUS_ERROR;
-            $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension') . ': ' . $extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
+            $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension').': '.$extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
         }
 
         return $array;
@@ -435,9 +435,9 @@ 
         $formatted_expected_value = $expected_value;
 
         if ($formatter) {
-            if (method_exists($this, 'format_' . $formatter)) {
-                $formatted_current_value = call_user_func(array($this, 'format_' . $formatter), $current_value);
-                $formatted_expected_value = call_user_func(array($this, 'format_' . $formatter), $expected_value);
+            if (method_exists($this, 'format_'.$formatter)) {
+                $formatted_current_value = call_user_func(array($this, 'format_'.$formatter), $current_value);
+                $formatted_expected_value = call_user_func(array($this, 'format_'.$formatter), $expected_value);
             }
         }
 
@@ -452,13 +452,13 @@ 
      */
     public function get_link($title, $url)
     {
-        return '<a href="' . $url . '" target="about:bank">' . $title . '</a>';
+        return '<a href="'.$url.'" target="about:bank">'.$title.'</a>';
     }
 
     public function format_yes_no_optional($value)
     {
     	$return = '';
-    	switch($value) {
+    	switch ($value) {
      		case 0:
      			$return = get_lang('No');
      			break;