Minor - Updated PHPDoc headers

main/coursecopy/classes/Announcement.class.php

@@ -6,7 +6,7 @@ require_once 'Resource.class.php';
 /**
  * An announcement
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class Announcement extends Resource
 {
@@ -71,4 +71,4 @@ class Announcement extends Resource
 		echo $this->date.': '.$this->title;
 	}
 }
-?>
+?>

main/coursecopy/classes/Course.class.php

@@ -8,7 +8,7 @@ require_once 'Event.class.php';
 /**
  * A course-object to use in Export/Import/Backup/Copy
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class Course
 {

main/coursecopy/classes/CourseArchiver.class.php

@@ -8,9 +8,9 @@ require_once api_get_path(LIBRARY_PATH).'pclzip/pclzip.lib.php';
  * Some functions to write a course-object to a zip-file and to read a course-
  * object from such a zip-file.
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  *
- * @todo Use archive-folder of Dokeos?
+ * @todo Use archive-folder of Chamilo?
  */
 class CourseArchiver
 {
@@ -175,7 +175,7 @@ class CourseArchiver
 	 * Read a course-object from a zip-file
 	 * @return course The course
 	 * @param boolean $delete Delete the file after reading the course?
-	 * @todo Check if the archive is a correct Dokeos-export
+	 * @todo Check if the archive is a correct Chamilo-export
 	 */
 	function read_course($filename,$delete = false)
 	{
@@ -213,4 +213,4 @@ class CourseArchiver
 		$course->backup_path = $unzip_dir;
 		return $course;
 	}
-}
+}

main/coursecopy/classes/CourseBuilder.class.php

@@ -23,9 +23,9 @@ require_once 'CourseSession.class.php';
 require_once 'wiki.class.php';
 
 /**
- * Class which can build a course-object from a Dokeos-course.
+ * Class which can build a course-object from a Chamilo-course.
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class CourseBuilder {
 	/**

main/coursecopy/classes/CourseDescription.class.php

@@ -6,6 +6,7 @@ require_once 'Resource.class.php';
 /**
  * A course description
  * @author Bart Mollet <bart.mollet@hogent.be>
+ * @package chamilo.backup
  */
 class CourseDescription extends Resource
 {
@@ -43,4 +44,4 @@ class CourseDescription extends Resource
 		echo $this->title;
 	}
 }
-?>
+?>

main/coursecopy/classes/CourseRecycler.class.php

@@ -4,9 +4,9 @@
 require_once 'Course.class.php';
 
 /**
- * Class to delete items from a Dokeos-course
+ * Class to delete items from a Chamilo-course
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class CourseRecycler
 {
@@ -25,7 +25,7 @@ class CourseRecycler
     }
     /**
      * Delete all items from the course.
-     * This deletes all items in the course-object from the current Dokeos-
+     * This deletes all items in the course-object from the current Chamilo-
      * course
      */
     function recycle()

main/coursecopy/classes/CourseRestorer.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Course Restorer script
+ * @package chamilo.backup
+ */
 require_once 'Course.class.php';
 require_once 'Event.class.php';
 require_once 'Link.class.php';
@@ -27,7 +30,7 @@ define('FILE_SKIP', 1);
 define('FILE_RENAME', 2);
 define('FILE_OVERWRITE', 3);
 /**
- * Class to restore items from a course object to a Dokeos-course
+ * Class to restore items from a course object to a Chamilo-course
  * @author Bart Mollet <bart.mollet@hogent.be>
  * @author Julio Montoya <gugli100@gmail.com> Several fixes/improvements
  * @package chamilo.backup
@@ -1408,7 +1411,7 @@ class CourseRestorer
 					}
 					*/
 					/*
-					//Get the new ref ID for all items that are not sco (dokeos quizzes, documents, etc)
+					//Get the new ref ID for all items that are not sco (chamilo quizzes, documents, etc)
 					$ref = '';
 					if(!empty($item['ref']) && $lp->lp_type!='2'){
 						$ref = $this->get_new_id($item['item_type'],$item['ref']);

main/coursecopy/classes/CourseSession.class.php

@@ -1,10 +1,11 @@
 <?php 
-/* For licensing terms, see /dokeos_license.txt */
+/* For licensing terms, see /license.txt */
 require_once('Resource.class.php');
 
 /*
  * A course session
- *  @author Jhon Hinojosa <jhon.hinojosa@dokeos.com>
+ *  @author Jhon Hinojosa <jhon.hinojosa@beeznest.com>
+ * @package chamilo.backup
  **/
 class CourseSession extends Resource {
 	var $title; // The title session
@@ -27,4 +28,4 @@ class CourseSession extends Resource {
 		echo $this->title;	
 	}
 }
