ilCourseObjectiveListGUI Class Reference

List gui for course objectives. More...

Inheritance diagram for ilCourseObjectiveListGUI:

Collaboration diagram for ilCourseObjectiveListGUI:

Public Member Functions
	__construct ()
	Constructor.
	init ()
	init
	getProperties ()
	get properties
	getListItemHTML ($a_ref_id, $a_obj_id, $a_title, $a_description)
	get list item html
	insertTitle ()
	insert title
	insertProgressInfo ()
	insert objective status
Public Member Functions inherited from ilObjectListGUI
	ilObjectListGUI ()
	constructor
	setContainerObject (&$container_obj)
	set the container object (e.g categorygui) Used for link, delete ...
	getContainerObject ()
	get container object
	enableProperties ($a_status)
	En/disable properties.
	getPropertiesStatus ()
	enablePreconditions ($a_status)
	En/disable preconditions.
	getNoticePropertiesStatus ()
	enableNoticeProperties ($a_status)
	En/disable notices.
	getPreconditionsStatus ()
	enableDescription ($a_status)
	En/disable description.
	getDescriptionStatus ()
	getSearchFragmentStatus ()
	Show hide search result fragments.
	enableSearchFragments ($a_status)
	En/disable description.
	enableLinkedPath ($a_status)
	Enable linked path.
	enabledRelevance ()
	enabled relevance
	enableRelevance ($a_status)
	enable relevance
	setRelevance ($a_rel)
	set relevance
	getRelevance ()
	get relevance
	enableIcon ($a_status)
	En/Dis-able icons.
	getIconStatus ()
	Are icons enabled?
	enableCheckbox ($a_status)
	En/Dis-able checkboxes.
	getCheckboxStatus ()
	Are checkboxes enabled?
	enableExpand ($a_status)
	En/Dis-able expand/collapse link.
	getExpandStatus ()
	Is expand/collapse enabled.
	setExpanded ($a_status)
	isExpanded ()
	setPositionInputField ($a_field_index, $a_position_value)
	Set position input field.
	enableDelete ($a_status)
	En/disable delete.
	getDeleteStatus ()
	enableCut ($a_status)
	En/disable cut.
	getCutStatus ()
	enableCopy ($a_status)
	En/disable copy.
	getCopyStatus ()
	enableSubscribe ($a_status)
	En/disable subscribe.
	getSubscribeStatus ()
	enablePayment ($a_status)
	En/disable payment.
	getPaymentStatus ()
	enableLink ($a_status)
	En/disable link.
	getLinkStatus ()
	enablePath ($a_path)
	En/disable path.
	getPathStatus ()
	enableCommands ($a_status, $a_std_only=false)
	En/disable commands.
	getCommandsStatus ()
	enableInfoScreen ($a_info_screen)
	En/disable path.
	addSubItemHTML ($a_html)
	Add HTML for subitem (used for sessions)
	getInfoScreenStatus ()
	enableProgressInfo ($a_status)
	enable progress info
	getProgressInfoStatus ()
	get progress info status
	enableSubstitutions ($a_status)
	Enable substitutions.
	getSubstitutionStatus ()
	Get substitution status.
	enableItemDetailLinks ($a_status)
	enable item detail links E.g Direct links to chapters or pages
	getItemDetailLinkStatus ()
	get item detail link status
	setItemDetailLinks ($a_detail_links, $a_intro_txt= '')
	set items detail links
	insertItemDetailLinks ()
	insert item detail links
	setTitle ($a_title)
	getTitle ()
	getTitle overwritten in class.ilObjLinkResourceList.php
	setDescription ($a_description)
	getDescription ()
	getDescription overwritten in class.ilObjLinkResourceList.php
	setSearchFragment ($a_text)
	set search fragment
	getSearchFragment ()
	get search fragment
	setSeparateCommands ($a_val)
	Set separate commands.
	getSeparateCommands ()
	Get separate commands.
	getCommandId ()
	get command id Normally the ref id.
	setAdditionalInformation ($a_val)
	Set additional information.
	getAdditionalInformation ()
	Get additional information.
	setDetailsLevel ($a_level)
	Details level Currently used in Search which shows only limited properties of forums Currently used for Sessions (switch between minimal and extended view for each session)
	getDetailsLevel ()
	Get current details level.
	checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type, $a_obj_id="")
	initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="")
	inititialize new item (is called by getItemHTML())
	createDefaultCommand ($command)
	Get default command link Overwritten for e.g categories,courses => they return a goto link If search engine visibility is enabled these object type return a goto_CLIENT_ID_cat_99.html link.
	getCommandLink ($a_cmd)
	Get command link url.
	getCommandFrame ($a_cmd)
	Get command target frame.
	getCommandImage ($a_cmd)
	Get command icon image.
	getProperties ($a_item= '')
	Get item properties.
	addCustomProperty ($a_property="", $a_value="", $a_alert=false, $a_newline=false)
	add custom property
	getCustomProperties ($a_prop)
	get custom properties
	getNoticeProperties ()
	get notice properties
	addCustomCommand ($a_link, $a_lang_var, $a_frame="")
	add a custom command
	getCommands ()
	get all current commands for a specific ref id (in the permission context of the current user)
	getIconImageType ()
	Returns the icon image type.
	insertSubstitutions ()
	Insert substitutions.
	insertDescription ()
	insert item description
	insertSearchFragment ()
	Insert highlighted search fragment.
	insertRelevance ()
	insert relevance
	setMode ($a_mode)
	set output mode
	getMode ()
	get output mode
	setConditionDepth ($a_depth)
	set depth for precondition output (stops at level 5)
	isMode ($a_mode)
	check current output mode
	insertProperties ($a_item= '')
	insert properties
	insertNoticeProperties ()
	insertPayment ()
	insert payment information
	insertPreconditions ()
	insert all missing preconditions
	insertCommand ($a_href, $a_text, $a_frame="", $a_img="")
	insert command button
	insertDeleteCommand ()
	insert cut command
	insertLinkCommand ()
	insert link command
	insertCutCommand ()
	insert cut command
	insertCopyCommand ()
	Insert copy command.
	insertPasteCommand ()
	Insert paste command.
	insertSubscribeCommand ()
	insert subscribe command
	insertInfoScreenCommand ()
	insert info screen command
	insertCommands ($a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="")
	insert all commands into html code
	appendRepositoryFrameParameter ($a_link)
	workaround: all links into the repository (from outside) must tell repository to setup the frameset
	insertPath ()
	insert path
	insertIconsAndCheckboxes ()
	Insert icons and checkboxes.
	insertSubItems ()
	Insert subitems.
	insertPositionField ()
	Insert field for positioning.
	adminCommandsIncluded ()
	returns whether any admin commands (link, delete, cut) are included in the output
	storeAccessCache ()
	Store access cache.
	getListItemHTML ($a_ref_id, $a_obj_id, $a_title, $a_description, $a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="")
	Get all item information (title, commands, description) in HTML.
	getCommandsHTML ()
	Get commands HTML (must be called after get list item html)
	isSideBlock ()
	Returns whether current item is a block in a side column or not.
	setBoldTitle ($a_bold_title)
	public boolean $a_bold_title set the item title bold
	isTitleBold ()
	public

