ilObjectListGUI Class Reference

Class ilObjectListGUI. More...

Inheritance diagram for ilObjectListGUI:

Collaboration diagram for ilObjectListGUI:

Public Member Functions
	ilObjectListGUI ()
	constructor More...
	setContainerObject ($container_obj)
	set the container object (e.g categorygui) Used for link, delete ... More...
	getContainerObject ()
	get container object More...
	init ()
	initialisation More...
	enableProperties ($a_status)
	En/disable properties. More...
	getPropertiesStatus ()
	enablePreconditions ($a_status)
	En/disable preconditions. More...
	getNoticePropertiesStatus ()
	enableNoticeProperties ($a_status)
	En/disable notices. More...
	getPreconditionsStatus ()
	enableDescription ($a_status)
	En/disable description. More...
	getDescriptionStatus ()
	getSearchFragmentStatus ()
	Show hide search result fragments. More...
	enableSearchFragments ($a_status)
	En/disable description. More...
	enableLinkedPath ($a_status)
	Enable linked path. More...
	enabledRelevance ()
	enabled relevance More...
	enableRelevance ($a_status)
	enable relevance More...
	setRelevance ($a_rel)
	set relevance More...
	getRelevance ()
	get relevance More...
	enableIcon ($a_status)
	En/Dis-able icons. More...
	getIconStatus ()
	Are icons enabled? More...
	enableCheckbox ($a_status)
	En/Dis-able checkboxes. More...
	getCheckboxStatus ()
	Are checkboxes enabled? More...
	enableExpand ($a_status)
	En/Dis-able expand/collapse link. More...
	getExpandStatus ()
	Is expand/collapse enabled. More...
	setExpanded ($a_status)
	isExpanded ()
	setPositionInputField ($a_field_index, $a_position_value)
	Set position input field. More...
	enableDelete ($a_status)
	En/disable delete. More...
	getDeleteStatus ()
	enableCut ($a_status)
	En/disable cut. More...
	getCutStatus ()
	enableCopy ($a_status)
	En/disable copy. More...
	getCopyStatus ()
	enableSubscribe ($a_status)
	En/disable subscribe. More...
	getSubscribeStatus ()
	enablePayment ($a_status)
	En/disable payment. More...
	getPaymentStatus ()
	enableLink ($a_status)
	En/disable link. More...
	getLinkStatus ()
	enablePath ($a_path)
	En/disable path. More...
	getPathStatus ()
	enableCommands ($a_status, $a_std_only=false)
	En/disable commands. More...
	getCommandsStatus ()
	enableInfoScreen ($a_info_screen)
	En/disable path. More...
	addSubItemHTML ($a_html)
	Add HTML for subitem (used for sessions) More...
	getInfoScreenStatus ()
	enableProgressInfo ($a_status)
	enable progress info More...
	getProgressInfoStatus ()
	get progress info status More...
	enableSubstitutions ($a_status)
	Enable substitutions. More...
	getSubstitutionStatus ()
	Get substitution status. More...
	enableItemDetailLinks ($a_status)
	enable item detail links E.g Direct links to chapters or pages More...
	getItemDetailLinkStatus ()
	get item detail link status More...
	setItemDetailLinks ($a_detail_links, $a_intro_txt='')
	set items detail links More...
	insertItemDetailLinks ()
	insert item detail links More...
	setTitle ($a_title)
	getTitle ()
	getTitle overwritten in class.ilObjLinkResourceList.php More...
	setDescription ($a_description)
	getDescription ()
	getDescription overwritten in class.ilObjLinkResourceList.php More...
	setSearchFragment ($a_text)
	set search fragment More...
	getSearchFragment ()
	get search fragment More...
	setSeparateCommands ($a_val)
	Set separate commands. More...
	getSeparateCommands ()
	Get separate commands. More...
	getCommandId ()
	get command id Normally the ref id. More...
	setAdditionalInformation ($a_val)
	Set additional information. More...
	getAdditionalInformation ()
	Get additional information. More...
	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) More...
	getDetailsLevel ()
	Get current details level. More...
	enableRepositoryTransfer ($a_value)
	Enable copy/move to repository (from personal workspace) More...
	restrictToGoto ($a_value)
	Restrict all actions/links to goto. More...
	checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type, $a_obj_id="")
	initItem ($a_ref_id, $a_obj_id, $a_title="", $a_description="", $a_context=self::CONTEXT_REPOSITORY)
	inititialize new item (is called by getItemHTML()) More...
	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. More...
	getCommandLink ($a_cmd)
	Get command link url. More...
	getCommandFrame ($a_cmd)
	Get command target frame. More...
	getCommandImage ($a_cmd)
	Get command icon image. More...
	getProperties ($a_item='')
	Get item properties. More...
	addCustomProperty ($a_property="", $a_value="", $a_alert=false, $a_newline=false)
	add custom property More...
	getCustomProperties ($a_prop)
	get custom properties More...
	getAlertProperties ()
	get all alert properties More...
	getNoticeProperties ()
	get notice properties More...
	addCustomCommand ($a_link, $a_lang_var, $a_frame="", $onclick="")
	add a custom command More...
	forceVisibleOnly ($a_stat)
	Force visible access only. More...
	isVisibleOnlyForced ()
	Force unreadable. More...
	getCommands ()
	get all current commands for a specific ref id (in the permission context of the current user) More...
	getIconImageType ()
	Returns the icon image type. More...
	insertTitle ()
	insert item title More...
	insertSubstitutions ()
	Insert substitutions. More...
	insertDescription ()
	insert item description More...
	insertSearchFragment ()
	Insert highlighted search fragment. More...
	insertRelevance ()
	insert relevance More...
	setMode ($a_mode)
	set output mode More...
	getMode ()
	get output mode More...
	setConditionDepth ($a_depth)
	set depth for precondition output (stops at level 5) More...
	isMode ($a_mode)
	check current output mode More...
	insertProperties ($a_item='')
	insert properties More...
	insertNoticeProperties ()
	insertPayment ()
	insert payment information More...
	insertPreconditions ()
	insert all missing preconditions More...
	insertCommand ($a_href, $a_text, $a_frame="", $a_img="", $a_cmd="", $a_onclick="")
	insert command button More...
	insertDeleteCommand ()
	insert cut command More...
	insertLinkCommand ()
	insert link command More...
	insertCutCommand ($a_to_repository=false)
	insert cut command More...
	insertCopyCommand ($a_to_repository=false)
	Insert copy command. More...
	insertPasteCommand ()
	Insert paste command. More...
	insertSubscribeCommand ()
	insert subscribe command More...
	insertInfoScreenCommand ()
	insert info screen command More...
	insertCommonSocialCommands ($a_header_actions=false)
	Insert common social commands (comments, notes, tagging) More...
	insertTimingsCommand ()
	insert edit timings command More...
	insertCommands ($a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="", $a_header_actions=false)
	insert all commands into html code More...
	enableComments ($a_value, $a_enable_comments_settings=true)
	Toogle comments action status. More...
	enableNotes ($a_value)
	Toogle notes action status. More...
	enableTags ($a_value)
	Toogle tags action status. More...
	enableRating ($a_value, $a_text=null, $a_categories=false, array $a_ctrl_path=null)
	Toogle rating action status. More...
	enableMultiDownload ($a_value)
	Toggles whether multiple objects can be downloaded at once or not. More...
	insertMultiDownloadCommand ()
	enableDownloadCheckbox ($a_ref_id, $a_value)
	getDownloadCheckboxState ()
	setHeaderSubObject ($a_type, $a_id)
	Set sub object identifier. More...
	addHeaderIcon ($a_id, $a_img, $a_tooltip=null, $a_onclick=null, $a_status_text=null, $a_href=null)
	addHeaderIconHTML ($a_id, $a_html)
	setAjaxHash ($a_hash)
	getHeaderAction ()
	Get header action. More...
	appendRepositoryFrameParameter ($a_link)
	workaround: all links into the repository (from outside) must tell repository to setup the frameset More...
	modifySAHSlaunch ($a_link, $wtarget)
	workaround: SAHS in new javavasript-created window or iframe More...
	insertPath ()
	insert path More...
	insertProgressInfo ()
	insert progress info More...
	insertIconsAndCheckboxes ()
	Insert icons and checkboxes. More...
	insertSubItems ()
	Insert subitems. More...
	insertPositionField ()
	Insert field for positioning. More...
	adminCommandsIncluded ()
	returns whether any admin commands (link, delete, cut) are included in the output More...
	storeAccessCache ()
	Store access cache. More...
	getListItemHTML ($a_ref_id, $a_obj_id, $a_title, $a_description, $a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="", $a_context=self::CONTEXT_REPOSITORY)
	Get all item information (title, commands, description) in HTML. More...
	setParentRefId ($a_ref_id)
	Set current parent ref id to enable unique js-ids (sessions, etc.) More...
	getCommandsHTML ()
	Get commands HTML (must be called after get list item html) More...
	isSideBlock ()
	Returns whether current item is a block in a side column or not. More...
	setBoldTitle ($a_bold_title)
	public boolean $a_bold_title set the item title bold More...
	isTitleBold ()
	public More...
	enableTimings ($a_status)
	enable timings link More...
	isFileUploadAllowed ()
	Gets a value indicating whether file uploads to this object are allowed or not. More...
	insertFileUpload ()
	Inserts a file upload component. More...

Static Public Member Functions
static	prepareJsLinks ($a_redraw_url, $a_notes_url, $a_tags_url, $a_tpl=null)
	Insert js/ajax links into template. More...
static	preloadCommonProperties ($a_obj_ids, $a_context)
	Preload common properties. More...

Data Fields
const	DETAILS_MINIMAL = 10
const	DETAILS_SEARCH = 20
const	DETAILS_ALL = 30
const	CONTEXT_REPOSITORY = 1
const	CONTEXT_WORKSPACE = 2
const	CONTEXT_SHOP = 3
const	CONTEXT_WORKSPACE_SHARING = 4
const	CONTEXT_PERSONAL_DESKTOP = 5
const	CONTEXT_SEARCH = 6
const	DOWNLOAD_CHECKBOX_NONE = 0
const	DOWNLOAD_CHECKBOX_ENABLED = 1
const	DOWNLOAD_CHECKBOX_DISABLED = 2
	$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()
	$multi_download_enabled = false
	$download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE

Protected Member Functions
	buildGotoLink ()
	insertPaymentCommand ($has_extension_prices=false)
	parseConditions ($toggle_id, $conditions, $obligatory=true)
	getUniqueItemId ($a_as_div=false)
	Get unique item identifier (for js-actions) More...
	isCommentsActivated ($a_type, $a_ref_id, $a_obj_id, $a_header_actions, $a_check_write_access=true)
	Check comments status against comments settings and context. More...

Protected Attributes
	$obj_id
	$ref_id
	$type
	$sub_obj_id
	$sub_obj_type
	$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
	$reference_ref_id = false
	$separate_commands = false
	$search_fragment_enabled = false
	$additional_information = false
	$static_link_enabled = false
	$repository_transfer_enabled = false
	$shared = false
	$restrict_to_goto = false
	$comments_enabled = false
	$comments_settings_enabled = false
	$notes_enabled = false
	$tags_enabled = false
	$rating_enabled = false
	$rating_categories_enabled = false
	$rating_text = false
	$rating_ctrl_path = false
	$timings_enabled = true
	$force_visible_only = false
	$prevent_duplicate_commands = array()
	$parent_ref_id

Static Protected Attributes
static	$cnt_notes = array()
static	$cnt_tags = array()
static	$comments_activation = array()
static	$preload_done = false

Detailed Description

Class ilObjectListGUI.

Important note:

All access checking should be made within $ilAccess and the checkAccess of the ilObj...Access classes. Do not additionally enable or disable any commands within this GUI class or in derived classes, except when the container (e.g. a search result list) generally refuses them.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e $Id$

Definition at line 23 of file class.ilObjectListGUI.php.

Member Function Documentation

addCustomCommand()

ilObjectListGUI::addCustomCommand	(		$a_link,
			$a_lang_var,
			$a_frame = "",
			$onclick = ""
	)

add a custom command

Definition at line 1323 of file class.ilObjectListGUI.php.

        {
                $this->cust_commands[] =
                        array("link" => $a_link, "lang_var" => $a_lang_var,
                        "frame" => $a_frame, "onclick" => $onclick);
        }

addCustomProperty()

ilObjectListGUI::addCustomProperty	(		$a_property = "",
			$a_value = "",
			$a_alert = false,
			$a_newline = false
	)

add custom property

Definition at line 1266 of file class.ilObjectListGUI.php.

Referenced by ilObjectActivation\addListGUIActivationProperty(), getListItemHTML(), ilObjRemoteCategoryListGUI\getProperties(), ilObjRemoteCourseListGUI\getProperties(), ilObjRemoteWikiListGUI\getProperties(), ilObjRemoteGlossaryListGUI\getProperties(), ilObjRemoteTestListGUI\getProperties(), ilObjRemoteFileListGUI\getProperties(), ilObjRemoteGroupListGUI\getProperties(), ilObjRemoteLearningModuleListGUI\getProperties(), insertCommands(), and insertPayment().

        {
                $this->cust_prop[] = array("property" => $a_property, "value" => $a_value,
                        "alert" => $a_alert, "newline" => $a_newline);
        }

Here is the caller graph for this function:

addHeaderIcon()

ilObjectListGUI::addHeaderIcon	(		$a_id,
			$a_img,
			$a_tooltip = null,
			$a_onclick = null,
			$a_status_text = null,
			$a_href = null
	)

Parameters

string	$a_id
string	$a_img
string	$a_tooltip
string	$a_onclick
string	$a_status_text
string	$a_href

Definition at line 3008 of file class.ilObjectListGUI.php.

Referenced by getHeaderAction().

        {
                $this->header_icons[$a_id] = array("img" => $a_img,
                                "tooltip" => $a_tooltip,
                                "onclick" => $a_onclick,
                                "status_text" => $a_status_text,
                                "href" => $a_href);
        }

Here is the caller graph for this function:

addHeaderIconHTML()

ilObjectListGUI::addHeaderIconHTML	(		$a_id,
			$a_html
	)

Parameters

string	$a_id
string	$a_html

Definition at line 3022 of file class.ilObjectListGUI.php.

Referenced by getHeaderAction().

        {
                $this->header_icons[$a_id] = $a_html;
        }

Here is the caller graph for this function:

addSubItemHTML()

ilObjectListGUI::addSubItemHTML

(

$a_html

)

Add HTML for subitem (used for sessions)

Parameters

string

$a_html

subitems HTML

Definition at line 628 of file class.ilObjectListGUI.php.

        {
                $this->sub_item_html[] = $a_html;
        }

adminCommandsIncluded()

ilObjectListGUI::adminCommandsIncluded

(

)

returns whether any admin commands (link, delete, cut) are included in the output

Definition at line 3397 of file class.ilObjectListGUI.php.

        {
                return $this->adm_commands_included;
        }

appendRepositoryFrameParameter()

ilObjectListGUI::appendRepositoryFrameParameter

(

$a_link

)

workaround: all links into the repository (from outside) must tell repository to setup the frameset

Definition at line 3191 of file class.ilObjectListGUI.php.

References $_GET, and ilUtil\appendUrlParameterString().