-?>
+?>

main/coursecopy/classes/Document.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Document class file
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 define('DOCUMENT','file');
@@ -9,7 +12,7 @@ define('FOLDER','folder');
 /**
  * An document
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class Document extends Resource
 {

main/coursecopy/classes/DummyCourseCreator.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Dummy course creator
+ * @package chamilo.backup
+ */
 require_once 'Course.class.php';
 require_once 'Document.class.php';
 require_once 'Event.class.php';
@@ -204,7 +207,7 @@ class DummyCourseCreator
 		{
 			$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, 'Dokeos Administrator', 0, 0, $topic_id, 0, 1);
+			$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
@@ -212,7 +215,7 @@ class DummyCourseCreator
 		{
 			$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'), '2005-03-31 12:10:00', 'Dokeos', 'Administrator', 0, $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

main/coursecopy/classes/Event.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Event backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
@@ -77,4 +80,4 @@ class Event extends Resource
 		echo $this->title.' ('.$this->start_date.' -> '.$this->end_date.')';
 	}
 }
-?>
+?>

main/coursecopy/classes/Forum.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Forum backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**

main/coursecopy/classes/ForumCategory.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Forum category backup class
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**

main/coursecopy/classes/ForumPost.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Forum post backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**

main/coursecopy/classes/ForumTopic.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Forum topic backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**

main/coursecopy/classes/Glossary.class.php

@@ -1,12 +1,15 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Glossary backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
  * Add resource glossary
  * @author Isaac flores <florespaz@bidsoftperu.com>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class Glossary extends Resource
 {
@@ -40,4 +43,4 @@ class Glossary extends Resource
 		echo $this->name;
 	}
 }
-?>
+?>

main/coursecopy/classes/Link.class.php

@@ -1,10 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Link backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
- * A WWW-link from the Links-module in a Dokeos-course.
+ * A WWW-link from the Links-module in a Chamilo-course.
  * @author Bart Mollet <bart.mollet@hogent.be>
  */
 class Link extends Resource
@@ -31,7 +34,7 @@ class Link extends Resource
 	var $on_homepage;
 	/**
 	 * Create a new Link
-	 * @param int $id The id of this link in the Dokeos-course
+	 * @param int $id The id of this link in the Chamilo-course
 	 * @param string $title
 	 * @param string $url
 	 * @param string $description
@@ -54,4 +57,4 @@ class Link extends Resource
 		echo $this->title.' ('.$this->url.')';
 	}
 }
-?>
+?>

main/coursecopy/classes/LinkCategory.class.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Link category backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
@@ -43,4 +46,4 @@ class LinkCategory extends Resource
 		echo $this->title.' '.$this->description.'<br />';
 	}
 }
-?>
+?>

main/coursecopy/classes/Quiz.class.php

@@ -1,12 +1,16 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Exercises backup script
+ * @package chamilo.backup
+ */
 
 require_once 'Resource.class.php';
 
 /**
  * An Quiz
  * @author Bart Mollet <bart.mollet@hogent.be>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class Quiz extends Resource
 {

main/coursecopy/classes/QuizQuestion.class.php

@@ -1,5 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Exercises questions backup script
+ * @package chamilo.backup
+ */
 
 require_once 'Resource.class.php';
 
@@ -88,4 +92,4 @@ class QuizQuestion extends Resource
 		parent::show();
 		echo $this->question;
 	}
-}
+}

main/coursecopy/classes/Resource.class.php

@@ -1,7 +1,11 @@
 <?php
 /* For licensing terms, see /license.txt */
 /**
- * All possible resource-types
+ * General resources backup script
+ * @package chamilo.backup
+ */
+/**
+ * Definition of all possible resource-types
  */
 define('RESOURCE_DOCUMENT', 'document');
 define('RESOURCE_GLOSSARY', 'glossary');