Additional Inherited Members
Data Fields inherited from ilObjectListGUI
const	DETAILS_MINIMAL = 10
const	DETAILS_SEARCH = 20
const	DETAILS_ALL = 30
	$ctrl
	$description_enabled = true
	$preconditions_enabled = true
	$properties_enabled = true
	$notice_properties_enabled = true
	$commands_enabled = true
	$cust_prop = array()
	$cust_commands = array()
	$info_screen_enabled = false
	$condition_depth = 0
	$std_cmd_only = false
	$sub_item_html = array()
Protected Member Functions inherited from ilObjectListGUI
	insertPaymentCommand ()
Protected Attributes inherited from ilObjectListGUI
	$substitutions = null
	$substitutions_enabled = false
	$icons_enabled = false
	$checkboxes_enabled = false
	$position_enabled = false
	$progress_enabled = false
	$item_detail_links_enabled = false
	$item_detail_links = array()
	$item_detail_links_intro = ''
	$search_fragments_enabled = false
	$search_fragment = ''
	$path_linked = false
	$enabled_relevance = false
	$relevance = 0
	$expand_enabled = false
	$is_expanded = true
	$bold_title = false
	$copy_enabled = true
	$details_level = self::DETAILS_ALL

Detailed Description

List gui for course objectives.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 37 of file class.ilCourseObjectiveListGUI.php.

