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

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

Indentation +279 added lines, -279 removed lines

@@ -20,289 +20,289 @@
  */
 class DummyCourseCreator
 {
-	/**
-	 * The dummy course
-	 */
-	public $course;
-	/**
-	 *
-	 */
-	public $default_property = array();
+    /**
+     * The dummy course
+     */
+    public $course;
+    /**
+     *
+     */
+    public $default_property = array();
 
-	/**
-	 * Create the dummy course
-	 */
-	public function create_dummy_course($course_code)
-	{
-		$this->default_property['insert_user_id'] = '1';
-		$this->default_property['insert_date'] = date('Y-m-d H:i:s');
-		$this->default_property['lastedit_date'] = date('Y-m-d H:i:s');
-		$this->default_property['lastedit_user_id'] = '1';
-		$this->default_property['to_group_id'] = '0';
-		$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';
+    /**
+     * Create the dummy course
+     */
+    public function create_dummy_course($course_code)
+    {
+        $this->default_property['insert_user_id'] = '1';
+        $this->default_property['insert_date'] = date('Y-m-d H:i:s');
+        $this->default_property['lastedit_date'] = date('Y-m-d H:i:s');
+        $this->default_property['lastedit_user_id'] = '1';
+        $this->default_property['to_group_id'] = '0';
+        $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';
 
-		$course = api_get_course_info($course_code);
-		$this->course = new Course();
-		$tmp_path = api_get_path(SYS_COURSE_PATH).$course['directory'].'/document/tmp_'.uniqid('');
-		@mkdir($tmp_path, api_get_permissions_for_new_directories(), true);
-		$this->course->backup_path = $tmp_path;
-		$this->create_dummy_links();
-		$this->create_dummy_events();
-		$this->create_dummy_forums();
-		$this->create_dummy_announcements();
-		$this->create_dummy_documents();
-		$this->create_dummy_learnpaths();
-		$cr = new CourseRestorer($this->course);
-		$cr->set_file_option(FILE_OVERWRITE);
-		$cr->restore($course_code);
-		rmdirr($tmp_path);
-	}
-	/**
-	 * Create dummy documents
-	 */
-	function create_dummy_documents()
-	{
-		$course = api_get_course_info();
-		$course_doc_path = $this->course->backup_path.'/document/';
-		$number_of_documents = rand(10, 30);
-		$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 ++)
-		{
-			$path = '';
-			$doc_type = rand(0, count($extensions) - 1);
-			$extension = $extensions[$doc_type];
-			$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 ++)
-			{
-				$path .= 'directory/';
-				$directories[$path] = 1;
-			}
-			$dir_to_make = $course_doc_path.$path;
-			if (!is_dir($dir_to_make))
-			{
-				@mkdir($dir_to_make, api_get_permissions_for_new_directories(), true);
-			}
-			$file = $course_doc_path.$path.$filename;
-			$fp = fopen($file, 'w');
-			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->item_properties[] = $property;
-			$this->course->add_resource($document);
-		}
-		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);
-			$property['lastedit_type'] = 'FolderCreated';
-			$document->item_properties[] = $property;
-			$this->course->add_resource($document);
-		}
-	}
-	/**
-	 * Create dummy announcements
-	 */
-	function create_dummy_announcements()
-	{
-		$property = $this->default_property;
-		$property['lastedit_type'] = 'AnnouncementAdded';
-		$property['tool'] = TOOL_ANNOUNCEMENT;
-		$number_of_announcements = rand(10, 30);
-		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->item_properties[] = $property;
-			$this->course->add_resource($announcement);
-		}
-	}
-	/**
-	 * Create dummy events
-	 */
-	function create_dummy_events()
-	{
-		$number_of_events = rand(10, 30);
-		$property = $this->default_property;
-		$property['lastedit_type'] = 'AgendaAdded';
-		$property['tool'] = TOOL_CALENDAR_EVENT;
-		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);
-			$year = intval(date('Y'));
-			$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);
-			$year = intval(date('Y'));
-			$time = mktime($hour,$minute,$second,$month,$day,$year);
-			$end_date = date('Y-m-d H:m:s', $time);
-			$event = new CalendarEvent(
-				$i,
-				$this->get_dummy_content('title'),
-				$this->get_dummy_content('text'),
-				$start_date,
-				$end_date
-			);
-			$event->item_properties[] = $property;
-			$this->course->add_resource($event);
-		}
-	}
-	/**
-	 * Create dummy links
-	 */
-	function create_dummy_links()
-	{
-		// create categorys
-		$number_of_categories = rand(5, 10);
-		for ($i = 0; $i < $number_of_categories; $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;
-		$property = $this->default_property;
-		$property['lastedit_type'] = 'LinkAdded';
-		$property['tool'] = TOOL_LINK;
-		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->item_properties[] = $property;
-			$this->course->add_resource($link);
-		}
-	}
-	/**
-	 * Create dummy forums
-	 */
-	function create_dummy_forums()
-	{
-		$number_of_categories = rand(2, 6);
-		$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 ();
-		// create categorys
-		$order = 1;
-		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 ++)
-		{
-			$topic_id = rand(1, $number_of_topics);
-			$last_topic_post[$topic_id] = $post_id;
-			$post = new ForumPost($post_id, $this->get_dummy_content('title'), $this->get_dummy_content('text'), date('Y-m-d H:i:s'), 1, 'Portal Administrator', 0, 0, $topic_id, 0, 1);
-			$this->course->add_resource($post);
-		}
-		// create topics
-		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];
-			$topic = new ForumTopic($topic_id, $this->get_dummy_content('title'), '2011-03-31 12:10:00', 'Chamilo', 'Administrator', 0, $forum_id, $last_topic_post[$topic_id]);
-			$this->course->add_resource($topic);
-		}
-		// create forums
-		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]);
-			$this->course->add_resource($forum);
-		}
-	}
-	/**
-	 * Create dummy learnpaths
-	 */
-	function create_dummy_learnpaths()
-	{
-		$number_of_learnpaths = rand(3,5);
-		$global_item_id = 1;
-		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++)
-		{
-			$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++)
-			{
-				$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)];
-				$item = array();
-				$item['type'] = $resource->type;
-				$item['id'] = $resource->source_id;
-				$item['display_order'] = $item_id;
-				$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)
-				{
-					$item['prereq_type'] = 'i';
-					$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);
-		$this->course->add_resource($lp);
-		}
-	}
-	/**
-	 * Get dummy titles, descriptions and texts
-	 */
-	function get_dummy_content($type)
-	{
-		$dummy_text = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Quisque lectus. Duis sodales. Vivamus et nunc. Phasellus interdum est a lorem. Fusce venenatis luctus lectus. Mauris quis turpis ac erat rhoncus suscipit. Phasellus elit dui, semper at, porta ut, egestas ac, enim. Quisque pellentesque, nisl nec consequat mollis, ipsum justo pellentesque nibh, non faucibus odio ante at lorem. Donec vitae pede ut felis ultricies semper. Suspendisse velit nibh, interdum quis, gravida nec, dapibus ac, leo. Cras id sem ut tellus tincidunt scelerisque. Aenean ac magna feugiat dolor accumsan dignissim. Integer eget nisl.
+        $course = api_get_course_info($course_code);
+        $this->course = new Course();
+        $tmp_path = api_get_path(SYS_COURSE_PATH).$course['directory'].'/document/tmp_'.uniqid('');
+        @mkdir($tmp_path, api_get_permissions_for_new_directories(), true);
+        $this->course->backup_path = $tmp_path;
+        $this->create_dummy_links();
+        $this->create_dummy_events();
+        $this->create_dummy_forums();
+        $this->create_dummy_announcements();
+        $this->create_dummy_documents();
+        $this->create_dummy_learnpaths();
+        $cr = new CourseRestorer($this->course);
+        $cr->set_file_option(FILE_OVERWRITE);
+        $cr->restore($course_code);
+        rmdirr($tmp_path);
+    }
+    /**
+     * Create dummy documents
+     */
+    function create_dummy_documents()
+    {
+        $course = api_get_course_info();
+        $course_doc_path = $this->course->backup_path.'/document/';
+        $number_of_documents = rand(10, 30);
+        $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 ++)
+        {
+            $path = '';
+            $doc_type = rand(0, count($extensions) - 1);
+            $extension = $extensions[$doc_type];
+            $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 ++)
+            {
+                $path .= 'directory/';
+                $directories[$path] = 1;
+            }
+            $dir_to_make = $course_doc_path.$path;
+            if (!is_dir($dir_to_make))
+            {
+                @mkdir($dir_to_make, api_get_permissions_for_new_directories(), true);
+            }
+            $file = $course_doc_path.$path.$filename;
+            $fp = fopen($file, 'w');
+            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->item_properties[] = $property;
+            $this->course->add_resource($document);
+        }
+        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);
+            $property['lastedit_type'] = 'FolderCreated';
+            $document->item_properties[] = $property;
+            $this->course->add_resource($document);
+        }
+    }
+    /**
+     * Create dummy announcements
+     */
+    function create_dummy_announcements()
+    {
+        $property = $this->default_property;
+        $property['lastedit_type'] = 'AnnouncementAdded';
+        $property['tool'] = TOOL_ANNOUNCEMENT;
+        $number_of_announcements = rand(10, 30);
+        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->item_properties[] = $property;
+            $this->course->add_resource($announcement);
+        }
+    }
+    /**
+     * Create dummy events
+     */
+    function create_dummy_events()
+    {
+        $number_of_events = rand(10, 30);
+        $property = $this->default_property;
+        $property['lastedit_type'] = 'AgendaAdded';
+        $property['tool'] = TOOL_CALENDAR_EVENT;
+        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);
+            $year = intval(date('Y'));
+            $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);
+            $year = intval(date('Y'));
+            $time = mktime($hour,$minute,$second,$month,$day,$year);
+            $end_date = date('Y-m-d H:m:s', $time);
+            $event = new CalendarEvent(
+                $i,
+                $this->get_dummy_content('title'),
+                $this->get_dummy_content('text'),
+                $start_date,
+                $end_date
+            );
+            $event->item_properties[] = $property;
+            $this->course->add_resource($event);
+        }
+    }
+    /**
+     * Create dummy links
+     */
+    function create_dummy_links()
+    {
+        // create categorys
+        $number_of_categories = rand(5, 10);
+        for ($i = 0; $i < $number_of_categories; $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;
+        $property = $this->default_property;
+        $property['lastedit_type'] = 'LinkAdded';
+        $property['tool'] = TOOL_LINK;
+        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->item_properties[] = $property;
+            $this->course->add_resource($link);
+        }
+    }
+    /**
+     * Create dummy forums
+     */
+    function create_dummy_forums()
+    {
+        $number_of_categories = rand(2, 6);
+        $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 ();
+        // create categorys
+        $order = 1;
+        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 ++)
+        {
+            $topic_id = rand(1, $number_of_topics);
+            $last_topic_post[$topic_id] = $post_id;
+            $post = new ForumPost($post_id, $this->get_dummy_content('title'), $this->get_dummy_content('text'), date('Y-m-d H:i:s'), 1, 'Portal Administrator', 0, 0, $topic_id, 0, 1);
+            $this->course->add_resource($post);
+        }
+        // create topics
+        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];
+            $topic = new ForumTopic($topic_id, $this->get_dummy_content('title'), '2011-03-31 12:10:00', 'Chamilo', 'Administrator', 0, $forum_id, $last_topic_post[$topic_id]);
+            $this->course->add_resource($topic);
+        }
+        // create forums
+        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]);
+            $this->course->add_resource($forum);
+        }
+    }
+    /**
+     * Create dummy learnpaths
+     */
+    function create_dummy_learnpaths()
+    {
+        $number_of_learnpaths = rand(3,5);
+        $global_item_id = 1;
+        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++)
+        {
+            $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++)
+            {
+                $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)];
+                $item = array();
+                $item['type'] = $resource->type;
+                $item['id'] = $resource->source_id;
+                $item['display_order'] = $item_id;
+                $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)
+                {
+                    $item['prereq_type'] = 'i';
+                    $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);
+        $this->course->add_resource($lp);
+        }
+    }
+    /**
+     * Get dummy titles, descriptions and texts
+     */
+    function get_dummy_content($type)
+    {
+        $dummy_text = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Quisque lectus. Duis sodales. Vivamus et nunc. Phasellus interdum est a lorem. Fusce venenatis luctus lectus. Mauris quis turpis ac erat rhoncus suscipit. Phasellus elit dui, semper at, porta ut, egestas ac, enim. Quisque pellentesque, nisl nec consequat mollis, ipsum justo pellentesque nibh, non faucibus odio ante at lorem. Donec vitae pede ut felis ultricies semper. Suspendisse velit nibh, interdum quis, gravida nec, dapibus ac, leo. Cras id sem ut tellus tincidunt scelerisque. Aenean ac magna feugiat dolor accumsan dignissim. Integer eget nisl.
 		Ut sit amet nulla. Vestibulum venenatis posuere mauris. Nullam magna leo, blandit luctus, consequat quis, gravida nec, justo. Nam pede. Etiam ut nisl. In at quam scelerisque sapien faucibus commodo. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Proin mattis lorem quis nunc. Praesent placerat ligula id elit. Aenean blandit, purus sit amet pharetra auctor, libero orci rutrum felis, sit amet sodales mauris ipsum ultricies sapien. Vivamus wisi. Cras elit elit, ullamcorper ac, interdum nec, pulvinar nec, lacus. In lacus. Vivamus auctor, arcu vitae tincidunt porta, eros lacus tristique justo, vitae semper risus neque eget massa. Vivamus turpis.
 		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)
