From d7b03fe73b58a2c3a1ed1a894b158ac1030559c2 Mon Sep 17 00:00:00 2001 From: Julio Montoya Date: Fri, 14 Sep 2012 15:08:45 +0200 Subject: [PATCH] Minor cosmetic changes --- main/coursecopy/classes/Resource.class.php | 341 +++++++++++---------- 1 file changed, 172 insertions(+), 169 deletions(-) diff --git a/main/coursecopy/classes/Resource.class.php b/main/coursecopy/classes/Resource.class.php index 90c8ccee67..5e49bb287f 100644 --- a/main/coursecopy/classes/Resource.class.php +++ b/main/coursecopy/classes/Resource.class.php @@ -1,4 +1,5 @@ source_id = $id; - $this->type = $type; - $this->destination_id = -1; - $this->linked_resources = array (); - $this->item_properties = array (); - } - /** - * Add linked resource - */ - function add_linked_resource($type, $id) - { - $this->linked_resources[$type][] = $id; - } - /** - * Get linked resources - */ - function get_linked_resources() - { - return $this->linked_resources; - } - /** - * Checks if this resource links to a given resource - */ - function links_to(& $resource) - { - if (is_array($this->linked_resources[$resource->get_type()])) - { - return in_array($resource->get_id(), $this->linked_resources[$resource->get_type()]); - } - return false; - } - /** - * Returns the id of this resource. - * @return int The id of this resource in the source course. - */ - function get_id() - { - return $this->source_id; - } - /** - * Resturns the type of this resource - * @return constant The type. - */ - function get_type() - { - return $this->type; - } - /** - * Get the constant which defines the tool of this resource. This is - * used in the item_properties table. - * @param bool $for_item_property_table (optional) Added by Ivan, 29-AUG-2009: A parameter for resolving differencies between defined TOOL_* constants and hardcoded strings that are stored in the database. - * Example: The constant TOOL_THREAD is defined in the main_api.lib.php with the value 'thread', but the "Forums" tool records in the field 'tool' in the item property table the hardcoded value 'forum_thread'. - * @todo once the RESOURCE_* constants are replaced by the globally - * defined TOOL_* constants, this function will be replaced by get_type() - */ - function get_tool($for_item_property_table = true) - { - switch($this->get_type()) - { - case RESOURCE_DOCUMENT: - return TOOL_DOCUMENT; - case RESOURCE_LINK: - return TOOL_LINK; - case RESOURCE_EVENT: - return TOOL_CALENDAR_EVENT; - case RESOURCE_COURSEDESCRIPTION: - return TOOL_COURSE_DESCRIPTION; - case RESOURCE_LEARNPATH: - return TOOL_LEARNPATH; - case RESOURCE_ANNOUNCEMENT: - return TOOL_ANNOUNCEMENT; - case RESOURCE_FORUMCATEGORY: - return 'forum_category'; // Ivan, 29-AUG-2009: A constant like TOOL_FORUM_CATEGORY is missing in main_api.lib.php. Such a constant has been defined in the forum tool for local needs. - case RESOURCE_FORUM: - return TOOL_FORUM; - case RESOURCE_FORUMTOPIC: - if ($for_item_property_table) - { - return 'forum_thread'; // Ivan, 29-AUG-2009: A hardcoded value that the "Forums" tool stores in the item property table. - } - return TOOL_THREAD; - case RESOURCE_FORUMPOST: - return TOOL_POST; - case RESOURCE_QUIZ: - return TOOL_QUIZ; - //case RESOURCE_QUIZQUESTION: //no corresponding global constant - // return TOOL_QUIZ_QUESTION; - //case RESOURCE_TOOL_INTRO: - // return TOOL_INTRO; - //case RESOURCE_LINKCATEGORY: - // return TOOL_LINK_CATEGORY; - //case RESOURCE_SCORM: - // return TOOL_SCORM_DOCUMENT; - case RESOURCE_SURVEY: - return TOOL_SURVEY; - //case RESOURCE_SURVEYQUESTION: - // return TOOL_SURVEY_QUESTION; - //case RESOURCE_SURVEYINVITATION: - // return TOOL_SURVEY_INVITATION; - case RESOURCE_GLOSSARY: - return TOOL_GLOSSARY; - case RESOURCE_WIKI: - return TOOL_WIKI; - case RESOURCE_THEMATIC: - return TOOL_COURSE_PROGRESS; - case RESOURCE_ATTENDANCE: - return TOOL_ATTENDANCE; - default: - return null; - } - } - /** - * Set the destination id - * @param int $id The id of this resource in the destination course. - */ - function set_new_id($id) - { - $this->destination_id = $id; - } - /** - * Check if this resource is allready restored in the destination course. - * @return bool true if allready restored (i.e. destination_id is set). - */ - function is_restored() - { - return $this->destination_id > -1; - } - /** - * Show this resource - */ - function show() - { - //echo 'RESOURCE: '.$this->get_id().' '.$type[$this->get_type()].' '; - } -} +class Resource { + + /** + * The id from this resource in the source course + */ + var $source_id; + + /** + * The id from this resource in the destination course + */ + var $destination_id; + + /** + * The type of this resource + */ + var $type; + + /** + * Linked resources + */ + var $linked_resources; + + /** + * The properties of this resource + */ + var $item_properties; + + /** + * Create a new Resource + * @param int $id The id of this resource in the source course. + * @param constant $type The type of this resource. + */ + function Resource($id, $type) { + $this->source_id = $id; + $this->type = $type; + $this->destination_id = -1; + $this->linked_resources = array(); + $this->item_properties = array(); + } + + /** + * Add linked resource + */ + function add_linked_resource($type, $id) { + $this->linked_resources[$type][] = $id; + } + + /** + * Get linked resources + */ + function get_linked_resources() { + return $this->linked_resources; + } + + /** + * Checks if this resource links to a given resource + */ + function links_to(& $resource) { + if (is_array($this->linked_resources[$resource->get_type()])) { + return in_array($resource->get_id(), $this->linked_resources[$resource->get_type()]); + } + return false; + } + + /** + * Returns the id of this resource. + * @return int The id of this resource in the source course. + */ + function get_id() { + return $this->source_id; + } + + /** + * Resturns the type of this resource + * @return constant The type. + */ + function get_type() { + return $this->type; + } + + /** + * Get the constant which defines the tool of this resource. This is + * used in the item_properties table. + * @param bool $for_item_property_table (optional) Added by Ivan, 29-AUG-2009: A parameter for resolving differencies between defined TOOL_* constants and hardcoded strings that are stored in the database. + * Example: The constant TOOL_THREAD is defined in the main_api.lib.php with the value 'thread', but the "Forums" tool records in the field 'tool' in the item property table the hardcoded value 'forum_thread'. + * @todo once the RESOURCE_* constants are replaced by the globally + * defined TOOL_* constants, this function will be replaced by get_type() + */ + function get_tool($for_item_property_table = true) { + switch ($this->get_type()) { + case RESOURCE_DOCUMENT: + return TOOL_DOCUMENT; + case RESOURCE_LINK: + return TOOL_LINK; + case RESOURCE_EVENT: + return TOOL_CALENDAR_EVENT; + case RESOURCE_COURSEDESCRIPTION: + return TOOL_COURSE_DESCRIPTION; + case RESOURCE_LEARNPATH: + return TOOL_LEARNPATH; + case RESOURCE_ANNOUNCEMENT: + return TOOL_ANNOUNCEMENT; + case RESOURCE_FORUMCATEGORY: + return 'forum_category'; // Ivan, 29-AUG-2009: A constant like TOOL_FORUM_CATEGORY is missing in main_api.lib.php. Such a constant has been defined in the forum tool for local needs. + case RESOURCE_FORUM: + return TOOL_FORUM; + case RESOURCE_FORUMTOPIC: + if ($for_item_property_table) { + return 'forum_thread'; // Ivan, 29-AUG-2009: A hardcoded value that the "Forums" tool stores in the item property table. + } + return TOOL_THREAD; + case RESOURCE_FORUMPOST: + return TOOL_POST; + case RESOURCE_QUIZ: + return TOOL_QUIZ; + //case RESOURCE_QUIZQUESTION: //no corresponding global constant + // return TOOL_QUIZ_QUESTION; + //case RESOURCE_TOOL_INTRO: + // return TOOL_INTRO; + //case RESOURCE_LINKCATEGORY: + // return TOOL_LINK_CATEGORY; + //case RESOURCE_SCORM: + // return TOOL_SCORM_DOCUMENT; + case RESOURCE_SURVEY: + return TOOL_SURVEY; + //case RESOURCE_SURVEYQUESTION: + // return TOOL_SURVEY_QUESTION; + //case RESOURCE_SURVEYINVITATION: + // return TOOL_SURVEY_INVITATION; + case RESOURCE_GLOSSARY: + return TOOL_GLOSSARY; + case RESOURCE_WIKI: + return TOOL_WIKI; + case RESOURCE_THEMATIC: + return TOOL_COURSE_PROGRESS; + case RESOURCE_ATTENDANCE: + return TOOL_ATTENDANCE; + default: + return null; + } + } + + /** + * Set the destination id + * @param int $id The id of this resource in the destination course. + */ + function set_new_id($id) { + $this->destination_id = $id; + } + + /** + * Check if this resource is allready restored in the destination course. + * @return bool true if allready restored (i.e. destination_id is set). + */ + function is_restored() { + return $this->destination_id > -1; + } + + /** + * Show this resource + */ + function show() { + //echo 'RESOURCE: '.$this->get_id().' '.$type[$this->get_type()].' '; + } +} \ No newline at end of file