ilObjectListGUI Class Reference

Class ilObjectListGUI. More...

Inheritance diagram for ilObjectListGUI:

Collaboration diagram for ilObjectListGUI:

Public Member Functions
	__construct ($a_context=self::CONTEXT_REPOSITORY)
	constructor More...
	setContainerObject ($container_obj)
	set the container object (e.g categorygui) Used for link, delete ... commands 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 ()
	enableLink ($a_status)
	En/disable link. More...
	getLinkStatus ()
	enablePath ($a_path, $a_start_node=null, \ilPathGUI $path_gui=null)
	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...
	getDefaultCommand ()
	Get default command. More...
	checkCommandAccess ($a_permission, $a_cmd, $a_ref_id, $a_type, $a_obj_id="")
	initItem ($a_ref_id, $a_obj_id, $type, $a_title="", $a_description="")
	inititialize new item (is called by getItemHTML()) More...
	setConditionTarget ($a_ref_id, $a_obj_id, $a_target_type)
	resetConditionTarget ()
	disableTitleLink ($a_status)
	setDefaultCommandParameters (array $a_params)
	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 ()
	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...
	determineProperties ()
	Determine properties. More...
	insertProperties ()
	insert properties More...
	insertNoticeProperties ()
	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)
	addHeaderGlyph ($a_id, $a_glyph, $a_onclick=null)
	setAjaxHash ($a_hash)
	getHeaderAction (ilGlobalTemplateInterface $a_main_tpl=null)
	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...
	getTypeIcon ()
	Get object type specific type icon. 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="")
	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...
	getUniqueItemId ($a_as_div=false)
	Get unique item identifier (for js-actions) 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)
	@access public @params boolean $a_bold_title set the item title bold More...
	isTitleBold ()
	@access 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...
	getAsListItem (int $ref_id, int $obj_id, string $type, string $title, string $description)
	Get list item ui object. More...
	getAsCard (int $ref_id, int $obj_id, string $type, string $title, string $description)
	Get card object. More...
	checkInfoPageOnAsynchronousRendering ()

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_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 ()
	parseConditions ($toggle_id, $conditions, $obligatory=true)
	modifyTitleLink ($a_default_link)
	resetCustomData ()
	reset properties and commands 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...
	getTileImagePath ()

Protected Attributes
	$access
	$lng
	$user
	$obj_definition
	$tree
	$settings
	$tpl
	$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
	$context
	$title_link = ''
	$title_link_disabled = false
	$path_gui = null
	$ui
	$object_service
	$fav_manager

Static Protected Attributes
static	$cnt_notes = array()
static	$cnt_tags = array()
static	$tags = array()
static	$comments_activation = array()
static	$preload_done = false
static	$js_unique_id = 0
static	$tpl_file_name = "tpl.container_list_item.html"
static	$tpl_component = "Services/Container"

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.

Constructor & Destructor Documentation

__construct()

ilObjectListGUI::__construct

(

$a_context = self::CONTEXT_REPOSITORY

)

constructor

Reimplemented in ilObjCategoryListGUI, ilObjChatroomListGUI, ilObjContentPageListGUI, ilObjTestListGUI, ilObjQuestionPoolListGUI, and ilObjectPluginListGUI.

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

    {
        global $DIC;
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->obj_definition = $DIC["objDefinition"];
        $this->tree = $DIC->repositoryTree();
        $this->settings = $DIC->settings();
 
        $this->ui = $DIC->ui();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->mode = IL_LIST_FULL;
        $this->path_enabled = false;
        $this->context = $a_context;
 
        $this->object_service = $DIC->object();
 
        $this->enableComments(false);
        $this->enableNotes(false);
        $this->enableTags(false);
 
        // unique js-ids
        $this->setParentRefId((int) $_REQUEST["ref_id"]);
 
        //echo "list";
        $this->init();
 
        include_once('Services/LDAP/classes/class.ilLDAPRoleGroupMapping.php');
        $this->ldap_mapping = ilLDAPRoleGroupMapping::_getInstance();
        $this->fav_manager = new ilFavouritesManager();
 
        $this->lng->loadLanguageModule("obj");
        $this->lng->loadLanguageModule("rep");
    }

References $DIC, ilLDAPRoleGroupMapping\_getInstance(), enableComments(), enableNotes(), enableTags(), IL_LIST_FULL, init(), setParentRefId(), settings(), ui(), and user().

Here is the call graph for this function:

Member Function Documentation

addCustomCommand()

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

add a custom command

Definition at line 1319 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 1265 of file class.ilObjectListGUI.php.

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

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

Here is the caller graph for this function:

addHeaderGlyph()

ilObjectListGUI::addHeaderGlyph	(		$a_id,
			$a_glyph,
			$a_onclick = null
	)

Parameters

string	$a_id
string	$a_html

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

    {
        $this->header_icons[$a_id] = array("glyph" => $a_glyph, "onclick" => $a_onclick);
    }

Referenced by getHeaderAction().

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 2846 of file class.ilObjectListGUI.php.

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

addHeaderIconHTML()

ilObjectListGUI::addHeaderIconHTML	(		$a_id,
			$a_html
	)

Parameters

string	$a_id
string	$a_html

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

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

Referenced by getHeaderAction().

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 685 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 3322 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 3085 of file class.ilObjectListGUI.php.

    {
        // 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;
    }

References $_GET, and ilUtil\appendUrlParameterString().

Referenced by insertCommands(), and insertTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

buildGotoLink()

ilObjectListGUI::buildGotoLink ( )

protected

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

    {
        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;
        }
    }

References CONTEXT_WORKSPACE_SHARING, and ilWorkspaceAccessHandler\getGotoLink().

Referenced by insertTitle().

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

return

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseListGUI, ilObjCourseReferenceListGUI, ilObjGroupListGUI, ilObjGroupReferenceListGUI, ilObjSessionListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

    {
        $ilAccess = $this->access;
 
        // 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) {
            $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;
    }

References $access, and isVisibleOnlyForced().

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkInfoPageOnAsynchronousRendering()

ilObjectListGUI::checkInfoPageOnAsynchronousRendering

(

)

Returns

bool

Reimplemented in ilObjCategoryListGUI, and ilObjContentPageListGUI.

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

                                                           : bool
    {
        return false;
    }

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.

@access public

Parameters

int	command link

Reimplemented in ilObjTestListGUI.

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

    {
        // begin-patch lok
        if ($this->static_link_enabled and !$this->default_command_params) {
            include_once('./Services/Link/classes/class.ilLink.php');
            if ($link = ilLink::_getStaticLink($this->ref_id, $this->type, false)) {
                $command['link'] = $link;
                $command['frame'] = '_top';
            }
        }
        if ($this->default_command_params) {
            $params = array();
            foreach ($this->default_command_params as $name => $value) {
                $params[] = $name . '=' . $value;
            }
            $params = implode('&', $params);
 
            // #12370
            if (!stristr($command['link'], '?')) {
                $command['link'] .= '?' . $params;
            } else {
                $command['link'] .= '&' . $params;
            }
        }
        return $command;
    }

References $name, and ilLink\_getStaticLink().

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

determineProperties()

ilObjectListGUI::determineProperties

(

)

Determine properties.

Returns

array

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

    {
        $ilAccess = $this->access;
        $lng = $this->lng;
        $ilUser = $this->user;
 
        $props = $this->getProperties();
        $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 ($ilUser->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)
        require_once 'Services/Notes/classes/class.ilNote.php';
        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 ||
                is_array(self::$tags[$note_obj_id])) &&
            ($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 ||
                    is_array(self::$tags[$note_obj_id]))) {
                $tags_set = new ilSetting("tags");
                if ($tags_set->get("enable")) {
                    $tags_url = ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $redraw_js);
 
                    // list object tags
                    if (is_array(self::$tags[$note_obj_id])) {
                        $tags_tmp = array();
                        foreach (self::$tags[$note_obj_id] as $tag => $is_tag_owner) {
                            if ($is_tag_owner) {
                                $tags_tmp[] = "<a class=\"ilTag ilTagRelHigh\" href='#' onclick=\"return " .
                                    $tags_url . "\">" . $tag . "</a>";
                            } else {
                                $tags_tmp[] = "<span class=\"ilTag ilTagRelMiddle\">" . $tag . "</span>";
                            }
                        }
                        $tags_value = implode(" ", $tags_tmp);
                        $nl = true;
                        $prop_text = "";
                    } // tags counter
                    else {
                        $tags_value = "<a href='#' onclick=\"return " . $tags_url . "\">" .
                            self::$cnt_tags[$note_obj_id] . "</a>";
                        $prop_text = $lng->txt("tagging_tags");
                    }
                    $props[] = array("alert" => false,
                        "property" => $prop_text,
                        "value" => $tags_value,
                        "newline" => $nl);
                    $nl = false;
                }
            }
        }
        if (!is_array($props)) {
            return [];
        }
        return $props;
    }

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

Referenced by insertProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

disableTitleLink()

ilObjectListGUI::disableTitleLink