Constructor & Destructor Documentation

ilCourseObjectiveListGUI::__construct

(

)

Constructor.

public

Definition at line 44 of file class.ilCourseObjectiveListGUI.php.

        {
                parent::__construct();
        }

Member Function Documentation

ilCourseObjectiveListGUI::getListItemHTML	(		$a_ref_id,
			$a_obj_id,
			$a_title,
			$a_description
	)

get list item html

public

Parameters

int	ref_id
int	obj_id
string	title
string	description

Returns

Definition at line 94 of file class.ilCourseObjectiveListGUI.php.

References ilObjectListGUI\initItem(), ilObjectListGUI\insertDescription(), ilObjectListGUI\insertIconsAndCheckboxes(), insertProgressInfo(), ilObjectListGUI\insertSubItems(), and insertTitle().

        {
                $this->tpl =& new ilTemplate ("tpl.container_list_item.html", true, true);
                $this->initItem($a_ref_id, $a_obj_id, $a_title, $a_description);

                $this->insertIconsAndCheckboxes();
                $this->insertTitle();
                $this->insertDescription();
                $this->insertProgressInfo();
                
                // subitems
                $this->insertSubItems();

                // reset properties and commands
                $this->cust_prop = array();
                $this->cust_commands = array();
                $this->sub_item_html = array();
                $this->position_enabled = false;
                
                return $this->tpl->get();
        }

Here is the call graph for this function:

ilCourseObjectiveListGUI::getProperties

(

)

get properties

public

Returns

Definition at line 79 of file class.ilCourseObjectiveListGUI.php.

        {
                return parent::getProperties();
        }

ilCourseObjectiveListGUI::init

(

)

init

public

Parameters

@return

Reimplemented from ilObjectListGUI.

Definition at line 56 of file class.ilCourseObjectiveListGUI.php.

        {
                $this->static_link_enabled = true;
                $this->delete_enabled = false;
                $this->cut_enabled = false;
                $this->subscribe_enabled = false;
                $this->link_enabled = false;
                $this->payment_enabled = false;
                $this->info_screen_enabled = false;
                $this->progress_enabled = true;
                $this->type = "lobj";
                //$this->gui_class_name = "ilobjcoursegui";
                
                // general commands array
                $this->commands = array();
        }

ilCourseObjectiveListGUI::insertProgressInfo

(

)

insert objective status

protected

Parameters

@return

Reimplemented from ilObjectListGUI.

Definition at line 148 of file class.ilCourseObjectiveListGUI.php.

References $lng, ilObjectListGUI\getContainerObject(), ilUtil\getImagePath(), ilCourseObjectiveResultCache\getStatus(), IL_OBJECTIVE_STATUS_FINAL, IL_OBJECTIVE_STATUS_FINISHED, IL_OBJECTIVE_STATUS_NONE, IL_OBJECTIVE_STATUS_PRETEST, IL_OBJECTIVE_STATUS_PRETEST_NON_SUGGEST, and ilCourseObjectiveResultCache\isSuggested().