-		{
-		 case 'description':
-		 	$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)]);
-		 	break;
-		 case 'text':
-		 	$texts = explode("\n",$dummy_text);
-		 	return $texts[rand(0,count($texts)-1)];
-		 	break;
-		}
-	}
+        switch($type)
+        {
+            case 'description':
+             $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)]);
+                break;
+            case 'text':
+             $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)
     {

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

Indentation +242 added lines, -242 removed lines

@@ -9,260 +9,260 @@
  */
 class LearnpathLink extends AbstractLink
 {
-	private $course_info = null;
-	private $learnpath_table = null;
-	private $learnpath_data = null;
-
-	/**
-	 * Constructor
-	 */
-	public function __construct()
-	{
-		parent::__construct();
-		$this->set_type(LINK_LEARNPATH);
-	}
-
-	/**
-	 * Generate an array of learnpaths that a teacher hasn't created a link for.
-	 * @return array 2-dimensional array - every element contains 2 subelements (id, name)
-	 */
-	public function get_not_created_links()
-	{
-		return false;
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
-
-		$tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
-
-		$sql = 'SELECT id, name from '.$this->get_learnpath_table().' lp
+    private $course_info = null;
+    private $learnpath_table = null;
+    private $learnpath_data = null;
+
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->set_type(LINK_LEARNPATH);
+    }
+
+    /**
+     * Generate an array of learnpaths that a teacher hasn't created a link for.
+     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
+     */
+    public function get_not_created_links()
+    {
+        return false;
+        if (empty($this->course_code))
+            die('Error in get_not_created_links() : course code not set');
+
+        $tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
+
+        $sql = 'SELECT id, name from '.$this->get_learnpath_table().' lp
 				WHERE c_id = '.$this->course_id.' AND id NOT IN '
-			.' (SELECT ref_id FROM '.$tbl_grade_links
-			.' WHERE type = '.LINK_LEARNPATH
-			." AND course_code = '".$this->get_course_code()."'"
-			.') AND lp.session_id='.api_get_session_id().'';
-
-		$result = Database::query($sql);
-
-		$cats=array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
-		}
-
-		return $cats;
-	}
-
-	/**
-	 * Generate an array of all learnpaths available.
-	 * @return array 2-dimensional array - every element contains 2 subelements (id, name)
-	 */
-	public function get_all_links()
-	{
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
-
-		$session_id = api_get_session_id();
-		if (empty($session_id)) {
-			$session_condition = api_get_session_condition(0, true);
-		} else {
-			$session_condition = api_get_session_condition($session_id, true, true);
-		}
-
-		$sql = 'SELECT id, name FROM '.$this->get_learnpath_table().'
+            .' (SELECT ref_id FROM '.$tbl_grade_links
+            .' WHERE type = '.LINK_LEARNPATH
+            ." AND course_code = '".$this->get_course_code()."'"
+            .') AND lp.session_id='.api_get_session_id().'';
+
+        $result = Database::query($sql);
+
+        $cats=array();
+        while ($data=Database::fetch_array($result)) {
+            $cats[] = array ($data['id'], $data['name']);
+        }
+
+        return $cats;
+    }
+
+    /**
+     * Generate an array of all learnpaths available.
+     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
+     */
+    public function get_all_links()
+    {
+        if (empty($this->course_code))
+            die('Error in get_not_created_links() : course code not set');
+
+        $session_id = api_get_session_id();
+        if (empty($session_id)) {
+            $session_condition = api_get_session_condition(0, true);
+        } else {
+            $session_condition = api_get_session_condition($session_id, true, true);
+        }
+
+        $sql = 'SELECT id, name FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' '.$session_condition.' ';
-		$result = Database::query($sql);
+        $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;
-	}
+        return $cats;
+    }
 
 
-	/**
-	 * Has anyone used this learnpath yet ?
-	 */
-	public function has_results()
-	{
-		$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
-		$sql = "SELECT count(id) AS number FROM $tbl_stats
+    /**
+     * Has anyone used this learnpath yet ?
+     */
+    public function has_results()
+    {
+        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
+        $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');
-		return ($number[0] != 0);
-	}
-
-	/**
-	 * 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)
-	 * @return	array (score, max) if student is given
-	 * 			array (sum of scores, number of scores) otherwise
-	 * 			or null if no scores available
-	 */
-	public function calc_score($stud_id = null, $type = null)
-	{
-		$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
-		$session_id = api_get_session_id();
-
-		$sql = "SELECT * FROM $tbl_stats
+        $result = Database::query($sql);
+        $number = Database::fetch_array($result,'NUM');
+        return ($number[0] != 0);
+    }
+
+    /**
+     * 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)
+     * @return	array (score, max) if student is given
+     * 			array (sum of scores, number of scores) otherwise
+     * 			or null if no scores available
+     */
+    public function calc_score($stud_id = null, $type = null)
+    {
+        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
+        $session_id = api_get_session_id();
+
+        $sql = "SELECT * FROM $tbl_stats
                 WHERE
                 	c_id = ".$this->course_id." AND
                     lp_id = ".$this->get_ref_id()." AND
                     session_id = $session_id ";
 
-		if (isset($stud_id))
-			$sql .= ' AND user_id = '.intval($stud_id);
-
-		// order by id, that way the student's first attempt is accessed first
-		$sql .= ' ORDER BY view_count DESC';
-
-		$scores = Database::query($sql);
-		// for 1 student
-		if (isset($stud_id)) {
-			if ($data = Database::fetch_assoc($scores)) {
-				return array ($data['progress'], 100);
-			} else
-				return null;
-		} else {
-			// all students -> get average
-			$students = array();  // user list, needed to make sure we only
-			// take first attempts into account
-			$rescount = 0;
-			$sum = 0;
-			$bestResult = 0;
-			$sumResult = 0;
-			while ($data = Database::fetch_array($scores)) {
-				if (!(array_key_exists($data['user_id'], $students))) {
-					$students[$data['user_id']] = $data['progress'];
-					$rescount++;
-					$sum += $data['progress'] / 100;
-					$sumResult += $data['progress'];
-
-					if ($data['progress'] > $bestResult) {
-						$bestResult = $data['progress'];
-					}
-				}
-			}
-
-			if ($rescount == 0) {
-				return null;
-			} else {
-
-				switch ($type) {
-					case 'best':
-						return array($bestResult, 100);
-						break;
-					case 'average':
-						return array($sumResult/$rescount, 100);
-						break;
-					case 'ranking':
-						return AbstractLink::getCurrentUserRanking($stud_id, $students);
-						break;
-					default:
-						return array($sum, $rescount);
-						break;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get URL where to go to if the user clicks on the link.
-	 */
-	public function get_link()
-	{
-		$url = api_get_path(WEB_PATH).'main/newscorm/lp_controller.php?cidReq='.$this->get_course_code().'&gradebook=view';
-		$session_id = api_get_session_id();
-		if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
-			$url .= '&action=view&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
-		} else {
-			$url .= '&action=build&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
-		}
-		return $url;
-	}
-
-	/**
-	 * Get name to display: same as learnpath title
-	 */
-	public function get_name()
-	{
-		$data = $this->get_learnpath_data();
-		return $data['name'];
-	}
-
-	/**
-	 * Get description to display: same as learnpath description
-	 */
-	public function get_description()
-	{
-		$data = $this->get_learnpath_data();
-		return $data['description'];
-	}
-
-	/**
-	 * Check if this still links to a learnpath
-	 */
-	public function is_valid_link() {
-		$sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
+        if (isset($stud_id))
+            $sql .= ' AND user_id = '.intval($stud_id);
+
+        // order by id, that way the student's first attempt is accessed first
+        $sql .= ' ORDER BY view_count DESC';
+
+        $scores = Database::query($sql);
+        // for 1 student
+        if (isset($stud_id)) {
+            if ($data = Database::fetch_assoc($scores)) {
+                return array ($data['progress'], 100);
+            } else
+                return null;
+        } else {
+            // all students -> get average
+            $students = array();  // user list, needed to make sure we only
+            // take first attempts into account
+            $rescount = 0;
+            $sum = 0;
+            $bestResult = 0;
+            $sumResult = 0;
+            while ($data = Database::fetch_array($scores)) {
+                if (!(array_key_exists($data['user_id'], $students))) {
+                    $students[$data['user_id']] = $data['progress'];
+                    $rescount++;
+                    $sum += $data['progress'] / 100;
+                    $sumResult += $data['progress'];
+
+                    if ($data['progress'] > $bestResult) {
+                        $bestResult = $data['progress'];
+                    }
+                }
+            }
+
+            if ($rescount == 0) {
+                return null;
+            } else {
+
+                switch ($type) {
+                    case 'best':
+                        return array($bestResult, 100);
+                        break;
+                    case 'average':
+                        return array($sumResult/$rescount, 100);
+                        break;
+                    case 'ranking':
+                        return AbstractLink::getCurrentUserRanking($stud_id, $students);
+                        break;
+                    default:
+                        return array($sum, $rescount);
+                        break;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get URL where to go to if the user clicks on the link.
+     */
+    public function get_link()
+    {
+        $url = api_get_path(WEB_PATH).'main/newscorm/lp_controller.php?cidReq='.$this->get_course_code().'&gradebook=view';
+        $session_id = api_get_session_id();
+        if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
+            $url .= '&action=view&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
+        } else {
+            $url .= '&action=build&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
+        }
+        return $url;
+    }
+
+    /**
+     * Get name to display: same as learnpath title
+     */
+    public function get_name()
+    {
+        $data = $this->get_learnpath_data();
+        return $data['name'];
+    }
+
+    /**
+     * Get description to display: same as learnpath description
+     */
+    public function get_description()
+    {
+        $data = $this->get_learnpath_data();
+        return $data['description'];
+    }
+
+    /**
+     * Check if this still links to a learnpath
+     */
+    public function is_valid_link() {
+        $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');
-		return ($number[0] != 0);
-	}
-
-	public function get_type_name()
-	{
-		return get_lang('LearningPaths');
-	}
-
-	public function needs_name_and_description()
-	{
-		return false;
-	}
-
-	public function needs_max()
-	{
-		return false;
-	}
-
-	public function needs_results()
-	{
-		return false;
-	}
-
-	public function is_allowed_to_change_name()
-	{
-		return false;
-	}
-
-	// INTERNAL FUNCTIONS
-
-	/**
-	 * Lazy load function to get the database table of the learnpath
-	 */
-	private function get_learnpath_table()
-	{
-		$this->learnpath_table = Database :: get_course_table(TABLE_LP_MAIN);
-		return $this->learnpath_table;
-	}
-
-	/**
-	 * Lazy load function to get the database contents of this learnpath
-	 */
-	private function get_learnpath_data()
-	{
-		if (!isset($this->learnpath_data)) {
-			$sql = 'SELECT * FROM '.$this->get_learnpath_table().'
+        $result = Database::query($sql);
+        $number = Database::fetch_row($result,'NUM');
+        return ($number[0] != 0);
+    }
+
+    public function get_type_name()
+    {
+        return get_lang('LearningPaths');
+    }
+
+    public function needs_name_and_description()
+    {
+        return false;
+    }
+
+    public function needs_max()
+    {
+        return false;
+    }
+
+    public function needs_results()
+    {
+        return false;
+    }
+
+    public function is_allowed_to_change_name()
+    {
+        return false;
+    }
+
+    // INTERNAL FUNCTIONS
+
+    /**
+     * Lazy load function to get the database table of the learnpath
+     */
+    private function get_learnpath_table()
+    {
+        $this->learnpath_table = Database :: get_course_table(TABLE_LP_MAIN);
+        return $this->learnpath_table;
+    }
+
+    /**
+     * Lazy load function to get the database contents of this learnpath
+     */
+    private function get_learnpath_data()
+    {
+        if (!isset($this->learnpath_data)) {
+            $sql = 'SELECT * FROM '.$this->get_learnpath_table().'
                     WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
-			$result = Database::query($sql);
-			$this->learnpath_data = Database::fetch_array($result);
-		}
-		return $this->learnpath_data;
-	}
-
-	public function get_icon_name()
-	{
-		return 'learnpath';
-	}
+            $result = Database::query($sql);
+            $this->learnpath_data = Database::fetch_array($result);
+        }
+        return $this->learnpath_data;
+    }
+
+    public function get_icon_name()
+    {
+        return 'learnpath';
+    }
 }

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

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

Indentation +346 added lines, -346 removed lines

@@ -10,28 +10,28 @@ 
  */
 class UserDataGenerator
 {
-	// Sorting types constants
-	const UDG_SORT_TYPE = 1;
-	const UDG_SORT_NAME = 2;
-	const UDG_SORT_COURSE = 4;
-	const UDG_SORT_CATEGORY = 8;
-	const UDG_SORT_AVERAGE = 16;
-	const UDG_SORT_SCORE = 32;
-	const UDG_SORT_MASK = 64;
-
-	const UDG_SORT_ASC = 128;
-	const UDG_SORT_DESC = 256;
-
-	private $items;
-	private $userid;
-
-	private $coursecodecache;
-	private $categorycache;
-	private $scorecache;
-	private $avgcache;
-
-	public function UserDataGenerator($userid, $evals = array(), $links = array())
-	{
+    // Sorting types constants
+    const UDG_SORT_TYPE = 1;
+    const UDG_SORT_NAME = 2;
+    const UDG_SORT_COURSE = 4;
+    const UDG_SORT_CATEGORY = 8;
+    const UDG_SORT_AVERAGE = 16;
+    const UDG_SORT_SCORE = 32;
+    const UDG_SORT_MASK = 64;
+
+    const UDG_SORT_ASC = 128;
+    const UDG_SORT_DESC = 256;
+
+    private $items;
+    private $userid;
+
+    private $coursecodecache;
+    private $categorycache;
+    private $scorecache;
+    private $avgcache;
+
+    public function UserDataGenerator($userid, $evals = array(), $links = array())
+    {
         $this->userid = $userid;
         $evals_filtered = array();
         $result = array();
@@ -62,330 +62,330 @@ 
         $this->avgcache = null;
     }
 
-	/**
-	 * Get total number of items (rows)
-	 */
-	public function get_total_items_count()
-	{
-		return count($this->items);
-	}
-
-	/**
-	 * Get actual array data
-	 * @return array 2-dimensional array - each array contains the elements:
-	 * 0: eval/link object
-	 * 1: item name
-	 * 2: course name
-	 * 3: category name
-	 * 4: average score
-	 * 5: student's score
-	 * 6: student's score as custom display (only if custom scoring enabled)
-	 */
-	public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
-	{
-		// do some checks on count, redefine if invalid value
-		if (!isset($count)) {
-			$count = count ($this->items) - $start;
-		}
-		if ($count < 0) {
-			$count = 0;
-		}
-		$allitems = $this->items;
-
-		// sort users array
-		if ($sorting & self :: UDG_SORT_TYPE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
-		} elseif ($sorting & self :: UDG_SORT_COURSE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
-		} elseif ($sorting & self :: UDG_SORT_CATEGORY) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_category'));
-		} 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();
-			}
-			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()]
-					= $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()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
-		}
-
-		if ($sorting & self :: UDG_SORT_DESC) {
-			$allitems = array_reverse($allitems);
-		}
-		// select the items we have to display
-		$visibleitems = array_slice($allitems, $start, $count);
-
-		// fill score cache if not done yet
-		if (!isset ($this->scorecache)) {
-			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-
-		}
-		// generate the data to display
-		$scoredisplay = ScoreDisplay :: instance();
-		$data = array();
-		foreach ($visibleitems as $item) {
-			$row = array ();
-			$row[] = $item;
-			$row[] = $item->get_name();
-			$row[] = $this->build_course_name($item);
-			$row[] = $this->build_category_name($item);
-			$row[] = $this->build_average_column($item, $ignore_score_color);
-			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
-			$data[] = $row;
-		}
-		return $data;
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_type($item1, $item2)
-	{
-		if ($item1->get_item_type() == $item2->get_item_type()) {
-			return $this->sort_by_name($item1,$item2);
-		} else {
-			return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_course($item1, $item2)
-	{
-		$name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
-		$name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_category($item1, $item2)
-	{
-		$cat1 = $this->get_category_cached($item1->get_category_id());
-		$cat2 = $this->get_category_cached($item2->get_category_id());
-		$name1 = api_strtolower($this->get_category_name_to_display($cat1));
-		$name2 = api_strtolower($this->get_category_name_to_display($cat2));
-
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_name($item1, $item2)
-	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	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()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	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()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	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()];
-
-		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
-	}
-
-	/**
-	 * @param $score1
-	 * @param $score2
-	 * @return int
-	 */
-	function compare_scores($score1, $score2)
-	{
-		if (!isset($score1)) {
-			return (isset($score2) ? 1 : 0);
-		} elseif (!isset($score2)) {
-			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
-			return 0;
-		} else {
-			return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item
-	 * @return mixed
-	 */
-	private function build_course_name($item)
-	{
-		return $this->get_course_name_from_code_cached($item->get_course_code());
-	}
-
-	/**
-	 * @param $item
-	 * @return string
-	 */
-	private function build_category_name($item)
-	{
-		$cat = $this->get_category_cached($item->get_category_id());
-
-		return $this->get_category_name_to_display($cat);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_average_column($item, $ignore_score_color)
-	{
-		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
-		} else {
-			$avgscore = $item->calc_score();
-		}
-
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_AVERAGE;
-		/*if ($ignore_score_color)
+    /**
+     * Get total number of items (rows)
+     */
+    public function get_total_items_count()
+    {
+        return count($this->items);
+    }
+
+    /**
+     * Get actual array data
+     * @return array 2-dimensional array - each array contains the elements:
+     * 0: eval/link object
+     * 1: item name
+     * 2: course name
+     * 3: category name
+     * 4: average score
+     * 5: student's score
+     * 6: student's score as custom display (only if custom scoring enabled)
+     */
+    public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
+    {
+        // do some checks on count, redefine if invalid value
+        if (!isset($count)) {
+            $count = count ($this->items) - $start;
+        }
+        if ($count < 0) {
+            $count = 0;
+        }
+        $allitems = $this->items;
+
+        // sort users array
+        if ($sorting & self :: UDG_SORT_TYPE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_type'));
+        }elseif ($sorting & self :: UDG_SORT_NAME) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_name'));
+        } elseif ($sorting & self :: UDG_SORT_COURSE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_course'));
+        } elseif ($sorting & self :: UDG_SORT_CATEGORY) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_category'));
+        } 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();
+            }
+            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()]
+                    = $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()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
+        }
+
+        if ($sorting & self :: UDG_SORT_DESC) {
+            $allitems = array_reverse($allitems);
+        }
+        // select the items we have to display
+        $visibleitems = array_slice($allitems, $start, $count);
+
+        // fill score cache if not done yet
+        if (!isset ($this->scorecache)) {
+            foreach ($visibleitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+
+        }
+        // generate the data to display
+        $scoredisplay = ScoreDisplay :: instance();
+        $data = array();
+        foreach ($visibleitems as $item) {
+            $row = array ();
+            $row[] = $item;
+            $row[] = $item->get_name();
+            $row[] = $this->build_course_name($item);
+            $row[] = $this->build_category_name($item);
+            $row[] = $this->build_average_column($item, $ignore_score_color);
+            $row[] = $this->build_result_column($item, $ignore_score_color);
+            if ($scoredisplay->is_custom())
+                $row[] = $this->build_mask_column($item, $ignore_score_color);
+            $data[] = $row;
+        }
+        return $data;
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_type($item1, $item2)
+    {
+        if ($item1->get_item_type() == $item2->get_item_type()) {
+            return $this->sort_by_name($item1,$item2);
+        } else {
+            return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_course($item1, $item2)
+    {
+        $name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
+        $name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_category($item1, $item2)
+    {
+        $cat1 = $this->get_category_cached($item1->get_category_id());
+        $cat2 = $this->get_category_cached($item2->get_category_id());
+        $name1 = api_strtolower($this->get_category_name_to_display($cat1));
+        $name2 = api_strtolower($this->get_category_name_to_display($cat2));
+
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_name($item1, $item2)
+    {
+        return api_strnatcmp($item1->get_name(),$item2->get_name());
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    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()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    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()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    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()];
+
+        return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
+    }
+
+    /**
+     * @param $score1
+     * @param $score2
+     * @return int
+     */
+    function compare_scores($score1, $score2)
+    {
+        if (!isset($score1)) {
+            return (isset($score2) ? 1 : 0);
+        } elseif (!isset($score2)) {
+            return -1;
+        } elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+            return 0;
+        } else {
+            return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item
+     * @return mixed
+     */
+    private function build_course_name($item)
+    {
+        return $this->get_course_name_from_code_cached($item->get_course_code());
+    }
+
+    /**
+     * @param $item
+     * @return string
+     */
+    private function build_category_name($item)
+    {
+        $cat = $this->get_category_cached($item->get_category_id());
+
+        return $this->get_category_name_to_display($cat);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_average_column($item, $ignore_score_color)
+    {
+        if (isset($this->avgcache)) {
+            $avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+        } else {
+            $avgscore = $item->calc_score();
+        }
+
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_AVERAGE;
+        /*if ($ignore_score_color)
 			$displaytype |= SCORE_IGNORE_SPLIT;
         */
-		return $scoredisplay->display_score($avgscore, $displaytype);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_result_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_mask_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
-	}
-
-	/**
-	 * @param $coursecode
-	 * @return mixed
-	 */
-	private function get_course_name_from_code_cached($coursecode)
-	{
-		if (isset ($this->coursecodecache)
-			&& isset ($this->coursecodecache[$coursecode])) {
-			return $this->coursecodecache[$coursecode];
-		} else {
-			$name = CourseManager::getCourseNameFromCode($coursecode);
-			$this->coursecodecache[$coursecode] = $name;
-			return $name;
-		}
-	}
-
-	/**
-	 * @param $category_id
-	 * @return null
-	 */
-	private function get_category_cached($category_id)
-	{
-		if (isset ($this->categorycache)
-			&& isset ($this->categorycache[$category_id])) {
-			return $this->categorycache[$category_id];
-		}else {
-			$cat = Category::load($category_id);
-			if (isset($cat)){
-				$this->categorycache[$category_id] = $cat[0];
-				return $cat[0];
-			}else
-				return null;
-		}
-	}
-
-	/**
-	 * @param $cat
-	 * @return string
-	 */
-	private function get_category_name_to_display($cat)
-	{
-		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
-				return '';
-			} else {
-				return $cat->get_name();
-			}
-		} else {
-			return '';
-		}
-	}
+        return $scoredisplay->display_score($avgscore, $displaytype);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_result_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_mask_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
+    }
+
+    /**
+     * @param $coursecode
+     * @return mixed
+     */
+    private function get_course_name_from_code_cached($coursecode)
+    {
+        if (isset ($this->coursecodecache)
+            && isset ($this->coursecodecache[$coursecode])) {
+            return $this->coursecodecache[$coursecode];
+        } else {
+            $name = CourseManager::getCourseNameFromCode($coursecode);
+            $this->coursecodecache[$coursecode] = $name;
+            return $name;
+        }
+    }
+
+    /**
+     * @param $category_id
+     * @return null
+     */
+    private function get_category_cached($category_id)
+    {
+        if (isset ($this->categorycache)
+            && isset ($this->categorycache[$category_id])) {
+            return $this->categorycache[$category_id];
+        }else {
+            $cat = Category::load($category_id);
+            if (isset($cat)){
+                $this->categorycache[$category_id] = $cat[0];
+                return $cat[0];
+            }else
+                return null;
+        }
+    }
+
+    /**
+     * @param $cat
+     * @return string
+     */
+    private function get_category_name_to_display($cat)
+    {
+        if (isset($cat)) {
+            if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+                return '';
+            } else {
+                return $cat->get_name();
+            }
+        } else {
+            return '';
+        }
+    }
 }

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)

Indentation +1 added lines, -1 removed lines

@@ -1510,7 +1510,7 @@
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".implode(", ", $group_memberships)."))
                         ) ";
                     } else {
-                       $cond_user_id = " AND (
+                        $cond_user_id = " AND (
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".api_get_group_id()."))
                         )";
                     }

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

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

Indentation +13 added lines, -13 removed lines

@@ -401,19 +401,19 @@
 
     public function format_yes_no_optional($value)
     {
-    	$return = '';
-    	switch($value) {
-     		case 0:
-     			$return = get_lang('No');
-     			break;
-     		case 1:
-     			$return = get_lang('Yes');
-     			break;
-			case 2:
-				$return = get_lang('Optional');
-				break;
-    	}
-    	return $return;
+        $return = '';
+        switch($value) {
+                case 0:
+                 $return = get_lang('No');
+                    break;
+                case 1:
+                 $return = get_lang('Yes');
+                    break;
+            case 2:
+                $return = get_lang('Optional');
+                break;
+        }
+        return $return;
 
     }