(

$a_status

)

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

    {
        $this->title_link_disabled = $a_status;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

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 456 of file class.ilObjectListGUI.php.

    {
        $this->checkboxes_enabled = $a_status;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI(), ilObjStudyProgrammeListGUI\getListItemHTML(), and ilObjStudyProgrammeReferenceListGUI\getListItemHTML().

Here is the caller graph for this function:

enableCommands()

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

En/disable commands.

Parameters

bool

Returns

void

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

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

Referenced by ilContainerObjectiveGUI\addItemDetails(), ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableComments()

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

Toogle comments action status.

Parameters

boolean

$a_value

Reimplemented in ilOrgUnitExtensionListGUI.

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

    {
        $ilSetting = $this->settings;
 
        // 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;
    }

References $ilSetting, and $settings.

Referenced by __construct(), ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableCopy()

ilObjectListGUI::enableCopy

(

$a_status

)

En/disable copy.

Parameters

bool

Returns

void

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

    {
        $this->copy_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableCut()

ilObjectListGUI::enableCut

(

$a_status

)

En/disable cut.

Parameters

bool

Returns

void

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

    {
        $this->cut_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableDelete()

ilObjectListGUI::enableDelete

(

$a_status

)

En/disable delete.

Parameters

bool

Returns

void

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

    {
        $this->delete_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableDescription()

ilObjectListGUI::enableDescription

(

$a_status

)

En/disable description.

Parameters

bool

Returns

void

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

    {
        $this->description_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableDownloadCheckbox()

ilObjectListGUI::enableDownloadCheckbox	(		$a_ref_id,
			$a_value
	)

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

    {
        $ilAccess = $this->access;
 
        // 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;
        }
    }

References $_SESSION, $access, DOWNLOAD_CHECKBOX_DISABLED, DOWNLOAD_CHECKBOX_ENABLED, DOWNLOAD_CHECKBOX_NONE, and getContainerObject().

Here is the call graph for this function:

enabledRelevance()

ilObjectListGUI::enabledRelevance

(

)

enabled relevance

Returns

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

    {
        return $this->enabled_relevance;
    }

References $enabled_relevance.

Referenced by getListItemHTML(), and insertRelevance().

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 476 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 436 of file class.ilObjectListGUI.php.

    {
        $this->icons_enabled = $a_status;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI(), and ilObjOrgUnitListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

enableInfoScreen()

ilObjectListGUI::enableInfoScreen

(

$a_info_screen

)

En/disable path.

Parameters

bool

Returns

void

Reimplemented in ilObjItemGroupListGUI.

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

    {
        $this->info_screen_enabled = $a_info_screen;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableItemDetailLinks()

ilObjectListGUI::enableItemDetailLinks

(

$a_status

)

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

@access public

Parameters

bool

Returns

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

    {
        $this->item_detail_links_enabled = $a_status;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

enableLink()

ilObjectListGUI::enableLink

(

$a_status

)

En/disable link.

Parameters

bool

Returns

void

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

    {
        $this->link_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableLinkedPath()

ilObjectListGUI::enableLinkedPath

(

$a_status

)

Enable linked path.

Parameters

bool

Returns

Definition at line 388 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 2729 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

Reimplemented in ilOrgUnitExtensionListGUI.

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

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

References $ilSetting, and $settings.

Referenced by __construct().

Here is the caller graph for this function:

enableNoticeProperties()

ilObjectListGUI::enableNoticeProperties

(

$a_status

)

En/disable notices.

Parameters

bool

Returns

void

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

    {
        $this->notice_properties_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enablePath()

ilObjectListGUI::enablePath	(		$a_path,
			$a_start_node = null,
		\ilPathGUI	$path_gui = null
	)

En/disable path.

Parameters

bool
int

Returns

void

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

    {
        $this->path_enabled = $a_path;
        $this->path_start_node = (int) $a_start_node;
        $this->path_gui = $path_gui;
    }

References $path_gui.

enablePreconditions()

ilObjectListGUI::enablePreconditions

(

$a_status

)

En/disable preconditions.

Parameters

bool

Returns

void

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

    {
        $this->preconditions_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableProgressInfo()

ilObjectListGUI::enableProgressInfo

(

$a_status

)

enable progress info

@access public

Parameters

return

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

    {
        $this->progress_enabled = $a_status;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableProperties()

ilObjectListGUI::enableProperties

(

$a_status

)

En/disable properties.

Parameters

bool

Returns

void

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

    {
        $this->properties_enabled = $a_status;
 
        return;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails(), ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

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 2713 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 406 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 958 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 376 of file class.ilObjectListGUI.php.

    {
        $this->search_fragment_enabled = $a_status;
 
        return;
    }

enableSubscribe()

ilObjectListGUI::enableSubscribe

(

$a_status

)

En/disable subscribe.

Parameters

bool

Returns

void

Reimplemented in ilObjItemGroupListGUI.

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

    {
        $this->subscribe_enabled = $a_status;
 
        return;
    }

Referenced by ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), and ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI().

Here is the caller graph for this function:

enableSubstitutions()

ilObjectListGUI::enableSubstitutions

(

$a_status

)

Enable substitutions.

@access public

Parameters

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

    {
        $this->substitutions_enabled = $a_status;
    }

Referenced by ilObjGroupListGUI\init(), ilObjIndividualAssessmentListGUI\init(), and ilObjSessionListGUI\init().

Here is the caller graph for this function:

enableTags()

ilObjectListGUI::enableTags

(

$a_value

)

Toogle tags action status.

Parameters

boolean

$a_value

Reimplemented in ilOrgUnitExtensionListGUI.

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

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

Referenced by __construct(), ilStudyProgrammeExpandableProgressListGUI\configureItemGUI(), ilStudyProgrammeIndividualPlanProgressListGUI\configureItemGUI(), and ilTaggingClassificationProvider\initListGUI().

Here is the caller graph for this function:

enableTimings()

ilObjectListGUI::enableTimings

(

$a_status

)

enable timings link

@access public

Parameters

bool

Returns

Definition at line 3703 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 1330 of file class.ilObjectListGUI.php.

    {
        $this->force_visible_only = $a_stat;
    }

getAdditionalInformation()

ilObjectListGUI::getAdditionalInformation

(

)

Get additional information.

Returns

string additional information

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

    {
        return $this->additional_information;
    }

References $additional_information.

Referenced by getListItemHTML().

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.

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

References getProperties().

Here is the call graph for this function:

getAsCard()

ilObjectListGUI::getAsCard	(	int	$ref_id,
		int	$obj_id,
		string	$type,
		string	$title,
		string	$description
	)

Get card object.

Parameters

int	$ref_id
int	$obj_id
string	$type
string	$title
string	$description

Returns

\ILIAS\UI\Component\Card\Card|null

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

      : ?\ILIAS\UI\Component\Card\Card {
        $ui = $this->ui;
 
        // even b tag produced bugs, see #32304
        $description = strip_tags($description);
 
        $this->initItem(
            $ref_id,
            $obj_id,
            $type,
            $title,
            $description
        );
 
        $user = $this->user;
        $access = $this->access;
 
        $this->enableCommands(true);
 
        $sections = [];
 
        // description, @todo: move to new ks element
        if ($description != "") {
            $sections[] = $ui->factory()->legacy("<div class='il-multi-line-cap-3'>" . $description . "</div>");
        }
 
        $this->insertCommands();
        $actions = [];
 
        foreach ($this->current_selection_list->getItems() as $item) {
            if (!isset($item["onclick"]) || $item["onclick"] == "") {
                $actions[] =
                    $ui->factory()->button()->shy($item["title"], $item["link"]);
            } else {
                $actions[] =
                    $ui->factory()->button()->shy($item["title"], "")->withAdditionalOnLoadCode(function ($id) use ($item) {
                        return
                            "$('#$id').click(function(e) { " . $item["onclick"] . "});";
                    });
            }
        }
 
        $def_command = $this->getDefaultCommand();
 
        if ($def_command["frame"] != "") {
            /* this seems to be introduced due to #25624, but does not fix it
                removed with ##30732
            $button =
                $ui->factory()->button()->shy("Open", "")->withAdditionalOnLoadCode(function ($id) use ($def_command) {
                    return
                        "$('#$id').click(function(e) { window.open('" . str_replace(
                            "&amp;",
                            "&",
                            $def_command["link"]
                        ) . "', '" . $def_command["frame"] . "');});";
                });
            $actions[] = $button;*/
        }
        $dropdown = $ui->factory()->dropdown()->standard($actions)
                       ->withAriaLabel(sprintf(
                           $this->lng->txt('actions_for'),
                           htmlspecialchars(addslashes($title))
                       ));
 
 
        $path = $this->getTileImagePath();
 
        // workaround for #26205
        // we should get rid of _top links completely and gifure our how
        // to manage scorm links better
        if ($def_command["frame"] == "_top") {
            $def_command["frame"] = "";
        }
 
        // workaround for scorm
        $modified_link =
            $this->modifySAHSlaunch($def_command["link"], $def_command["frame"]);
 
        $image = $this->ui->factory()
                          ->image()
                          ->responsive($path, '');
        if ($def_command['link'] != '') {    // #24256
            if ($def_command["frame"] != "" && ($modified_link == $def_command["link"])) {
                $image = $image->withAdditionalOnLoadCode(function ($id) use ($def_command) {
                    return
                        "$('#$id').click(function(e) { window.open('" . str_replace(
                            "&amp;",
                            "&",
                            $def_command["link"]
                        ) . "', '" . $def_command["frame"] . "');});";
                });
 
                $button =
                    $ui->factory()->button()->shy($title, "")->withAdditionalOnLoadCode(function ($id) use (
                        $def_command
                    ) {
                        return
                            "$('#$id').click(function(e) { window.open('" . str_replace(
                                "&amp;",
                                "&",
                                $def_command["link"]
                            ) . "', '" . $def_command["frame"] . "');});";
                    });
                $title = $ui->renderer()->render($button);
            } else {
                $image = $image->withAction($modified_link);
            }
        }
 
        if ($type == 'sess') {
            if ($title != "") {
                $title = ": " . $title;
            }
            $app_info = ilSessionAppointment::_lookupAppointment($obj_id);
            $title = ilSessionAppointment::_appointmentToString(
                $app_info['start'],
                $app_info['end'],
                $app_info['fullday']
            ) . $title;
        }
 
        $icon = $this->ui->factory()
                         ->symbol()
                         ->icon()
                         ->standard($type, $this->lng->txt('obj_' . $type))
                         ->withIsOutlined(true);
 
        // card title action
        $card_title_action = "";
        if ($def_command["link"] != "" && ($def_command["frame"] == "" || $modified_link != $def_command["link"])) {    // #24256
            $card_title_action = $modified_link;
        } elseif ($def_command['link'] == "" &&
            $this->getInfoScreenStatus() &&
            $access->checkAccessOfUser(
                $user->getId(),
                "visible",
                "",
                $ref_id
            )) {
            $card_title_action = ilLink::_getLink($ref_id);
            if ($image->getAction() == "") {
                $image = $image->withAction($card_title_action);
            }
        }
 
        $card = $ui->factory()->card()->repositoryObject(
            $title . '<span data-list-item-id="' . $this->getUniqueItemId(true) . '"></span>',
            $image
        )->withObjectIcon(
            $icon
        )->withActions(
            $dropdown
        );
 
        if ($card_title_action != "") {
            $card = $card->withTitleAction($card_title_action);
        }
 
        $l = [];
        foreach ($this->determineProperties() as $p) {
            if ($p["alert"] && $p['property'] !== $this->lng->txt('learning_progress')) {
                $l[(string) $p['property']] = (string) $p['value'];
            }
        }
        if (count($l) > 0) {
            $prop_list = $ui->factory()->listing()->descriptive($l);
            $sections[] = $prop_list;
        }
        if (count($sections) > 0) {
            $card = $card->withSections($sections);
        }
 
        $lp = ilLPStatus::getListGUIStatus($obj_id, false);
        if (is_array($lp) && array_key_exists('status', $lp)) {
            $percentage = (int) ilLPStatus::_lookupPercentage($obj_id, $this->user->getId());
            if ($lp['status'] == ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                $percentage = 100;
            }
 
            $card = $card->withProgress(
                $ui->factory()
                   ->chart()
                   ->progressMeter()
                   ->mini(100, $percentage)
            );
        }
 
        return $card;
    }

getAsListItem()

ilObjectListGUI::getAsListItem	(	int	$ref_id,
		int	$obj_id,
		string	$type,
		string	$title,
		string	$description
	)

Get list item ui object.

Parameters

int	$ref_id
int	$obj_id
string	$type
string	$title
string	$description

Returns

\ILIAS\UI\Component\Item\Item|null

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

      : ?\ILIAS\UI\Component\Item\Item {
        $ui = $this->ui;
 
        // even b tag produced bugs, see #32304
        $description = strip_tags($description);
 
        $this->initItem(
            $ref_id,
            $obj_id,
            $type,
            $title,
            $description
        );
 
        $this->enableCommands(true);
 
        // actions
        $this->insertCommands();
        $actions = [];
        foreach ($this->current_selection_list->getItems() as $action_item) {
            $action = $ui->factory()
                ->button()
                ->shy($action_item['title'], $action_item['link']);
 
            // Dirty hack to remain the "onclick" action of action items
            if ($action_item['onclick'] != null && $action_item['onclick'] != '') {
                $action = $action->withAdditionalOnLoadCode(function ($id) use ($action_item) {
                    return "$('#$id').click(function(){" . $action_item['onclick'] . ";});";
                });
            }
 
            $actions[] = $action;
        }
 
        $dropdown = $ui->factory()
            ->dropdown()
            ->standard($actions)
            ->withAriaLabel(sprintf(
                $this->lng->txt('actions_for'),
                htmlspecialchars(addslashes($title))
            ));
 
        $def_command = $this->getDefaultCommand();
 
        $icon = $this->ui->factory()
            ->symbol()
            ->icon()
            ->custom(ilObject::_getIcon($obj_id), $this->lng->txt("icon") . " " . $this->lng->txt('obj_' . $type))
            ->withSize('medium');
 
 
        if ($def_command['link']) {
            $def_command['link'] = $this->modifySAHSlaunch($def_command['link'], $def_command['frame']);
            $new_viewport = !in_array($this->getDefaultCommand()['frame'], ['', '_top', '_self', '_parent'], true); // Cannot use $def_command['frame']. $this->default_command has been edited.
            $link = $this->ui->factory()
                             ->link()
                             ->standard($this->getTitle(), $def_command['link'])
                             ->withOpenInNewViewport($new_viewport);
            $list_item = $ui->factory()->item()->standard($link);
        } else {
            $list_item = $ui->factory()->item()->standard($this->getTitle());
        }
 
        if ($description != "") {
            $list_item = $list_item->withDescription($description);
        }
        $list_item = $list_item->withActions($dropdown)->withLeadIcon($icon);
 
 
        $l = [];
        $this->enableComments(true);
        $this->enableNotes(true);
        $this->enableTags(true);
        $this->enableRating(true);
 
        foreach ($this->determineProperties() as $p) {
            //if ($p['property'] !== $this->lng->txt('learning_progress')) {
            $l[(string) $p['property']] = (string) $p['value'];
            //}
        }
        if (count($l) > 0) {
            $list_item = $list_item->withProperties($l);
        }
 
        // @todo: learning progress
 
 
        /*
        $lp = ilLPStatus::getListGUIStatus($item['obj_id'], false);
        if (is_array($lp) && array_key_exists('status', $lp)) {
            $percentage = (int)ilLPStatus::_lookupPercentage($item['obj_id'], $this->user->getId());
            if ($lp['status'] == ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                $percentage = 100;
            }
 
            $card = $card->withProgress(
                $this->uiFactory
                    ->chart()
                    ->progressMeter()
                    ->mini(100, $percentage)
            );
        }*/
 
        return $list_item;
    }

getCheckboxStatus()

ilObjectListGUI::getCheckboxStatus

(

)

Are checkboxes enabled?

Returns

boolean icons enabled?

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

    {
        return $this->checkboxes_enabled;
    }

References $checkboxes_enabled.

Referenced by ilObjStudyProgrammeListGUI\getListItemHTML(), ilObjStudyProgrammeReferenceListGUI\getListItemHTML(), ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), and insertIconsAndCheckboxes().

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

Reimplemented in ilObjBookingPoolListGUI, ilObjCategoryListGUI, ilObjExerciseListGUI, ilObjExternalFeedListGUI, ilObjFileListGUI, ilObjFolderListGUI, ilObjForumListGUI, ilObjGlossaryListGUI, ilObjGroupListGUI, ilObjFileBasedLMListGUI, ilObjIndividualAssessmentListGUI, ilObjLearningModuleListGUI, ilObjMediaCastListGUI, ilObjMediaPoolListGUI, ilObjRemoteCategoryListGUI, ilObjRemoteCourseListGUI, ilObjRemoteFileListGUI, ilObjRemoteGlossaryListGUI, ilObjRemoteGroupListGUI, ilObjRemoteLearningModuleListGUI, ilObjRemoteTestListGUI, ilObjRemoteWikiListGUI, ilObjSAHSLearningModuleListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjTestListGUI, ilObjQuestionPoolListGUI, ilObjLinkResourceListGUI, ilObjWikiListGUI, and ilObjectPluginListGUI.

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

    {
        // begin-patch fm
        if ($a_cmd == 'fileManagerLaunch') {
            return '_blank';
        }
        // end-patch fm
        return "";
    }

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

Here is the caller graph for this function:

getCommandId()

ilObjectListGUI::getCommandId

(

)

get command id Normally the ref id.

Overwritten for course and category references

@access public

Parameters

return

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjGroupReferenceListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

    {
        return $this->ref_id;
    }

References $ref_id.

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

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

Reimplemented in ilObjFileListGUI, and ilObjLearningModuleListGUI.

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

    {
        return "";
    }

Referenced by getCommands().

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

Reimplemented in ilObjBookingPoolListGUI, ilObjCategoryListGUI, ilObjCategoryReferenceListGUI, ilObjCmiXapiListGUI, ilObjCourseReferenceListGUI, ilObjExerciseListGUI, ilObjExternalFeedListGUI, ilObjFileListGUI, ilObjFolderListGUI, ilObjForumListGUI, ilObjGlossaryListGUI, ilObjGroupListGUI, ilObjGroupReferenceListGUI, ilObjFileBasedLMListGUI, ilObjIndividualAssessmentListGUI, ilObjItemGroupListGUI, ilObjLearningModuleListGUI, ilObjLTIConsumerListGUI, ilObjMediaCastListGUI, ilObjMediaPoolListGUI, ilObjOrgUnitListGUI, ilObjRootFolderListGUI, ilObjSAHSLearningModuleListGUI, ilObjSessionListGUI, ilObjStudyProgrammeListGUI, ilObjStudyProgrammeReferenceListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjTestListGUI, ilObjQuestionPoolListGUI, ilObjLinkResourceListGUI, ilObjWikiListGUI, ilObjWorkspaceRootFolderListGUI, and ilObjectPluginListGUI.

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

    {
        if ($this->context == self::CONTEXT_REPOSITORY) {
            // BEGIN WebDAV Get mount webfolder link.
            require_once('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
            if ($a_cmd == 'mount_webfolder' && ilDAVActivationChecker::_isActive()) {
                global $DIC;
                $uri_builder = new ilWebDAVUriBuilder($DIC->http()->request());
                return $uri_builder->getUriToMountInstructionModalByRef($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);
        }
    }

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

Referenced by getCommands(), ilObjBlogListGUI\insertCommand(), and insertInfoScreenCommand().

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

@access 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)

Reimplemented in ilObjBlogListGUI, ilObjCloudListGUI, and ilObjTestListGUI.

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

    {
        $ilAccess = $this->access;
        $ilUser = $this->user;
 
        $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"];
            }
 
            // Suppress commands that don't make sense for anonymous users
            if ($ilUser->getId() == ANONYMOUS_USER_ID &&
                $command['enable_anonymous'] == 'false') {
                continue;
            }
 
            // all access checking should be made within $ilAccess and
            // the checkAccess of the ilObj...Access classes
            //$access = $ilAccess->checkAccess($permission, $cmd, $this->ref_id, $this->type);
            $access = $this->checkCommandAccess($permission, $cmd, $this->ref_id, $this->type);
 
            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;
    }

References $access, $ilUser, $txt, $user, ANONYMOUS_USER_ID, checkCommandAccess(), getCommandFrame(), getCommandImage(), and getCommandLink().

Referenced by insertCommands().

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 3570 of file class.ilObjectListGUI.php.

    {
        return $this->insertCommands();
    }

References insertCommands().

Here is the call graph for this function:

getCommandsStatus()

ilObjectListGUI::getCommandsStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->commands_enabled;
    }

References $commands_enabled.

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

Here is the caller graph for this function:

getContainerObject()

ilObjectListGUI::getContainerObject

(

)

get container object

@access public

Parameters

return object container

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

    {
        return $this->container_obj;
    }

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

Here is the caller graph for this function:

getCopyStatus()

ilObjectListGUI::getCopyStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->copy_enabled;
    }

References $copy_enabled.

getCustomProperties()

ilObjectListGUI::getCustomProperties

(

$a_prop

)

get custom properties

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

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

Referenced by determineProperties().

Here is the caller graph for this function:

getCutStatus()

ilObjectListGUI::getCutStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->cut_enabled;
    }

getDefaultCommand()

ilObjectListGUI::getDefaultCommand

(

)

Get default command.

Returns

array

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

    {
        return $this->default_command;
    }

getDeleteStatus()

ilObjectListGUI::getDeleteStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->delete_enabled;
    }

getDescription()

ilObjectListGUI::getDescription

(

)

getDescription overwritten in class.ilObjLinkResourceList.php

Returns

string description

Reimplemented in ilObjLinkResourceListGUI.

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

    {
        return $this->description;
    }

Referenced by insertDescription().

Here is the caller graph for this function:

getDescriptionStatus()

ilObjectListGUI::getDescriptionStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->description_enabled;
    }

References $description_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getDetailsLevel()

ilObjectListGUI::getDetailsLevel

(

)

Get current details level.

Returns

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

    {
        return $this->details_level;
    }

References $details_level.

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

Here is the caller graph for this function:

getDownloadCheckboxState()

ilObjectListGUI::getDownloadCheckboxState

(

)

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

    {
        return $this->download_checkbox_state;
    }

References $download_checkbox_state.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), and insertIconsAndCheckboxes().

Here is the caller graph for this function:

getExpandStatus()

ilObjectListGUI::getExpandStatus

(

)

Is expand/collapse enabled.

Returns

boolean icons enabled?

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

    {
        return $this->expand_enabled;
    }

References $expand_enabled.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), and insertIconsAndCheckboxes().

Here is the caller graph for this function:

getHeaderAction()

ilObjectListGUI::getHeaderAction

(

ilGlobalTemplateInterface

$a_main_tpl = null

)

Get header action.

Returns

string

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

    {
        global $DIC;
 
        $ilUser = $this->user;
        $lng = $this->lng;
 
        if ($a_main_tpl == null) {
            $main_tpl = $DIC["tpl"];
        } else {
            $main_tpl = $a_main_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_tag.svg"),
                    $lng->txt("tagging_tags").": ".count($tags),
                    ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $redraw_js),
                    count($tags));*/
 
                $f = $this->ui->factory();
                $this->addHeaderGlyph(
                    "tags",
                    $f->symbol()->glyph()->tag("#")
                    ->withCounter($f->counter()->status((int) count($tags))),
                    ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $redraw_js)
                );
            }
        }
 
        // 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");
            $type = ($this->sub_obj_type == "")
                ? $this->type
                : $this->sub_obj_type;
            $cnt = ilNote::_countNotesAndComments($this->obj_id, $this->sub_obj_id, $type);
 
            if ($this->notes_enabled && $cnt[$this->obj_id][IL_NOTE_PRIVATE] > 0) {
                /*$this->addHeaderIcon("notes",
                    ilUtil::getImagePath("note_unlabeled.svg"),
                    $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]
                    );*/
 
                $f = $this->ui->factory();
                $this->addHeaderGlyph(
                    "notes",
                    $f->symbol()->glyph()->note("#")
                    ->withCounter($f->counter()->status((int) $cnt[$this->obj_id][IL_NOTE_PRIVATE])),
                    ilNoteGUI::getListNotesJSCall($this->ajax_hash, $redraw_js)
                );
            }
 
            if ($comments_enabled && $cnt[$this->obj_id][IL_NOTE_PUBLIC] > 0) {
                $lng->loadLanguageModule("notes");
 
                /*$this->addHeaderIcon("comments",
                    ilUtil::getImagePath("comment_unlabeled.svg"),
                    $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]);*/
 
                $f = $this->ui->factory();
                $this->addHeaderGlyph(
                    "comments",
                    $f->symbol()->glyph()->comment("#")
                    ->withCounter($f->counter()->status((int) $cnt[$this->obj_id][IL_NOTE_PUBLIC])),
                    ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $redraw_js)
                );
            }
        }
 
        // 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);
            }
            $main_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["glyph"]) {
                        if ($attr["onclick"]) {
                            $htpl->setCurrentBlock("prop_glyph_oc");
                            $htpl->setVariable("GLYPH_ONCLICK", $attr["onclick"]);
                            $htpl->parseCurrentBlock();
                        }
                        $renderer = $this->ui->renderer();
                        $html = $renderer->render($attr["glyph"]);
                        $htpl->setCurrentBlock("prop_glyph");
                        $htpl->setVariable("GLYPH", $html);
                        $htpl->parseCurrentBlock();
                    } else {
                        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();
                        }
 
 
                        $htpl->setCurrentBlock("prop");
                        if ($attr["href"] || $attr["onclick"]) {
                            $htpl->setVariable("TAG", "a");
                        } else {
                            $htpl->setVariable("TAG", "span");
                        }
                        $htpl->setVariable("PROP_ID", $id);
                        $htpl->setVariable("IMG", ilUtil::img($attr["img"], $attr["tooltip"]));
                        if ($attr["href"] != "") {
                            $htpl->setVariable("PROP_HREF", ' 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) . "   "
                );
            }
        }
 
        $this->setTitle(ilObject::_lookupTitle($this->obj_id));
        $htpl->setVariable(
            "ACTION_DROP_DOWN",
            $this->insertCommands(false, false, "", true)
        );
 
        return $htpl->get();
    }