Referenced by getListItemHTML().

        {
                global $ilUser,$lng;
                
                $lng->loadLanguageModule('trac');

                $this->tpl->setCurrentBlock('item_progress');
                
                switch(ilCourseObjectiveResultCache::getStatus($ilUser->getId(),$this->getContainerObject()->object->getId(),$this->obj_id))
                {
                        case IL_OBJECTIVE_STATUS_NONE:
                                $this->tpl->setVariable('TXT_PROGRESS_INFO',$this->lng->txt('crs_objective_status'));
                                $this->tpl->setVariable('PROGRESS_TYPE_IMG', ilUtil::getImagePath('scorm/not_attempted.gif'));
                                $this->tpl->setVariable('PROGRESS_ALT_IMG',$this->lng->txt('trac_no_attempted'));
                                break;
                                
                        case IL_OBJECTIVE_STATUS_PRETEST_NON_SUGGEST:
                        case IL_OBJECTIVE_STATUS_PRETEST:
                                $this->tpl->setVariable('TXT_PROGRESS_INFO',$this->lng->txt('crs_objective_pretest'));
                                if(ilCourseObjectiveResultCache::isSuggested($ilUser->getId(),$this->getContainerObject()->object->getId(),$this->obj_id))
                                {
                                        $this->tpl->setVariable('PROGRESS_TYPE_IMG', ilUtil::getImagePath('scorm/failed.gif'));
                                        $this->tpl->setVariable('PROGRESS_ALT_IMG',$this->lng->txt('trac_failed'));
                                }
                                else
                                {
                                        $this->tpl->setVariable('PROGRESS_TYPE_IMG', ilUtil::getImagePath('scorm/passed.gif'));
                                        $this->tpl->setVariable('PROGRESS_ALT_IMG',$this->lng->txt('trac_passed'));
                                }
                                break;
                                
                        case IL_OBJECTIVE_STATUS_FINISHED:
                        case IL_OBJECTIVE_STATUS_FINAL:
                                $this->tpl->setVariable('TXT_PROGRESS_INFO',$this->lng->txt('crs_objective_result'));
                                if(ilCourseObjectiveResultCache::isSuggested($ilUser->getId(),$this->getContainerObject()->object->getId(),$this->obj_id))
                                {
                                        $this->tpl->setVariable('PROGRESS_TYPE_IMG', ilUtil::getImagePath('scorm/failed.gif'));
                                        $this->tpl->setVariable('PROGRESS_ALT_IMG',$this->lng->txt('trac_failed'));
                                }
                                else
                                {
                                        $this->tpl->setVariable('PROGRESS_TYPE_IMG', ilUtil::getImagePath('scorm/passed.gif'));
                                        $this->tpl->setVariable('PROGRESS_ALT_IMG',$this->lng->txt('trac_passed'));
                                }
                                break;  
                                
                                                
                }
                $this->tpl->parseCurrentBlock();                                
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseObjectiveListGUI::insertTitle

(

)

insert title

public

Parameters

@return

Reimplemented from ilObjectListGUI.

Definition at line 123 of file class.ilCourseObjectiveListGUI.php.

References ilObjectListGUI\getCommandsStatus(), ilObjectListGUI\getContainerObject(), and ilObjectListGUI\getTitle().

Referenced by getListItemHTML().

        {
                if(!$this->getCommandsStatus())
                {
                        $this->tpl->setCurrentBlock("item_title");
                        $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
                        $this->tpl->parseCurrentBlock();
                        return true;
                }
                
                $this->tpl->setCurrentBlock("item_title_linked");
                $this->tpl->setVariable("TXT_TITLE_LINKED", $this->getTitle());
                $this->tpl->setVariable("HREF_TITLE_LINKED",'repository.php?ref_id='.$this->getContainerObject()->object->getRefId().'&objective_details='.$this->obj_id);
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• Modules/Course/classes/class.ilCourseObjectiveListGUI.php