Referenced by insertCommands(), and insertTitle().

        {
                $script = substr(strrchr($_SERVER["PHP_SELF"],"/"),1);

                // we should get rid of this nonsense with 4.4 (alex)
                if ((strtolower($_GET["baseClass"]) != "ilrepositorygui") &&
                        is_int(strpos($a_link,"baseClass=ilRepositoryGUI")))
                {
                        if ($this->type != "frm")
                        {
                                $a_link = 
                                        ilUtil::appendUrlParameterString($a_link, "rep_frame=1");
                        }
                }
                
                return $a_link;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

buildGotoLink()

ilObjectListGUI::buildGotoLink ( )

protected

Definition at line 1555 of file class.ilObjectListGUI.php.

References ilWorkspaceAccessHandler\getGotoLink().

Referenced by insertTitle().

        {
                switch($this->context)
                {
                        case self::CONTEXT_WORKSPACE_SHARING:
                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
                                return ilWorkspaceAccessHandler::getGotoLink($this->ref_id, $this->obj_id);
                        
                        default:
                                // not implemented yet
                                break;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkCommandAccess()

ilObjectListGUI::checkCommandAccess	(		$a_permission,
			$a_cmd,
			$a_ref_id,
			$a_type,
			$a_obj_id = ""
	)

Parameters

Definition at line 918 of file class.ilObjectListGUI.php.

References isVisibleOnlyForced().

Referenced by getCommands(), getListItemHTML(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertLinkCommand(), insertSubscribeCommand(), insertTimingsCommand(), and isCommentsActivated().

        {
                global $ilAccess;
                
                // e.g: subitems should not be readable since their parent sesssion is readonly.
                if($a_permission != 'visible' and $this->isVisibleOnlyForced())
                {
                        return false;
                }

                $cache_prefix = null;
                if($this->context == self::CONTEXT_WORKSPACE || $this->context == self::CONTEXT_WORKSPACE_SHARING)
                {
                        $cache_prefix = "wsp";
                        if(!$this->ws_access)
                        {
                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
                                $this->ws_access = new ilWorkspaceAccessHandler();
                        }
                }

                if (isset($this->access_cache[$a_permission]["-".$a_cmd][$cache_prefix.$a_ref_id]))
                {
                        return $this->access_cache[$a_permission]["-".$a_cmd][$cache_prefix.$a_ref_id];
                }

                if($this->context == self::CONTEXT_REPOSITORY || $this->context == self::CONTEXT_SHOP)
                {
                        $access = $ilAccess->checkAccess($a_permission,$a_cmd,$a_ref_id,$a_type,$a_obj_id);
                        if ($ilAccess->getPreventCachingLastResult())
                        {
                                $this->prevent_access_caching = true;
                        }
                }
                else
                {
                        $access = $this->ws_access->checkAccess($a_permission,$a_cmd,$a_ref_id,$a_type);
                }

                $this->access_cache[$a_permission]["-".$a_cmd][$cache_prefix.$a_ref_id] = $access;
                return $access;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

createDefaultCommand()

ilObjectListGUI::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.

public

Parameters

int	command link

Definition at line 1000 of file class.ilObjectListGUI.php.

References ilLink\_getStaticLink().

Referenced by insertCommands(), and insertPaymentCommand().

        {
                if($this->static_link_enabled)
                {
                        include_once('./Services/Link/classes/class.ilLink.php');
                        if($link = ilLink::_getStaticLink($this->ref_id,$this->type,false))
                        {
                                $command['link'] = $link;
                                $command['frame'] = '_top';
                        }
                }
                return $command;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

enableCheckbox()

ilObjectListGUI::enableCheckbox

(

$a_status

)

En/Dis-able checkboxes.

Parameters

boolean

checkbox on/off

Definition at line 382 of file class.ilObjectListGUI.php.

        {
                $this->checkboxes_enabled = $a_status;
        }

enableCommands()

ilObjectListGUI::enableCommands	(		$a_status,
			$a_std_only = false
	)

En/disable commands.

Parameters

bool

Returns

void

Definition at line 597 of file class.ilObjectListGUI.php.

        {
                $this->commands_enabled = $a_status;
                $this->std_cmd_only = $a_std_only;
        }

enableComments()

ilObjectListGUI::enableComments	(		$a_value,
			$a_enable_comments_settings = true
	)

Toogle comments action status.

Parameters

boolean

$a_value

Definition at line 2821 of file class.ilObjectListGUI.php.

References $ilSetting.

Referenced by ilObjectListGUI().

        {
                global $ilSetting;
                
                // global switch
                if($ilSetting->get("disable_comments"))
                {
                        $a_value = false;
                }
                
                $this->comments_enabled = (bool)$a_value;
                $this->comments_settings_enabled = (bool)$a_enable_comments_settings;
        }

Here is the caller graph for this function:

enableCopy()

ilObjectListGUI::enableCopy

(

$a_status

)

En/disable copy.

Parameters

bool

Returns

void

Definition at line 490 of file class.ilObjectListGUI.php.

        {
                $this->copy_enabled = $a_status;

                return;
        }

enableCut()

ilObjectListGUI::enableCut

(

$a_status

)

En/disable cut.

Parameters

bool

Returns

void

Definition at line 468 of file class.ilObjectListGUI.php.

        {
                $this->cut_enabled = $a_status;

                return;
        }

enableDelete()

ilObjectListGUI::enableDelete

(

$a_status

)

En/disable delete.

Parameters

bool

Returns

void

Definition at line 445 of file class.ilObjectListGUI.php.

        {
                $this->delete_enabled = $a_status;

                return;
        }

enableDescription()

ilObjectListGUI::enableDescription

(

$a_status

)

En/disable description.

Parameters

bool

Returns

void

Definition at line 268 of file class.ilObjectListGUI.php.

        {
                $this->description_enabled = $a_status;

                return;
        }

enableDownloadCheckbox()

ilObjectListGUI::enableDownloadCheckbox	(		$a_ref_id,
			$a_value
	)

Definition at line 2928 of file class.ilObjectListGUI.php.

References $_SESSION, and getContainerObject().

        {
                global $ilAccess;
                
                // TODO: delegate to list object class!
                if (!$this->getContainerObject()->isActiveAdministrationPanel() || $_SESSION["clipboard"])
                {
                        if (in_array($this->type, array("file", "fold")) &&
                                $ilAccess->checkAccess("read", "", $a_ref_id, $this->type))
                        {                       
                                $this->download_checkbox_state = self::DOWNLOAD_CHECKBOX_ENABLED;
                        }
                        else
                        {
                                $this->download_checkbox_state = self::DOWNLOAD_CHECKBOX_DISABLED;
                        }
                }
                else
                {
                        $this->download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE;
                }
        }

Here is the call graph for this function:

enabledRelevance()

ilObjectListGUI::enabledRelevance

(

)

enabled relevance

Returns

Definition at line 323 of file class.ilObjectListGUI.php.

References $enabled_relevance.

Referenced by getListItemHTML(), and insertRelevance().

        {
                return $this->enabled_relevance;
        }

Here is the caller graph for this function:

enableExpand()

ilObjectListGUI::enableExpand

(

$a_status

)

En/Dis-able expand/collapse link.

Parameters

boolean

checkbox on/off

Definition at line 402 of file class.ilObjectListGUI.php.

        {
                $this->expand_enabled = $a_status;
        }

enableIcon()

ilObjectListGUI::enableIcon

(

$a_status

)

En/Dis-able icons.

Parameters

boolean

icons on/off

Definition at line 362 of file class.ilObjectListGUI.php.

        {
                $this->icons_enabled = $a_status;
        }

enableInfoScreen()

ilObjectListGUI::enableInfoScreen

(

$a_info_screen

)

En/disable path.

Parameters

bool

Returns

void

Definition at line 618 of file class.ilObjectListGUI.php.

        {
                $this->info_screen_enabled = $a_info_screen;
        }

enableItemDetailLinks()

ilObjectListGUI::enableItemDetailLinks

(

$a_status

)

enable item detail links E.g Direct links to chapters or pages

public

Parameters

bool

Returns

Definition at line 698 of file class.ilObjectListGUI.php.

        {
                $this->item_detail_links_enabled = $a_status;
        }

enableLink()

ilObjectListGUI::enableLink

(

$a_status

)

En/disable link.

Parameters

bool

Returns

void

Definition at line 554 of file class.ilObjectListGUI.php.

        {
                $this->link_enabled = $a_status;

                return;
        }

enableLinkedPath()

ilObjectListGUI::enableLinkedPath

(

$a_status

)

Enable linked path.

Parameters

bool

Returns

Definition at line 314 of file class.ilObjectListGUI.php.

        {
                $this->path_linked = $a_status;
        }

enableMultiDownload()

ilObjectListGUI::enableMultiDownload

(

$a_value

)

Toggles whether multiple objects can be downloaded at once or not.

Parameters

boolean

$a_value

true, to allow downloading of multiple objects; otherwise, false.

Definition at line 2893 of file class.ilObjectListGUI.php.

        {
                $folder_set = new ilSetting("fold");
                if (!$folder_set->get("enable_multi_download"))
                {
                        $a_value = false;                       
                }
                $this->multi_download_enabled = (bool)$a_value;
        }

enableNotes()

ilObjectListGUI::enableNotes

(

$a_value

)

Toogle notes action status.

Parameters

boolean

$a_value

Definition at line 2840 of file class.ilObjectListGUI.php.

References $ilSetting.

Referenced by ilObjectListGUI().

        {
                global $ilSetting;
                
                // global switch
                if($ilSetting->get("disable_notes"))
                {
                        $a_value = false;
                }
                
                $this->notes_enabled = (bool)$a_value;
        }

Here is the caller graph for this function:

enableNoticeProperties()

ilObjectListGUI::enableNoticeProperties

(

$a_status

)

En/disable notices.

Parameters

bool

Returns

void

Definition at line 246 of file class.ilObjectListGUI.php.

        {
                $this->notice_properties_enabled = $a_status;

                return;
        }

enablePath()

ilObjectListGUI::enablePath

(

$a_path

)

En/disable path.

Parameters

bool

Returns

void

Definition at line 576 of file class.ilObjectListGUI.php.

        {
                $this->path_enabled = $a_path;
        }

enablePayment()

ilObjectListGUI::enablePayment

(

$a_status

)

En/disable payment.

Parameters

bool

Returns

void

Definition at line 533 of file class.ilObjectListGUI.php.

        {
                $this->payment_enabled = $a_status;

                return;
        }

enablePreconditions()

ilObjectListGUI::enablePreconditions

(

$a_status

)

En/disable preconditions.

Parameters

bool

Returns

void

Definition at line 228 of file class.ilObjectListGUI.php.

        {
                $this->preconditions_enabled = $a_status;

                return;
        }

enableProgressInfo()

ilObjectListGUI::enableProgressInfo

(

$a_status

)

enable progress info

public

Parameters

Definition at line 650 of file class.ilObjectListGUI.php.

        {
                $this->progress_enabled = $a_status;
        }

enableProperties()

ilObjectListGUI::enableProperties

(

$a_status

)

En/disable properties.

Parameters

bool

Returns

void

Definition at line 206 of file class.ilObjectListGUI.php.

Referenced by insertCommands().

        {
                $this->properties_enabled = $a_status;

                return;
        }

Here is the caller graph for this function:

enableRating()

ilObjectListGUI::enableRating	(		$a_value,
			$a_text = null,
			$a_categories = false,
		array	$a_ctrl_path = null
	)

Toogle rating action status.

Parameters

boolean	$a_value
string	$a_text
boolean	$a_categories
array	$a_ctrl_path

Definition at line 2876 of file class.ilObjectListGUI.php.

        {                               
                $this->rating_enabled = (bool)$a_value;
                
                if($this->rating_enabled)
                {
                        $this->rating_categories_enabled = (bool)$a_categories;
                        $this->rating_text = $a_text;
                        $this->rating_ctrl_path = $a_ctrl_path;                                                                                                 
                }
        }

enableRelevance()

ilObjectListGUI::enableRelevance

(

$a_status

)

enable relevance

Returns

Definition at line 332 of file class.ilObjectListGUI.php.

        {
                $this->enabled_relevance = $a_status;    
        }

enableRepositoryTransfer()

ilObjectListGUI::enableRepositoryTransfer

(

$a_value

)

Enable copy/move to repository (from personal workspace)

Parameters

bool

$a_value

Definition at line 898 of file class.ilObjectListGUI.php.

        {
                $this->repository_transfer_enabled = (bool)$a_value;
        }

enableSearchFragments()

ilObjectListGUI::enableSearchFragments

(

$a_status

)

En/disable description.

Parameters

bool

Returns

void

Definition at line 302 of file class.ilObjectListGUI.php.

        {
                $this->search_fragment_enabled = $a_status;

                return;
        }

enableSubscribe()

ilObjectListGUI::enableSubscribe

(

$a_status

)

En/disable subscribe.

Parameters

bool

Returns

void

Definition at line 512 of file class.ilObjectListGUI.php.

        {
                $this->subscribe_enabled = $a_status;

                return;
        }

enableSubstitutions()

ilObjectListGUI::enableSubstitutions

(

$a_status

)

Enable substitutions.

public

Parameters

Definition at line 674 of file class.ilObjectListGUI.php.

        {
                $this->substitutions_enabled = $a_status;
        }

enableTags()

ilObjectListGUI::enableTags

(

$a_value

)

Toogle tags action status.

Parameters

boolean

$a_value

Definition at line 2858 of file class.ilObjectListGUI.php.

Referenced by ilObjectListGUI().

        {
                $tags_set = new ilSetting("tags");
                if (!$tags_set->get("enable"))
                {
                        $a_value = false;                       
                }
                $this->tags_enabled = (bool)$a_value;
        }

Here is the caller graph for this function:

enableTimings()

ilObjectListGUI::enableTimings

(

$a_status

)

enable timings link

public

Parameters

bool

Returns

Definition at line 3771 of file class.ilObjectListGUI.php.

        {
                $this->timings_enabled = (bool)$a_status;
        }

forceVisibleOnly()

ilObjectListGUI::forceVisibleOnly

(

$a_stat

)

Force visible access only.

Parameters

type

$a_stat

Definition at line 1334 of file class.ilObjectListGUI.php.

        {
                $this->force_visible_only = $a_stat;
        }

getAdditionalInformation()

ilObjectListGUI::getAdditionalInformation

(

)

Get additional information.

Returns

string additional information

Definition at line 867 of file class.ilObjectListGUI.php.

References $additional_information.

Referenced by getListItemHTML().

        {
                return $this->additional_information;
        }

Here is the caller graph for this function:

getAlertProperties()

ilObjectListGUI::getAlertProperties

(

)

get all alert properties

Returns

array

Definition at line 1292 of file class.ilObjectListGUI.php.

References getProperties().

        {
                $alert = array();
                foreach((array)$this->getProperties() as $prop)
                {
                        if($prop['alert'] == true)
                        {
                                $alert[] = $prop;
                        }
                }
                return $alert;
        }

Here is the call graph for this function:

getCheckboxStatus()

ilObjectListGUI::getCheckboxStatus

(

)

Are checkboxes enabled?

Returns

boolean icons enabled?

Definition at line 392 of file class.ilObjectListGUI.php.

References $checkboxes_enabled.

Referenced by insertIconsAndCheckboxes().

        {
                return $this->checkboxes_enabled;
        }

Here is the caller graph for this function:

getCommandFrame()

ilObjectListGUI::getCommandFrame

(

$a_cmd

)

Get command target frame.

Overwrite this method if link frame is not current frame

Parameters

string

$a_cmd

command

Returns

string command target frame

Definition at line 1076 of file class.ilObjectListGUI.php.

References ilDAVActivationChecker\_isActive().

Referenced by getCommands(), insertCommonSocialCommands(), ilObjOrgUnitListGUI\insertInfoScreenCommand(), and insertInfoScreenCommand().

        {
                // BEGIN WebDAV Get mount webfolder link.
                require_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
                if ($a_cmd == 'mount_webfolder' && ilDAVActivationChecker::_isActive())
                {
                        return '_blank';        
                }
                // begin-patch fm
                if($a_cmd == 'fileManagerLaunch')
                {
                        return '_blank';
                }
                // end-patch fm
                return "";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getCommandId()

ilObjectListGUI::getCommandId

(

)

get command id Normally the ref id.

Overwritten for course and category references

public

Parameters

Definition at line 847 of file class.ilObjectListGUI.php.

References $ref_id.

Referenced by getCommandLink(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertIconsAndCheckboxes(), insertLinkCommand(), insertPasteCommand(), and insertSubscribeCommand().

        {
                return $this->ref_id;
        }

Here is the caller graph for this function:

getCommandImage()

ilObjectListGUI::getCommandImage

(

$a_cmd

)

Get command icon image.

Overwrite this method if an icon is provided

Parameters

string

$a_cmd

command

Returns

string image path

Definition at line 1102 of file class.ilObjectListGUI.php.

Referenced by getCommands().

        {
                return "";
        }

Here is the caller graph for this function:

getCommandLink()

ilObjectListGUI::getCommandLink

(

$a_cmd

)

Get command link url.

Overwrite this method, if link target is not build by ctrl class (e.g. "forum.php"). This is the case for all links now, but bringing everything to ilCtrl should be realised in the future.

Parameters

string

$a_cmd

command

Returns

string command link url

Definition at line 1027 of file class.ilObjectListGUI.php.

References $_GET, ilDAVActivationChecker\_isActive(), getCommandId(), and ilDAVServer\getInstance().

Referenced by getCommands(), insertCommonSocialCommands(), and insertInfoScreenCommand().

        {
                if($this->context == self::CONTEXT_REPOSITORY || $this->context == self::CONTEXT_SHOP)
                {
                        // BEGIN WebDAV Get mount webfolder link.
                        require_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
                        if ($a_cmd == 'mount_webfolder' && ilDAVActivationChecker::_isActive())
                        {
                                require_once ('Services/WebDAV/classes/class.ilDAVServer.php');
                                $davServer = ilDAVServer::getInstance();

                                // XXX: The following is a very dirty, ugly trick.
                                //        To mount URI needs to be put into two attributes:
                                //        href and folder. This hack returns both attributes
                                //        like this:  http://...mount_uri..." folder="http://...folder_uri...
                                return $davServer->getMountURI($this->ref_id).
                                                        '" folder="'.$davServer->getFolderURI($this->ref_id);
                        }
                        // END WebDAV Get mount webfolder link.

                        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $this->getCommandId());
                        $cmd_link = $this->ctrl->getLinkTargetByClass("ilrepositorygui", $a_cmd);
                        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
                        return $cmd_link;

                        /* separate method for this line
                        $cmd_link = $this->ctrl->getLinkTargetByClass($this->gui_class_name,
                                $a_cmd);
                        return $cmd_link;
                        */
                }
                else
                {
                        $this->ctrl->setParameterByClass($this->gui_class_name, "ref_id", "");
                        $this->ctrl->setParameterByClass($this->gui_class_name, "wsp_id", $this->ref_id);
                        return $this->ctrl->getLinkTargetByClass($this->gui_class_name, $a_cmd);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getCommands()

ilObjectListGUI::getCommands

(

)

get all current commands for a specific ref id (in the permission context of the current user)

!!!NOTE!!!: Please use getListHTML() if you want to display the item including all commands

!!!NOTE 2!!!: Please do not overwrite this method in derived classes becaus it will get pretty large and much code will be simply copy-and-pasted. Insert smaller object type related method calls instead. (like getCommandLink() or getCommandFrame())

public

Parameters

int

$a_ref_id

ref id of object

Returns

array array of command arrays including "permission" => permission name "cmd" => command "link" => command link url "frame" => command link frame "lang_var" => language variable of command "granted" => true/false: command granted or not "access_info" => access info object (to do: implementation)

Definition at line 1371 of file class.ilObjectListGUI.php.

References $cmd, $ilBench, checkCommandAccess(), getCommandFrame(), getCommandImage(), and getCommandLink().

Referenced by insertCommands(), and insertPaymentCommand().

        {
                global $ilAccess, $ilBench;

                $ref_commands = array();
                foreach($this->commands as $command)
                {
                        $permission = $command["permission"];
                        $cmd = $command["cmd"];
                        $lang_var = $command["lang_var"];
                        $txt = "";
                        $info_object = null;
                        
                        if (isset($command["txt"]))
                        {
                                $txt = $command["txt"];
                        }

                        // BEGIN WebDAV: Suppress commands that don't make sense for anonymous users.
                        // Suppress commands that don't make sense for anonymous users
                        global $ilias;
                        if ($ilias->account->getId() == ANONYMOUS_USER_ID &&
                                $command['enable_anonymous'] == 'false')
                        {
                                continue;
                        }
                        // END WebDAV: Suppress commands that don't make sense for anonymous users.

                        // all access checking should be made within $ilAccess and
                        // the checkAccess of the ilObj...Access classes
                        $ilBench->start("ilObjectListGUI", "4110_get_commands_check_access");
                        //$access = $ilAccess->checkAccess($permission, $cmd, $this->ref_id, $this->type);
                        $access = $this->checkCommandAccess($permission,$cmd,$this->ref_id,$this->type);
                        $ilBench->stop("ilObjectListGUI", "4110_get_commands_check_access");

                        if ($access)
                        {
                                $cmd_link = $this->getCommandLink($command["cmd"]);
                                $cmd_frame = $this->getCommandFrame($command["cmd"]);
                                $cmd_image = $this->getCommandImage($command["cmd"]);
                                $access_granted = true;
                        }
                        else
                        {
                                $access_granted = false;
                                $info_object = $ilAccess->getInfo();
                        }

                        if (!isset($command["default"]))
                        {
                                $command["default"] = "";
                        }
                        $ref_commands[] = array(
                                "permission" => $permission,
                                "cmd" => $cmd,
                                "link" => $cmd_link,
                                "frame" => $cmd_frame,
                                "lang_var" => $lang_var,
                                "txt" => $txt,
                                "granted" => $access_granted,
                                "access_info" => $info_object,
                                "img" => $cmd_image,
                                "default" => $command["default"]
                        );
                }

                return $ref_commands;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getCommandsHTML()

ilObjectListGUI::getCommandsHTML

(

)

Get commands HTML (must be called after get list item html)

Definition at line 3660 of file class.ilObjectListGUI.php.

References insertCommands().

        {
                return $this->insertCommands();
        }

Here is the call graph for this function:

getCommandsStatus()

ilObjectListGUI::getCommandsStatus

(

)

Parameters

bool

Returns

bool

Definition at line 607 of file class.ilObjectListGUI.php.

References $commands_enabled.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), getListItemHTML(), insertCommands(), insertIconsAndCheckboxes(), ilCourseObjectiveListGUI\insertTitle(), and insertTitle().

        {
                return $this->commands_enabled;
        }

Here is the caller graph for this function:

getContainerObject()

ilObjectListGUI::getContainerObject

(

)

get container object

public

Parameters

Definition at line 167 of file class.ilObjectListGUI.php.

Referenced by enableDownloadCheckbox(), getListItemHTML(), insertCutCommand(), insertDeleteCommand(), insertLinkCommand(), insertMultiDownloadCommand(), insertPasteCommand(), ilCourseObjectiveListGUI\insertProgressInfo(), insertSubscribeCommand(), and ilCourseObjectiveListGUI\insertTitle().

        {
                return $this->container_obj;
        }

Here is the caller graph for this function:

getCopyStatus()

ilObjectListGUI::getCopyStatus

(

)

Parameters

bool

Returns

bool

Definition at line 501 of file class.ilObjectListGUI.php.

References $copy_enabled.

        {
                return $this->copy_enabled;
        }

getCustomProperties()

ilObjectListGUI::getCustomProperties

(

$a_prop

)

get custom properties

Definition at line 1276 of file class.ilObjectListGUI.php.

Referenced by insertProperties().

        {
                if (is_array($this->cust_prop))
                {
                        foreach($this->cust_prop as $prop)
                        {
                                $a_prop[] = $prop;
                        }
                }
                return $a_prop;
        }

Here is the caller graph for this function:

getCutStatus()

ilObjectListGUI::getCutStatus

(

)

Parameters

bool

Returns

bool

Definition at line 479 of file class.ilObjectListGUI.php.

        {
                return $this->cut_enabled;
        }

getDeleteStatus()

ilObjectListGUI::getDeleteStatus

(

)

Parameters

bool

Returns

bool

Definition at line 457 of file class.ilObjectListGUI.php.

        {
                return $this->delete_enabled;
        }

getDescription()

ilObjectListGUI::getDescription

(

)

getDescription overwritten in class.ilObjLinkResourceList.php

Returns

string description

Definition at line 795 of file class.ilObjectListGUI.php.

Referenced by insertDescription().

        {
                return $this->description;
        }

Here is the caller graph for this function:

getDescriptionStatus()

ilObjectListGUI::getDescriptionStatus

(

)

Parameters

bool

Returns

bool

Definition at line 280 of file class.ilObjectListGUI.php.

References $description_enabled.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

        {
                return $this->description_enabled;
        }

Here is the caller graph for this function:

getDetailsLevel()

ilObjectListGUI::getDetailsLevel

(

)

Get current details level.

Returns

Definition at line 888 of file class.ilObjectListGUI.php.

References $details_level.

Referenced by ilObjSessionListGUI\getProperties(), getProperties(), and ilObjForumListGUI\initItem().

        {
                return $this->details_level;
        }

Here is the caller graph for this function:

getDownloadCheckboxState()

ilObjectListGUI::getDownloadCheckboxState

(

)

Definition at line 2951 of file class.ilObjectListGUI.php.

References $download_checkbox_state.

Referenced by insertIconsAndCheckboxes().

        {
                return $this->download_checkbox_state;  
        }

Here is the caller graph for this function:

getExpandStatus()

ilObjectListGUI::getExpandStatus

(

)

Is expand/collapse enabled.

Returns

boolean icons enabled?

Definition at line 412 of file class.ilObjectListGUI.php.

References $expand_enabled.

Referenced by insertIconsAndCheckboxes().

        {
                return $this->expand_enabled;
        }

Here is the caller graph for this function:

getHeaderAction()

ilObjectListGUI::getHeaderAction

(

)

Get header action.

Returns

string

Definition at line 3037 of file class.ilObjectListGUI.php.

References $comments_enabled, $ilUser, $lng, $obj_id, $tpl, ilNote\_countNotesAndComments(), ilObject\_lookupType(), addHeaderIcon(), addHeaderIconHTML(), ilTooltipGUI\addTooltip(), ilUtil\getImagePath(), ilNoteGUI\getListCommentsJSCall(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), ilTagging\getTagsForUserAndObject(), IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, ilUtil\img(), insertCommands(), and isCommentsActivated().

        {
                global $ilUser, $lng, $tpl;
                
                $htpl = new ilTemplate("tpl.header_action.html", true, true, "Services/Repository");    
                
                $redraw_js = "il.Object.redrawActionHeader();";
                
                // tags
                if($this->tags_enabled)
                {                       
                        include_once("./Services/Tagging/classes/class.ilTagging.php");
                        $tags = ilTagging::getTagsForUserAndObject($this->obj_id, 
                                ilObject::_lookupType($this->obj_id), 0, "", $ilUser->getId());
                        if (count($tags) > 0)
                        {
                                include_once("./Services/Tagging/classes/class.ilTaggingGUI.php");
                                $lng->loadLanguageModule("tagging");
                                $this->addHeaderIcon("tags",                                    
                                        ilUtil::getImagePath("icon_tags_s.png"),
                                        $lng->txt("tagging_tags").": ".count($tags),
                                        ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $redraw_js),
                                        count($tags));                          
                        }
                }
                                
                // notes and comments
                $comments_enabled = $this->isCommentsActivated($this->type, $this->ref_id, $this->obj_id, true, false);
                if($this->notes_enabled || $comments_enabled)
                {
                        include_once("./Services/Notes/classes/class.ilNote.php");
                        include_once("./Services/Notes/classes/class.ilNoteGUI.php");
                        $cnt = ilNote::_countNotesAndComments($this->obj_id, $this->sub_obj_id);

                        if($this->notes_enabled && $cnt[$this->obj_id][IL_NOTE_PRIVATE] > 0)
                        {
                                $this->addHeaderIcon("notes",
                                        ilUtil::getImagePath("note_unlabeled.png"),
                                        $lng->txt("private_notes").": ".$cnt[$this->obj_id][IL_NOTE_PRIVATE],
                                        ilNoteGUI::getListNotesJSCall($this->ajax_hash, $redraw_js),
                                        $cnt[$this->obj_id][IL_NOTE_PRIVATE]
                                        );
                        }

                        if($comments_enabled && $cnt[$this->obj_id][IL_NOTE_PUBLIC] > 0)
                        {
                                $lng->loadLanguageModule("notes");
                                
                                $this->addHeaderIcon("comments",
                                        ilUtil::getImagePath("comment_unlabeled.png"),
                                        $lng->txt("notes_public_comments").": ".$cnt[$this->obj_id][IL_NOTE_PUBLIC],
                                        ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $redraw_js),
                                        $cnt[$this->obj_id][IL_NOTE_PUBLIC]);
                        }                       
                }
                
                // rating
                if($this->rating_enabled)
                {                                                                       
                        include_once("./Services/Rating/classes/class.ilRatingGUI.php");
                        $rating_gui = new ilRatingGUI();
                        $rating_gui->enableCategories($this->rating_categories_enabled);
                        // never rate sub objects from header action!
                        $rating_gui->setObject($this->obj_id, $this->type);                                                                             
                        if($this->rating_text)
                        {
                                $rating_gui->setYourRatingText($this->rating_text);
                        }                                                       
                        
                        $this->ctrl->setParameterByClass("ilRatingGUI", "cadh", $this->ajax_hash);      
                        $this->ctrl->setParameterByClass("ilRatingGUI", "rnsb", true);  
                        if($this->rating_ctrl_path)
                        {                               
                                $rating_gui->setCtrlPath($this->rating_ctrl_path);              
                                $ajax_url = $this->ctrl->getLinkTargetByClass($this->rating_ctrl_path, "saveRating", "", true, false);
                        }
                        else
                        {
                                // ???
                                $ajax_url = $this->ctrl->getLinkTargetByClass("ilRatingGUI", "saveRating", "", true, false);
                        }               
                        $tpl->addOnLoadCode("il.Object.setRatingUrl('".$ajax_url."');");
                        
                        $this->addHeaderIconHTML("rating", 
                                $rating_gui->getHtml(true, 
                                        $this->checkCommandAccess("read", "", $this->ref_id, $this->type), 
                                        "il.Object.saveRating(%rating%);"));                                                            
                }
                
                if($this->header_icons)
                {                       
                        include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                        
                        $chunks = array();
                        foreach($this->header_icons as $id => $attr)
                        {                                                               
                                $id = "headp_".$id;
                                
                                if(is_array($attr))
                                {                               
                                        if($attr["onclick"])
                                        {                               
                                                $htpl->setCurrentBlock("onclick");
                                                $htpl->setVariable("PROP_ONCLICK", $attr["onclick"]);
                                                $htpl->parseCurrentBlock();
                                        }

                                        if($attr["status_text"])
                                        {
                                                $htpl->setCurrentBlock("status");
                                                $htpl->setVariable("PROP_TXT", $attr["status_text"]);
                                                $htpl->parseCurrentBlock();
                                        }
                                        
                                        if(!$attr["href"])
                                        {
                                                $attr["href"] = "#";
                                        }

                                        $htpl->setCurrentBlock("prop");
                                        $htpl->setVariable("PROP_ID", $id);
                                        $htpl->setVariable("IMG", ilUtil::img($attr["img"]));                                                                           
                                        $htpl->setVariable("PROP_HREF", $attr["href"]);                                                                                                 
                                        $htpl->parseCurrentBlock();
                                        
                                        if($attr["tooltip"])
                                        {                                       
                                                ilTooltipGUI::addTooltip($id, $attr["tooltip"]);
                                        }
                                }
                                else
                                {
                                        $chunks[] = $attr;
                                }
                        }
                        
                        if(sizeof($chunks))
                        {
                                $htpl->setVariable("PROP_CHUNKS", 
                                        implode("   ", $chunks)."   ");
                        }
                }
                
                $htpl->setVariable("ACTION_DROP_DOWN",
                        $this->insertCommands(false, false, "", true));
                
                return $htpl->get();
        }

Here is the call graph for this function:

getIconImageType()

ilObjectListGUI::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'.

Definition at line 1448 of file class.ilObjectListGUI.php.

References $type.

Referenced by insertIconsAndCheckboxes().

        {
                if ($this->type == "sahs" && $this->offline_mode) {
                        return $this->type . "_offline";        
                }
                return $this->type;
        }

Here is the caller graph for this function:

getIconStatus()

ilObjectListGUI::getIconStatus

(

)

Are icons enabled?

Returns

boolean icons enabled?

Definition at line 372 of file class.ilObjectListGUI.php.

References $icons_enabled.

Referenced by insertIconsAndCheckboxes().

        {
                return $this->icons_enabled;
        }

Here is the caller graph for this function:

getInfoScreenStatus()

ilObjectListGUI::getInfoScreenStatus

(

)

Parameters

bool

Returns

bool

Definition at line 638 of file class.ilObjectListGUI.php.

References $info_screen_enabled.

Referenced by insertCommands().

        {
                return $this->info_screen_enabled;
        }

Here is the caller graph for this function:

getItemDetailLinkStatus()

ilObjectListGUI::getItemDetailLinkStatus

(

)

get item detail link status

public

Returns

bool

Definition at line 709 of file class.ilObjectListGUI.php.

References $item_detail_links_enabled.

Referenced by getListItemHTML().

        {
                return $this->item_detail_links_enabled;
        }

Here is the caller graph for this function:

getLinkStatus()

ilObjectListGUI::getLinkStatus

(

)

Parameters

bool

Returns

bool

Definition at line 565 of file class.ilObjectListGUI.php.

        {
                return $this->link_enabled;
        }

getListItemHTML()

ilObjectListGUI::getListItemHTML	(		$a_ref_id,
			$a_obj_id,
			$a_title,
			$a_description,
			$a_use_asynch = false,
			$a_get_asynch_commands = false,
			$a_asynch_url = "",
			$a_context = self::CONTEXT_REPOSITORY
	)

Get all item information (title, commands, description) in HTML.

public

Parameters

int	$a_ref_id	item reference id
int	$a_obj_id	item object id
int	$a_title	item title
int	$a_description	item description
bool	$a_use_asynch
bool	$a_get_asynch_commands
string	$a_asynch_url
bool	$a_context	workspace/tree context

Returns

string html code

Definition at line 3430 of file class.ilObjectListGUI.php.

References $ilBench, $ilCtrl, $ilUser, $type, ilObjFileAccess\_isFileHidden(), ilObject\_lookupType(), addCustomProperty(), ilCommonActionDispatcherGUI\buildAjaxHash(), checkCommandAccess(), enabledRelevance(), getAdditionalInformation(), getCommandsStatus(), getContainerObject(), getDescriptionStatus(), getItemDetailLinkStatus(), getNoticePropertiesStatus(), getPreconditionsStatus(), getProgressInfoStatus(), getPropertiesStatus(), getSearchFragmentStatus(), getSeparateCommands(), getUniqueItemId(), ilRating\hasRatingInListGUI(), IL_LIST_AS_TRIGGER, initItem(), insertCommands(), insertDescription(), insertFileUpload(), insertIconsAndCheckboxes(), insertItemDetailLinks(), insertNoticeProperties(), insertPath(), insertPositionField(), insertPreconditions(), insertProgressInfo(), insertProperties(), insertRelevance(), insertSearchFragment(), insertSubItems(), insertTitle(), isFileUploadAllowed(), isMode(), setAjaxHash(), storeAccessCache(), ilCommonActionDispatcherGUI\TYPE_REPOSITORY, and ilCommonActionDispatcherGUI\TYPE_WORKSPACE.

        {
                global $ilAccess, $ilBench, $ilUser, $ilCtrl;

                // this variable stores wheter any admin commands
                // are included in the output
                $this->adm_commands_included = false;

                // only for permformance exploration
                $type = ilObject::_lookupType($a_obj_id);

                // initialization
                $ilBench->start("ilObjectListGUI", "1000_getListHTML_init$type");
                $this->initItem($a_ref_id, $a_obj_id, $a_title, $a_description, $a_context);
                $ilBench->stop("ilObjectListGUI", "1000_getListHTML_init$type");
                
                // prepare ajax calls
                include_once "Services/Object/classes/class.ilCommonActionDispatcherGUI.php";
                if($a_context == self::CONTEXT_REPOSITORY)
                {
                        $node_type = ilCommonActionDispatcherGUI::TYPE_REPOSITORY;
                }
                else
                {
                        $node_type = ilCommonActionDispatcherGUI::TYPE_WORKSPACE;
                }
                $this->setAjaxHash(ilCommonActionDispatcherGUI::buildAjaxHash($node_type, $a_ref_id, $type, $a_obj_id));                
                                
                if ($a_use_asynch && $a_get_asynch_commands)
                {
                        return $this->insertCommands(true, true);
                }                               
                
                if($this->rating_enabled)
                {                                               
                        if(ilRating::hasRatingInListGUI($this->obj_id, $this->type))
                        {                               
                                $may_rate = $this->checkCommandAccess("read", "", $this->ref_id, $this->type);                          
                                
                                $rating = new ilRatingGUI();
                                $rating->setObject($this->obj_id, $this->type);
                                $this->addCustomProperty(
                                        $this->lng->txt("rating_average_rating"), 
                                        $rating->getListGUIProperty($this->ref_id, $may_rate, $this->ajax_hash, $this->parent_ref_id), 
                                        false, 
                                        true
                                );
                        }       
                }
                
                // read from cache
                include_once("Services/Object/classes/class.ilListItemAccessCache.php");
                $this->acache = new ilListItemAccessCache();
                $cres = $this->acache->getEntry($ilUser->getId().":".$a_ref_id);
                if($this->acache->getLastAccessStatus() == "hit")
                {
                        $this->access_cache = unserialize($cres);
                }
                else
                {
                        // write to cache
                        $this->storeAccessCache();
                }
                
                // visible check
                if (!$this->checkCommandAccess("visible", "", $a_ref_id, "", $a_obj_id))
                {                       
                        $ilBench->stop("ilObjectListGUI", "2000_getListHTML_check_visible");
                        return "";
                }
                
                // BEGIN WEBDAV
                if($type=='file' AND ilObjFileAccess::_isFileHidden($a_title))
                {
                        return "";
                }
                // END WEBDAV
                
                
                $this->tpl = new ilTemplate("tpl.container_list_item.html", true, true,
                        "Services/Container", "DEFAULT", false, true);

                if ($this->getCommandsStatus() || 
                        ($this->payment_enabled && IS_PAYMENT_ENABLED))
                {
                        if (!$this->getSeparateCommands())
                        {
                                $this->tpl->setVariable("COMMAND_SELECTION_LIST",
                                        $this->insertCommands($a_use_asynch, $a_get_asynch_commands, $a_asynch_url));
                        }
                }                
                
                if($this->getProgressInfoStatus())
                {
                        $this->insertProgressInfo();    
                }

                // insert title and describtion
                $this->insertTitle();
                if (!$this->isMode(IL_LIST_AS_TRIGGER))
                {
                        if ($this->getDescriptionStatus())
                        {
                                $this->insertDescription();
                        }
                }

                if($this->getSearchFragmentStatus())
                {
                        $this->insertSearchFragment();
                }
                if($this->enabledRelevance())
                {
                        $this->insertRelevance();
                }

                // properties
                $ilBench->start("ilObjectListGUI", "6000_insert_properties$type");
                if ($this->getPropertiesStatus())
                {
                        $this->insertProperties();
                }
                $ilBench->stop("ilObjectListGUI", "6000_insert_properties$type");

                // notice properties
                $ilBench->start("ilObjectListGUI", "6500_insert_notice_properties$type");
                if($this->getNoticePropertiesStatus())
                {
                        $this->insertNoticeProperties();
                }
                $ilBench->stop("ilObjectListGUI", "6500_insert_notice_properties$type");

                // preconditions
                $ilBench->start("ilObjectListGUI", "7000_insert_preconditions");
                if ($this->getPreconditionsStatus())
                {
                        $this->insertPreconditions();
                }
                $ilBench->stop("ilObjectListGUI", "7000_insert_preconditions");

                // path
                $ilBench->start("ilObjectListGUI", "8000_insert_path");
                $this->insertPath();
                $ilBench->stop("ilObjectListGUI", "8000_insert_path");
                
                $ilBench->start("ilObjectListGUI", "8500_item_detail_links");
                if($this->getItemDetailLinkStatus())
                {
                        $this->insertItemDetailLinks();                 
                }
                $ilBench->stop("ilObjectListGUI", "8500_item_detail_links");

                // icons and checkboxes
                $this->insertIconsAndCheckboxes();
                
                // input field for position
                $this->insertPositionField();

                // subitems
                $this->insertSubItems();
                
                // file upload
                if ($this->isFileUploadAllowed())
                {
                        $this->insertFileUpload();      
                }

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

                $this->tpl->setVariable("DIV_CLASS",'ilContainerListItemOuter');
                $this->tpl->setVariable("DIV_ID", 'id = "'.$this->getUniqueItemId(true).'"');
                $this->tpl->setVariable("ADDITIONAL", $this->getAdditionalInformation());
                
                // #11554 - make sure that internal ids are reset
                $this->ctrl->setParameter($this->getContainerObject(), "item_ref_id", "");
                
                return $this->tpl->get();
        }

Here is the call graph for this function:

getMode()

ilObjectListGUI::getMode

(

)

get output mode

Returns

string output mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER)

Definition at line 1688 of file class.ilObjectListGUI.php.

        {
                return $this->mode;
        }

getNoticeProperties()

ilObjectListGUI::getNoticeProperties

(

)

get notice properties

Definition at line 1308 of file class.ilObjectListGUI.php.

Referenced by insertNoticeProperties().

        {
                $this->notice_prop = array();
                if($infos = $this->ldap_mapping->getInfoStrings($this->obj_id,true))
                {
                        foreach($infos as $info)
                        {
                                $this->notice_prop[] = array('value' => $info);
                        }
                }               
                return $this->notice_prop ? $this->notice_prop : array();
        }       

Here is the caller graph for this function:

getNoticePropertiesStatus()

ilObjectListGUI::getNoticePropertiesStatus

(

)

Definition at line 235 of file class.ilObjectListGUI.php.

References $notice_properties_enabled.

Referenced by getListItemHTML().

        {
                return $this->notice_properties_enabled;
        }

Here is the caller graph for this function:

getPathStatus()

ilObjectListGUI::getPathStatus

(

)

Parameters

bool

Returns

bool

Definition at line 586 of file class.ilObjectListGUI.php.

Referenced by insertPath().

        {
                return $this->path_enabled;
        }

Here is the caller graph for this function:

getPaymentStatus()

ilObjectListGUI::getPaymentStatus

(

)

Parameters

bool

Returns

bool

Definition at line 544 of file class.ilObjectListGUI.php.

        {
                return $this->payment_enabled;
        }

getPreconditionsStatus()

ilObjectListGUI::getPreconditionsStatus

(

)

Parameters

bool

Returns

bool

Definition at line 258 of file class.ilObjectListGUI.php.

References $preconditions_enabled.

Referenced by getListItemHTML().

        {
                return $this->preconditions_enabled;
        }

Here is the caller graph for this function:

getProgressInfoStatus()

ilObjectListGUI::getProgressInfoStatus

(

)

get progress info status

public

Parameters

Definition at line 662 of file class.ilObjectListGUI.php.

References $progress_enabled.

Referenced by getListItemHTML().

        {
                return $this->progress_enabled;
        }

Here is the caller graph for this function:

getProperties()

ilObjectListGUI::getProperties

(

$a_item = ''

)

Get item properties.

Overwrite this method to add properties at the bottom of the item html

Returns

array array of property arrays: "alert" (boolean) => display as an alert property (usually in red) "property" (string) => property name "value" (string) => property value

Definition at line 1118 of file class.ilObjectListGUI.php.

References $ilUser, $lng, ilDAVActivationChecker\_isActive(), ilChangeEvent\_isActive(), ilChangeEvent\_lookupChangeState(), ilChangeEvent\_lookupInsideChangeState(), and getDetailsLevel().

Referenced by getAlertProperties(), ilObjForumListGUI\initItem(), and insertProperties().

        {
                global $objDefinition;

                $props = array();
                // please list alert properties first
                // example (use $lng->txt instead of "Status"/"Offline" strings):
                // $props[] = array("alert" => true, "property" => "Status", "value" => "Offline");
                // $props[] = array("alert" => false, "property" => ..., "value" => ...);
                // ...
                
                // #8280: WebDav is only supported in repository
                if($this->context == self::CONTEXT_REPOSITORY)
                {
                        // BEGIN WebDAV Display locking information
                        require_once ('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
                        if (ilDAVActivationChecker::_isActive())
                        {
                                require_once ('Services/WebDAV/classes/class.ilDAVServer.php');
                                global $ilias, $lng;

                                // Show lock info
                                require_once('Services/WebDAV/classes/class.ilDAVLocks.php');
                                $davLocks = new ilDAVLocks();
                                if ($ilias->account->getId() != ANONYMOUS_USER_ID)
                                {
                                        $locks =& $davLocks->getLocksOnObjectObj($this->obj_id);
                                        if (count($locks) > 0)
                                        {
                                                $lockUser = new ilObjUser($locks[0]['ilias_owner']);

                                                $props[] = array(
                                                        "alert" => false, 
                                                        "property" => $lng->txt("in_use_by"),
                                                        "value" => $lockUser->getLogin(),
                                                        "link" =>       "./ilias.php?user=".$locks[0]['ilias_owner'].'&cmd=showUserProfile&cmdClass=ilpersonaldesktopgui&cmdNode=1&baseClass=ilPersonalDesktopGUI',
                                                );
                                        }
                                }
                                // END WebDAV Display locking information

                                if($this->getDetailsLevel() == self::DETAILS_SEARCH)
                                {
                                        return $props;
                                }

                                // BEGIN WebDAV Display warning for invisible Unix files and files with special characters
                                if (preg_match('/^(\\.|\\.\\.)$/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_interoperability"),
                                                "value" => $lng->txt("filename_special_filename"),
                                                'propertyNameVisible' => false);
                                } 
                                else if (preg_match('/^\\./', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_visibility"),
                                                "value" => $lng->txt("filename_hidden_unix_file"),
                                                'propertyNameVisible' => false);
                                }
                                else if (preg_match('/~$/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_visibility"),
                                                "value" => $lng->txt("filename_hidden_backup_file"),
                                                'propertyNameVisible' => false);
                                }
                                else if (preg_match('/[\\/]/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_interoperability"),
                                                "value" => $lng->txt("filename_special_characters"),
                                                'propertyNameVisible' => false);
                                } 
                                else if (preg_match('/[\\\\\\/:*?"<>|]/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_interoperability"),
                                                "value" => $lng->txt("filename_windows_special_characters"),
                                                'propertyNameVisible' => false);
                                }
                                else if (preg_match('/\\.$/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_interoperability"),
                                                "value" => $lng->txt("filename_windows_empty_extension"),
                                                'propertyNameVisible' => false);
                                } 
                                else if (preg_match('/^(\\.|\\.\\.)$/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_interoperability"),
                                                "value" => $lng->txt("filename_special_filename"),
                                                'propertyNameVisible' => false);
                                } 
                                else if (preg_match('/#/', $this->title))
                                {
                                        $props[] = array("alert" => false, "property" => $lng->txt("filename_interoperability"),
                                                "value" => $lng->txt("filename_windows_webdav_issue"),
                                                'propertyNameVisible' => false);
                                }
                        }
                        // END WebDAV Display warning for invisible files and files with special characters
                
                        // BEGIN ChangeEvent: display changes.
                        require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                        if (ilChangeEvent::_isActive())
                        {
                                global $ilias, $lng, $ilUser;
                                if ($ilias->account->getId() != ANONYMOUS_USER_ID)
                                {
                                        // Performance improvement: for container objects
                                        // we only display 'changed inside' events, for
                                        // leaf objects we only display 'object new/changed'
                                        // events
                                        $isContainer = in_array($this->type, array('cat', 'fold', 'crs', 'grp'));
                                        if($isContainer)
                                        {
                                                $state = ilChangeEvent::_lookupInsideChangeState($this->obj_id, $ilUser->getId());
                                                if($state > 0)
                                                {
                                                        $props[] = array(
                                                                "alert" => true,
                                                                "value" => $lng->txt('state_changed_inside'),
                                                                'propertyNameVisible' => false);
                                                }
                                        }
                                        /*
                                         * elseif(!$objDefinition->isAdministrationObject(ilObject::_lookupType($this->obj_id)))
                                         * 
                                         * only files support write events properly
                                         */
                                        elseif($this->type == "file")
                                        {
                                                $state = ilChangeEvent::_lookupChangeState($this->obj_id, $ilUser->getId());
                                                if($state > 0)
                                                {
                                                        $props[] = array(
                                                                "alert" => true,
                                                                "value" => $lng->txt(($state == 1) ? 'state_unread' : 'state_changed'),
                                                                'propertyNameVisible' => false);
                                                }
                                        }
                                }
                        }
                        // END ChangeEvent: display changes.
                }

                return $props;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getPropertiesStatus()

ilObjectListGUI::getPropertiesStatus

(

)

Parameters

bool

Returns

bool

Definition at line 218 of file class.ilObjectListGUI.php.

References $properties_enabled.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

        {
                return $this->properties_enabled;
        }

Here is the caller graph for this function:

getRelevance()

ilObjectListGUI::getRelevance

(

)

get relevance

Parameters

Definition at line 352 of file class.ilObjectListGUI.php.

References $relevance.

Referenced by insertRelevance().

        {
                return $this->relevance;
        }

Here is the caller graph for this function:

getSearchFragment()

ilObjectListGUI::getSearchFragment

(

)

get search fragment

Returns

Definition at line 814 of file class.ilObjectListGUI.php.

References $search_fragment.

Referenced by insertSearchFragment().

        {
                return $this->search_fragment;   
        }

Here is the caller graph for this function:

getSearchFragmentStatus()

ilObjectListGUI::getSearchFragmentStatus

(

)

Show hide search result fragments.

Parameters

bool

Returns

bool

Definition at line 291 of file class.ilObjectListGUI.php.

References $search_fragment_enabled.

Referenced by getListItemHTML().

        {
                return $this->search_fragment_enabled;
        }

Here is the caller graph for this function:

getSeparateCommands()

ilObjectListGUI::getSeparateCommands

(

)

Get separate commands.

Returns

boolean separate commands

Definition at line 834 of file class.ilObjectListGUI.php.

References $separate_commands.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

        {
                return $this->separate_commands;
        }

Here is the caller graph for this function:

getSubscribeStatus()

ilObjectListGUI::getSubscribeStatus

(

)

Parameters

bool

Returns

bool

Definition at line 523 of file class.ilObjectListGUI.php.

        {
                return $this->subscribe_enabled;
        }

getSubstitutionStatus()

ilObjectListGUI::getSubstitutionStatus

(

)

Get substitution status.

public

Definition at line 685 of file class.ilObjectListGUI.php.

References $substitutions_enabled.

Referenced by insertDescription().

        {
                return $this->substitutions_enabled;
        }

Here is the caller graph for this function:

getTitle()

ilObjectListGUI::getTitle

(

)

getTitle overwritten in class.ilObjLinkResourceList.php

Returns

string title

Definition at line 776 of file class.ilObjectListGUI.php.

Referenced by ilCourseObjectiveListGUI\insertTitle(), and insertTitle().

        {
                return $this->title;
        }

Here is the caller graph for this function:

getUniqueItemId()

ilObjectListGUI::getUniqueItemId (   $a_as_div = false )

protected

Get unique item identifier (for js-actions)

Parameters

bool

$a_as_div

Returns

string

Definition at line 3630 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML(), insertCommands(), insertFileUpload(), insertPreconditions(), and parseConditions().

        {
                // use correct id for references
                $id_ref = ($this->reference_ref_id > 0)
                        ? $this->reference_ref_id
                        : $this->ref_id;
                
                // add unique identifier for preconditions (objects can appear twice in same container)
                if($this->condition_depth)
                {
                        $id_ref .= "_pc".$this->condition_depth;
                }
                
                // unique
                $id_ref .= "_pref_".$this->parent_ref_id;               
        
                if(!$a_as_div)
                {
                        return $id_ref;
                }
                else
                {
                        // action menu [yellow] toggle
                        return "lg_div_".$id_ref;
                }
        }

Here is the caller graph for this function:

ilObjectListGUI()

ilObjectListGUI::ilObjectListGUI

(

)

constructor

Definition at line 121 of file class.ilObjectListGUI.php.

References $_REQUEST, $ilCtrl, $lng, ilLDAPRoleGroupMapping\_getInstance(), enableComments(), enableNotes(), enableTags(), IL_LIST_FULL, init(), and setParentRefId().

Referenced by ilObjOrgUnitListGUI\__construct(), ilObjBookingPoolListGUI\__construct(), ilObjChatroomListGUI\__construct(), ilObjCategoryListGUI\ilObjCategoryListGUI(), ilObjCourseListGUI\ilObjCourseListGUI(), ilObjDlBookListGUI\ilObjDlBookListGUI(), ilObjExerciseListGUI\ilObjExerciseListGUI(), ilObjExternalFeedListGUI\ilObjExternalFeedListGUI(), ilObjFileBasedLMListGUI\ilObjFileBasedLMListGUI(), ilObjFileListGUI\ilObjFileListGUI(), ilObjFolderListGUI\ilObjFolderListGUI(), ilObjGlossaryListGUI\ilObjGlossaryListGUI(), ilObjGroupListGUI\ilObjGroupListGUI(), ilObjiLincClassroomListGUI\ilObjiLincClassroomListGUI(), ilObjiLincCourseListGUI\ilObjiLincCourseListGUI(), ilObjLearningModuleListGUI\ilObjLearningModuleListGUI(), ilObjLinkResourceListGUI\ilObjLinkResourceListGUI(), ilObjMediaCastListGUI\ilObjMediaCastListGUI(), ilObjMediaPoolListGUI\ilObjMediaPoolListGUI(), ilObjQuestionPoolListGUI\ilObjQuestionPoolListGUI(), ilObjRootFolderListGUI\ilObjRootFolderListGUI(), ilObjSAHSLearningModuleListGUI\ilObjSAHSLearningModuleListGUI(), ilObjSurveyListGUI\ilObjSurveyListGUI(), ilObjSurveyQuestionPoolListGUI\ilObjSurveyQuestionPoolListGUI(), ilObjTestListGUI\ilObjTestListGUI(), and ilObjWikiListGUI\ilObjWikiListGUI().

        {
                global $rbacsystem, $ilCtrl, $lng, $ilias;

                $this->rbacsystem = $rbacsystem;
                $this->ilias = $ilias;
                $this->ctrl = $ilCtrl;
                $this->lng = $lng;
                $this->mode = IL_LIST_FULL;
                $this->path_enabled = false;
                
                $this->enableComments(false);
                $this->enableNotes(false);
                $this->enableTags(false);
                
                // unique js-ids
                $this->setParentRefId($_REQUEST["ref_id"]);
                
//echo "list";
                $this->init();
                
                include_once('Services/LDAP/classes/class.ilLDAPRoleGroupMapping.php');
                $this->ldap_mapping = ilLDAPRoleGroupMapping::_getInstance();
                
                $lng->loadLanguageModule("obj");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilObjectListGUI::init

(

)

initialisation

this method should be overwritten by derived classes

Definition at line 178 of file class.ilObjectListGUI.php.

References ilObjectAccess\_getCommands().

Referenced by ilObjectListGUI().

        {
                // Create static links for default command (linked title) or not
                $this->static_link_enabled = true;
                $this->delete_enabled = true;
                $this->cut_enabled = true;
                $this->subscribe_enabled = true;
                $this->link_enabled = false;
                $this->copy_enabled = false;
                $this->payment_enabled = false;
                $this->progress_enabled = false;
                $this->notice_properties_enabled = true;
                $this->info_screen_enabled = false;
                $this->type = "";                                       // "cat", "course", ...
                $this->gui_class_name = "";                     // "ilobjcategorygui", "ilobjcoursegui", ...

                // general commands array, e.g.
                include_once('./Services/Object/classes/class.ilObjectAccess.php');
                $this->commands = ilObjectAccess::_getCommands();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

initItem()

ilObjectListGUI::initItem	(		$a_ref_id,
			$a_obj_id,
			$a_title = "",
			$a_description = "",
			$a_context = self::CONTEXT_REPOSITORY
	)

inititialize new item (is called by getItemHTML())

Parameters

int	$a_ref_id	reference id
int	$a_obj_id	object id
string	$a_title	title
string	$a_description	description
int	$a_context	tree/workspace

Definition at line 970 of file class.ilObjectListGUI.php.

References ilObjSAHSLearningModuleAccess\_lookupUserIsOfflineMode(), setDescription(), and setTitle().

Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

        {
                $this->offline_mode = false;
                include_once('Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php');
                if ($this->type == "sahs") {
                        $this->offline_mode = ilObjSAHSLearningModuleAccess::_lookupUserIsOfflineMode($a_obj_id);       
                }
                $this->access_cache = array();
                $this->ref_id = $a_ref_id;
                $this->obj_id = $a_obj_id;
                $this->context = $a_context;
                $this->setTitle($a_title);
                $this->setDescription($a_description);
                #$this->description = $a_description;
                                
                // checks, whether any admin commands are included in the output
                $this->adm_commands_included = false;
                $this->prevent_access_caching = false;

        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertCommand()

ilObjectListGUI::insertCommand	(		$a_href,
			$a_text,
			$a_frame = "",
			$a_img = "",
			$a_cmd = "",
			$a_onclick = ""
	)

insert command button

private

Parameters

string	$a_href	link url target
string	$a_text	link text
string	$a_frame	link frame target

Definition at line 2172 of file class.ilObjectListGUI.php.

Referenced by insertCommands(), insertCommonSocialCommands(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), ilObjOrgUnitListGUI\insertInfoScreenCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertMultiDownloadCommand(), insertPasteCommand(), insertSubscribeCommand(), and insertTimingsCommand().

        {
                // #11099
                $chksum = md5($a_href.$a_text); 
                if($a_href == "#" || 
                        !in_array($chksum, $this->prevent_duplicate_commands))
                {
                        if($a_href != "#")
                        {
                                $this->prevent_duplicate_commands[] = $chksum;
                        }
                        
                        $prevent_background_click = false;
                        if ($a_cmd =='mount_webfolder')
                        {
                                $prevent_background_click = true;
                        }
                        $this->current_selection_list->addItem($a_text, "", $a_href, $a_img, $a_text, $a_frame,
                                "", $prevent_background_click, $a_onclick);
                }                               
        }

Here is the caller graph for this function:

insertCommands()

ilObjectListGUI::insertCommands	(		$a_use_asynch = false,
			$a_get_asynch_commands = false,
			$a_asynch_url = "",
			$a_header_actions = false
	)

insert all commands into html code

private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

Definition at line 2601 of file class.ilObjectListGUI.php.

References $ilUser, $lng, ilContainer\_lookupContainerSetting(), addCustomProperty(), appendRepositoryFrameParameter(), createDefaultCommand(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, enableProperties(), getCommands(), getCommandsStatus(), ilUtil\getImagePath(), getInfoScreenStatus(), getUniqueItemId(), IL_LIST_AS_TRIGGER, IL_NO_LICENSE, ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, insertCommand(), insertCommonSocialCommands(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertMultiDownloadCommand(), insertPasteCommand(), insertPayment(), insertSubscribeCommand(), insertTimingsCommand(), and isMode().

Referenced by getCommandsHTML(), getHeaderAction(), ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

        {
                global $lng, $ilUser;

                if (!$this->getCommandsStatus())
                {
                        return;
                }

                include_once("Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
                $this->current_selection_list = new ilAdvancedSelectionListGUI();
                $this->current_selection_list->setAsynch($a_use_asynch && !$a_get_asynch_commands);
                $this->current_selection_list->setAsynchUrl($a_asynch_url);
                $this->current_selection_list->setListTitle($lng->txt("actions"));
                $this->current_selection_list->setId("act_".$this->getUniqueItemId(false));
                $this->current_selection_list->setSelectionHeaderClass("small");
                $this->current_selection_list->setItemLinkClass("xsmall");
                $this->current_selection_list->setLinksMode("il_ContainerItemCommand2");
                $this->current_selection_list->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
                $this->current_selection_list->setUseImages(false);
                $this->current_selection_list->setAdditionalToggleElement($this->getUniqueItemId(true), "ilContainerListItemOuterHighlight");

                include_once 'Services/Payment/classes/class.ilPaymentObject.php';
                
                $this->ctrl->setParameterByClass($this->gui_class_name, "ref_id", $this->ref_id);

                // only standard command?
                $only_default = false;
                if ($a_use_asynch && !$a_get_asynch_commands)
                {
                        $only_default = true;
                }

                $this->default_command = false;
                $this->prevent_duplicate_commands = array();
                
                // we only allow the following commands inside the header actions
                $valid_header_commands = array("mount_webfolder");

                $commands = $this->getCommands($this->ref_id, $this->obj_id);           
                foreach($commands as $command)
                {
                        if($a_header_actions && !in_array($command["cmd"], $valid_header_commands))
                        {
                                continue;
                        }
                        
                        if ($command["granted"] == true )
                        {
                                if (!$command["default"] === true)
                                {
                                        if (!$this->std_cmd_only && !$only_default)
                                        {
                                                // workaround for repository frameset
                                                $command["link"] = 
                                                        $this->appendRepositoryFrameParameter($command["link"]);

                                                // standard edit icon
                                                if ($command["lang_var"] == "edit" && $command["img"] == "")
                                                {
                                                        $command["img"] = ilUtil::getImagePath("cmd_edit_s.png");
                                                }

                                                $cmd_link = $command["link"];
                                                $txt = ($command["lang_var"] == "")
                                                        ? $command["txt"]
                                                        : $this->lng->txt($command["lang_var"]);
                                                $this->insertCommand($cmd_link, $txt,
                                                        $command["frame"], $command["img"], $command["cmd"]);
                                        }
                                }
                                else
                                {
                                        $this->default_command = $this->createDefaultCommand($command);
                                        //$this->default_command = $command;
                                }
                        }
                        elseif($command["default"] === true)
                        {
                                $items =& $command["access_info"];
                                foreach ($items as $item)
                                {
                                        if ($item["type"] == IL_NO_LICENSE)
                                        {
                                                $this->addCustomProperty($this->lng->txt("license"),$item["text"],true);
                                                $this->enableProperties(true);
                                                break;
                                        }
                                }
                        }
                }               

                if (!$only_default)
                {
                        // custom commands
                        if (is_array($this->cust_commands))
                        {
                                foreach ($this->cust_commands as $command)
                                {
                                        $this->insertCommand($command["link"], $this->lng->txt($command["lang_var"]),
                                                $command["frame"], "", $command["cmd"], $command["onclick"]);
                                }
                        }

                        // info screen commmand
                        if ($this->getInfoScreenStatus())
                        {
                                $this->insertInfoScreenCommand();
                        }

                        if (!$this->isMode(IL_LIST_AS_TRIGGER))
                        {
                                // edit timings
                                if($this->timings_enabled)
                                {
                                        $this->insertTimingsCommand();
                                }
                                
                                // delete
                                if ($this->delete_enabled)
                                {
                                        $this->insertDeleteCommand();
                                }

                                // link
                                if ($this->link_enabled)
                                {
                                        $this->insertLinkCommand();
                                }

                                // cut
                                if ($this->cut_enabled)
                                {
                                        $this->insertCutCommand();
                                }

                                // copy
                                if ($this->copy_enabled)
                                {
                                        $this->insertCopyCommand();
                                }

                                // cut/copy from workspace to repository
                                if ($this->repository_transfer_enabled)
                                {
                                        $this->insertCutCommand(true);
                                        $this->insertCopyCommand(true);
                                }

                                // subscribe
                                if ($this->subscribe_enabled)
                                {
                                        $this->insertSubscribeCommand();
                                }

                                // multi download
                                if ($this->multi_download_enabled && $a_header_actions)
                                {
                                        $this->insertMultiDownloadCommand();
                                }

                                // BEGIN PATCH Lucene search
                                if($this->cut_enabled or $this->link_enabled)
                                {
                                        $this->insertPasteCommand();
                                }
                                // END PATCH Lucene Search

                                if(IS_PAYMENT_ENABLED)
                                {
                                        $this->insertPayment();
                                }
                        }
                }
                
                // common social commands (comment, notes, tags)
                if (!$only_default && !$this->isMode(IL_LIST_AS_TRIGGER))
                {
                        $this->insertCommonSocialCommands($a_header_actions);
                }
                
                if(!$a_header_actions)
                {
                        $this->ctrl->clearParametersByClass($this->gui_class_name);
                }

                // fix bug #12417
                // there is one case, where no action menu should be displayed:
                // public area, category, no info tab
                // todo: make this faster and remove type specific implementation if possible
                if ($a_use_asynch && !$a_get_asynch_commands && !$a_header_actions)
                {
                        if ($ilUser->getId() == ANONYMOUS_USER_ID && $this->type == "cat")
                        {
                                include_once("./Services/Container/classes/class.ilContainer.php");
                                include_once("./Services/Object/classes/class.ilObjectServiceSettingsGUI.php");
                                if (!ilContainer::_lookupContainerSetting(
                                        $this->obj_id,
                                        ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                                        true))
                                {
                                        return;
                                }
                        }
                }

                if ($a_use_asynch && $a_get_asynch_commands)
                {
                        return $this->current_selection_list->getHTML(true);
                }
                
                return $this->current_selection_list->getHTML();                
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertCommonSocialCommands()

ilObjectListGUI::insertCommonSocialCommands

(

$a_header_actions = false

)

Insert common social commands (comments, notes, tagging)

Parameters

Definition at line 2516 of file class.ilObjectListGUI.php.

References $comments_enabled, $ilSetting, $ilUser, $lng, $ref_id, $reference_ref_id, $tpl, getCommandFrame(), getCommandLink(), ilNoteGUI\getListCommentsJSCall(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), insertCommand(), and isCommentsActivated().

Referenced by insertCommands().

        {
                global $ilSetting, $lng, $ilUser, $tpl;
                
                if ($this->std_cmd_only ||
                        ($ilUser->getId() == ANONYMOUS_USER_ID))
                {
                        return;
                }
                $lng->loadLanguageModule("notes");
                $lng->loadLanguageModule("tagging");
                $cmd_link = $this->getCommandLink("infoScreen")."#notes_top";
                $cmd_tag_link = $this->getCommandLink("infoScreen");
                $cmd_frame = $this->getCommandFrame("infoScreen");
                include_once("./Services/Notes/classes/class.ilNoteGUI.php");
                
                // reference objects have translated ids, revert to originals
                $note_ref_id = $this->ref_id;
                if($this->reference_ref_id)
                {
                        $note_ref_id = $this->reference_ref_id;
                }
                
                $js_updater = $a_header_actions
                        ? "il.Object.redrawActionHeader();"
                        : "il.Object.redrawListItem(".$note_ref_id.")";
                
                $comments_enabled = $this->isCommentsActivated($this->type, $this->ref_id, $this->obj_id, $a_header_actions, true);
                if($comments_enabled)
                {                       
                        $this->insertCommand("#", $this->lng->txt("notes_comments"), $cmd_frame,
                                "", "", ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $js_updater));
                }

                if($this->notes_enabled)
                {
                        $this->insertCommand("#", $this->lng->txt("notes"), $cmd_frame,
                                "", "", ilNoteGUI::getListNotesJSCall($this->ajax_hash, $js_updater));
                }
                
                if ($this->tags_enabled)
                {
                        include_once("./Services/Tagging/classes/class.ilTaggingGUI.php");
                        //$this->insertCommand($cmd_tag_link, $this->lng->txt("tagging_set_tag"), $cmd_frame);
                        $this->insertCommand("#", $this->lng->txt("tagging_set_tag"), $cmd_frame,
                                "", "", ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $js_updater));
                }               
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertCopyCommand()

ilObjectListGUI::insertCopyCommand

(

$a_to_repository = false

)

Insert copy command.

Parameters

bool

$a_to_repository

Definition at line 2344 of file class.ilObjectListGUI.php.

References checkCommandAccess(), getCommandId(), and insertCommand().

Referenced by insertCommands().

        {
                if($this->std_cmd_only)
                {
                        return;
                }
                
                if($this->checkCommandAccess('copy', 'copy', $this->ref_id, $this->type))
                {
                        if($this->context != self::CONTEXT_WORKSPACE && $this->context != self::CONTEXT_WORKSPACE_SHARING)
                        {
                                $this->ctrl->setParameterByClass('ilobjectcopygui','source_id',$this->getCommandId());
                                $cmd_copy = $this->ctrl->getLinkTargetByClass('ilobjectcopygui','initTargetSelection');
                                $this->insertCommand($cmd_copy, $this->lng->txt('copy'));
                        }
                        else
                        {
                                $this->ctrl->setParameter($this->container_obj, "ref_id",
                                        $this->container_obj->object->getRefId());                                                                      
                                $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
                                
                                if(!$a_to_repository)
                                {
                                        $cmd_copy = $this->ctrl->getLinkTarget($this->container_obj, 'copy');
                                        $this->insertCommand($cmd_copy, $this->lng->txt('copy'));
                                }
                                else
                                {
                                        $cmd_copy = $this->ctrl->getLinkTarget($this->container_obj, 'copy_to_repository');
                                        $this->insertCommand($cmd_copy, $this->lng->txt('wsp_copy_to_repository'));                     
                                }
                        }
                                
                        $this->adm_commands_included = true;                    
                }
                return;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertCutCommand()

ilObjectListGUI::insertCutCommand

(

$a_to_repository = false

)

insert cut command

protected

Parameters

bool

$a_to_repository

Definition at line 2289 of file class.ilObjectListGUI.php.

References checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

        {
                global $ilAccess;
                
                if ($this->std_cmd_only)
                {
                        return;
                }
                // BEGIN PATCH Lucene search
                if(is_object($this->getContainerObject()) and 
                        $this->getContainerObject() instanceof ilAdministrationCommandHandling)
                {
                        if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
                        {
                                $this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
                                $cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "cut");
                                $this->insertCommand($cmd_link, $this->lng->txt("move"));
                                $this->adm_commands_included = true;
                                return true;
                        }
                        return false;
                }
                // END PATCH Lucene Search

                // if the permission is changed here, it  has
                // also to be changed in ilContainerContentGUI, determineAdminCommands
                if($this->checkCommandAccess('delete','',$this->ref_id,$this->type) &&
                        $this->container_obj->object)
                {                                               
                        $this->ctrl->setParameter($this->container_obj, "ref_id",
                                $this->container_obj->object->getRefId());                                                                      
                        $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
                        
                        if(!$a_to_repository)
                        {
                                $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "cut");
                                $this->insertCommand($cmd_link, $this->lng->txt("move"), "",
                                        ilUtil::getImagePath("cmd_move_s.png"));
                        }
                        else
                        {
                                $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "cut_for_repository");
                                $this->insertCommand($cmd_link, $this->lng->txt("wsp_move_to_repository"), "",
                                        ilUtil::getImagePath("cmd_move_s.png"));
                        }
                        
                        $this->adm_commands_included = true;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertDeleteCommand()

ilObjectListGUI::insertDeleteCommand

(

)

insert cut command

private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

Definition at line 2201 of file class.ilObjectListGUI.php.

References checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

        {
                if ($this->std_cmd_only)
                {
                        return;
                }

                if(is_object($this->getContainerObject()) and 
                        $this->getContainerObject() instanceof ilAdministrationCommandHandling)
                {
                        if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
                        {
                                $this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
                                $cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "delete");
                                $this->insertCommand($cmd_link, $this->lng->txt("delete"));
                                $this->adm_commands_included = true;
                                return true;
                        }
                        return false;
                }
                
                if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
                {
                        $this->ctrl->setParameter($this->container_obj, "ref_id",
                                $this->container_obj->object->getRefId());
                        $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
                        $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "delete");
                        $this->insertCommand($cmd_link, $this->lng->txt("delete"), "",
                                ilUtil::getImagePath("cmd_delete_s.png"));
                        $this->adm_commands_included = true;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertDescription()

ilObjectListGUI::insertDescription

(

)

insert item description

private

Parameters

object	$a_tpl	template object
string	$a_desc	item description

Definition at line 1615 of file class.ilObjectListGUI.php.

References getDescription(), getSubstitutionStatus(), and insertSubstitutions().

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

        {
                if($this->getSubstitutionStatus())
                {
                        $this->insertSubstitutions();
                        if(!$this->substitutions->isDescriptionEnabled())
                        {
                                return true;
                        }
                }
                
                $this->tpl->setCurrentBlock("item_description");
                $this->tpl->setVariable("TXT_DESC", $this->getDescription());
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertFileUpload()

ilObjectListGUI::insertFileUpload

(

)

Inserts a file upload component.

Definition at line 3791 of file class.ilObjectListGUI.php.

References getUniqueItemId(), and ilFileUploadGUI\initFileUpload().

Referenced by getListItemHTML().

        {
                include_once("./Services/FileUpload/classes/class.ilFileUploadGUI.php");
                ilFileUploadGUI::initFileUpload();

                $upload = new ilFileUploadGUI($this->getUniqueItemId(true), $this->ref_id);                             
                
                $this->tpl->setCurrentBlock("fileupload");
                $this->tpl->setVariable("FILE_UPLOAD", $upload->getHTML());
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertIconsAndCheckboxes()

ilObjectListGUI::insertIconsAndCheckboxes

(

)

Insert icons and checkboxes.

Definition at line 3270 of file class.ilObjectListGUI.php.

References $lng, ilObject\_getIcon(), getCheckboxStatus(), getCommandId(), getCommandsStatus(), getDownloadCheckboxState(), getExpandStatus(), getIconImageType(), getIconStatus(), ilUtil\getImagePath(), isExpanded(), and ilPlugin\lookupTxt().

Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

        {
                global $lng, $objDefinition;
                
                $cnt = 0;
                if ($this->getCheckboxStatus())
                {
                        $this->tpl->setCurrentBlock("check");
                        $this->tpl->setVariable("VAL_ID", $this->getCommandId());
                        $this->tpl->parseCurrentBlock();
                        $cnt += 1;
                }
                else if ($this->getDownloadCheckboxState() != self::DOWNLOAD_CHECKBOX_NONE)
                {
                        $this->tpl->setCurrentBlock("check_download");
                        if ($this->getDownloadCheckboxState() == self::DOWNLOAD_CHECKBOX_ENABLED)
                                $this->tpl->setVariable("VAL_ID", $this->getCommandId());
                        else
                                $this->tpl->setVariable("VAL_VISIBILITY", "visibility: hidden;\" disabled=\"disabled");
                        $this->tpl->parseCurrentBlock();
                        $cnt += 1;
                }
                elseif($this->getExpandStatus())
                {
                        $this->tpl->setCurrentBlock('expand');
                        
                        if($this->isExpanded())
                        {
                                $this->ctrl->setParameter($this->container_obj,'expand',-1 * $this->obj_id);
                                $this->tpl->setVariable('EXP_HREF',$this->ctrl->getLinkTarget($this->container_obj,'',$this->getUniqueItemId(true)));
                                $this->ctrl->clearParameters($this->container_obj);                     
                                #$this->tpl->setVariable('EXP_IMG',ilUtil::getImagePath('browser/minus.png'));
                                $this->tpl->setVariable('EXP_IMG',ilUtil::getImagePath('tree_exp.png'));
                        $this->tpl->setVariable('EXP_ALT',$this->lng->txt('collapse'));
                        }
                        else
                        {
                                $this->ctrl->setParameter($this->container_obj,'expand',$this->obj_id);
                                $this->tpl->setVariable('EXP_HREF',$this->ctrl->getLinkTarget($this->container_obj,'',$this->getUniqueItemId(true)));
                                $this->ctrl->clearParameters($this->container_obj);
                                #$this->tpl->setVariable('EXP_IMG',ilUtil::getImagePath('browser/plus.png'));
                                $this->tpl->setVariable('EXP_IMG',ilUtil::getImagePath('tree_col.png'));
                                $this->tpl->setVariable('EXP_ALT',$this->lng->txt('expand'));
                        }
                        
                        $this->tpl->parseCurrentBlock();
                        $cnt += 1;
                }
                
                if ($this->getIconStatus())
                {
                        if ($cnt == 1)
                        {
                                $this->tpl->touchBlock("i_1");  // indent
                        }
                        
                        // icon link
                        if (!$this->default_command || (!$this->getCommandsStatus() && !$this->restrict_to_goto))
                        {
                        }
                        else
                        {
                                $this->tpl->setCurrentBlock("icon_link_s");

                                if ($this->default_command["frame"] != "")
                                {
                                        $this->tpl->setVariable("ICON_TAR", "target='".$this->default_command["frame"]."'");
                                }

                                $this->tpl->setVariable("ICON_HREF",
                                        $this->default_command["link"]);
                                $this->tpl->parseCurrentBlock();
                                $this->tpl->touchBlock("icon_link_e");
                        }

                        $this->tpl->setCurrentBlock("icon");
                        if (!$objDefinition->isPlugin($this->getIconImageType()))
                        {
                                $this->tpl->setVariable("ALT_ICON", $lng->txt("icon")." ".$lng->txt("obj_".$this->getIconImageType()));
                        }
                        else
                        {
                                include_once("Services/Component/classes/class.ilPlugin.php");
                                $this->tpl->setVariable("ALT_ICON", $lng->txt("icon")." ".
                                        ilPlugin::lookupTxt("rep_robj", $this->getIconImageType(), "obj_".$this->getIconImageType()));
                        }

                        $this->tpl->setVariable("SRC_ICON",
                                ilObject::_getIcon($this->obj_id, "small", $this->getIconImageType()));
                        $this->tpl->parseCurrentBlock();
                        $cnt += 1;
                }
                
                $this->tpl->touchBlock("d_".$cnt);      // indent main div
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertInfoScreenCommand()

ilObjectListGUI::insertInfoScreenCommand

(

)

insert info screen command

Definition at line 2498 of file class.ilObjectListGUI.php.

References getCommandFrame(), getCommandLink(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

        {
                if ($this->std_cmd_only)
                {
                        return;
                }
                $cmd_link = $this->getCommandLink("infoScreen");
                $cmd_frame = $this->getCommandFrame("infoScreen");
                $this->insertCommand($cmd_link, $this->lng->txt("info_short"), $cmd_frame,
                        ilUtil::getImagePath("cmd_info_s.png"));
        }               

Here is the call graph for this function:

Here is the caller graph for this function:

insertItemDetailLinks()

ilObjectListGUI::insertItemDetailLinks

(

)

insert item detail links

public

Parameters

Definition at line 734 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

        {
                if(!count($this->item_detail_links))
                {
                        return true;
                }
                if(strlen($this->item_detail_links_intro))
                {
                        $this->tpl->setCurrentBlock('item_detail_intro');
                        $this->tpl->setVariable('ITEM_DETAIL_INTRO_TXT',$this->item_detail_links_intro);
                        $this->tpl->parseCurrentBlock();                        
                }
                
                foreach($this->item_detail_links as $info)
                {
                        $this->tpl->setCurrentBlock('item_detail_link');
                        $this->tpl->setVariable('ITEM_DETAIL_LINK_TARGET',$info['target']);
                        $this->tpl->setVariable('ITEM_DETAIL_LINK_DESC',$info['desc']);
                        $this->tpl->setVariable('ITEM_DETAIL_LINK_HREF',$info['link']);
                        $this->tpl->setVariable('ITEM_DETAIL_LINK_NAME',$info['name']);
                        $this->tpl->parseCurrentBlock();                        
                }
                $this->tpl->setCurrentBlock('item_detail_links');
                $this->tpl->parseCurrentBlock();
        }

Here is the caller graph for this function:

insertLinkCommand()

ilObjectListGUI::insertLinkCommand

(

)

insert link command

private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

Definition at line 2241 of file class.ilObjectListGUI.php.

References ilObject\_lookupType(), checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

        {
                global $ilAccess;

                if ($this->std_cmd_only)
                {
                        return;
                }
                // BEGIN PATCH Lucene search
                
                if(is_object($this->getContainerObject()) and 
                        $this->getContainerObject() instanceof ilAdministrationCommandHandling)
                {
                        global $objDefinition;
        
                        if($this->checkCommandAccess('delete','',$this->ref_id,$this->type) and
                                $objDefinition->allowLink(ilObject::_lookupType($this->obj_id)))
                        {
                                $this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
                                $cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "link");
                                $this->insertCommand($cmd_link, $this->lng->txt("link"));
                                $this->adm_commands_included = true;
                                return true;
                        }
                        return false;           
                }
                // END PATCH Lucene Search

                // if the permission is changed here, it  has
                // also to be changed in ilContainerGUI, admin command check
                if($this->checkCommandAccess('delete','',$this->ref_id,$this->type))
                {
                        $this->ctrl->setParameter($this->container_obj, "ref_id",
                                $this->container_obj->object->getRefId());
                        $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
                        $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "link");
                        $this->insertCommand($cmd_link, $this->lng->txt("link"), "",
                                ilUtil::getImagePath("cmd_link_s.png"));
                        $this->adm_commands_included = true;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertMultiDownloadCommand()

ilObjectListGUI::insertMultiDownloadCommand

(

)

Definition at line 2903 of file class.ilObjectListGUI.php.

References $_GET, $cmd, ilObject\_lookupType(), getContainerObject(), and insertCommand().

Referenced by insertCommands().

        {
                global $ilAccess, $objDefinition;
                
                if ($this->std_cmd_only)
                        return;
                
                if(!$objDefinition->isContainer(ilObject::_lookupType($this->obj_id)))
                        return false;
                
                if(is_object($this->getContainerObject()) &&
                        $this->getContainerObject() instanceof ilContainerGUI)
                {
                        $this->ctrl->setParameter($this->getContainerObject(), "type", "");
                        $this->ctrl->setParameter($this->getContainerObject(), "item_ref_id", "");
                        $this->ctrl->setParameter($this->getContainerObject(), "active_node", "");
                        $cmd = $_GET["cmd"] == "enableMultiDownload" ? "render" : "enableMultiDownload";
                        $cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), $cmd);
                        $this->insertCommand($cmd_link, $this->lng->txt("download_multiple_objects"));
                        return true;
                }
                
                return false;                           
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertNoticeProperties()

ilObjectListGUI::insertNoticeProperties

(

)

Definition at line 1870 of file class.ilObjectListGUI.php.

References getNoticeProperties().

Referenced by getListItemHTML().

        {
                $this->getNoticeProperties();
                foreach($this->notice_prop as $property)
                {
                        $this->tpl->setCurrentBlock('notice_item');
                        $this->tpl->setVariable('NOTICE_ITEM_VALUE',$property['value']);
                        $this->tpl->parseCurrentBlock();
                }
                $this->tpl->setCurrentBlock('notice_property');
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertPasteCommand()

ilObjectListGUI::insertPasteCommand

(

)

Insert paste command.

Definition at line 2386 of file class.ilObjectListGUI.php.

References $_SESSION, ilObject\_lookupType(), getCommandId(), getContainerObject(), and insertCommand().

Referenced by insertCommands().

        {
                global $ilAccess, $objDefinition;
                
                if ($this->std_cmd_only)
                {
                        return;
                }
                
                if(!$objDefinition->isContainer(ilObject::_lookupType($this->obj_id)))
                {
                        return false;
                }
                
                if(is_object($this->getContainerObject()) and
                        $this->getContainerObject() instanceof ilAdministrationCommandHandling and
                        isset($_SESSION['clipboard']))
                {
                        $this->ctrl->setParameter($this->getContainerObject(),'item_ref_id',$this->getCommandId());
                        $cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), "paste");
                        $this->insertCommand($cmd_link, $this->lng->txt("paste"));
                        $this->adm_commands_included = true;
                        return true;
                }
                return false;                           
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertPath()

ilObjectListGUI::insertPath

(

)

insert path

Definition at line 3233 of file class.ilObjectListGUI.php.

References $lng, and getPathStatus().

Referenced by getListItemHTML().

        {
                global $tree, $lng;
                
                if($this->getPathStatus() != false)
                {
                        include_once 'Services/Tree/classes/class.ilPathGUI.php';
                        $path_gui = new ilPathGUI();
                        $path_gui->enableTextOnly(!$this->path_linked);
                        $path_gui->setUseImages(false);
                                
                        $this->tpl->setCurrentBlock("path_item");
                        $this->tpl->setVariable('PATH_ITEM',$path_gui->getPath(ROOT_FOLDER_ID,$this->ref_id));
                        $this->tpl->parseCurrentBlock();

                        $this->tpl->setCurrentBlock("path");
                        $this->tpl->setVariable("TXT_LOCATION", $lng->txt("locator"));
                        $this->tpl->parseCurrentBlock();
                        return true;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertPayment()

ilObjectListGUI::insertPayment

(

)

insert payment information

private

Definition at line 1889 of file class.ilObjectListGUI.php.

References $ilUser, $lng, ilPaymentBookings\_hasAccess(), ilPaymentObject\_hasExtensions(), ilPaymentBookings\_lookupOrder(), ilPaymentObject\_lookupPobjectId(), addCustomProperty(), ilDatePresentation\formatDate(), ilUtil\getImagePath(), IL_CAL_UNIX, and insertPaymentCommand().

Referenced by insertCommands().

        {
                global $ilAccess,$ilObjDataCache,$ilUser;

                if(IS_PAYMENT_ENABLED && $this->payment_enabled)
                {
                        include_once './Services/Payment/classes/class.ilPaymentObject.php';
                        include_once './Services/Payment/classes/class.ilPaymentBookings.php';

                        if(ilPaymentobject::_requiresPurchaseToAccess($this->ref_id))
                        {
                                if(ilPaymentBookings::_hasAccess(ilPaymentObject::_lookupPobjectId($a_ref_id), $ilUser->getId()))
                                {
                                        // get additional information about order_date and duration

                                        $order_infos = array();
                                        $order_infos = ilPaymentBookings::_lookupOrder(ilPaymentObject::_lookupPobjectId($this->ref_id));

                                        if(count($order_infos) > 0)
                                        {
                                                global $lng;
                                                $pay_lang = $lng;
                                                $pay_lang->loadLanguageModule('payment');
                                                $alert = true;
                                                $a_newline = true;
                                                $a_property = $pay_lang->txt('object_purchased_date');
                                                $a_value = ilDatePresentation::formatDate(new ilDateTime($order_infos["order_date"],IL_CAL_UNIX));

                                                $this->addCustomProperty($a_property, $a_value, $alert, $a_newline);

                                                $alert = true;
                                                $a_newline = true;
                                                $a_property = $this->lng->txt('object_duration');
                                                if($order_infos['duration'] == 0)
                                                        $a_value = $pay_lang->txt('unlimited_duration');
                                                else
                                                        $a_value = $order_infos['duration'] .' '.$this->lng->txt('months');
                                                $this->addCustomProperty($a_property, $a_value, $alert, $a_newline);
                                        }

                                        // check for extension prices
                                        if(ilPaymentObject::_hasExtensions($this->ref_id))
                                        {
                                                $has_extension_prices = true;
                                                $this->insertPaymentCommand($has_extension_prices);
                                        }

                                }
                                else
                                {
                                        // only relevant and needed for the shop content page

                                        $this->ctpl = new ilTemplate("tpl.container_list_item_commands.html", true, true,
                                                "Services/Container", "DEFAULT", false, true);
                                        $this->ctpl->setCurrentBlock('payment');
                                        $this->ctpl->setVariable('PAYMENT_TYPE_IMG', ilUtil::getImagePath('icon_pays.png'));
                                        $this->ctpl->setVariable('PAYMENT_ALT_IMG', $this->lng->txt('payment_system') . ': ' . $this->lng->txt('payment_buyable'));
                                        $this->ctpl->parseCurrentBlock();

                                        $this->insertPaymentCommand();
                                }
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertPaymentCommand()

ilObjectListGUI::insertPaymentCommand (   $has_extension_prices = false )

protected

Definition at line 1954 of file class.ilObjectListGUI.php.

References $type, createDefaultCommand(), and getCommands().

Referenced by insertPayment().

        {
                $commands = $this->getCommands($this->ref_id, $this->obj_id);
                foreach($commands as $command)
                { 
                        if($command['default'] === true)
                        {
                                $command = $this->createDefaultCommand($command);
//                              if(is_null($command['link']) )
//                              {
                                        switch($this->type)
                                        {
                                                case 'sahs':
                                                        $command['link'] = 'ilias.php?baseClass=ilSAHSPresentationGUI&ref_id='.$this->ref_id;
                                                        break;
                                                
                                                case 'lm':
                                                        $command['link'] = 'ilias.php?baseClass=ilLMPresentationGUI&ref_id='.$this->ref_id;
                                                        break;
                                                case 'exc':
                                                default:
                                                        $command['link'] = 'ilias.php?baseClass=ilShopController&cmdClass=ilshoppurchasegui&ref_id='.$this->ref_id;
                                                        break;  
                                        }                                       
//                              }

                                $type = $this->type;
                                if(strpos($command['link'], '_'.$type.'_') !== false)
                                {
                                        $demo_link = str_replace('_'.$type.'_', '_'.$type.'purchasetypedemo_', $command['link']);
                                        $buy_link = str_replace('_'.$type.'_', '_'.$type.'purchasetypebuy_', $command['link']);
                                }
                                else
                                {
                                        $demo_link = $command['link'].(strpos($command['link'], '?') === false ? '?' : '&').'purchasetype=demo';
                                        $buy_link = $command['link'].(strpos($command['link'], '?') === false ? '?' : '&').'purchasetype=buy';
                                }

                                $this->current_selection_list->addItem($this->lng->txt('payment_demo'), "", $demo_link, $a_img, $this->lng->txt('payment_demo'), $command['frame']);
                                if($has_extension_prices == true)
                                {
                                        $this->current_selection_list->addItem($this->lng->txt('buy_extension'), "", $buy_link, $a_img, $this->lng->txt('buy_extension'), $command['frame']);
                                }
                                else
                                        $this->current_selection_list->addItem($this->lng->txt('buy'), "", $buy_link, $a_img, $this->lng->txt('buy'), $command['frame']);

                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertPositionField()

ilObjectListGUI::insertPositionField

(

)

Insert field for positioning.

Definition at line 3382 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

        {
                if ($this->position_enabled)
                {
                        $this->tpl->setCurrentBlock("position");
                        $this->tpl->setVariable("POS_ID", $this->position_field_index);
                        $this->tpl->setVariable("POS_VAL", $this->position_value);
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the caller graph for this function:

insertPreconditions()

ilObjectListGUI::insertPreconditions

(

)

insert all missing preconditions

Definition at line 2114 of file class.ilObjectListGUI.php.

References $lng, ilConditionHandler\_getConditionsOfTarget(), ilObject\_lookupTitle(), getUniqueItemId(), parseConditions(), and ilUtil\sortArray().

Referenced by getListItemHTML().

        {
                global $ilAccess, $lng, $objDefinition,$tree;

                include_once("./Services/AccessControl/classes/class.ilConditionHandler.php");

                $missing_cond_exist = false;
                
                // do not show multi level conditions (messes up layout)
                if ($this->condition_depth > 0)
                {
                        return;
                }

                // Sort by title
                /*
                foreach(ilConditionHandler::_getConditionsOfTarget($this->ref_id, $this->obj_id) as $condition)
                {
                        $condition['title'] = ilObject::_lookupTitle($condition['trigger_obj_id']);
                }
                */

                $conditions = ilConditionHandler::_getConditionsOfTarget($this->ref_id, $this->obj_id);
                if(sizeof($conditions))
                {
                        for($i = 0; $i < count($conditions); $i++)
                        {
                                $conditions[$i]['title'] = ilObject::_lookupTitle($conditions[$i]['trigger_obj_id']);
                        }
                        $conditions = ilUtil::sortArray($conditions,'title','DESC');
                        
                        $div_id = $this->getUniqueItemId();

                        // Show obligatory and optional preconditions seperated
                        $all_done_obl = $this->parseConditions($div_id,$conditions,true);
                        $all_done_opt = $this->parseConditions($div_id,$conditions,false);
                        
                        if(!$all_done_obl || !$all_done_opt)
                        {
                                $this->tpl->setCurrentBlock("preconditions_toggle");
                                $this->tpl->setVariable("PRECONDITION_TOGGLE_INTRO", $this->lng->txt("precondition_toggle"));
                                $this->tpl->setVariable("PRECONDITION_TOGGLE_TRIGGER", $this->lng->txt("show"));
                                $this->tpl->setVariable("PRECONDITION_TOGGLE_ID", $div_id);
                                $this->tpl->setVariable("TXT_PRECONDITION_SHOW", $this->lng->txt("show"));
                                $this->tpl->setVariable("TXT_PRECONDITION_HIDE", $this->lng->txt("hide"));
                                $this->tpl->parseCurrentBlock();
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertProgressInfo()

ilObjectListGUI::insertProgressInfo

(

)

insert progress info

public

Returns

Definition at line 3261 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

        {
                return true;
        }

Here is the caller graph for this function:

insertProperties()

ilObjectListGUI::insertProperties

(

$a_item = ''

)

insert properties

private

Definition at line 1725 of file class.ilObjectListGUI.php.

References $ilUser, $lng, $obj_id, $ref_id, $reference_ref_id, getCustomProperties(), ilNoteGUI\getListCommentsJSCall(), ilLPStatus\getListGUIStatus(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), getProperties(), IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, and isCommentsActivated().

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

        {
                global $ilAccess, $lng, $ilUser;
                
                $props = $this->getProperties($a_item);
                $props = $this->getCustomProperties($props);
                
                if($this->context != self::CONTEXT_WORKSPACE && $this->context != self::CONTEXT_WORKSPACE_SHARING)
                {                                               
                        // add learning progress custom property                
                        include_once "Services/Tracking/classes/class.ilLPStatus.php";
                        $lp = ilLPStatus::getListGUIStatus($this->obj_id);
                        if($lp)
                        {                                                                               
                                $props[] = array("alert" => false,
                                        "property" => $lng->txt("learning_progress"),
                                        "value" => $lp,
                                        "newline" => true);     
                        }                       
                        
                        // add no item access note in public section
                        // for items that are visible but not readable
                        if ($this->ilias->account->getId() == ANONYMOUS_USER_ID)
                        {
                                if (!$ilAccess->checkAccess("read", "", $this->ref_id, $this->type, $this->obj_id))
                                {
                                        $props[] = array("alert" => true,
                                                "value" => $lng->txt("no_access_item_public"),
                                                "newline" => true);
                                }
                        }
                }
                
                // reference objects have translated ids, revert to originals
                $note_ref_id = $this->ref_id;
                $note_obj_id = $this->obj_id;
                if($this->reference_ref_id)
                {
                        $note_ref_id = $this->reference_ref_id;
                        $note_obj_id = $this->reference_obj_id;
                }
                
                $redraw_js = "il.Object.redrawListItem(".$note_ref_id.");";
                
                // add common properties (comments, notes, tags)
                if ((self::$cnt_notes[$note_obj_id][IL_NOTE_PRIVATE] > 0 ||
                        self::$cnt_notes[$note_obj_id][IL_NOTE_PUBLIC] > 0 || 
                        self::$cnt_tags[$note_obj_id] > 0) &&
                        ($ilUser->getId() != ANONYMOUS_USER_ID))
                {                       
                        include_once("./Services/Notes/classes/class.ilNoteGUI.php");
                        include_once("./Services/Tagging/classes/class.ilTaggingGUI.php");
                        
                        $nl = true;
                        if ($this->isCommentsActivated($this->type, $this->ref_id, $this->obj_id, false, false)
                                && self::$cnt_notes[$note_obj_id][IL_NOTE_PUBLIC] > 0)
                        {
                                $props[] = array("alert" => false,
                                        "property" => $lng->txt("notes_comments"),
                                        "value" => "<a href='#' onclick=\"return ".
                                                ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $redraw_js)."\">".
                                                self::$cnt_notes[$note_obj_id][IL_NOTE_PUBLIC]."</a>",
                                        "newline" => $nl);
                                $nl = false;
                        }

                        if ($this->notes_enabled && self::$cnt_notes[$note_obj_id][IL_NOTE_PRIVATE] > 0)
                        {
                                $props[] = array("alert" => false,
                                        "property" => $lng->txt("notes"),
                                        "value" => "<a href='#' onclick=\"return ".
                                                ilNoteGUI::getListNotesJSCall($this->ajax_hash, $redraw_js)."\">".
                                                self::$cnt_notes[$note_obj_id][IL_NOTE_PRIVATE]."</a>",
                                        "newline" => $nl);
                                $nl = false;
                        }
                        if ($this->tags_enabled && self::$cnt_tags[$note_obj_id] > 0)
                        {
                                $tags_set = new ilSetting("tags");
                                if ($tags_set->get("enable"))
                                {
                                        $props[] = array("alert" => false,
                                                "property" => $lng->txt("tagging_tags"),
                                                "value" => "<a href='#' onclick=\"return ".
                                                        ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $redraw_js)."\">".
                                                self::$cnt_tags[$note_obj_id]."</a>",
                                                "newline" => $nl);
                                        $nl = false;
                                }
                        }
                }
                
                $cnt = 1;
                if (is_array($props) && count($props) > 0)
                {
                        foreach($props as $prop)
                        {
                                // BEGIN WebDAV: Display a separator between properties.
                                if ($cnt > 1)
                                {
                                        $this->tpl->touchBlock("separator_prop");
                                }
                                // END WebDAV: Display a separator between properties.

                                if ($prop["alert"] == true)
                                {
                                        $this->tpl->touchBlock("alert_prop");
                                }
                                else
                                {
                                        $this->tpl->touchBlock("std_prop");
                                }
                                if ($prop["newline"] == true && $cnt > 1)
                                {
                                        $this->tpl->touchBlock("newline_prop");
                                }
                                //BEGIN WebDAV: Support hidden property names.
                                if (isset($prop["property"]) && $prop['propertyNameVisible'] !== false)
                                //END WebDAV: Support hidden property names.
                                {
                                        $this->tpl->setCurrentBlock("prop_name");
                                        $this->tpl->setVariable("TXT_PROP", $prop["property"]);
                                        $this->tpl->parseCurrentBlock();
                                }
                                $this->tpl->setCurrentBlock("item_property");
                                //BEGIN WebDAV: Support links in property values.
                                if ($prop['link'])
                                {
                                        $this->tpl->setVariable("LINK_PROP", $prop['link']);
                                        $this->tpl->setVariable("LINK_VAL_PROP", $prop["value"]);
                                }
                                else
                                {
                                        $this->tpl->setVariable("VAL_PROP", $prop["value"]);
                                }
                                //END WebDAV: Support links in property values.
                                $this->tpl->parseCurrentBlock();

                                $cnt++;
                        }
                        $this->tpl->setCurrentBlock("item_properties");
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertRelevance()

ilObjectListGUI::insertRelevance

(

)

insert relevance

Parameters

Definition at line 1650 of file class.ilObjectListGUI.php.

References $lng, enabledRelevance(), ilUtil\getImagePath(), and getRelevance().

Referenced by getListItemHTML().

        {
                global $lng;
                
                if(!$this->enabledRelevance() or !(int) $this->getRelevance())
                {
                        return false;
                }
                
                $width1 = (int) $this->getRelevance();
                $width2 = (int) (100 - $width1);
                
                $this->tpl->setCurrentBlock('relevance');
                #$this->tpl->setVariable('TXT_RELEVANCE',$lng->txt('search_relevance'));
                $this->tpl->setVariable('VAL_REL',sprintf("%.02f %%",$this->getRelevance()));
                $this->tpl->setVariable('WIDTH_A',$width1);
                $this->tpl->setVariable('WIDTH_B',$width2);
                $this->tpl->setVariable('IMG_A',ilUtil::getImagePath("relevance_blue.png"));
                $this->tpl->setVariable('IMG_B',ilUtil::getImagePath("relevance_dark.png"));
                $this->tpl->parseCurrentBlock();
                
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertSearchFragment()

ilObjectListGUI::insertSearchFragment

(

)

Insert highlighted search fragment.

Returns

Definition at line 1635 of file class.ilObjectListGUI.php.

References getSearchFragment().

Referenced by getListItemHTML().

        {
                if(strlen($this->getSearchFragment()))
                {
                        $this->tpl->setCurrentBlock('search_fragment');
                        $this->tpl->setVariable('TXT_SEARCH_FRAGMENT',$this->getSearchFragment().' ...');
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertSubItems()

ilObjectListGUI::insertSubItems

(

)

Insert subitems.

Definition at line 3369 of file class.ilObjectListGUI.php.

Referenced by ilCourseObjectiveListGUI\getListItemHTML(), and getListItemHTML().

        {
                foreach ($this->sub_item_html as $sub_html)
                {
                        $this->tpl->setCurrentBlock("subitem");
                        $this->tpl->setVariable("SUBITEM", $sub_html);
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the caller graph for this function:

insertSubscribeCommand()

ilObjectListGUI::insertSubscribeCommand

(

)

insert subscribe command

private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

Definition at line 2420 of file class.ilObjectListGUI.php.

References $ilSetting, $ilUser, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), checkCommandAccess(), getCommandId(), getContainerObject(), ilUtil\getImagePath(), and insertCommand().

Referenced by insertCommands().

        {
                global $ilSetting, $ilUser;

                if ($this->std_cmd_only)
                {
                        return;
                }
                
                if((int)$ilSetting->get('disable_my_offers'))
                {
                        return;
                }
                
                $type = ilObject::_lookupType(ilObject::_lookupObjId($this->getCommandId()));

                if ($ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        // BEGIN WebDAV: Lock/Unlock objects
                        /* This code section is temporarily commented out. 
                           I will reactivate it at a later point, when I get the
               the backend working properly. - Werner Randelshofer 2008-04-17
                        if (is_object($this->container_obj) && $this->rbacsystem->checkAccess("write", $this->ref_id))
                        {
                                require_once 'Services/WebDAV/classes/class.ilDAVServer.php';
                                if (ilDAVServer::_isActive() && ilDAVServer::_isActionsVisible())
                                {
                                        $this->ctrl->setParameter($this->container_obj, "ref_id",
                                                $this->container_obj->object->getRefId());
                                        $this->ctrl->setParameter($this->container_obj, "type", $this->type);
                                        $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->ref_id);
                                        $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "lock");
                                        $this->insertCommand($cmd_link, $this->lng->txt("lock"));

                                        $this->ctrl->setParameter($this->container_obj, "ref_id",
                                                $this->container_obj->object->getRefId());
                                        $this->ctrl->setParameter($this->container_obj, "type", $this->type);
                                        $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->ref_id);
                                        $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "unlock");
                                        $this->insertCommand($cmd_link, $this->lng->txt("unlock"));
                                }
                        }
                        */
                        // END WebDAV: Lock/Unlock objects

                        if (!$ilUser->isDesktopItem($this->getCommandId(), $type))
                        {
                                // Pass type and object ID to ilAccess to improve performance
                            global $ilAccess;
                        if ($this->checkCommandAccess("read", "", $this->ref_id, $this->type, $this->obj_id))
                                {
                                        if($this->getContainerObject() instanceof ilDesktopItemHandling)
                                        {
                                                $this->ctrl->setParameter($this->container_obj, "type", $type);
                                                $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
                                                $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "addToDesk");
                                                $this->insertCommand($cmd_link, $this->lng->txt("to_desktop"), "",
                                                        ilUtil::getImagePath("cmd_pd_put_s.png"));
                                        }                                       
                                }
                        }
                        else
                        {
                                if ($this->getContainerObject() instanceof ilDesktopItemHandling)
                                {
                                        $this->ctrl->setParameter($this->container_obj, "type", $type);
                                        $this->ctrl->setParameter($this->container_obj, "item_ref_id", $this->getCommandId());
                                        $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "removeFromDesk");
                                        $this->insertCommand($cmd_link, $this->lng->txt("unsubscribe"), "",
                                                ilUtil::getImagePath("cmd_pd_rem_s.png"));
                                }
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertSubstitutions()

ilObjectListGUI::insertSubstitutions

(

)

Insert substitutions.

public

Definition at line 1575 of file class.ilObjectListGUI.php.

References $data.

Referenced by insertDescription().

        {
                $fields_shown = false;
                foreach($this->substitutions->getParsedSubstitutions($this->ref_id,$this->obj_id) as $data)
                {
                        if($data['bold'])
                        {
                                $data['name'] = '<strong>'.$data['name'].'</strong>';
                                $data['value'] = '<strong>'.$data['value'].'</strong>';
                        }
                        $this->tpl->touchBlock("std_prop");
                        $this->tpl->setCurrentBlock('item_property');
                        if($data['show_field'])
                        {
                                $this->tpl->setVariable('TXT_PROP',$data['name']);
                        }
                        $this->tpl->setVariable('VAL_PROP',$data['value']);
                        $this->tpl->parseCurrentBlock();

                        if($data['newline'])
                        {
                                $this->tpl->touchBlock('newline_prop');
                        }
                        $fields_shown = false;
                        
                }
                if($fields_shown)
                {
                        $this->tpl->touchBlock('newline_prop');
                }
        }

Here is the caller graph for this function:

insertTimingsCommand()

ilObjectListGUI::insertTimingsCommand

(

)

insert edit timings command

protected

Definition at line 2570 of file class.ilObjectListGUI.php.

References $parent_ref_id, checkCommandAccess(), and insertCommand().

Referenced by insertCommands().

        {               
                if ($this->std_cmd_only || !$this->container_obj->object)
                {
                        return;
                }
                
                $parent_ref_id = $this->container_obj->object->getRefId();
                $parent_type = $this->container_obj->object->getType();
                
                if($this->checkCommandAccess('write','',$parent_ref_id,$parent_type) ||
                        $this->checkCommandAccess('write','',$this->ref_id,$this->type))
                {                                                                                               
                        $this->ctrl->setParameterByClass('ilobjectactivationgui','cadh',
                                $this->ajax_hash);      
                        $this->ctrl->setParameterByClass('ilobjectactivationgui','parent_id',
                                $parent_ref_id);                                                                                        
                        $cmd_lnk = $this->ctrl->getLinkTargetByClass(array($this->gui_class_name, 'ilcommonactiondispatchergui', 'ilobjectactivationgui'),
                                'edit');
                        
                        $this->insertCommand($cmd_lnk, $this->lng->txt('obj_activation_list_gui'));                     
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

insertTitle()

ilObjectListGUI::insertTitle

(

)

insert item title

private

Parameters

object	$a_tpl	template object
string	$a_title	item title

Definition at line 1464 of file class.ilObjectListGUI.php.

References $preview, appendRepositoryFrameParameter(), buildGotoLink(), ilPreviewGUI\CONTEXT_REPOSITORY, ilPreviewGUI\CONTEXT_WORKSPACE, getCommandsStatus(), ilUtil\getImagePath(), getTitle(), ilPreview\hasPreview(), ilPreview\lookupRenderStatus(), modifySAHSlaunch(), and ilPreview\RENDER_STATUS_NONE.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), and getListItemHTML().

        {
                if($this->restrict_to_goto)
                {                       
                        $this->default_command = array("frame" => "",
                                "link" => $this->buildGotoLink());
                }
                
                if (!$this->default_command || (!$this->getCommandsStatus() && !$this->restrict_to_goto))
                {               
                        $this->tpl->setCurrentBlock("item_title");
                        $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
                        $this->tpl->parseCurrentBlock();
                }
                else
                {
                        $this->default_command["link"] = 
                                $this->modifySAHSlaunch($this->default_command["link"],$this->default_command["frame"]);

                        if ($this->default_command["frame"] != "")
                        {
                                        $this->tpl->setCurrentBlock("title_linked_frame");
                                        $this->tpl->setVariable("TARGET_TITLE_LINKED", $this->default_command["frame"]);
                                        $this->tpl->parseCurrentBlock();
                        }
                                
                        // workaround for repository frameset
                        #var_dump("<pre>",$this->default_command['link'],"</pre>");
                        $this->default_command["link"] = 
                                $this->appendRepositoryFrameParameter($this->default_command["link"]);

                        #var_dump("<pre>",$this->default_command['link'],"</pre>");
                        

                        // the default command is linked with the title
                        $this->tpl->setCurrentBlock("item_title_linked");
                        $this->tpl->setVariable("TXT_TITLE_LINKED", $this->getTitle());
                        $this->tpl->setVariable("HREF_TITLE_LINKED", $this->default_command["link"]);
                        
                        // has preview?
                        include_once("./Services/Preview/classes/class.ilPreview.php");
                        if (ilPreview::hasPreview($this->obj_id, $this->type))
                        {
                                include_once("./Services/Preview/classes/class.ilPreviewGUI.php");
                                
                                // get context for access checks later on
                                $access_handler = null;
                                $context;
                                switch ($this->context)
                                {
                                        case self::CONTEXT_WORKSPACE:
                                        case self::CONTEXT_WORKSPACE_SHARING:
                                                $context = ilPreviewGUI::CONTEXT_WORKSPACE;
                                                include_once("./Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php");
                                                $access_handler = new ilWorkspaceAccessHandler();
                                                break;  
                                        
                                        default:
                                                global $ilAccess;
                                                $context = ilPreviewGUI::CONTEXT_REPOSITORY;
                                                $access_handler = $ilAccess;
                                                break;  
                                }
                                
                                $preview = new ilPreviewGUI($this->ref_id, $context, $this->obj_id, $access_handler);
                                $preview_status = ilPreview::lookupRenderStatus($this->obj_id);
                                $preview_status_class = "";
                                $preview_text_topic = "preview_show";
                                if ($preview_status == ilPreview::RENDER_STATUS_NONE)
                                {
                                        $preview_status_class = "ilPreviewStatusNone";
                                        $preview_text_topic = "preview_none";
                                }
                                $this->tpl->setCurrentBlock("item_title_linked");
                                $this->tpl->setVariable("PREVIEW_STATUS_CLASS", $preview_status_class);
                                $this->tpl->setVariable("SRC_PREVIEW_ICON", ilUtil::getImagePath("preview.png", "Services/Preview"));
                                $this->tpl->setVariable("TXT_PREVIEW", $this->lng->txt($preview_text_topic));
                                $this->tpl->setVariable("SCRIPT_PREVIEW_CLICK", $preview->getJSCall($this->getUniqueItemId(true)));
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        $this->tpl->parseCurrentBlock();
                }
                
                if ($this->bold_title == true)
                {
                        $this->tpl->touchBlock('bold_title_start');
                        $this->tpl->touchBlock('bold_title_end');
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isCommentsActivated()

ilObjectListGUI::isCommentsActivated (   $a_type,   $a_ref_id,   $a_obj_id,   $a_header_actions,   $a_check_write_access = true  )

protected

Check comments status against comments settings and context.

Parameters

string	$a_type
int	$a_ref_id
int	$a_obj_id
bool	$a_header_actions
bool	$a_check_write_access

Returns

bool

Definition at line 3731 of file class.ilObjectListGUI.php.

References checkCommandAccess(), and ilNote\commentsActivated().

Referenced by getHeaderAction(), insertCommonSocialCommands(), and insertProperties().

        {
                if($this->comments_enabled)
                {
                        if(!$this->comments_settings_enabled)
                        {
                                return true;
                        }
                        if($a_check_write_access && $this->checkCommandAccess('write','', $a_ref_id, $a_type))
                        {
                                return true;
                        }                                               
                        // fallback to single object check if no preloaded data
                        // only the repository does preloadCommonProperties() yet
                        if(!$a_header_actions && self::$preload_done)
                        {
                                if(self::$comments_activation[$a_obj_id][$a_type])
                                {
                                        return true;
                                }
                        }                       
                        else
                        {       
                                include_once("./Services/Notes/classes/class.ilNote.php");
                                if(ilNote::commentsActivated($a_obj_id, 0, $a_type))
                                {
                                        return true;
                                }
                        }
                }
                return false;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isExpanded()

ilObjectListGUI::isExpanded

(

)

Definition at line 422 of file class.ilObjectListGUI.php.

References $is_expanded.

Referenced by insertIconsAndCheckboxes().

        {
                return $this->is_expanded;
        }

Here is the caller graph for this function:

isFileUploadAllowed()

ilObjectListGUI::isFileUploadAllowed

(

)

Gets a value indicating whether file uploads to this object are allowed or not.

Returns

bool true, if file upload is allowed; otherwise, false.

Definition at line 3781 of file class.ilObjectListGUI.php.

References ilFileUploadUtil\isUploadAllowed().

Referenced by getListItemHTML().

        {
                // check if file upload allowed
                include_once("./Services/FileUpload/classes/class.ilFileUploadUtil.php");
                return ilFileUploadUtil::isUploadAllowed($this->ref_id, $this->type);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isMode()

ilObjectListGUI::isMode

(

$a_mode

)

check current output mode

Parameters

string

$a_mode

(IL_LIST_FULL | IL_LIST_AS_TRIGGER)

Returns

boolen true if current mode is $a_mode

Definition at line 1708 of file class.ilObjectListGUI.php.

Referenced by ilObjiLincClassroomListGUI\getListItemHTML(), getListItemHTML(), and insertCommands().

        {
                if ($a_mode == $this->mode)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Here is the caller graph for this function:

isSideBlock()

ilObjectListGUI::isSideBlock

(

)

Returns whether current item is a block in a side column or not.

Definition at line 3668 of file class.ilObjectListGUI.php.

        {
                return false;
        }

isTitleBold()

ilObjectListGUI::isTitleBold

(

)

public

Returns

boolean returns if the item title is bold or not

Definition at line 3689 of file class.ilObjectListGUI.php.

References $bold_title.

        {
                return $this->bold_title;
        }

isVisibleOnlyForced()

ilObjectListGUI::isVisibleOnlyForced

(

)

Force unreadable.

Returns

type

Definition at line 1343 of file class.ilObjectListGUI.php.

References $force_visible_only.

Referenced by checkCommandAccess().

        {
                return $this->force_visible_only;
        }

Here is the caller graph for this function:

modifySAHSlaunch()

ilObjectListGUI::modifySAHSlaunch	(		$a_link,
			$wtarget
	)

workaround: SAHS in new javavasript-created window or iframe

Definition at line 3212 of file class.ilObjectListGUI.php.

References ilBrowser\isMobile().

Referenced by insertTitle().

        {
                if (strstr($a_link, 'ilSAHSPresentationGUI') && !$this->offline_mode)
                {
                        include_once 'Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php';
                        $sahs_obj = new ilObjSAHSLearningModule($this->ref_id);
                        $om = $sahs_obj->getOpenMode();
                        $width = $sahs_obj->getWidth();
                        $height = $sahs_obj->getHeight();
                        if ($om != 0 && !ilBrowser::isMobile())
                        {
                                $this->default_command["frame"]="";
                                $a_link = "javascript:void(0); onclick=startSAHS('".$a_link."','".$wtarget."',".$om.",".$width.",".$height.");";
                        }
                }
                return $a_link;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

parseConditions()

ilObjectListGUI::parseConditions (   $toggle_id,   $conditions,   $obligatory = true  )

protected

Definition at line 2004 of file class.ilObjectListGUI.php.

References $lng, $location, $ok, ilConditionHandler\_checkCondition(), ilObject\_lookupTitle(), ilConditionHandler\calculateRequiredTriggers(), ilMemberViewSettings\getInstance(), ilConditionHandler\getOptionalConditionsOfTarget(), getUniqueItemId(), and IL_LIST_AS_TRIGGER.

Referenced by insertPreconditions().

        {
                global $ilAccess, $lng, $objDefinition,$tree;
                
                $num_required = ilConditionHandler::calculateRequiredTriggers($this->ref_id, $this->obj_id);
                $num_optional_required =
                        $num_required - count($conditions) + count(ilConditionHandler::getOptionalConditionsOfTarget($this->ref_id, $this->obj_id));

                // Check if all conditions are fullfilled
                $visible_conditions = array();
                $passed_optional = 0;
                foreach($conditions as $condition)
                {
                        if($obligatory and !$condition['obligatory'])
                        {
                                continue;
                        }
                        if(!$obligatory and $condition['obligatory'])
                        {
                                continue;
                        }

                        if($tree->isDeleted($condition['trigger_ref_id']))
                        {
                                continue;
                        }

                        include_once 'Services/Container/classes/class.ilMemberViewSettings.php';
                        $ok = ilConditionHandler::_checkCondition($condition['id']) and
                                !ilMemberViewSettings::getInstance()->isActive();

                        if(!$ok)
                        {
                                $visible_conditions[] = $condition['id'];
                        }

                        if(!$obligatory and $ok)
                        {
                                ++$passed_optional;
                                // optional passed
                                if($passed_optional >= $num_optional_required)
                                {
                                        return true;
                                }
                        }
                }

                foreach($conditions as $condition)
                {
                        if(!in_array($condition['id'], $visible_conditions))
                        {
                                continue;
                        }

                        $cond_txt = $lng->txt("condition_".$condition["operator"])." ".
                                $condition["value"];

                        // display trigger item
                        $class = $objDefinition->getClassName($condition["trigger_type"]);
                        $location = $objDefinition->getLocation($condition["trigger_type"]);
                        if ($class == "" && $location == "")
                        {
                                continue;
                        }
                        $missing_cond_exist = true;

                        $full_class = "ilObj".$class."ListGUI";
                        include_once($location."/class.".$full_class.".php");
                        $item_list_gui = new $full_class($this);
                        $item_list_gui->setMode(IL_LIST_AS_TRIGGER);
                        $item_list_gui->enablePath(false);
                        $item_list_gui->enableIcon(true);
                        $item_list_gui->setConditionDepth($this->condition_depth + 1);
                        $item_list_gui->setParentRefId($this->getUniqueItemId()); // yes we can
                        $item_list_gui->addCustomProperty($this->lng->txt("precondition_required_itemlist"), $cond_txt, false, true);
                        $trigger_html = $item_list_gui->getListItemHTML($condition['trigger_ref_id'],
                                $condition['trigger_obj_id'], ilObject::_lookupTitle($condition["trigger_obj_id"]),
                                 "");
                        $this->tpl->setCurrentBlock("precondition");
                        if ($trigger_html == "")
                        {
                                $trigger_html = $this->lng->txt("precondition_not_accessible");
                        }
                        $this->tpl->setVariable("TXT_CONDITION", trim($cond_txt));
                        $this->tpl->setVariable("TRIGGER_ITEM", $trigger_html);
                        $this->tpl->parseCurrentBlock();
                }
                
                if ($missing_cond_exist and $obligatory)
                {
                        $this->tpl->setCurrentBlock("preconditions");
                        $this->tpl->setVariable("CONDITION_TOGGLE_ID", "_obl_".$toggle_id);
                        $this->tpl->setVariable("TXT_PRECONDITIONS", $lng->txt("preconditions_obligatory_hint"));
                        $this->tpl->parseCurrentBlock();
                        
                }
                elseif($missing_cond_exist and !$obligatory)
                {
                        $this->tpl->setCurrentBlock("preconditions");
                        $this->tpl->setVariable("CONDITION_TOGGLE_ID", "_opt_".$toggle_id);
                        $this->tpl->setVariable("TXT_PRECONDITIONS", sprintf($lng->txt("preconditions_optional_hint"),$num_optional_required));
                        $this->tpl->parseCurrentBlock();
                }

                return !$missing_cond_exist;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

preloadCommonProperties()

static ilObjectListGUI::preloadCommonProperties (   $a_obj_ids,   $a_context  )

static

Preload common properties.

Parameters

Definition at line 3700 of file class.ilObjectListGUI.php.

References $lng, ilNote\_countNotesAndCommentsMultiple(), ilTagging\_countTags(), and ilNote\getRepObjActivation().

Referenced by ilObjectListGUIPreloader\preload().

        {
                global $lng;
                
                if($a_context == self::CONTEXT_REPOSITORY)
                {
                        $lng->loadLanguageModule("notes");
                        $lng->loadLanguageModule("tagging");
                        $lng->loadLanguageModule("rating");

                        include_once("./Services/Tagging/classes/class.ilTagging.php");
                        self::$cnt_tags = ilTagging::_countTags($a_obj_ids);

                        include_once("./Services/Notes/classes/class.ilNote.php");
                        self::$cnt_notes = ilNote::_countNotesAndCommentsMultiple($a_obj_ids, true);
                        self::$comments_activation = ilNote::getRepObjActivation($a_obj_ids);   
                }
                
                self::$preload_done = true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareJsLinks()

static ilObjectListGUI::prepareJsLinks (   $a_redraw_url,   $a_notes_url,   $a_tags_url,   $a_tpl = null  )

static

Insert js/ajax links into template.

Definition at line 2959 of file class.ilObjectListGUI.php.

References $tpl, ilTaggingGUI\initJavascript(), and ilNoteGUI\initJavascript().

Referenced by ilObjWorkspaceFolderGUI\render().

        {
                global $tpl;
                
                if (is_null($a_tpl))
                {
                        $a_tpl = $tpl;
                }
                
                if($a_notes_url)
                {
                        include_once("./Services/Notes/classes/class.ilNoteGUI.php");
                        ilNoteGUI::initJavascript($a_notes_url);
                }
                
                if($a_tags_url)
                {
                        include_once("./Services/Tagging/classes/class.ilTaggingGUI.php");
                        ilTaggingGUI::initJavascript($a_tags_url);
                }
                
                if($a_redraw_url)
                {
                        $a_tpl->addOnLoadCode("il.Object.setRedrawAHUrl('".
                                                $a_redraw_url."');");   
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

restrictToGoto()

ilObjectListGUI::restrictToGoto

(

$a_value

)

Restrict all actions/links to goto.

Parameters

bool

$a_value

Definition at line 908 of file class.ilObjectListGUI.php.

        {
                $this->restrict_to_goto = (bool)$a_value;
        }

setAdditionalInformation()

ilObjectListGUI::setAdditionalInformation

(

$a_val

)

Set additional information.

Parameters

string

additional information

Definition at line 857 of file class.ilObjectListGUI.php.

        {
                $this->additional_information = $a_val;
        }

setAjaxHash()

ilObjectListGUI::setAjaxHash

(

$a_hash

)

Definition at line 3027 of file class.ilObjectListGUI.php.

Referenced by getListItemHTML().

        {
                $this->ajax_hash = $a_hash;
        }

Here is the caller graph for this function:

setBoldTitle()

ilObjectListGUI::setBoldTitle

(

$a_bold_title

)

public boolean $a_bold_title set the item title bold

Definition at line 3678 of file class.ilObjectListGUI.php.

        {
                $this->bold_title = $a_bold_title;
                
        }

setConditionDepth()

ilObjectListGUI::setConditionDepth

(

$a_depth

)

set depth for precondition output (stops at level 5)

Definition at line 1696 of file class.ilObjectListGUI.php.

        {
                $this->condition_depth = $a_depth;
        }

setContainerObject()

ilObjectListGUI::setContainerObject

(

$container_obj

)

set the container object (e.g categorygui) Used for link, delete ...

commands

this method should be overwritten by derived classes

Definition at line 155 of file class.ilObjectListGUI.php.

        {
                $this->container_obj = $container_obj;
        }

setDescription()

ilObjectListGUI::setDescription

(

$a_description

)

Parameters

string

description

Returns

bool

Definition at line 785 of file class.ilObjectListGUI.php.

Referenced by initItem().

        {
                $this->description = $a_description;
        }

Here is the caller graph for this function:

setDetailsLevel()

ilObjectListGUI::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)

Parameters

int

$a_level

Returns

Definition at line 879 of file class.ilObjectListGUI.php.

        {
                $this->details_level = $a_level;
        }

setExpanded()

ilObjectListGUI::setExpanded

(

$a_status

)

Definition at line 417 of file class.ilObjectListGUI.php.

        {
                $this->is_expanded = $a_status;
        }

setHeaderSubObject()

ilObjectListGUI::setHeaderSubObject	(		$a_type,
			$a_id
	)

Set sub object identifier.

Parameters

string	$a_type
int	$a_id

Definition at line 2993 of file class.ilObjectListGUI.php.

        {
                $this->sub_obj_type = $a_type;
                $this->sub_obj_id = (int)$a_id;
        }               

setItemDetailLinks()

ilObjectListGUI::setItemDetailLinks	(		$a_detail_links,
			$a_intro_txt = ''
	)

set items detail links

public

Parameters

array

e.g. array(0 => array('desc' => 'Page: ','link' => 'ilias.php...','name' => 'Page XYZ')

Returns

Definition at line 721 of file class.ilObjectListGUI.php.

        {
                $this->item_detail_links = $a_detail_links;
                $this->item_detail_links_intro = $a_intro_txt;
        }

setMode()

ilObjectListGUI::setMode

(

$a_mode

)

set output mode

Parameters

string

$a_mode

output mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER)

Definition at line 1678 of file class.ilObjectListGUI.php.

        {
                $this->mode = $a_mode;
        }

setParentRefId()

ilObjectListGUI::setParentRefId

(

$a_ref_id

)

Set current parent ref id to enable unique js-ids (sessions, etc.)

Parameters

int

$a_ref_id

Definition at line 3619 of file class.ilObjectListGUI.php.

Referenced by ilObjectListGUI().

        {
                $this->parent_ref_id = $a_ref_id;
        }

Here is the caller graph for this function:

setPositionInputField()

ilObjectListGUI::setPositionInputField	(		$a_field_index,
			$a_position_value
	)

Set position input field.

Parameters

string	$a_field_index	e.g. "[crs][34]"
string	$a_position_value	e.g. "2.0"

Definition at line 432 of file class.ilObjectListGUI.php.

        {
                $this->position_enabled = true;
                $this->position_field_index = $a_field_index;
                $this->position_value = $a_position_value;
        }

setRelevance()

ilObjectListGUI::setRelevance

(

$a_rel

)

set relevance

Parameters

int

Returns

Definition at line 342 of file class.ilObjectListGUI.php.

        {
                $this->relevance = $a_rel; 
        }

setSearchFragment()

ilObjectListGUI::setSearchFragment

(

$a_text

)

set search fragment

Parameters

string

$a_text

highlighted search fragment

Returns

Definition at line 805 of file class.ilObjectListGUI.php.

        {
                $this->search_fragment = $a_text; 
        }

setSeparateCommands()

ilObjectListGUI::setSeparateCommands

(

$a_val

)

Set separate commands.

Parameters

boolean

separate commands

Definition at line 824 of file class.ilObjectListGUI.php.

        {
                $this->separate_commands = $a_val;
        }

setTitle()

ilObjectListGUI::setTitle

(

$a_title

)

Parameters

string

title

Returns

bool

Definition at line 766 of file class.ilObjectListGUI.php.

Referenced by initItem().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

storeAccessCache()

ilObjectListGUI::storeAccessCache

(

)

Store access cache.

Definition at line 3405 of file class.ilObjectListGUI.php.

References $ilUser, and $ref_id.

Referenced by getListItemHTML().

        {
                global $ilUser;
                if($this->acache->getLastAccessStatus() == "miss" &&
                        !$this->prevent_access_caching)
                {
                        $this->acache->storeEntry($ilUser->getId().":".$this->ref_id,
                                serialize($this->access_cache), $this->ref_id);
                }
        }

Here is the caller graph for this function:

Field Documentation

$additional_information

ilObjectListGUI::$additional_information = false

protected

Definition at line 90 of file class.ilObjectListGUI.php.

Referenced by getAdditionalInformation().

$bold_title

ilObjectListGUI::$bold_title = false

protected

Definition at line 81 of file class.ilObjectListGUI.php.

Referenced by isTitleBold().

$checkboxes_enabled

ilObjectListGUI::$checkboxes_enabled = false

protected

Definition at line 65 of file class.ilObjectListGUI.php.

Referenced by getCheckboxStatus().

$cnt_notes

ilObjectListGUI::$cnt_notes = array()

staticprotected

Definition at line 112 of file class.ilObjectListGUI.php.

$cnt_tags

ilObjectListGUI::$cnt_tags = array()

staticprotected

Definition at line 113 of file class.ilObjectListGUI.php.

$commands_enabled

ilObjectListGUI::$commands_enabled = true

Definition at line 45 of file class.ilObjectListGUI.php.

Referenced by getCommandsStatus().

$comments_activation

ilObjectListGUI::$comments_activation = array()

staticprotected

Definition at line 114 of file class.ilObjectListGUI.php.

$comments_enabled

ilObjectListGUI::$comments_enabled = false

protected

Definition at line 97 of file class.ilObjectListGUI.php.

Referenced by getHeaderAction(), and insertCommonSocialCommands().

$comments_settings_enabled

ilObjectListGUI::$comments_settings_enabled = false

protected

Definition at line 98 of file class.ilObjectListGUI.php.

$condition_depth

ilObjectListGUI::$condition_depth = 0

Definition at line 49 of file class.ilObjectListGUI.php.

$copy_enabled

ilObjectListGUI::$copy_enabled = true

protected

Definition at line 83 of file class.ilObjectListGUI.php.

Referenced by getCopyStatus().

$ctrl

ilObjectListGUI::$ctrl

Definition at line 40 of file class.ilObjectListGUI.php.

$cust_commands

ilObjectListGUI::$cust_commands = array()

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

$cust_prop

ilObjectListGUI::$cust_prop = array()

Definition at line 46 of file class.ilObjectListGUI.php.

$description_enabled

ilObjectListGUI::$description_enabled = true

Definition at line 41 of file class.ilObjectListGUI.php.

Referenced by getDescriptionStatus().

$details_level

ilObjectListGUI::$details_level = self::DETAILS_ALL

protected

Definition at line 85 of file class.ilObjectListGUI.php.

Referenced by getDetailsLevel().

$download_checkbox_state

ilObjectListGUI::$download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE

Definition at line 53 of file class.ilObjectListGUI.php.

Referenced by getDownloadCheckboxState().

$enabled_relevance

ilObjectListGUI::$enabled_relevance = false

protected

Definition at line 76 of file class.ilObjectListGUI.php.

Referenced by enabledRelevance().

$expand_enabled

ilObjectListGUI::$expand_enabled = false

protected

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

Referenced by getExpandStatus().

$force_visible_only

ilObjectListGUI::$force_visible_only = false

protected

Definition at line 108 of file class.ilObjectListGUI.php.

Referenced by isVisibleOnlyForced().

$icons_enabled

ilObjectListGUI::$icons_enabled = false

protected

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

Referenced by getIconStatus().

$info_screen_enabled

ilObjectListGUI::$info_screen_enabled = false

Definition at line 48 of file class.ilObjectListGUI.php.

Referenced by ilObjCategoryListGUI\getInfoScreenStatus(), and getInfoScreenStatus().

$is_expanded

ilObjectListGUI::$is_expanded = true

protected

Definition at line 80 of file class.ilObjectListGUI.php.

Referenced by isExpanded().

$item_detail_links

ilObjectListGUI::$item_detail_links = array()

protected

Definition at line 69 of file class.ilObjectListGUI.php.

$item_detail_links_enabled

ilObjectListGUI::$item_detail_links_enabled = false

protected

Definition at line 68 of file class.ilObjectListGUI.php.

Referenced by getItemDetailLinkStatus().

$item_detail_links_intro

ilObjectListGUI::$item_detail_links_intro = ''

protected

Definition at line 70 of file class.ilObjectListGUI.php.

$multi_download_enabled

ilObjectListGUI::$multi_download_enabled = false

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

$notes_enabled

ilObjectListGUI::$notes_enabled = false

protected

Definition at line 99 of file class.ilObjectListGUI.php.

$notice_properties_enabled

ilObjectListGUI::$notice_properties_enabled = true

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

Referenced by getNoticePropertiesStatus().

$obj_id

ilObjectListGUI::$obj_id

protected

Definition at line 55 of file class.ilObjectListGUI.php.

Referenced by ilObjSessionListGUI\getAppointmentInfo(), getHeaderAction(), ilObjCourseListGUI\getProperties(), ilObjGroupListGUI\getProperties(), ilCourseObjectiveListGUI\insertProgressInfo(), insertProperties(), and ilCourseObjectiveListGUI\insertTitle().

$parent_ref_id

ilObjectListGUI::$parent_ref_id

protected

Definition at line 110 of file class.ilObjectListGUI.php.

Referenced by insertTimingsCommand().

$path_linked

ilObjectListGUI::$path_linked = false

protected

Definition at line 74 of file class.ilObjectListGUI.php.

$position_enabled

ilObjectListGUI::$position_enabled = false

protected

Definition at line 66 of file class.ilObjectListGUI.php.

$preconditions_enabled

ilObjectListGUI::$preconditions_enabled = true

Definition at line 42 of file class.ilObjectListGUI.php.

Referenced by getPreconditionsStatus().

$preload_done

ilObjectListGUI::$preload_done = false

staticprotected

Definition at line 115 of file class.ilObjectListGUI.php.

$prevent_duplicate_commands

ilObjectListGUI::$prevent_duplicate_commands = array()

protected

Definition at line 109 of file class.ilObjectListGUI.php.

$progress_enabled

ilObjectListGUI::$progress_enabled = false

protected

Definition at line 67 of file class.ilObjectListGUI.php.

Referenced by getProgressInfoStatus().

$properties_enabled

ilObjectListGUI::$properties_enabled = true

Definition at line 43 of file class.ilObjectListGUI.php.

Referenced by getPropertiesStatus().

$rating_categories_enabled

ilObjectListGUI::$rating_categories_enabled = false

protected

Definition at line 103 of file class.ilObjectListGUI.php.

$rating_ctrl_path

ilObjectListGUI::$rating_ctrl_path = false

protected

Definition at line 105 of file class.ilObjectListGUI.php.

$rating_enabled

ilObjectListGUI::$rating_enabled = false

protected

Definition at line 102 of file class.ilObjectListGUI.php.

$rating_text

ilObjectListGUI::$rating_text = false

protected

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

$ref_id

ilObjectListGUI::$ref_id

protected

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

Referenced by getCommandId(), ilObjiLincClassroomListGUI\getCommands(), insertCommonSocialCommands(), insertProperties(), and storeAccessCache().

$reference_ref_id

ilObjectListGUI::$reference_ref_id = false

protected

Definition at line 87 of file class.ilObjectListGUI.php.

Referenced by insertCommonSocialCommands(), and insertProperties().

$relevance

ilObjectListGUI::$relevance = 0

protected

Definition at line 77 of file class.ilObjectListGUI.php.

Referenced by getRelevance().

$repository_transfer_enabled

ilObjectListGUI::$repository_transfer_enabled = false

protected

Definition at line 93 of file class.ilObjectListGUI.php.

$restrict_to_goto

ilObjectListGUI::$restrict_to_goto = false

protected

Definition at line 95 of file class.ilObjectListGUI.php.

$search_fragment

ilObjectListGUI::$search_fragment = ''

protected

Definition at line 73 of file class.ilObjectListGUI.php.

Referenced by getSearchFragment().

$search_fragment_enabled

ilObjectListGUI::$search_fragment_enabled = false

protected

Definition at line 89 of file class.ilObjectListGUI.php.

Referenced by getSearchFragmentStatus().

$search_fragments_enabled

ilObjectListGUI::$search_fragments_enabled = false

protected

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

$separate_commands

ilObjectListGUI::$separate_commands = false

protected

Definition at line 88 of file class.ilObjectListGUI.php.

Referenced by getSeparateCommands().

$shared

ilObjectListGUI::$shared = false

protected

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

$static_link_enabled

ilObjectListGUI::$static_link_enabled = false

protected

Definition at line 91 of file class.ilObjectListGUI.php.

$std_cmd_only

ilObjectListGUI::$std_cmd_only = false

Definition at line 50 of file class.ilObjectListGUI.php.

$sub_item_html

ilObjectListGUI::$sub_item_html = array()

Definition at line 51 of file class.ilObjectListGUI.php.

$sub_obj_id

ilObjectListGUI::$sub_obj_id

protected

Definition at line 58 of file class.ilObjectListGUI.php.

$sub_obj_type

ilObjectListGUI::$sub_obj_type

protected

Definition at line 59 of file class.ilObjectListGUI.php.

$substitutions

ilObjectListGUI::$substitutions = null

protected

Definition at line 61 of file class.ilObjectListGUI.php.

$substitutions_enabled

ilObjectListGUI::$substitutions_enabled = false

protected

Definition at line 62 of file class.ilObjectListGUI.php.

Referenced by getSubstitutionStatus().

$tags_enabled

ilObjectListGUI::$tags_enabled = false

protected

Definition at line 100 of file class.ilObjectListGUI.php.

$timings_enabled

ilObjectListGUI::$timings_enabled = true

protected

Definition at line 107 of file class.ilObjectListGUI.php.

$type

ilObjectListGUI::$type

protected

Definition at line 57 of file class.ilObjectListGUI.php.

Referenced by ilObjFileListGUI\getIconImageType(), getIconImageType(), getListItemHTML(), ilObjSAHSLearningModuleListGUI\getProperties(), ilObjectPluginListGUI\getType(), insertPaymentCommand(), and insertSubscribeCommand().

CONTEXT_PERSONAL_DESKTOP

const ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP = 5

Definition at line 33 of file class.ilObjectListGUI.php.

Referenced by ilPDSelectedItemsBlockGUI\getMembershipItemsPerLocation(), ilPDSelectedItemsBlockGUI\getMembershipItemsPerType(), ilPDSelectedItemsBlockGUI\getSelectedItemsPerLocation(), ilPDSelectedItemsBlockGUI\getSelectedItemsPerType(), and ilObjectListGUIPreloader\preload().

CONTEXT_REPOSITORY

const ilObjectListGUI::CONTEXT_REPOSITORY = 1

Definition at line 29 of file class.ilObjectListGUI.php.

Referenced by ilContainer\getSubItems(), ilCommonActionDispatcherGUI\initHeaderAction(), and ilObjectListGUIPreloader\preload().

CONTEXT_SEARCH

const ilObjectListGUI::CONTEXT_SEARCH = 6

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

Referenced by ilObjectListGUIPreloader\preload(), and ilSearchResultPresentation\renderItemList().

CONTEXT_SHOP

const ilObjectListGUI::CONTEXT_SHOP = 3

Definition at line 31 of file class.ilObjectListGUI.php.

Referenced by ilShopResultPresentationGUI\renderItems().

CONTEXT_WORKSPACE

const ilObjectListGUI::CONTEXT_WORKSPACE = 2

Definition at line 30 of file class.ilObjectListGUI.php.

Referenced by ilObjWorkspaceFolderTableGUI\fillRow(), ilObjWorkspaceFolderTableGUI\getItems(), and ilCommonActionDispatcherGUI\initHeaderAction().

CONTEXT_WORKSPACE_SHARING

const ilObjectListGUI::CONTEXT_WORKSPACE_SHARING = 4

Definition at line 32 of file class.ilObjectListGUI.php.

DETAILS_ALL

const ilObjectListGUI::DETAILS_ALL = 30

Definition at line 27 of file class.ilObjectListGUI.php.

Referenced by ilObjWorkspaceFolderTableGUI\fillRow(), ilObjSessionListGUI\getProperties(), ilObjForumListGUI\initItem(), and ilContainerContentGUI\renderItem().

DETAILS_MINIMAL

const ilObjectListGUI::DETAILS_MINIMAL = 10

Definition at line 25 of file class.ilObjectListGUI.php.

Referenced by ilObjSessionListGUI\getProperties(), and ilContainerContentGUI\renderItem().

DETAILS_SEARCH

const ilObjectListGUI::DETAILS_SEARCH = 20

Definition at line 26 of file class.ilObjectListGUI.php.

Referenced by ilLuceneSearchObjectListGUIFactory\factory().

DOWNLOAD_CHECKBOX_DISABLED

const ilObjectListGUI::DOWNLOAD_CHECKBOX_DISABLED = 2

Definition at line 38 of file class.ilObjectListGUI.php.

DOWNLOAD_CHECKBOX_ENABLED

const ilObjectListGUI::DOWNLOAD_CHECKBOX_ENABLED = 1

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

DOWNLOAD_CHECKBOX_NONE

const ilObjectListGUI::DOWNLOAD_CHECKBOX_NONE = 0

Definition at line 36 of file class.ilObjectListGUI.php.

---

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

• Services/Object/classes/class.ilObjectListGUI.php