References $comments_enabled, $DIC, Vendor\Package\$f, $ilUser, $lng, $tags, $type, $user, ilNote\_countNotesAndComments(), ilObject\_lookupTitle(), ilObject\_lookupType(), addHeaderGlyph(), addHeaderIconHTML(), ilTooltipGUI\addTooltip(), ilNoteGUI\getListCommentsJSCall(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), ilTagging\getTagsForUserAndObject(), IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, ilUtil\img(), insertCommands(), isCommentsActivated(), setTitle(), and ui().

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

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjFileListGUI, ilObjGroupReferenceListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

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

References $type.

Referenced by ilObjLTIConsumerListGUI\getIconHref(), getTypeIcon(), and insertIconsAndCheckboxes().

Here is the caller graph for this function:

getIconStatus()

ilObjectListGUI::getIconStatus

(

)

Are icons enabled?

Returns

boolean icons enabled?

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

    {
        return $this->icons_enabled;
    }

References $icons_enabled.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), and insertIconsAndCheckboxes().

Here is the caller graph for this function:

getInfoScreenStatus()

ilObjectListGUI::getInfoScreenStatus

(

)

Parameters

bool

Returns

bool

Reimplemented in ilObjCategoryListGUI, and ilObjContentPageListGUI.

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

    {
        return $this->info_screen_enabled;
    }

