Inheritance diagram for ilObjCategoryReferenceListGUI:

Collaboration diagram for ilObjCategoryReferenceListGUI:

Public Member Functions
	__construct ()
	Constructor.
	getIconImageType ()
	Returns the icon image type.
	getCommandId ()
	get command id
	init ()
	initialisation
	initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="")
	inititialize new item Course reference inits the course item
	getProperties ()
	checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type)
	getCommandLink ($a_cmd)
	get command link
Public Member Functions inherited from ilObjCategoryListGUI
	ilObjCategoryListGUI ()
	constructor
	getCommandFrame ($a_cmd)
	Get command target frame.
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.
	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="")
	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.
	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)
	insertTitle ()
	insert item title
	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
	insertProgressInfo ()
	insert progress info
	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
	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.
	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="")
	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.
	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)
	insertTitle ()
	insert item title
	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="", $a_cmd="")
	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
	insertProgressInfo ()
	insert progress info
	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

Protected Attributes
	$reference_obj_id = null
	$reference_ref_id = null
	$deleted = false

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 ()
	insertPaymentCommand ()

Detailed Description

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

Version: $Id$

Definition at line 34 of file class.ilObjCategoryReferenceListGUI.php.

Constructor & Destructor Documentation

ilObjCategoryReferenceListGUI::__construct ( )

Constructor.

public

Definition at line 47 of file class.ilObjCategoryReferenceListGUI.php.

        {
                parent::__construct();
        }

Member Function Documentation

ilObjCategoryReferenceListGUI::checkCommandAccess	(	$a_permission,
		$a_cmd,
		$a_ref_id,
		$a_type
	)

Parameters

@return

Definition at line 161 of file class.ilObjCategoryReferenceListGUI.php.

References getCommandId().

        {
                global $ilAccess;
                
                switch($a_cmd)
                {
                        case 'edit':
                        case 'cut':
                        case 'delete':
                        case 'link':
                                return $ilAccess->checkAccess($a_permission,$a_cmd,$this->getCommandId());
                        
                        default:
                                return $ilAccess->checkAccess($a_permission,$a_cmd,$a_ref_id,$a_type);
                                
                }
        }

Here is the call graph for this function:

ilObjCategoryReferenceListGUI::getCommandId ( )

get command id

public

Parameters

@return

Reimplemented from ilObjectListGUI.

Definition at line 64 of file class.ilObjCategoryReferenceListGUI.php.

References $reference_ref_id.

Referenced by checkCommandAccess().

        {
                return $this->reference_ref_id;
        }

Here is the caller graph for this function:

ilObjCategoryReferenceListGUI::getCommandLink ( $a_cmd )

get command link

public

Parameters

string $a_cmd

Returns

Reimplemented from ilObjCategoryListGUI.

Definition at line 186 of file class.ilObjCategoryReferenceListGUI.php.

        {
                switch($a_cmd)
                {
                        case '':
                        case 'view':
                        case 'join':
                        case 'infoScreen':                              
                                return 'repository.php?ref_id='.$this->ref_id.'&cmd='.$a_cmd;
                        default:
                                return 'repository.php?ref_id='.$this->getCommandId().'&cmd='.$a_cmd;
                }
        }

ilObjCategoryReferenceListGUI::getIconImageType ( )

Returns the icon image type.

For most objects, this is same as the object type, e.g. 'cat','fold'. We can return here other values, to express a specific state of an object, e.g. 'crs_offline", and/or to express a specific kind of object, e.g. 'file_inline'.

Reimplemented from ilObjectListGUI.

Definition at line 52 of file class.ilObjCategoryReferenceListGUI.php.

        {
                return 'catr';
        }

ilObjCategoryReferenceListGUI::getProperties ( )

Definition at line 140 of file class.ilObjCategoryReferenceListGUI.php.

References $lng.

        {
                global $lng,$ilUser,$tree;
                $props = parent::getProperties();
                // offline
                if($tree->isDeleted($this->ref_id))
                {
                        $props[] = array("alert" => true, "property" => $lng->txt("status"),
                                "value" => $lng->txt("reference_deleted"));
                }
                return $props ? $props : array();
        }       

ilObjCategoryReferenceListGUI::init ( )

initialisation

Reimplemented from ilObjCategoryListGUI.

Definition at line 72 of file class.ilObjCategoryReferenceListGUI.php.

References ilAdvancedMDSubstitution\_getInstanceByObjectType().

        {
                $this->copy_enabled = false;
                $this->static_link_enabled = false;
                $this->delete_enabled = true;
                $this->cut_enabled = true;
                $this->subscribe_enabled = true;
                $this->link_enabled = false;
                $this->payment_enabled = true;
                $this->info_screen_enabled = true;
                $this->type = "cat";
                $this->gui_class_name = "ilobjcategorygui";
                
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDSubstitution.php');
                $this->substitutions = ilAdvancedMDSubstitution::_getInstanceByObjectType($this->type);
                if($this->substitutions->isActive())
                {
                        $this->substitutions_enabled = true;
                }
        }

Here is the call graph for this function:

ilObjCategoryReferenceListGUI::initItem	(	$a_ref_id,
		$a_obj_id,
		$a_title = `""`,
		$a_description = `""`
	)

inititialize new item Course reference inits the course item

Parameters

int	$a_ref_id	reference id
int	$a_obj_id	object id
string	$a_title	title
string	$a_description	description

Reimplemented from ilObjectListGUI.

Definition at line 104 of file class.ilObjCategoryReferenceListGUI.php.

References $deleted, $ilBench, ilObject\_getAllReferences(), ilObjectAccess\_getCommands(), ilObject\_lookupDescription(), ilContainerReference\_lookupTargetId(), and ilObject\_lookupTitle().

        {
                global $ilBench,$ilAccess,$tree;
                
                $this->reference_ref_id = $a_ref_id;
                $this->reference_obj_id = $a_obj_id;
                
                include_once('./Services/ContainerReference/classes/class.ilContainerReference.php');
                $target_obj_id = ilContainerReference::_lookupTargetId($a_obj_id);
                
                $target_ref_ids = ilObject::_getAllReferences($target_obj_id);
                $target_ref_id = current($target_ref_ids);
                $target_title = ilObject::_lookupTitle($target_obj_id);
                $target_description = ilObject::_lookupDescription($target_obj_id);
                
                $this->deleted = $tree->isDeleted($target_ref_id);
                
                
        
                parent::initItem($target_ref_id, $target_obj_id,$target_title,$target_description);
                // general commands array
                include_once('./Modules/CourseReference/classes/class.ilObjCourseReferenceAccess.php');
                $this->commands = ilObjCourseReferenceAccess::_getCommands($this->reference_ref_id);
                
                if($ilAccess->checkAccess('write','',$this->reference_ref_id) or $this->deleted)
                {
                        $this->info_screen_enabled = false;
                }
                else
                {
                        $this->info_screen_enabled = true;
                }
        }