@@ -25,11 +29,11 @@ define('RESOURCE_SURVEYINVITATION','survey_invitation');
 define('RESOURCE_WIKI','wiki');
 
 /**
- * Representation of a resource in a Dokeos-course.
+ * Representation of a resource in a Chamilo-course.
  * This is a base class of which real resource-classes (for Links,
  * Documents,...) should be derived.
  * @author Bart Mollet <bart.mollet@hogent.be>s
- * @package  dokeos.backup
+ * @package  chamilo.backup
  * @todo Use the gloabaly defined constants voor tools and remove the RESOURCE_*
  * constants
  */
@@ -192,4 +196,4 @@ class Resource
 	{
 		//echo 'RESOURCE: '.$this->get_id().' '.$type[$this->get_type()].' ';
 	}
-}
+}

main/coursecopy/classes/ScormDocument.class.php

@@ -1,12 +1,15 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * SCORM document backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
  * ScormDocument class
  * @author Olivier Brouckaert <oli.brouckaert@dokeos.com>
- * @package dokeos.backup
+ * @package chamilo.backup
  */
 class ScormDocument extends Resource
 {

main/coursecopy/classes/Survey.class.php

@@ -1,11 +1,15 @@
 <?php
 /* For licensing terms, see /license.txt */
 require_once 'Resource.class.php';
+/**
+ * Surveys backup script
+ * @package chamilo.backup
+ */
 
 /**
  * A survey
- * @author Yannick Warnier <yannick.warnier@dokeos.com>
- * @package dokeos.backup
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
+ * @package chamilo.backup
  */
 class Survey extends Resource
 {
@@ -136,4 +140,4 @@ class Survey extends Resource
 		echo $this->code.' - '.$this->title;
 	}
 }
-?>
+?>

main/coursecopy/classes/SurveyInvitation.class.php

@@ -1,12 +1,15 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Survey invitations backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
  * An SurveyInvitation
- * @author Yannick Warnier <yannick.warnier@dokeos.com>
- * @package dokeos.backup
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
+ * @package chamilo.backup
  */
 class SurveyInvitation extends Resource
 {
@@ -57,4 +60,4 @@ class SurveyInvitation extends Resource
 		echo $this->invitation_code;
 	}
 }
-?>
+?>

main/coursecopy/classes/SurveyQuestion.class.php

@@ -1,12 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Survey questions backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
-
 /**
- * An QuizQuestion
- * @author Yannick Warnier <yannick.warnier@dokeos.com>
- * @package dokeos.backup
+ * A SurveyQuestion
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
+ * @package chamilo.backup
  */
 class SurveyQuestion extends Resource
 {

main/coursecopy/classes/ToolIntro.class.php

@@ -1,10 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Tool intro backup script
+ * @package chamilo.backup
+ */
 require_once 'Resource.class.php';
 
 /**
- * A WWW-link from the Links-module in a Dokeos-course.
+ * A WWW-link from the Links-module in a Chamilo-course.
  * @author Bart Mollet <bart.mollet@hogent.be>
  */
 class ToolIntro extends Resource
@@ -18,7 +21,7 @@ class ToolIntro extends Resource
 
 	/**
 	 * Create a new text introduction
-	 * @param int $id The id of this tool introduction in the Dokeos-course
+	 * @param int $id The id of this tool introduction in the Chamilo-course
 	 * @param string $intro_text
 	 */
 	function ToolIntro($id, $intro_text)
@@ -87,4 +90,4 @@ class ToolIntro extends Resource
 		echo $this->intro_text;
 	}
 }
-?>
+?>

main/coursecopy/classes/wiki.class.php

@@ -1,7 +1,10 @@
 <?php
 /* For licensing terms, see /license.txt */
 require_once('Resource.class.php');
-
+/**
+ * Wiki backup script
+ * @package chamilo.backup
+ */
 /**
  * Class for migrating the wiki
  *
@@ -41,4 +44,4 @@ class Wiki extends Resource
 		echo $this->reflink.' ('. (empty($this->group_id) ? get_lang('Everyone') : get_lang('Group') . ' ' .  $this->group_id) .') ' . '<i>(' . $this->dtime . ')</i>';
 	}
 }
-?>
+?>