References $info_screen_enabled.

Referenced by insertCommands().

Here is the caller graph for this function:

getItemDetailLinkStatus()

ilObjectListGUI::getItemDetailLinkStatus

(

)

get item detail link status

@access public

Returns

bool

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

    {
        return $this->item_detail_links_enabled;
    }

References $item_detail_links_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getLinkStatus()

ilObjectListGUI::getLinkStatus

(

)

Parameters

bool

Returns

bool

Definition at line 619 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 = ""
	)

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

@access 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

Reimplemented in ilObjBlogListGUI.

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

      {
        $ilUser = $this->user;
 
        // 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
        $this->initItem($a_ref_id, $a_obj_id, $type, $a_title, $a_description);
 
        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
                                );*/
                $this->addCustomProperty(
                    "",
                    $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)) {
            $this->resetCustomData();
            return "";
        }
 
        // BEGIN WEBDAV
        if ($type == 'file' and ilObjFileAccess::_isFileHidden($a_title)) {
            $this->resetCustomData();
            return "";
        }
        // END WEBDAV
 
 
        $this->tpl = new ilTemplate(
            static::$tpl_file_name,
            true,
            true,
            static::$tpl_component,
            "DEFAULT",
            false,
            true
        );
 
        if ($this->getCommandsStatus()) {
            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
        if ($this->getPropertiesStatus()) {
            $this->insertProperties();
        }
 
        // notice properties
        if ($this->getNoticePropertiesStatus()) {
            $this->insertNoticeProperties();
        }
 
        // preconditions
        if ($this->getPreconditionsStatus()) {
            $this->insertPreconditions();
        }
 
        // path
        $this->insertPath();
 
        if ($this->getItemDetailLinkStatus()) {
            $this->insertItemDetailLinks();
        }
 
        // icons and checkboxes
        $this->insertIconsAndCheckboxes();
 
        // input field for position
        $this->insertPositionField();
 
        // subitems
        $this->insertSubItems();
 
        // file upload
        if ($this->isFileUploadAllowed()) {
            $this->insertFileUpload();
        }
 
        $this->resetCustomData();
 
        $this->tpl->setVariable("DIV_CLASS", 'ilContainerListItemOuter');
        $this->tpl->setVariable("DIV_ID", 'data-list-item-id="' . $this->getUniqueItemId(true) . '" id = "' . $this->getUniqueItemId(true) . '"');
        $this->tpl->setVariable("ADDITIONAL", $this->getAdditionalInformation());
 
        if (is_object($this->getContainerObject())) {
            // #11554 - make sure that internal ids are reset
            $this->ctrl->setParameter($this->getContainerObject(), "item_ref_id", "");
        }
 
        return $this->tpl->get();
    }

References $ilUser, $type, $user, ilObjFileAccess\_isFileHidden(), ilObject\_lookupType(), addCustomProperty(), 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(), resetCustomData(), and storeAccessCache().

Referenced by ilObjStudyProgrammeReferenceListGUI\getListItemHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

getMode()

ilObjectListGUI::getMode

(

)

get output mode

Returns

string output mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER)

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

    {
        return $this->mode;
    }

getNoticeProperties()

ilObjectListGUI::getNoticeProperties

(

)

get notice properties

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

    {
        $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();
    }

Referenced by insertNoticeProperties().

Here is the caller graph for this function:

getNoticePropertiesStatus()

ilObjectListGUI::getNoticePropertiesStatus

(

)

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

    {
        return $this->notice_properties_enabled;
    }

References $notice_properties_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getPathStatus()

ilObjectListGUI::getPathStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->path_enabled;
    }

Referenced by insertPath().

Here is the caller graph for this function:

getPreconditionsStatus()

ilObjectListGUI::getPreconditionsStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->preconditions_enabled;
    }

References $preconditions_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getProgressInfoStatus()

ilObjectListGUI::getProgressInfoStatus

(

)

get progress info status

@access public

Parameters

return

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

    {
        return $this->progress_enabled;
    }

References $progress_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getProperties()

ilObjectListGUI::getProperties

(

)

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

Reimplemented in ilObjBibliographicListGUI, ilObjBookingPoolListGUI, ilObjCategoryReferenceListGUI, ilObjChatroomListGUI, ilObjCloudListGUI, ilObjCmiXapiListGUI, ilObjCmiXapiVerificationListGUI, ilObjContentPageListGUI, ilCourseObjectiveListGUI, ilObjCourseListGUI, ilObjCourseVerificationListGUI, ilObjCourseReferenceListGUI, ilObjDataCollectionListGUI, ilObjExerciseListGUI, ilObjExerciseVerificationListGUI, ilObjExternalFeedListGUI, ilObjFileListGUI, ilObjFolderListGUI, ilObjForumListGUI, ilObjGlossaryListGUI, ilObjGroupListGUI, ilObjGroupReferenceListGUI, ilObjFileBasedLMListGUI, ilObjIndividualAssessmentListGUI, ilObjItemGroupListGUI, ilObjLearningModuleListGUI, ilObjLearningSequenceListGUI, ilObjLTIConsumerListGUI, ilObjLTIConsumerVerificationListGUI, ilObjMediaCastListGUI, ilObjMediaPoolListGUI, ilObjPollListGUI, ilObjPortfolioTemplateListGUI, ilObjRemoteCategoryListGUI, ilObjRemoteCourseListGUI, ilObjRemoteFileListGUI, ilObjRemoteGlossaryListGUI, ilObjRemoteGroupListGUI, ilObjRemoteLearningModuleListGUI, ilObjRemoteTestListGUI, ilObjRemoteWikiListGUI, ilObjSAHSLearningModuleListGUI, ilObjSCORMVerificationListGUI, ilObjSessionListGUI, ilObjStudyProgrammeReferenceListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjTestListGUI, ilObjTestVerificationListGUI, ilObjQuestionPoolListGUI, ilObjLinkResourceListGUI, ilObjWikiListGUI, and ilObjectPluginListGUI.

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

    {
        $lng = $this->lng;
        $ilUser = $this->user;
 
        $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) {
            // add centralized offline status
            if (ilObject::lookupOfflineStatus($this->obj_id)) {
                $props[] =
                    [
                        'alert' => true,
                        'property' => $lng->txt("status"),
                        'value' => $lng->txt("offline")
                    ];
            }
 
            // BEGIN WebDAV Display locking information
            require_once('Services/WebDAV/classes/class.ilDAVActivationChecker.php');
            if (ilDAVActivationChecker::_isActive()) {
                // Show lock info
                require_once('Services/WebDAV/classes/lock/class.ilWebDAVLockBackend.php');
                $webdav_lock_backend = new ilWebDAVLockBackend();
                if ($ilUser->getId() != ANONYMOUS_USER_ID) {
                    if ($lock = $webdav_lock_backend->getLocksOnObjectId($this->obj_id)) {
                        $lock_user = new ilObjUser($lock->getIliasOwner());
 
                        $props[] = array(
                            "alert" => false,
                            "property" => $lng->txt("in_use_by"),
                            "value" => $lock_user->getLogin(),
                            "link" => "./ilias.php?user=" . $lock_user->getId() . '&cmd=showUserProfile&cmdClass=ildashboardgui&baseClass=ilDashboardGUI',
                        );
                    }
                }
                // END WebDAV Display locking information
 
                if ($this->getDetailsLevel() == self::DETAILS_SEARCH) {
                    return $props;
                }
            }
            // END WebDAV Display warning for invisible files and files with special characters
        }
 
        return $props;
    }

References $ilUser, $lng, $user, ilDAVActivationChecker\_isActive(), ANONYMOUS_USER_ID, getDetailsLevel(), and ilObject\lookupOfflineStatus().

Referenced by determineProperties(), and getAlertProperties().

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 292 of file class.ilObjectListGUI.php.

    {
        return $this->properties_enabled;
    }

References $properties_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getRelevance()

ilObjectListGUI::getRelevance

(

)

get relevance

Parameters

return

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

    {
        return $this->relevance;
    }

References $relevance.

Referenced by insertRelevance().

Here is the caller graph for this function:

getSearchFragment()

ilObjectListGUI::getSearchFragment

(

)

get search fragment

Returns

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

    {
        return $this->search_fragment;
    }

References $search_fragment.

Referenced by insertSearchFragment().

Here is the caller graph for this function:

getSearchFragmentStatus()

ilObjectListGUI::getSearchFragmentStatus

(

)

Show hide search result fragments.

Parameters

bool

Returns

bool

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

    {
        return $this->search_fragment_enabled;
    }

References $search_fragment_enabled.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getSeparateCommands()

ilObjectListGUI::getSeparateCommands

(

)

Get separate commands.

Returns

boolean separate commands

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

    {
        return $this->separate_commands;
    }

References $separate_commands.

Referenced by getListItemHTML().

Here is the caller graph for this function:

getSubscribeStatus()

ilObjectListGUI::getSubscribeStatus

(

)

Parameters

bool

Returns

bool

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

    {
        return $this->subscribe_enabled;
    }

getSubstitutionStatus()

ilObjectListGUI::getSubstitutionStatus

(

)

Get substitution status.

@access public

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

    {
        return $this->substitutions_enabled;
    }

References $substitutions_enabled.

Referenced by insertDescription().

Here is the caller graph for this function:

getTileImagePath()

ilObjectListGUI::getTileImagePath ( )

protected

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

                                          : string
    {
        $img = $this->object_service->commonSettings()->tileImage()->getByObjId($this->obj_id);
        if ($img->exists()) {
            $path = $img->getFullPath();
        } else {
            $path = ilUtil::getImagePath('cont_tile/cont_tile_default_' . $this->type . '.svg');
            if (!is_file($path)) {
                $path = ilUtil::getImagePath('cont_tile/cont_tile_default.svg');
            }
        }
        return $path;
    }

References $img, and ilUtil\getImagePath().

Here is the call graph for this function:

getTitle()

ilObjectListGUI::getTitle

(

)

getTitle overwritten in class.ilObjLinkResourceList.php

Returns

string title

Reimplemented in ilObjFileListGUI, ilObjSessionListGUI, and ilObjLinkResourceListGUI.

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

    {
        return $this->title;
    }

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

Here is the caller graph for this function:

getTypeIcon()

ilObjectListGUI::getTypeIcon

(

)

Get object type specific type icon.

Returns

string

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjGroupReferenceListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

    {
        return ilObject::getIconForReference(
            (int) $this->ref_id,
            (int) $this->obj_id,
            (string) 'small',
            $this->getIconImageType()
        );
    }

References getIconImageType().

Referenced by insertIconsAndCheckboxes().

Here is the call graph for this function:

Here is the caller graph for this function:

getUniqueItemId()

ilObjectListGUI::getUniqueItemId

(

$a_as_div = false

)

Get unique item identifier (for js-actions)

Parameters

bool

$a_as_div

Returns

string

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

    {
        // 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;
        }
    }

References $condition_depth, and $parent_ref_id.

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

Here is the caller graph for this function:

init()

ilObjectListGUI::init

(

)

initialisation

this method should be overwritten by derived classes

Reimplemented in ilObjBibliographicListGUI, ilObjBlogListGUI, ilObjBookingPoolListGUI, ilObjCategoryListGUI, ilObjCategoryReferenceListGUI, ilObjChatroomListGUI, ilObjCloudListGUI, ilObjCmiXapiListGUI, ilObjCmiXapiVerificationListGUI, ilObjContentPageListGUI, ilCourseObjectiveListGUI, ilObjCourseListGUI, ilObjCourseVerificationListGUI, ilObjCourseReferenceListGUI, ilObjDataCollectionListGUI, ilObjExerciseListGUI, ilObjExerciseVerificationListGUI, ilObjExternalFeedListGUI, ilObjFileListGUI, ilObjFolderListGUI, ilObjForumListGUI, ilObjGlossaryListGUI, ilObjGroupListGUI, ilObjGroupReferenceListGUI, ilObjFileBasedLMListGUI, ilObjIndividualAssessmentListGUI, ilObjItemGroupListGUI, ilObjLearningModuleListGUI, ilObjLearningSequenceListGUI, ilObjLTIConsumerListGUI, ilObjLTIConsumerVerificationListGUI, ilObjMediaCastListGUI, ilObjMediaPoolListGUI, ilObjOrgUnitListGUI, ilObjPollListGUI, ilObjPortfolioTemplateListGUI, ilObjRemoteCategoryListGUI, ilObjRemoteCourseListGUI, ilObjRemoteFileListGUI, ilObjRemoteGlossaryListGUI, ilObjRemoteGroupListGUI, ilObjRemoteLearningModuleListGUI, ilObjRemoteTestListGUI, ilObjRemoteWikiListGUI, ilObjRootFolderListGUI, ilObjSAHSLearningModuleListGUI, ilObjSCORMVerificationListGUI, ilObjSessionListGUI, ilObjStudyProgrammeListGUI, ilObjStudyProgrammeReferenceListGUI, ilObjSurveyListGUI, ilObjSurveyQuestionPoolListGUI, ilObjTestListGUI, ilObjTestVerificationListGUI, ilObjQuestionPoolListGUI, ilObjLinkResourceListGUI, ilObjWikiListGUI, ilObjWorkspaceFolderListGUI, ilObjWorkspaceRootFolderListGUI, and ilObjectPluginListGUI.

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

    {
        // 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->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();
    }

References ilObjectAccess\_getCommands().

Referenced by __construct().

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,
			$type,
			$a_title = "",
			$a_description = ""
	)

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

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseListGUI, ilObjCourseReferenceListGUI, ilObjGroupReferenceListGUI, ilObjSAHSLearningModuleListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

    {
        $this->offline_mode = false;
        if ($this->type == "sahs") {
            include_once('Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php');
            $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->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;
 
        // prepare ajax calls
        include_once "Services/Object/classes/class.ilCommonActionDispatcherGUI.php";
        if ($this->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));
    }

References $type, ilObjSAHSLearningModuleAccess\_lookupUserIsOfflineMode(), ilCommonActionDispatcherGUI\buildAjaxHash(), setAjaxHash(), setDescription(), setTitle(), ilCommonActionDispatcherGUI\TYPE_REPOSITORY, and ilCommonActionDispatcherGUI\TYPE_WORKSPACE.

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

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

@access private

Parameters

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

Reimplemented in ilObjBlogListGUI.

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

    {
        // #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') {
                $a_onclick = "triggerWebDAVModal('$a_href')";
                $a_href = "#";
                ilWebDAVMountInstructionsModalGUI::maybeRenderWebDAVModalInGlobalTpl();
            }
 
            $this->current_selection_list->addItem(
                $a_text,
                "",
                $a_href,
                $a_img,
                $a_text,
                $a_frame,
                "",
                $prevent_background_click,
                $a_onclick
            );
        }
    }

References ilWebDAVMountInstructionsModalGUI\maybeRenderWebDAVModalInGlobalTpl().

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

Here is the call graph for this function:

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

Parameters

bool	$a_use_asynch
bool	$a_get_asynch_commands
string	$a_asynch_url
bool	$a_header_actions

Returns

string

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

      {
        $lng = $this->lng;
        $ilUser = $this->user;
 
        if (!$this->getCommandsStatus()) {
            return;
        }
 
        include_once("Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
        $this->current_selection_list = new ilAdvancedSelectionListGUI();
        $this->current_selection_list->setAriaListTitle(
            sprintf(
                $this->lng->txt('actions_for'),
                htmlspecialchars(addslashes($this->getTitle()))
            )
        );
        $this->current_selection_list->setAsynch($a_use_asynch && !$a_get_asynch_commands);
        $this->current_selection_list->setAsynchUrl($a_asynch_url);
        if ($a_header_actions) {
            $this->current_selection_list->setListTitle("<span class='hidden-xs'>" . $lng->txt("actions") . "</span>");
        } else {
            $this->current_selection_list->setListTitle("");
        }
        $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");
 
        $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"]);
 
                        $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;
                }
            }
        }
 
        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
            }
        }
 
        // 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->checkInfoPageOnAsynchronousRendering()) {
                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();
    }

References $ilUser, $lng, $txt, $user, ilContainer\_lookupContainerSetting(), ANONYMOUS_USER_ID, appendRepositoryFrameParameter(), createDefaultCommand(), ilAdvancedSelectionListGUI\DOWN_ARROW_DARK, getCommands(), getCommandsStatus(), getInfoScreenStatus(), getTitle(), getUniqueItemId(), IL_LIST_AS_TRIGGER, ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, insertCommand(), insertCommonSocialCommands(), insertCopyCommand(), insertCutCommand(), insertDeleteCommand(), insertInfoScreenCommand(), insertLinkCommand(), insertMultiDownloadCommand(), insertPasteCommand(), insertSubscribeCommand(), insertTimingsCommand(), and isMode().

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

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

return

Reimplemented in ilObjOrgUnitListGUI, and ilObjStudyProgrammeListGUI.

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

    {
        $lng = $this->lng;
        $ilUser = $this->user;
 
        if ($this->std_cmd_only ||
            ($ilUser->getId() == ANONYMOUS_USER_ID)) {
            return;
        }
        $lng->loadLanguageModule("notes");
        $lng->loadLanguageModule("tagging");
        $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)
            );
        }
    }

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

Referenced by insertCommands().

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 2204 of file class.ilObjectListGUI.php.

    {
        $objDefinition = $this->obj_definition;
 
        if ($this->std_cmd_only) {
            return;
        }
 
        if ($this->checkCommandAccess('copy', 'copy', $this->ref_id, $this->type) &&
            $objDefinition->allowCopy($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;
    }

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

Referenced by insertCommands().

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

@access protected

Parameters

bool

$a_to_repository

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

    {
        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"),
                    "",
                    ""
                );
            } else {
                $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, "cut_for_repository");
                $this->insertCommand(
                    $cmd_link,
                    $this->lng->txt("wsp_move_to_repository"),
                    "",
                    ""
                );
            }
 
            $this->adm_commands_included = true;
        }
    }

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

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertDeleteCommand()

ilObjectListGUI::insertDeleteCommand

(

)

insert cut command

@access private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

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

    {
        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"),
                "",
                ""
            );
            $this->adm_commands_included = true;
        }
    }

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

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertDescription()

ilObjectListGUI::insertDescription

(

)

insert item description

@access private

Parameters

object	$a_tpl	template object
string	$a_desc	item description

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

    {
        if ($this->getSubstitutionStatus()) {
            $this->insertSubstitutions();
            if (!$this->substitutions->isDescriptionEnabled()) {
                return true;
            }
        }
 
        // see bug #16519
        $d = $this->getDescription();
        // even b tag produced bugs, see #32304
        $d = strip_tags($d);
        $this->tpl->setCurrentBlock("item_description");
        $this->tpl->setVariable("TXT_DESC", $d);
        $this->tpl->parseCurrentBlock();
    }

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

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

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 3723 of file class.ilObjectListGUI.php.

    {
        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();
    }

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

Referenced by getListItemHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

insertIconsAndCheckboxes()

ilObjectListGUI::insertIconsAndCheckboxes

(

)

Insert icons and checkboxes.

Reimplemented in ilObjLTIConsumerListGUI, and ilObjOrgUnitListGUI.

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

    {
        $lng = $this->lng;
        $objDefinition = $this->obj_definition;
 
        $cnt = 0;
        if ($this->getCheckboxStatus()) {
            $this->tpl->setCurrentBlock("check");
            $this->tpl->setVariable("VAL_ID", $this->getCommandId());
            $this->tpl->parseCurrentBlock();
            $cnt += 1;
        } elseif ($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);
                // "view" added, see #19922
                $this->tpl->setVariable('EXP_HREF', $this->ctrl->getLinkTarget($this->container_obj, 'view', $this->getUniqueItemId(true)));
                $this->ctrl->clearParameters($this->container_obj);
                $this->tpl->setVariable('EXP_IMG', ilUtil::getImagePath('tree_exp.svg'));
                $this->tpl->setVariable('EXP_ALT', $this->lng->txt('collapse'));
            } else {
                $this->ctrl->setParameter($this->container_obj, 'expand', $this->obj_id);
                // "view" added, see #19922
                $this->tpl->setVariable('EXP_HREF', $this->ctrl->getLinkTarget($this->container_obj, 'view', $this->getUniqueItemId(true)));
                $this->ctrl->clearParameters($this->container_obj);
                $this->tpl->setVariable('EXP_IMG', ilUtil::getImagePath('tree_col.svg'));
                $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->title_link_disabled || !$this->default_command || (!$this->getCommandsStatus() && !$this->restrict_to_goto)) {
            } else {
                /*  see #28926
                $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("obj_" . $this->getIconImageType()));
            } else {
                include_once("Services/Component/classes/class.ilPlugin.php");
                $this->tpl->setVariable(
                    "ALT_ICON",
                    ilObjectPlugin::lookupTxtById($this->getIconImageType(), "obj_" . $this->getIconImageType())
                );
            }
 
            $this->tpl->setVariable(
                "SRC_ICON",
                $this->getTypeIcon()
            );
            $this->tpl->parseCurrentBlock();
            $cnt += 1;
        }
 
        $this->tpl->touchBlock("d_" . $cnt);    // indent main div
    }

References $lng, $obj_definition, getCheckboxStatus(), getCommandId(), getCommandsStatus(), getDownloadCheckboxState(), getExpandStatus(), getIconImageType(), getIconStatus(), ilUtil\getImagePath(), getTypeIcon(), isExpanded(), and ilObjectPlugin\lookupTxtById().

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

Here is the call graph for this function:

Here is the caller graph for this function:

insertInfoScreenCommand()

ilObjectListGUI::insertInfoScreenCommand

(

)

insert info screen command

Reimplemented in ilObjOrgUnitListGUI.

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

    {
        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("icon_info.svg")
        );
    }

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

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertItemDetailLinks()

ilObjectListGUI::insertItemDetailLinks

(

)

insert item detail links

@access public

Parameters

return

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

    {
        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();
    }

Referenced by getListItemHTML().

Here is the caller graph for this function:

insertLinkCommand()

ilObjectListGUI::insertLinkCommand

(

)

insert link command

@access private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

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

    {
        $objDefinition = $this->obj_definition;
 
        if ($this->std_cmd_only) {
            return;
        }
 
        // #17307
        if (!$this->checkCommandAccess('delete', '', $this->ref_id, $this->type) or
            !$objDefinition->allowLink($this->type)) {
            return false;
        }
 
        // BEGIN PATCH Lucene search
 
        if (is_object($this->getContainerObject()) and
            $this->getContainerObject() instanceof ilAdministrationCommandHandling) {
            $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;
        }
        // END PATCH Lucene Search
 
        // if the permission is changed here, it  has
        // also to be changed in ilContainerGUI, admin command check
        $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"),
            "",
            ""
        );
        $this->adm_commands_included = true;
        return true;
    }

References $obj_definition, checkCommandAccess(), getCommandId(), getContainerObject(), and insertCommand().

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertMultiDownloadCommand()

ilObjectListGUI::insertMultiDownloadCommand

(

)

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

    {
        $objDefinition = $this->obj_definition;
 
        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", "");
            // bugfix mantis 24559
            // undoing an erroneous change inside mantis 23516 by adding "Download Multiple Objects"-functionality for non-admins
            // as they don't have the possibility to use the multi-download-capability of the manage-tab
            $user_id = $this->user->getId();
            $hasAdminAccess = $this->access->checkAccessOfUser($user_id, "crs_admin", $this->ctrl->getCmd(), $_GET['ref_id']);
            // to still prevent duplicate download functions for admins the following if-else statement keeps the redirection for admins
            // while letting other course members access the original multi-download functionality
            if ($hasAdminAccess) {
                $cmd = $_GET["cmd"] == "enableAdministrationPanel" ? "render" : "enableAdministrationPanel";
            } else {
                $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;
    }

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

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertNoticeProperties()

ilObjectListGUI::insertNoticeProperties

(

)

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

    {
        $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();
    }

References getNoticeProperties().

Referenced by getListItemHTML().

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 2244 of file class.ilObjectListGUI.php.

    {
        $objDefinition = $this->obj_definition;
 
        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;
    }

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

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertPath()

ilObjectListGUI::insertPath

(

)

insert path

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

    {
        $lng = $this->lng;
 
        if ($this->getPathStatus() != false) {
            if (!$this->path_gui instanceof \ilPathGUI) {
                $path_gui = new \ilPathGUI();
            } else {
                $path_gui = $this->path_gui;
            }
 
            $path_gui->enableTextOnly(!$this->path_linked);
            $path_gui->setUseImages(false);
 
            $start_node = $this->path_start_node
                ? $this->path_start_node
                : ROOT_FOLDER_ID;
 
            $this->tpl->setCurrentBlock("path_item");
            $this->tpl->setVariable('PATH_ITEM', $path_gui->getPath($start_node, $this->ref_id));
            $this->tpl->parseCurrentBlock();
 
            $this->tpl->setCurrentBlock("path");
            $this->tpl->setVariable("TXT_LOCATION", $lng->txt("locator"));
            $this->tpl->parseCurrentBlock();
            return true;
        }
    }

References $lng, $path_gui, getPathStatus(), and ROOT_FOLDER_ID.

Referenced by getListItemHTML().

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 3308 of file class.ilObjectListGUI.php.

    {
        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();
        }
    }

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

Here is the caller graph for this function:

insertPreconditions()

ilObjectListGUI::insertPreconditions

(

)

insert all missing preconditions

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

    {
        include_once("./Services/Conditions/classes/class.ilConditionHandler.php");
 
        // do not show multi level conditions (messes up layout)
        if ($this->condition_depth > 0) {
            return;
        }
 
        if ($this->condition_target) {
            $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget(
                $this->condition_target['ref_id'],
                $this->condition_target['obj_id'],
                $this->condition_target['target_type']
            );
        } else {
            $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget($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');
 
            ++self::$js_unique_id;
 
            // Show obligatory and optional preconditions seperated
            $all_done_obl = $this->parseConditions(self::$js_unique_id, $conditions, true);
            $all_done_opt = $this->parseConditions(self::$js_unique_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", self::$js_unique_id);
                $this->tpl->setVariable("TXT_PRECONDITION_SHOW", $this->lng->txt("show"));
                $this->tpl->setVariable("TXT_PRECONDITION_HIDE", $this->lng->txt("hide"));
                $this->tpl->parseCurrentBlock();
            }
        }
    }

References $i, $js_unique_id, ilObject\_lookupTitle(), parseConditions(), and ilUtil\sortArray().

Referenced by getListItemHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

insertProgressInfo()

ilObjectListGUI::insertProgressInfo

(

)

insert progress info

@access public

Returns

Reimplemented in ilCourseObjectiveListGUI.

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

    {
        return true;
    }

Referenced by getListItemHTML().

Here is the caller graph for this function:

insertProperties()

ilObjectListGUI::insertProperties

(

)

insert properties

@access private

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

    {
        $props = $this->determineProperties();
        $cnt = 1;
        if (is_array($props) && count($props) > 0) {
            foreach ($props as $prop) {
                if ($cnt > 1) {
                    $this->tpl->touchBlock("separator_prop");
                }
 
                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 && $prop["property"] != "") {
                    //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();
        }
    }

References determineProperties().

Referenced by getListItemHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

insertRelevance()

ilObjectListGUI::insertRelevance

(

)

insert relevance

Parameters

return

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

    {
        if (!$this->enabledRelevance() or !(int) $this->getRelevance()) {
            return false;
        }
 
        include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";
        $pbar = ilProgressBar::getInstance();
        $pbar->setCurrent($this->getRelevance());
 
        $this->tpl->setCurrentBlock('relevance');
        $this->tpl->setVariable('REL_PBAR', $pbar->render());
        $this->tpl->parseCurrentBlock();
    }

References enabledRelevance(), ilProgressBar\getInstance(), and getRelevance().

Referenced by getListItemHTML().

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 1611 of file class.ilObjectListGUI.php.

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

References getSearchFragment().

Referenced by getListItemHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

insertSubItems()

ilObjectListGUI::insertSubItems

(

)

Insert subitems.

Reimplemented in ilStudyProgrammeCourseListGUI.

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

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

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

Here is the caller graph for this function:

insertSubscribeCommand()

ilObjectListGUI::insertSubscribeCommand

(

)

insert subscribe command

@access private

Parameters

object	$a_tpl	template object
int	$a_ref_id	item reference id

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

    {
        $ilSetting = $this->settings;
        $ilUser = $this->user;
 
        if ($this->std_cmd_only) {
            return;
        }
 
        // note: the setting disable_my_offers is used for
        // presenting the favourites in the main section of the dashboard
        // see also bug #32014
        if (!(bool) $ilSetting->get('rep_favourites', "0")) {
            return;
        }
 
        $type = ilObject::_lookupType(ilObject::_lookupObjId($this->getCommandId()));
 
        if ($ilUser->getId() != ANONYMOUS_USER_ID) {
            // #17467 - add ref_id to link (in repository only!)
            if (is_object($this->container_obj) &&
                !($this->container_obj instanceof ilAdministrationCommandHandling) &&
                is_object($this->container_obj->object)) {
                $this->ctrl->setParameter($this->container_obj, "ref_id", $this->container_obj->object->getRefId());
            }
 
            if (!$this->fav_manager->ifIsFavourite($ilUser->getId(), $this->getCommandId())) {
                // Pass type and object ID to ilAccess to improve performance
                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("rep_add_to_favourites"),
                            "",
                            ""
                        );
                    }
                }
            } 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("rep_remove_from_favourites"),
                        "",
                        ""
                    );
                }
            }
        }
    }

References $ilSetting, $ilUser, $settings, $type, $user, ilObject\_lookupObjId(), ilObject\_lookupType(), ANONYMOUS_USER_ID, checkCommandAccess(), getCommandId(), getContainerObject(), and insertCommand().

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertSubstitutions()

ilObjectListGUI::insertSubstitutions

(

)

Insert substitutions.

@access public

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

    {
        $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');
        }
    }

References $data.

Referenced by insertDescription().

Here is the caller graph for this function:

insertTimingsCommand()

ilObjectListGUI::insertTimingsCommand

(

)

insert edit timings command

@access protected

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjGroupReferenceListGUI, ilObjOrgUnitListGUI, ilObjStudyProgrammeListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

    {
        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();
 
        // #18737
        if ($this->reference_ref_id) {
            $this->ctrl->setParameterByClass('ilobjectactivationgui', 'ref_id', $this->reference_ref_id);
        }
 
        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'));
        }
 
        if ($this->reference_ref_id) {
            $this->ctrl->setParameterByClass('ilobjectactivationgui', 'ref_id', $this->ref_id);
        }
    }

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

Referenced by insertCommands().

Here is the call graph for this function:

Here is the caller graph for this function:

insertTitle()

ilObjectListGUI::insertTitle

(

)

insert item title

@access private

Parameters

object	$a_tpl	template object
string	$a_title	item title

Reimplemented in ilCourseObjectiveListGUI.

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

    {
        if ($this->restrict_to_goto) {
            $this->default_command = array("frame" => "",
                "link" => $this->buildGotoLink());
        }
        // begin-patch lok
        if (
                !$this->default_command ||
                (!$this->getCommandsStatus() && !$this->restrict_to_goto) ||
                $this->title_link_disabled
        ) {
            // end-patch lok
            $this->tpl->setCurrentBlock("item_title");
            $this->tpl->setVariable("TXT_TITLE", $this->getTitle());
            $this->tpl->parseCurrentBlock();
        } else {
            $this->default_command['link'] = $this->modifyTitleLink($this->default_command['link']);
 
            $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;
                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:
                        $ilAccess = $this->access;
                        $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"));
                $this->tpl->setVariable("ALT_PREVIEW_ICON", $this->lng->txt($preview_text_topic));
                $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');
        }
    }

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

Referenced by getListItemHTML().

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

Reimplemented in ilOrgUnitExtensionListGUI.

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

    {
        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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

isExpanded()

ilObjectListGUI::isExpanded

(

)

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

    {
        return $this->is_expanded;
    }

References $is_expanded.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), and insertIconsAndCheckboxes().

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 3713 of file class.ilObjectListGUI.php.

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

References ilFileUploadUtil\isUploadAllowed().

Referenced by getListItemHTML().

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 1675 of file class.ilObjectListGUI.php.

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

Referenced by getListItemHTML(), and insertCommands().

Here is the caller graph for this function:

isSideBlock()

ilObjectListGUI::isSideBlock

(

)

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

Reimplemented in ilObjExternalFeedListGUI.

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

    {
        return false;
    }

isTitleBold()

ilObjectListGUI::isTitleBold

(

)

@access public

Returns

boolean returns if the item title is bold or not

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

    {
        return $this->bold_title;
    }

References $bold_title.

isVisibleOnlyForced()

ilObjectListGUI::isVisibleOnlyForced

(

)

Force unreadable.

Returns

type

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

    {
        return $this->force_visible_only;
    }

References $force_visible_only.

Referenced by checkCommandAccess().

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 3122 of file class.ilObjectListGUI.php.

    {
        global $DIC;
 
        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 == 5 || $om == 1) && $width > 0 && $height > 0) {
                $om++;
            }
            if ($om != 0 && !$DIC['ilBrowser']->isMobile()) {
                $this->default_command["frame"] = "";
                $a_link = "javascript:void(0); onclick=startSAHS('" . $a_link . "','" . $wtarget . "'," . $om . "," . $width . "," . $height . ");";
            }
        }
        return $a_link;
    }

References $DIC.

Referenced by insertTitle().

Here is the caller graph for this function:

modifyTitleLink()

ilObjectListGUI::modifyTitleLink (   $a_default_link )

protected

Reimplemented in ilObjTestListGUI.

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

    {
        if ($this->default_command_params) {
            $params = array();
            foreach ($this->default_command_params as $name => $value) {
                $params[] = $name . '=' . $value;
            }
            $params = implode('&', $params);
 
 
            // #12370
            if (!stristr($a_default_link, '?')) {
                $a_default_link = ($a_default_link . '?' . $params);
            } else {
                $a_default_link = ($a_default_link . '&' . $params);
            }
        }
        return $a_default_link;
    }

References $name.

Referenced by insertTitle().

Here is the caller graph for this function:

parseConditions()

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

protected

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

    {
        $lng = $this->lng;
        $objDefinition = $this->obj_definition;
        $tree = $this->tree;
 
        $num_required = ilConditionHandler::calculateEffectiveRequiredTriggers($this->ref_id, $this->obj_id);
        $num_optional_required =
            $num_required - count($conditions) + count(ilConditionHandler::getEffectiveOptionalConditionsOfTarget($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) 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;
            }
 
            include_once './Services/Conditions/classes/class.ilConditionHandlerGUI.php';
            $cond_txt = ilConditionHandlerGUI::translateOperator($condition['trigger_obj_id'], $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);
 
            $item_list_gui->enableCommands($this->commands_enabled, $this->std_cmd_only);
            $item_list_gui->enableProperties($this->properties_enabled);
 
            $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;
    }

References $lng, $location, $obj_definition, $ok, $tree, ilConditionHandler\_checkCondition(), ilObject\_lookupTitle(), ilConditionHandler\calculateEffectiveRequiredTriggers(), ilConditionHandler\getEffectiveOptionalConditionsOfTarget(), ilMemberViewSettings\getInstance(), getUniqueItemId(), IL_LIST_AS_TRIGGER, and ilConditionHandlerGUI\translateOperator().

Referenced by insertPreconditions().

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

return

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

    {
        global $DIC;
        $lng = $DIC->language();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        if ($a_context == self::CONTEXT_REPOSITORY) {
            $active_notes = !$ilSetting->get("disable_notes");
            $active_comments = !$ilSetting->get("disable_comments");
 
            if ($active_notes || $active_comments) {
                include_once("./Services/Notes/classes/class.ilNote.php");
            }
 
            if ($active_comments) {
                // needed for action
                self::$comments_activation = ilNote::getRepObjActivation($a_obj_ids);
            }
 
            // properties are optional
            if ($ilSetting->get('comments_tagging_in_lists')) {
                if ($active_notes || $active_comments) {
                    self::$cnt_notes = ilNote::_countNotesAndCommentsMultiple($a_obj_ids, true);
 
                    $lng->loadLanguageModule("notes");
                }
 
                $tags_set = new ilSetting("tags");
                if ($tags_set->get("enable")) {
                    $all_users = $tags_set->get("enable_all_users");
 
                    include_once("./Services/Tagging/classes/class.ilTagging.php");
                    if (!$ilSetting->get('comments_tagging_in_lists_tags')) {
                        self::$cnt_tags = ilTagging::_countTags($a_obj_ids, $all_users);
                    } else {
                        $tag_user_id = null;
                        if (!$all_users) {
                            $tag_user_id = $ilUser->getId();
                        }
                        self::$tags = ilTagging::_getListTagsForObjects($a_obj_ids, $tag_user_id);
                    }
 
                    $lng->loadLanguageModule("tagging");
                }
            }
 
            $lng->loadLanguageModule("rating");
        }
 
        self::$preload_done = true;
    }

References $DIC, $ilSetting, $ilUser, $lng, ilNote\_countNotesAndCommentsMultiple(), ilTagging\_countTags(), ilTagging\_getListTagsForObjects(), and ilNote\getRepObjActivation().

Referenced by ilObjectListGUIPreloader\preload().

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 2800 of file class.ilObjectListGUI.php.

    {
        global $DIC;
        $tpl = $DIC["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, IL_NOTE_PRIVATE, $a_tpl);
        }
 
        if ($a_tags_url) {
            include_once("./Services/Tagging/classes/class.ilTaggingGUI.php");
            ilTaggingGUI::initJavascript($a_tags_url, $a_tpl);
        }
 
        if ($a_redraw_url) {
            $a_tpl->addOnLoadCode("il.Object.setRedrawAHUrl('" .
                        $a_redraw_url . "');");
        }
    }

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

Referenced by ilObjWorkspaceFolderGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

resetConditionTarget()

ilObjectListGUI::resetConditionTarget

(

)

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

    {
        $this->condition_target = array();
    }

resetCustomData()

ilObjectListGUI::resetCustomData ( )

protected

reset properties and commands

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

    {
        // #15747
        $this->cust_prop = array();
        $this->cust_commands = array();
        $this->sub_item_html = array();
        $this->position_enabled = false;
    }

Referenced by getListItemHTML().

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 968 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 917 of file class.ilObjectListGUI.php.

    {
        $this->additional_information = $a_val;
    }

Referenced by ilObjStudyProgrammeListGUI\getListItemHTML(), and ilObjStudyProgrammeReferenceListGUI\getListItemHTML().

Here is the caller graph for this function:

setAjaxHash()

ilObjectListGUI::setAjaxHash

(

$a_hash

)

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

    {
        $this->ajax_hash = $a_hash;
    }

Referenced by initItem().

Here is the caller graph for this function:

setBoldTitle()

ilObjectListGUI::setBoldTitle

(

$a_bold_title

)

@access public @params boolean $a_bold_title set the item title bold

Definition at line 3588 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 1663 of file class.ilObjectListGUI.php.

    {
        $this->condition_depth = $a_depth;
    }

setConditionTarget()

ilObjectListGUI::setConditionTarget	(		$a_ref_id,
			$a_obj_id,
			$a_target_type
	)

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

    {
        $this->condition_target = array(
            'ref_id' => $a_ref_id,
            'obj_id' => $a_obj_id,
            'target_type' => $a_target_type
        );
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

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 230 of file class.ilObjectListGUI.php.

    {
        $this->container_obj = $container_obj;
    }

setDefaultCommandParameters()

ilObjectListGUI::setDefaultCommandParameters

(

array

$a_params

)

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

    {
        $this->default_command_params = $a_params;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

setDescription()

ilObjectListGUI::setDescription

(

$a_description

)

Parameters

string

description

Returns

bool

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

    {
        $this->description = strip_tags(
            $a_description,
            ilObjectGUI::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
        );
    }

References ilObjectGUI\ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION.

Referenced by initItem().

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 939 of file class.ilObjectListGUI.php.

    {
        $this->details_level = $a_level;
    }

setExpanded()

ilObjectListGUI::setExpanded

(

$a_status

)

Definition at line 491 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 2831 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

@access public

Parameters

array

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

Returns

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

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

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

setMode()

ilObjectListGUI::setMode

(

$a_mode

)

set output mode

Parameters

string

$a_mode

output mode (IL_LIST_FULL | IL_LIST_AS_TRIGGER)

Definition at line 1645 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

string

$a_ref_id

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

    {
        $this->parent_ref_id = $a_ref_id;
    }

Referenced by __construct().

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 506 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 416 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 865 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 884 of file class.ilObjectListGUI.php.

    {
        $this->separate_commands = $a_val;
    }

setTitle()

ilObjectListGUI::setTitle

(

$a_title

)

Parameters

string

title

Returns

bool

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

    {
        $this->title = strip_tags(
            $a_title,
            ilObjectGUI::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
        );
    }

References ilObjectGUI\ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION.

Referenced by getHeaderAction(), ilObjStudyProgrammeReferenceListGUI\initItem(), and initItem().

Here is the caller graph for this function:

storeAccessCache()

ilObjectListGUI::storeAccessCache

(

)

Store access cache.

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

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

References $ilUser, and $user.

Referenced by getListItemHTML().

Here is the caller graph for this function:

Field Documentation

$access

ilObjectListGUI::$access

protected

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

Referenced by checkCommandAccess(), determineProperties(), enableDownloadCheckbox(), getCommands(), ilObjCategoryReferenceListGUI\initItem(), and insertTitle().

$additional_information

ilObjectListGUI::$additional_information = false

protected

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

Referenced by getAdditionalInformation().

$bold_title

ilObjectListGUI::$bold_title = false

protected

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

Referenced by isTitleBold().

$checkboxes_enabled

ilObjectListGUI::$checkboxes_enabled = false

protected

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

Referenced by getCheckboxStatus().

$cnt_notes

ilObjectListGUI::$cnt_notes = array()

staticprotected

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

$cnt_tags

ilObjectListGUI::$cnt_tags = array()

staticprotected

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

$commands_enabled

ilObjectListGUI::$commands_enabled = true

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

Referenced by getCommandsStatus().

$comments_activation

ilObjectListGUI::$comments_activation = array()

staticprotected

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

$comments_enabled

ilObjectListGUI::$comments_enabled = false

protected

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

Referenced by getHeaderAction(), insertCommonSocialCommands(), and ilOrgUnitExtensionListGUI\isCommentsActivated().

$comments_settings_enabled

ilObjectListGUI::$comments_settings_enabled = false

protected

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

$condition_depth

ilObjectListGUI::$condition_depth = 0

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

Referenced by getUniqueItemId().

$context

ilObjectListGUI::$context

protected

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

Referenced by insertTitle().

$copy_enabled

ilObjectListGUI::$copy_enabled = true

protected

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

Referenced by getCopyStatus().

$ctrl

ilObjectListGUI::$ctrl

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

Referenced by ilObjBookingPoolListGUI\getCommandLink(), ilObjCategoryListGUI\getCommandLink(), ilObjCategoryReferenceListGUI\getCommandLink(), ilObjFolderListGUI\getCommandLink(), ilObjFileBasedLMListGUI\getCommandLink(), ilObjItemGroupListGUI\getCommandLink(), ilObjLearningModuleListGUI\getCommandLink(), ilObjWorkspaceRootFolderListGUI\getCommandLink(), and ilObjBlogListGUI\insertCommand().

$cust_commands

ilObjectListGUI::$cust_commands = array()

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

$cust_prop

ilObjectListGUI::$cust_prop = array()

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

$description_enabled

ilObjectListGUI::$description_enabled = true

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

Referenced by getDescriptionStatus().

$details_level

ilObjectListGUI::$details_level = self::DETAILS_ALL

protected

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

Referenced by getDetailsLevel().

$download_checkbox_state

ilObjectListGUI::$download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE

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

Referenced by getDownloadCheckboxState().

$enabled_relevance

ilObjectListGUI::$enabled_relevance = false

protected

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

Referenced by enabledRelevance().

$expand_enabled

ilObjectListGUI::$expand_enabled = false

protected

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

Referenced by getExpandStatus().

$fav_manager

ilObjectListGUI::$fav_manager

protected

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

$force_visible_only

ilObjectListGUI::$force_visible_only = false

protected

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

Referenced by isVisibleOnlyForced().

$icons_enabled

ilObjectListGUI::$icons_enabled = false

protected

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

Referenced by getIconStatus().

$info_screen_enabled

ilObjectListGUI::$info_screen_enabled = false

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

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

$is_expanded

ilObjectListGUI::$is_expanded = true

protected

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

Referenced by isExpanded().

$item_detail_links

ilObjectListGUI::$item_detail_links = array()

protected

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

$item_detail_links_enabled

ilObjectListGUI::$item_detail_links_enabled = false

protected

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

Referenced by getItemDetailLinkStatus().

$item_detail_links_intro

ilObjectListGUI::$item_detail_links_intro = ''

protected

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

$js_unique_id

ilObjectListGUI::$js_unique_id = 0

staticprotected

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

Referenced by insertPreconditions().

$lng

ilObjectListGUI::$lng

protected

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

Referenced by ilObjItemGroupListGUI\__construct(), ilObjSessionListGUI\__construct(), ilObjStudyProgrammeListGUI\__construct(), determineProperties(), getHeaderAction(), ilObjBibliographicListGUI\getProperties(), ilObjBookingPoolListGUI\getProperties(), ilObjCategoryReferenceListGUI\getProperties(), ilObjCloudListGUI\getProperties(), ilObjCmiXapiVerificationListGUI\getProperties(), ilObjCourseListGUI\getProperties(), ilObjCourseVerificationListGUI\getProperties(), ilObjCourseReferenceListGUI\getProperties(), ilObjDataCollectionListGUI\getProperties(), ilObjExerciseListGUI\getProperties(), ilObjExerciseVerificationListGUI\getProperties(), ilObjExternalFeedListGUI\getProperties(), ilObjGlossaryListGUI\getProperties(), ilObjGroupListGUI\getProperties(), ilObjGroupReferenceListGUI\getProperties(), ilObjFileBasedLMListGUI\getProperties(), ilObjLearningModuleListGUI\getProperties(), ilObjLTIConsumerVerificationListGUI\getProperties(), ilObjMediaCastListGUI\getProperties(), ilObjMediaPoolListGUI\getProperties(), ilObjPollListGUI\getProperties(), ilObjPortfolioTemplateListGUI\getProperties(), ilObjRemoteCategoryListGUI\getProperties(), ilObjRemoteCourseListGUI\getProperties(), ilObjRemoteFileListGUI\getProperties(), ilObjRemoteGlossaryListGUI\getProperties(), ilObjRemoteGroupListGUI\getProperties(), ilObjRemoteLearningModuleListGUI\getProperties(), ilObjRemoteTestListGUI\getProperties(), ilObjRemoteWikiListGUI\getProperties(), ilObjSAHSLearningModuleListGUI\getProperties(), ilObjSCORMVerificationListGUI\getProperties(), ilObjSurveyListGUI\getProperties(), ilObjSurveyQuestionPoolListGUI\getProperties(), ilObjTestListGUI\getProperties(), ilObjTestVerificationListGUI\getProperties(), ilObjQuestionPoolListGUI\getProperties(), ilObjLinkResourceListGUI\getProperties(), ilObjWikiListGUI\getProperties(), getProperties(), ilObjectPluginListGUI\getProperties(), ilObjCloudListGUI\init(), insertCommands(), insertCommonSocialCommands(), ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), ilObjOrgUnitListGUI\insertIconsAndCheckboxes(), insertIconsAndCheckboxes(), insertPath(), ilCourseObjectiveListGUI\insertProgressInfo(), parseConditions(), and preloadCommonProperties().

$multi_download_enabled

ilObjectListGUI::$multi_download_enabled = false

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

$notes_enabled

ilObjectListGUI::$notes_enabled = false

protected

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

$notice_properties_enabled

ilObjectListGUI::$notice_properties_enabled = true

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

Referenced by getNoticePropertiesStatus().

$obj_definition

ilObjectListGUI::$obj_definition

protected

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

Referenced by insertCopyCommand(), ilObjLTIConsumerListGUI\insertIconsAndCheckboxes(), insertIconsAndCheckboxes(), insertLinkCommand(), insertMultiDownloadCommand(), insertPasteCommand(), and parseConditions().

$obj_id

ilObjectListGUI::$obj_id

protected

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

Referenced by determineProperties(), ilObjSessionListGUI\getAppointmentInfo(), ilObjFileBasedLMListGUI\getCommandFrame(), ilObjSAHSLearningModuleListGUI\getCommandFrame(), and ilObjOrgUnitListGUI\insertIconsAndCheckboxes().

$object_service

ilObjectListGUI::$object_service

protected

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

$parent_ref_id

ilObjectListGUI::$parent_ref_id

protected

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

Referenced by getUniqueItemId(), and insertTimingsCommand().

$path_gui

ilObjectListGUI::$path_gui = null

protected

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

Referenced by enablePath(), and insertPath().

$path_linked

ilObjectListGUI::$path_linked = false

protected

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

$position_enabled

ilObjectListGUI::$position_enabled = false

protected

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

$preconditions_enabled

ilObjectListGUI::$preconditions_enabled = true

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

Referenced by getPreconditionsStatus().

$preload_done

ilObjectListGUI::$preload_done = false

staticprotected

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

$prevent_duplicate_commands

ilObjectListGUI::$prevent_duplicate_commands = array()

protected

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

$progress_enabled

ilObjectListGUI::$progress_enabled = false

protected

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

Referenced by getProgressInfoStatus().

$properties_enabled

ilObjectListGUI::$properties_enabled = true

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

Referenced by getPropertiesStatus().

$rating_categories_enabled

ilObjectListGUI::$rating_categories_enabled = false

protected

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

$rating_ctrl_path

ilObjectListGUI::$rating_ctrl_path = false

protected

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

$rating_enabled

ilObjectListGUI::$rating_enabled = false

protected

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

$rating_text

ilObjectListGUI::$rating_text = false

protected

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

$ref_id

ilObjectListGUI::$ref_id

protected

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

Referenced by determineProperties(), getCommandId(), ilObjGlossaryListGUI\getCommandLink(), ilObjFileBasedLMListGUI\getCommandLink(), ilObjLearningModuleListGUI\getCommandLink(), ilObjSAHSLearningModuleListGUI\getCommandLink(), insertCommonSocialCommands(), and ilObjTestListGUI\modifyTitleLink().

$reference_ref_id

ilObjectListGUI::$reference_ref_id = false

protected

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

Referenced by determineProperties(), and insertCommonSocialCommands().

$relevance

ilObjectListGUI::$relevance = 0

protected

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

Referenced by getRelevance().

$repository_transfer_enabled

ilObjectListGUI::$repository_transfer_enabled = false

protected

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

$restrict_to_goto

ilObjectListGUI::$restrict_to_goto = false

protected

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

$search_fragment

ilObjectListGUI::$search_fragment = ''

protected

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

Referenced by getSearchFragment().

$search_fragment_enabled

ilObjectListGUI::$search_fragment_enabled = false

protected

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

Referenced by getSearchFragmentStatus().

$search_fragments_enabled

ilObjectListGUI::$search_fragments_enabled = false

protected

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

$separate_commands

ilObjectListGUI::$separate_commands = false

protected

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

Referenced by getSeparateCommands().

$settings

ilObjectListGUI::$settings

protected

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

Referenced by enableComments(), enableNotes(), and insertSubscribeCommand().

$shared

ilObjectListGUI::$shared = false

protected

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

$static_link_enabled

ilObjectListGUI::$static_link_enabled = false

protected

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

$std_cmd_only

ilObjectListGUI::$std_cmd_only = false

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

$sub_item_html

ilObjectListGUI::$sub_item_html = array()

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

$sub_obj_id

ilObjectListGUI::$sub_obj_id

protected

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

$sub_obj_type

ilObjectListGUI::$sub_obj_type

protected

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

$substitutions

ilObjectListGUI::$substitutions = null

protected

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

$substitutions_enabled

ilObjectListGUI::$substitutions_enabled = false

protected

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

Referenced by getSubstitutionStatus().

$tags

ilObjectListGUI::$tags = array()

staticprotected

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

Referenced by getHeaderAction().

$tags_enabled

ilObjectListGUI::$tags_enabled = false

protected

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

$timings_enabled

ilObjectListGUI::$timings_enabled = true

protected

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

$title_link

ilObjectListGUI::$title_link = ''

protected

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

$title_link_disabled

ilObjectListGUI::$title_link_disabled = false

protected

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

$tpl

ilObjectListGUI::$tpl

protected

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

Referenced by prepareJsLinks().

$tpl_component

ilObjectListGUI::$tpl_component = "Services/Container"

staticprotected

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

$tpl_file_name

ilObjectListGUI::$tpl_file_name = "tpl.container_list_item.html"

staticprotected

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

$tree

ilObjectListGUI::$tree

protected

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

Referenced by ilObjCategoryReferenceListGUI\getProperties(), ilObjCourseReferenceListGUI\getProperties(), ilObjGroupReferenceListGUI\getProperties(), ilObjCategoryReferenceListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilObjGroupReferenceListGUI\initItem(), and parseConditions().

$type

ilObjectListGUI::$type

protected

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

Referenced by getHeaderAction(), ilObjFileListGUI\getIconImageType(), getIconImageType(), getListItemHTML(), ilObjSAHSLearningModuleListGUI\getProperties(), ilObjectPluginListGUI\getType(), ilObjCategoryReferenceListGUI\initItem(), ilObjCourseListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilObjGroupReferenceListGUI\initItem(), ilObjSAHSLearningModuleListGUI\initItem(), initItem(), and insertSubscribeCommand().

$ui

ilObjectListGUI::$ui

protected

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

$user

ilObjectListGUI::$user

protected

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

Referenced by determineProperties(), getCommands(), getHeaderAction(), getListItemHTML(), ilObjCategoryReferenceListGUI\getProperties(), ilObjExerciseListGUI\getProperties(), ilObjExternalFeedListGUI\getProperties(), ilObjMediaCastListGUI\getProperties(), ilObjMediaPoolListGUI\getProperties(), ilObjSurveyListGUI\getProperties(), ilObjSurveyQuestionPoolListGUI\getProperties(), getProperties(), ilObjectPluginListGUI\getProperties(), insertCommands(), insertCommonSocialCommands(), insertSubscribeCommand(), and storeAccessCache().

CONTEXT_PERSONAL_DESKTOP

const ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP = 5

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

Referenced by ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjectListGUIPreloader\preload(), and ilPDSelectedItemsBlockViewGUI\preloadItemGroups().

CONTEXT_REPOSITORY

const ilObjectListGUI::CONTEXT_REPOSITORY = 1

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

Referenced by ilClassificationBlockGUI\filterContainer(), ilContainerStartObjectsContentTableGUI\getItems(), ilContainer\getSubItems(), ilCommonActionDispatcherGUI\initHeaderAction(), and ilObjectListGUIPreloader\preload().

CONTEXT_SEARCH

const ilObjectListGUI::CONTEXT_SEARCH = 6

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

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

CONTEXT_WORKSPACE

const ilObjectListGUI::CONTEXT_WORKSPACE = 2

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

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

CONTEXT_WORKSPACE_SHARING

const ilObjectListGUI::CONTEXT_WORKSPACE_SHARING = 4

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

Referenced by buildGotoLink(), and insertTitle().

DETAILS_ALL

const ilObjectListGUI::DETAILS_ALL = 30

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

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

DETAILS_MINIMAL

const ilObjectListGUI::DETAILS_MINIMAL = 10

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

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

DETAILS_SEARCH

const ilObjectListGUI::DETAILS_SEARCH = 20

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

Referenced by ilLuceneSearchObjectListGUIFactory\factory().

DOWNLOAD_CHECKBOX_DISABLED

const ilObjectListGUI::DOWNLOAD_CHECKBOX_DISABLED = 2

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

Referenced by enableDownloadCheckbox().

DOWNLOAD_CHECKBOX_ENABLED

const ilObjectListGUI::DOWNLOAD_CHECKBOX_ENABLED = 1

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

Referenced by enableDownloadCheckbox().

DOWNLOAD_CHECKBOX_NONE

const ilObjectListGUI::DOWNLOAD_CHECKBOX_NONE = 0

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

Referenced by enableDownloadCheckbox().

---

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

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