ilObjectListGUI Class Reference

Important note: More...

Inheritance diagram for ilObjectListGUI:

Collaboration diagram for ilObjectListGUI:

Public Member Functions
	setContainerObject (object $container_obj)
	getContainerObject ()
	init ()
	initialisation More...
	enableProperties (bool $status)
	getPropertiesStatus ()
	enablePreconditions (bool $status)
	getPreconditionsStatus ()
	enableNoticeProperties (bool $status)
	getNoticePropertiesStatus ()
	enableDescription (bool $status)
	getDescriptionStatus ()
	enableSearchFragments (bool $status)
	getSearchFragmentStatus ()
	enableLinkedPath (bool $status)
	setRelevance (int $rel)
	getRelevance ()
	enableIcon (bool $status)
	getIconStatus ()
	enableCheckbox (bool $status)
	getCheckboxStatus ()
	enableExpand (bool $status)
	getExpandStatus ()
	setExpanded (bool $status)
	isExpanded ()
	setPositionInputField (string $field_index, string $position_value)
	enableDelete (bool $status)
	getDeleteStatus ()
	enableCut (bool $status)
	getCutStatus ()
	enableCopy (bool $status)
	getCopyStatus ()
	enableSubscribe (bool $status)
	getSubscribeStatus ()
	enableLink (bool $status)
	getLinkStatus ()
	enablePath (bool $path, int $start_node=0, ?\ilPathGUI $path_gui=null)
	getPathStatus ()
	enableCommands (bool $status, bool $std_only=false)
	getCommandsStatus ()
	enableInfoScreen (bool $info_screen)
	getInfoScreenStatus ()
	addSubItemHTML (string $html)
	Add HTML for sub item (used for sessions) More...
	enableProgressInfo (bool $status)
	getProgressInfoStatus ()
	enableSubstitutions (bool $status)
	getSubstitutionStatus ()
	enableItemDetailLinks (bool $status)
	enable item detail links E.g Direct links to chapters or pages More...
	getItemDetailLinkStatus ()
	get item detail link status More...
	setItemDetailLinks (array $detail_links, string $intro_txt='')
	set items detail links More...
	insertItemDetailLinks ()
	setTitle (string $title)
	getTitle ()
	getTitle overwritten in class.ilObjLinkResourceList.php More...
	setDescription (string $description)
	getDescription ()
	getDescription overwritten in class.ilObjLinkResourceList.php More...
	setSearchFragment (string $text)
	getSearchFragment ()
	setSeparateCommands (bool $val)
	getSeparateCommands ()
	getCommandId ()
	get command id Normally the ref id. More...
	setAdditionalInformation (?string $val)
	getAdditionalInformation ()
	setDetailsLevel (int $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 ()
	enableRepositoryTransfer (bool $value)
	Enable copy/move to repository (from personal workspace) More...
	restrictToGoto (bool $value)
	Restrict all actions/links to goto. More...
	getDefaultCommand ()
	checkCommandAccess (string $permission, string $cmd, int $ref_id, string $type, ?int $obj_id=null)
	initItem (int $ref_id, int $obj_id, string $type, string $title='', string $description='')
	initialize new item (is called by getItemHTML()) More...
	setConditionTarget (int $ref_id, int $obj_id, string $target_type)
	resetConditionTarget ()
	disableTitleLink (bool $status)
	setDefaultCommandParameters (array $params)
	createDefaultCommand (array $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...
	getCommandFrame (string $cmd)
	Get command target frame. More...
	getCommandImage (string $cmd)
	Get command icon image. More...
	getProperties ()
	Get item properties. More...
	addCustomProperty (string $property='', string $value='', bool $alert=false, bool $newline=false)
	getCustomProperties (array $prop)
	getAlertProperties ()
	getNoticeProperties ()
	addCustomCommand (string $link, string $lang_var, string $frame='', string $onclick='')
	addCustomCommandButton (Button $button, ?Modal $triggeredModal=null)
	forceVisibleOnly (bool $stat)
	isVisibleOnlyForced ()
	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 ()
	insertSubstitutions ()
	insertDescription ()
	insertSearchFragment ()
	Insert highlighted search fragment. More...
	setMode (string $mode)
	set output mode More...
	getMode ()
	get output mode More...
	setConditionDepth (int $depth)
	set depth for precondition output (stops at level 5) More...
	isMode (string $mode)
	check current output mode More...
	determineProperties ()
	insertProperties ()
	insertNoticeProperties ()
	insertPreconditions ()
	insert all missing preconditions More...
	insertCommand (string $href, string $text, string $frame='', string $img='', string $cmd='', string $onclick='')
	insert command button More...
	insertDeleteCommand ()
	insertLinkCommand ()
	insertCutCommand (bool $to_repository=false)
	insertCopyCommand (bool $to_repository=false)
	insertPasteCommand ()
	insertSubscribeCommand ()
	insertInfoScreenCommand ()
	insertCommonSocialCommands (bool $header_actions=false)
	Insert common social commands (comments, notes, tagging) More...
	insertTimingsCommand ()
	ks, 23 OCT 2023: This function is badly named and it already was before the changes made today. More...
	enableComments (bool $value, bool $enable_comments_settings=true)
	enableNotes (bool $value)
	enableTags (bool $value)
	enableRating (bool $value, ?string $text=null, bool $categories=false, ?array $ctrl_path=null, bool $force_rate_parent=false)
	enableMultiDownload (bool $value)
	Toggles whether multiple objects can be downloaded at once or not. More...
	insertMultiDownloadCommand ()
	enableDownloadCheckbox (int $ref_id)
	getDownloadCheckboxState ()
	setHeaderSubObject (?string $type, ?int $id)
	addHeaderIcon (string $id, string $img, ?string $tooltip=null, ?string $onclick=null, ?string $status_text=null, ?string $href=null)
	addHeaderIconHTML (string $id, string $html)
	addHeaderGlyph (string $id, ILIAS\UI\Component\Symbol\Glyph\Glyph $glyph, $onclick=null)
	setAjaxHash (string $hash)
	getHeaderAction (?ilGlobalTemplateInterface $main_tpl=null)
	appendRepositoryFrameParameter (string $link)
	workaround: all links into the repository (from outside) must tell repository to set up the frameset More...
	modifySAHSlaunch (string $link, string $target)
	workaround: SAHS in new javavasript-created window or iframe More...
	insertPath ()
	insertProgressInfo ()
	insertIconsAndCheckboxes ()
	getTypeIcon ()
	Get object type specific type icon. More...
	insertSubItems ()
	insertPositionField ()
	adminCommandsIncluded ()
	returns whether any admin commands (link, delete, cut) are included in the output More...
	getListItemHTML (int $ref_id, int $obj_id, string $title, string $description)
	Get all item information (title, commands, description) in HTML. More...
	setParentRefId (int $ref_id)
	Set current parent ref id to enable unique js-ids (sessions, etc.) More...
	getUniqueItemId (bool $as_div=false)
	Get unique item identifier (for js-actions) More...
	getCommandsHTML (string $title='')
	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 (bool $bold_title)
	isTitleBold ()
	enableTimings (bool $status)
	enable timings link 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 ()
	insertLPCommand ()
	insert learning progress command More...

Static Public Member Functions
static	prepareJsLinks (string $redraw_url, string $notes_url, string $tags_url, ?ilGlobalTemplateInterface $tpl=null)
	Insert js/ajax links into template. More...
static	preloadCommonProperties (array $obj_ids, int $context)

Data Fields
const	IL_LIST_AS_TRIGGER = 'trigger'
const	IL_LIST_FULL = 'full'
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

Protected Member Functions
	enableLearningProgress (bool $enabled)
	enableLPSettingsCommand (bool $enabled)
	buildGotoLink ()
	parseConditions (int $toggle_id, array $conditions, bool $obligatory=true)
	getHeaderGlyphShyButton (ILIAS\UI\Component\Symbol\Glyph\Glyph $glyph, string $onclick_js)
	modifyTitleLink (string $default_link)
	resetCustomData ()
	reset properties and commands More...
	isCommentsActivated (string $type, int $ref_id, int $obj_id, bool $header_actions, bool $check_write_access=true)
	Check comments status against comments settings and context. More...

Protected Attributes
bool	$force_rate_parent = false
array	$access_cache
ilAccessHandler	$access
ilObjUser	$user
LocalDIC	$object_dic
Properties	$object_properties
ilObjectDefinition	$obj_definition
ilTree	$tree
ilSetting	$settings
HTTPServices	$http
UIServices	$ui
ilGlobalTemplateInterface	$main_tpl
ilRbacSystem	$rbacsystem
ilCtrlInterface	$ctrl
ilLanguage	$lng
string	$mode
bool	$path_enabled
int	$context
ILIAS HTTP Wrapper RequestWrapper	$request_wrapper
ILIAS Refinery Factory	$refinery
bool	$static_link_enabled = false
bool	$delete_enabled = false
bool	$cut_enabled = false
bool	$subscribe_enabled = false
bool	$link_enabled = false
bool	$copy_enabled = true
bool	$progress_enabled = false
bool	$notice_properties_enabled = true
bool	$info_screen_enabled = false
string	$type
string	$gui_class_name = ''
array	$commands = []
ilLDAPRoleGroupMapping	$ldap_mapping
ilFavouritesManager	$fav_manager
int	$requested_ref_id
string	$requested_cmd
string	$requested_base_class
ClipboardManager	$clipboard
bool	$description_enabled = true
bool	$preconditions_enabled = true
bool	$properties_enabled = true
bool	$commands_enabled = true
array	$cust_prop = []
array	$cust_commands = []
array	$cust_modals = []
int	$condition_depth = 0
bool	$std_cmd_only = false
array	$sub_item_html = []
bool	$multi_download_enabled = false
int	$download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE
int	$obj_id
int	$ref_id
int	$sub_obj_id
string	$sub_obj_type
ilAdvancedMDSubstitution	$substitutions = null
bool	$substitutions_enabled = false
bool	$icons_enabled = false
bool	$checkboxes_enabled = false
bool	$position_enabled = false
bool	$item_detail_links_enabled = false
array	$item_detail_links = []
string	$item_detail_links_intro = ''
bool	$search_fragments_enabled = false
string	$search_fragment = ''
bool	$path_linked = false
int	$relevance = 0
bool	$expand_enabled = false
bool	$is_expanded = true
bool	$bold_title = false
int	$details_level = self::DETAILS_ALL
int	$reference_ref_id = 0
int	$reference_obj_id = null
bool	$separate_commands = false
bool	$search_fragment_enabled = false
string	$additional_information = ''
bool	$repository_transfer_enabled = false
bool	$shared = false
bool	$restrict_to_goto = false
bool	$comments_enabled = false
bool	$comments_settings_enabled = false
bool	$notes_enabled = false
bool	$tags_enabled = false
bool	$rating_enabled = false
bool	$rating_categories_enabled = false
string	$rating_text = null
array	$rating_ctrl_path = null
bool	$timings_enabled = true
bool	$force_visible_only = false
array	$prevent_duplicate_commands = []
int	$parent_ref_id
string	$title_link = ''
bool	$title_link_disabled = false
bool	$lp_cmd_enabled = false
bool	$lp_settings_cmd_enabled = true
array	$current_actions = []
ilPathGUI	$path_gui = null
array	$default_command_params = []
array	$header_icons = []
object	$container_obj = null
ilTemplate	$tpl
string	$position_value
int	$path_start_node
array	$default_command = []
bool	$adm_commands_included
bool	$prevent_access_caching
array	$condition_target
array	$notice_prop = []
string	$ajax_hash
ilListItemAccessCache	$acache
string	$position_field_index = ''
string	$title = ''
string	$description = ''
ilWorkspaceAccessHandler	$ws_access

Static Protected Attributes
static array	$cnt_notes = []
static array	$cnt_tags = []
static array	$tags = []
static array	$comments_activation = []
static bool	$preload_done = false
static int	$js_unique_id = 0
static string	$tpl_file_name = 'tpl.container_list_item.html'
static string	$tpl_component = 'components/ILIAS/Container'

Private Member Functions
	populateCommands (bool $for_header)
	insert all commands into html code More...
	commandsNeedToBeHidden (bool $for_header)
	Fix bug #12417: We hide the action menu when we are in the public area. More...
	getCommandsDropdown (string $title, bool $for_header=false)
	getTileImage ()
	insertLPSettingsCommand ()
	buildTranslatedType ()

Private Attributes
ILIAS Notes Service	$notes_service

Detailed Description

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

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

addCustomCommand()

ilObjectListGUI::addCustomCommand	(	string	$link,
		string	$lang_var,
		string	$frame = '',
		string	$onclick = ''
	)

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

                                                                                                              : void
    {
        $this->cust_commands[] = [
            'link' => $link,
            'lang_var' => $lang_var,
            'frame' => $frame,
            'onclick' => $onclick
        ];
    }

Referenced by ilDashboardRecommendedContentGUI\addCustomCommandsToActionMenu().

Here is the caller graph for this function:

addCustomCommandButton()

ilObjectListGUI::addCustomCommandButton	(	Button	$button,
		?Modal	$triggeredModal = null
	)

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

     : void {
        $this->cust_commands[] = $button;
        if ($triggeredModal !== null) {
            $this->cust_modals[] = $triggeredModal;
        }
    }

addCustomProperty()

ilObjectListGUI::addCustomProperty	(	string	$property = '',
		string	$value = '',
		bool	$alert = false,
		bool	$newline = false
	)

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

     : void {
        $this->cust_prop[] = [
            'property' => $property,
            'value' => $value,
            'alert' => $alert,
            'newline' => $newline
        ];
    }

Referenced by ilContainerObjectiveGUI\addItemDetails(), ilObjectActivation\addListGUIActivationProperty(), 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	(	string	$id,
		ILIAS\UI\Component\Symbol\Glyph\Glyph	$glyph,
			$onclick = null
	)

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

                                                                                                             : void
    {
        $this->header_icons[$id] = ['glyph' => $glyph, 'onclick' => $onclick];
    }

References $id.

addHeaderIcon()

ilObjectListGUI::addHeaderIcon	(	string	$id,
		string	$img,
		?string	$tooltip = null,
		?string	$onclick = null,
		?string	$status_text = null,
		?string	$href = null
	)

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

     : void {
        $this->header_icons[$id] = [
            'img' => $img,
            'tooltip' => $tooltip,
            'onclick' => $onclick,
            'status_text' => $status_text,
            'href' => $href
        ];
    }

addHeaderIconHTML()

ilObjectListGUI::addHeaderIconHTML	(	string	$id,
		string	$html
	)

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

                                                               : void
    {
        $this->header_icons[$id] = $html;
    }

References $id.

addSubItemHTML()

ilObjectListGUI::addSubItemHTML

(

string

$html

)

Add HTML for sub item (used for sessions)

Parameters

string

$html

sub items HTML

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

                                                : void
    {
        $this->sub_item_html[] = $html;
    }

adminCommandsIncluded()

ilObjectListGUI::adminCommandsIncluded

(

)

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

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

                                           : bool
    {
        return $this->adm_commands_included;
    }

appendRepositoryFrameParameter()

ilObjectListGUI::appendRepositoryFrameParameter

(

string

$link

)

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

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

                                                                : string
    {
        // we should get rid of this nonsense with 4.4 (alex)
        $base_class = $this->request_wrapper->retrieve('baseClass', $this->refinery->kindlyTo()->string());
        if (
            (strtolower($base_class) != 'ilrepositorygui') &&
            is_int(strpos($link, 'baseClass=ilRepositoryGUI'))
        ) {
            if ($this->type != 'frm') {
                $link = ilUtil::appendUrlParameterString($link, 'rep_frame=1');
            }
        }
 
        return $link;
    }

References ilUtil\appendUrlParameterString(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

buildGotoLink()

ilObjectListGUI::buildGotoLink ( )

protected

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

                                      : ?string
    {
        switch ($this->context) {
            case self::CONTEXT_WORKSPACE_SHARING:
                return ilWorkspaceAccessHandler::getGotoLink($this->ref_id, $this->obj_id);
 
            default:
                // not implemented yet
                break;
        }
        return null;
    }

References ilWorkspaceAccessHandler\getGotoLink().

Here is the call graph for this function:

buildTranslatedType()

ilObjectListGUI::buildTranslatedType ( )

private

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

                                          : string
    {
        if ($this->obj_definition->isPlugin($this->getIconImageType())) {
            return ilObjectPlugin::lookupTxtById($this->getIconImageType(), 'obj_' . $this->getIconImageType());
        }
 
        return $this->lng->txt('obj_' . $this->getIconImageType());
    }

checkCommandAccess()

ilObjectListGUI::checkCommandAccess	(	string	$permission,
		string	$cmd,
		int	$ref_id,
		string	$type,
		?int	$obj_id = null
	)

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

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

     : bool {
        // e.g: sub items should not be readable since their parent session is readonly.
        if ($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 (!isset($this->ws_access)) {
                $this->ws_access = new ilWorkspaceAccessHandler();
            }
        }
 
        if (isset($this->access_cache[$permission]['-' . $cmd][$cache_prefix . $ref_id])) {
            return $this->access_cache[$permission]['-' . $cmd][$cache_prefix . $ref_id];
        }
 
        if ($this->context == self::CONTEXT_REPOSITORY || $this->context == self::CONTEXT_SEARCH) {
            $access = $this->access->checkAccess($permission, $cmd, $ref_id, $type, (int) $obj_id);
            if ($this->access->getPreventCachingLastResult()) {
                $this->prevent_access_caching = true;
            }
        } else {
            $access = $this->ws_access->checkAccess($permission, $cmd, $ref_id, $type);
        }
 
        $this->access_cache[$permission]['-' . $cmd][$cache_prefix . $ref_id] = $access;
        return $access;
    }

checkInfoPageOnAsynchronousRendering()

ilObjectListGUI::checkInfoPageOnAsynchronousRendering

(

)

Reimplemented in ilObjCategoryListGUI, ilObjContentPageListGUI, ilObjFileBasedLMListGUI, and ilObjLearningModuleListGUI.

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

                                                          : bool
    {
        return false;
    }

commandsNeedToBeHidden()

ilObjectListGUI::commandsNeedToBeHidden ( bool  $for_header )

private

Fix bug #12417: We hide the action menu when we are in the public area.

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

     : bool {
        if (!$for_header
            && $this->user->getId() === ANONYMOUS_USER_ID && $this->checkInfoPageOnAsynchronousRendering()
            && $this->object_properties->getPropertyInfoTabVisibility()) {
            return true;
        }
        return false;
    }

createDefaultCommand()

ilObjectListGUI::createDefaultCommand

(

array

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

Reimplemented in ilObjLearningSequenceListGUI, ilObjTestListGUI, and ilRemoteObjectBaseListGUI.

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

                                                        : array
    {
        if ($this->static_link_enabled and !$this->default_command_params) {
            if ($link = ilLink::_getStaticLink($this->ref_id, $this->type, false)) {
                $command['link'] = $link;
                $command['frame'] = '_top';
            }
        }
        if ($this->default_command_params) {
            $params = [];
            foreach ($this->default_command_params as $name => $value) {
                $params[] = $name . '=' . $value;
            }
            $params = implode('&', $params);
 
            if (!stristr($command['link'], '?')) {
                $command['link'] .= '?' . $params;
            } else {
                $command['link'] .= '&' . $params;
            }
        }
        return $command;
    }

References $params, and ilLink\_getStaticLink().

Here is the call graph for this function:

determineProperties()

ilObjectListGUI::determineProperties

(

)

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

                                         : array
    {
        $props = $this->getCustomProperties(
            $this->getProperties()
        );
 
        if ($this->context != self::CONTEXT_WORKSPACE && $this->context != self::CONTEXT_WORKSPACE_SHARING) {
            // add learning progress custom property
            $lp = ilLPStatus::getListGUIStatus($this->obj_id);
            if ($lp) {
                $props[] = [
                    'alert' => false,
                    'property' => $this->lng->txt('learning_progress'),
                    'value' => $lp,
                    'newline' => true
                ];
            }
 
            // add no item access note in public section
            // for items that are visible but not readable
            if ($this->user->getId() === ANONYMOUS_USER_ID) {
                if (!$this->access->checkAccess('read', '', $this->ref_id, $this->type, $this->obj_id)) {
                    $props[] = [
                        'alert' => true,
                        'value' => $this->lng->txt('no_access_item_public'),
                        'newline' => true
                    ];
                }
            }
        }
 
        // reference objects have translated ids, revert to originals
        $note_ref_id = $this->ref_id;
        $note_obj_id = $this->obj_id;
        if ($this->reference_ref_id) {
            $note_ref_id = $this->reference_ref_id;
            $note_obj_id = $this->reference_obj_id;
        }
        $redraw_js = 'il.Object.redrawListItem(' . $note_ref_id . ');';
 
        // add common properties (comments, notes, tags)
        if (
            (
                (
                    isset(self::$cnt_notes[$note_obj_id][Note::PRIVATE]) &&
                    self::$cnt_notes[$note_obj_id][Note::PRIVATE] > 0
                ) || (
                    isset(self::$cnt_notes[$note_obj_id][Note::PUBLIC]) &&
                    self::$cnt_notes[$note_obj_id][Note::PUBLIC] > 0
                ) || (
                    isset(self::$cnt_tags[$note_obj_id]) && self::$cnt_tags[$note_obj_id] > 0
                ) || (
                    isset(self::$tags[$note_obj_id]) && is_array(self::$tags[$note_obj_id])
                )
            ) && ($this->user->getId() !== ANONYMOUS_USER_ID)
        ) {
            $nl = true;
            $cnt_comments = self::$cnt_notes[$note_obj_id][Note::PUBLIC] ?? 0;
            if ($this->isCommentsActivated($this->type, $this->ref_id, $this->obj_id, false, false)
                && $cnt_comments > 0) {
                $props[] = [
                    'alert' => false,
                    'property' => $this->lng->txt('notes_comments'),
                    'value' =>
                        '<a href="#" onclick="return ' .
                        ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $redraw_js) . '">' .
                        self::$cnt_notes[$note_obj_id][Note::PUBLIC] . '</a>',
                    'newline' => $nl
                ];
                $nl = false;
            }
 
            $cnt_notes = self::$cnt_notes[$note_obj_id][Note::PRIVATE] ?? 0;
            if ($this->notes_enabled && $cnt_notes > 0) {
                $props[] = [
                    'alert' => false,
                    'property' => $this->lng->txt('notes'),
                    'value' =>
                        '<a href="#" onclick="return ' .
                        ilNoteGUI::getListNotesJSCall($this->ajax_hash, $redraw_js) . '">' .
                        self::$cnt_notes[$note_obj_id][Note::PRIVATE] . '</a>',
                    'newline' => $nl
                ];
                $nl = false;
            }
            $cnt_tags = self::$cnt_tags[$note_obj_id] ?? 0;
            if ($this->tags_enabled && ($cnt_tags > 0 || isset(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 (isset(self::$tags[$note_obj_id])) {
                        $tags_tmp = [];
                        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 = $this->lng->txt('tagging_tags');
                    }
                    $props[] = [
                        'alert' => false,
                        'property' => $prop_text,
                        'value' => $tags_value,
                        'newline' => $nl
                    ];
                }
            }
        }
 
        if (!isset($props)) {
            return [];
        }
 
        return $props;
    }

References $ref_id, ILIAS\Repository\access(), ANONYMOUS_USER_ID, ilNoteGUI\getListCommentsJSCall(), ilLPStatus\getListGUIStatus(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), ILIAS\Repository\lng(), true, and ILIAS\Repository\user().

Here is the call graph for this function:

disableTitleLink()

ilObjectListGUI::disableTitleLink

(

bool

$status

)

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

                                                  : void
    {
        $this->title_link_disabled = $status;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

enableCheckbox()

ilObjectListGUI::enableCheckbox

(

bool

$status

)

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

                                                : void
    {
        $this->checkboxes_enabled = $status;
    }

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

Here is the caller graph for this function:

enableCommands()

ilObjectListGUI::enableCommands	(	bool	$status,
		bool	$std_only = false
	)

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

                                                                        : void
    {
        $this->commands_enabled = $status;
        $this->std_cmd_only = $std_only;
    }

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

Here is the caller graph for this function:

enableComments()

ilObjectListGUI::enableComments	(	bool	$value,
		bool	$enable_comments_settings = true
	)

Reimplemented in ilOrgUnitExtensionListGUI.

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

                                                                                      : void
    {
        if ($this->settings->get('disable_comments')) {
            $value = false;
        }
 
        $this->comments_enabled = $value;
        $this->comments_settings_enabled = $enable_comments_settings;
    }

References ILIAS\Repository\settings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

enableCopy()

ilObjectListGUI::enableCopy

(

bool

$status

)

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

                                            : void
    {
        $this->copy_enabled = $status;
    }

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

Here is the caller graph for this function:

enableCut()

ilObjectListGUI::enableCut

(

bool

$status

)

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

                                           : void
    {
        $this->cut_enabled = $status;
    }

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

Here is the caller graph for this function:

enableDelete()

ilObjectListGUI::enableDelete

(

bool

$status

)

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

                                              : void
    {
        $this->delete_enabled = $status;
    }

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

Here is the caller graph for this function:

enableDescription()

ilObjectListGUI::enableDescription

(

bool

$status

)

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

                                                   : void
    {
        $this->description_enabled = $status;
    }

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

Here is the caller graph for this function:

enableDownloadCheckbox()

ilObjectListGUI::enableDownloadCheckbox

(

int

$ref_id

)

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

                                                       : void
    {
        // TODO: delegate to list object class!
        if (!$this->getContainerObject()->isActiveAdministrationPanel() || $this->clipboard->hasEntries()) {
            if (
                in_array($this->type, ['file', 'fold']) &&
                $this->access->checkAccess('read', '', $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 ILIAS\Repository\access().

Here is the call graph for this function:

enableExpand()

ilObjectListGUI::enableExpand

(

bool

$status

)

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

                                              : void
    {
        $this->expand_enabled = $status;
    }

enableIcon()

ilObjectListGUI::enableIcon

(

bool

$status

)

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

                                            : void
    {
        $this->icons_enabled = $status;
    }

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

Here is the caller graph for this function:

enableInfoScreen()

ilObjectListGUI::enableInfoScreen

(

bool

$info_screen

)

Reimplemented in ilObjItemGroupListGUI.

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

                                                       : void
    {
        $this->info_screen_enabled = $info_screen;
    }

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

Here is the caller graph for this function:

enableItemDetailLinks()

ilObjectListGUI::enableItemDetailLinks

(

bool

$status

)

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

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

                                                       : void
    {
        $this->item_detail_links_enabled = $status;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

enableLearningProgress()

ilObjectListGUI::enableLearningProgress ( bool  $enabled )

protected

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

                                                            : void
    {
        $this->lp_cmd_enabled = $enabled;
    }

Referenced by ilObjFileBasedLMListGUI\init(), ilObjLearningModuleListGUI\init(), and ilObjMediaCastListGUI\init().

Here is the caller graph for this function:

enableLink()

ilObjectListGUI::enableLink

(

bool

$status

)

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

                                            : void
    {
        $this->link_enabled = $status;
    }

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

Here is the caller graph for this function:

enableLinkedPath()

ilObjectListGUI::enableLinkedPath

(

bool

$status

)

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

                                                  : void
    {
        $this->path_linked = $status;
    }

enableLPSettingsCommand()

ilObjectListGUI::enableLPSettingsCommand ( bool  $enabled )

protected

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

                                                             : void
    {
        $this->lp_settings_cmd_enabled = $enabled;
    }

enableMultiDownload()

ilObjectListGUI::enableMultiDownload

(

bool

$value

)

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

Parameters

boolean

$value

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

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

                                                    : void
    {
        $folder_set = new ilSetting('fold');
        if (!$folder_set->get('enable_multi_download')) {
            $value = false;
        }
        $this->multi_download_enabled = $value;
    }

enableNotes()

ilObjectListGUI::enableNotes

(

bool

$value

)

Reimplemented in ilOrgUnitExtensionListGUI.

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

                                            : void
    {
        if ($this->settings->get('disable_notes')) {
            $value = false;
        }
 
        $this->notes_enabled = $value;
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

enableNoticeProperties()

ilObjectListGUI::enableNoticeProperties

(

bool

$status

)

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

                                                        : void
    {
        $this->notice_properties_enabled = $status;
    }

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

Here is the caller graph for this function:

enablePath()

ilObjectListGUI::enablePath	(	bool	$path,
		int	$start_node = 0,
		?\ilPathGUI	$path_gui = null
	)

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

                                                                                             : void
    {
        $this->path_enabled = $path;
        $this->path_start_node = $start_node;
        $this->path_gui = $path_gui;
    }

References $path, and $path_gui.

enablePreconditions()

ilObjectListGUI::enablePreconditions

(

bool

$status

)

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

                                                     : void
    {
        $this->preconditions_enabled = $status;
    }

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

Here is the caller graph for this function:

enableProgressInfo()

ilObjectListGUI::enableProgressInfo

(

bool

$status

)

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

                                                    : void
    {
        $this->progress_enabled = $status;
    }

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

Here is the caller graph for this function:

enableProperties()

ilObjectListGUI::enableProperties

(

bool

$status

)

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

                                                  : void
    {
        $this->properties_enabled = $status;
    }

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

Here is the caller graph for this function:

enableRating()

ilObjectListGUI::enableRating	(	bool	$value,
		?string	$text = null,
		bool	$categories = false,
		?array	$ctrl_path = null,
		bool	$force_rate_parent = false
	)

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

     : void {
        $this->rating_enabled = $value;
 
        if ($this->rating_enabled) {
            $this->rating_categories_enabled = $categories;
            $this->rating_text = $text;
            $this->rating_ctrl_path = $ctrl_path;
            $this->force_rate_parent = $force_rate_parent;
        }
    }

References $text.

enableRepositoryTransfer()

ilObjectListGUI::enableRepositoryTransfer

(

bool

$value

)

Enable copy/move to repository (from personal workspace)

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

                                                         : void
    {
        $this->repository_transfer_enabled = $value;
    }

enableSearchFragments()

ilObjectListGUI::enableSearchFragments

(

bool

$status

)

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

                                                       : void
    {
        $this->search_fragment_enabled = $status;
    }

enableSubscribe()

ilObjectListGUI::enableSubscribe

(

bool

$status

)

Reimplemented in ilObjItemGroupListGUI.

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

                                                 : void
    {
        $this->subscribe_enabled = $status;
    }

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

Here is the caller graph for this function:

enableSubstitutions()

ilObjectListGUI::enableSubstitutions

(

bool

$status

)

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

                                                     : void
    {
        $this->substitutions_enabled = $status;
    }

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

Here is the caller graph for this function:

enableTags()

ilObjectListGUI::enableTags

(

bool

$value

)

Reimplemented in ilOrgUnitExtensionListGUI.

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

                                           : void
    {
        $tags_set = new ilSetting('tags');
        if (!$tags_set->get('enable')) {
            $value = false;
        }
        $this->tags_enabled = $value;
    }

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

Here is the caller graph for this function:

enableTimings()

ilObjectListGUI::enableTimings

(

bool

$status

)

enable timings link

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

                                               : void
    {
        $this->timings_enabled = $status;
    }

forceVisibleOnly()

ilObjectListGUI::forceVisibleOnly

(

bool

$stat

)

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

                                                : void
    {
        $this->force_visible_only = $stat;
    }

getAdditionalInformation()

ilObjectListGUI::getAdditionalInformation

(

)

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

                                              : ?string
    {
        return $this->additional_information;
    }

References $additional_information.

getAlertProperties()

ilObjectListGUI::getAlertProperties

(

)

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

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

getAsCard()

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

Get card object.

Reimplemented in ilRemoteObjectBaseListGUI.

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

     : ?RepositoryObject {
        $ui = $this->ui;
 
        $title = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform($title);
        // even b tag produced bugs, see #32304
        $description = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
            $description
        );
 
        $this->initItem(
            $ref_id,
            $obj_id,
            $type,
            $title,
            $description
        );
 
        $user = $this->user;
        $access = $this->access;
 
        $this->enableCommands(true);
 
        $sections = [];
        if ($description !== '') {
            $sections[] = $ui->factory()->legacy()->content('<div class="il-multi-line-cap-3">' . $description . '</div>');
        }
 
        $this->populateCommands(false);
 
        $def_command = $this->getDefaultCommand();
 
        $dropdown = $this->getCommandsDropdown($title);
 
        // workaround for #26205
        // we should get rid of _top links completely and gifure our how
        // to manage scorm links better
        $def_cmd_frame = ($def_command['frame'] ?? '');
        if ($def_cmd_frame === '_top') {
            $def_cmd_frame = '';
        }
        $def_cmd_link = ($def_command['link'] ?? '');
 
        // workaround for scorm
        list($modified_link, $def_cmd_frame) =
            $this->modifySAHSlaunch($def_cmd_link, $def_cmd_frame);
 
        $image = $this->getTileImage();
 
        if ($def_cmd_link != '') {    // #24256
            if ($def_cmd_frame !== '' && ($modified_link === $def_cmd_link)) {
                $signal = (new SignalGenerator())->create();
                $this->main_tpl->addOnLoadCode(
                    "$(document).on('{$signal->getId()}', function(event, signalData) {"
                        . ' window.open("' . str_replace(
                            '&amp;',
                            '&',
                            $def_cmd_link
                        ) . '", "' . $def_cmd_frame . '");'
                    . '});'
                );
 
                $image = $image->withAction($signal);
 
                $button =
                    $ui->factory()->button()->shy($title, '')->appendOnClick($signal);
                $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'],
                (bool) $app_info['fullday']
            ) . $title;
        }
 
        $icon = $this->ui->factory()->symbol()->icon()->custom(
            $this->getTypeIcon(),
            $this->buildTranslatedType(),
            'medium'
        );
 
        // card title action
        $card_title_action = '';
        if ($def_cmd_link != '' && ($def_cmd_frame == '' || $modified_link != $def_cmd_link)) {    // #24256
            $card_title_action = $modified_link;
        } elseif ($def_cmd_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 (isset($p['alert']) && $p['alert'] == true
                && isset($p['property']) && $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.

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

     : ?Item {
        $ui = $this->ui;
 
        // even b tag produced bugs, see #32304
        $description = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
            $description
        );
 
        $this->initItem(
            $ref_id,
            $obj_id,
            $type,
            $title,
            $description
        );
 
        $this->enableCommands(true);
 
        // actions
        $this->populateCommands(false);
 
        $dropdown = $this->getCommandsDropdown($title);
        $def_command = $this->getDefaultCommand();
 
        if ($def_command['link'] ?? false) {
            list($def_command['link'], $def_command['frame']) =
                $this->modifySAHSlaunch($def_command['link'], $def_command['frame']);
            $new_viewport = !in_array($def_command['frame'], ['', '_top', '_self', '_parent'], true);
            $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(
            $this->ui->factory()->symbol()->icon()->custom(
                $this->getTypeIcon(),
                $this->buildTranslatedType(),
                'medium'
            )
        );
 
 
        $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);
        }
 
        return $list_item;
    }

getCheckboxStatus()

ilObjectListGUI::getCheckboxStatus

(

)

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

                                       : bool
    {
        return $this->checkboxes_enabled;
    }

References $checkboxes_enabled.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

getCommandFrame()

ilObjectListGUI::getCommandFrame

(

string

$cmd

)

Get command target frame.

Overwrite this method if link frame is not current frame

Parameters

string

$cmd

command

Returns

string command target frame

Reimplemented in ilObjFileListGUI, ilObjGroupListGUI, ilObjFileBasedLMListGUI, ilObjIndividualAssessmentListGUI, ilObjRemoteCategoryListGUI, ilObjRemoteCourseListGUI, ilObjRemoteFileListGUI, ilObjRemoteGlossaryListGUI, ilObjRemoteGroupListGUI, ilObjRemoteLearningModuleListGUI, ilObjRemoteTestListGUI, ilObjRemoteWikiListGUI, ilObjectPluginListGUI, ilObjQuestionPoolListGUI, and ilObjLinkResourceListGUI.

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

                                                : string
    {
        return '';
    }

Referenced by ilObjOrgUnitListGUI\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

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjGroupReferenceListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

                                  : int
    {
        return $this->ref_id;
    }

References $ref_id.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

getCommandImage()

ilObjectListGUI::getCommandImage

(

string

$cmd

)

Get command icon image.

Overwrite this method if an icon is provided

Parameters

string

$cmd

command

Returns

string image path

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

                                                : string
    {
        return '';
    }

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 because 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, ilObjFileListGUI, and ilObjTestListGUI.

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

                                 : array
    {
        $ref_commands = [];
        foreach ($this->commands as $command) {
            $permission = $command['permission'];
            $cmd = $command['cmd'];
            $lang_var = $command['lang_var'] ?? '';
            $txt = '';
            $info_object = null;
            $cmd_link = '';
            $cmd_frame = '';
            $cmd_image = '';
            $access_granted = false;
 
            if (isset($command['txt'])) {
                $txt = $command['txt'];
            }
 
            // Suppress commands that don't make sense for anonymous users
            if (
                $this->user->getId() == ANONYMOUS_USER_ID &&
                (isset($command['enable_anonymous']) && $command['enable_anonymous'] == 'false')
            ) {
                continue;
            }
 
            // all access checking should be made within $this->access and
            // the checkAccess of the ilObj...Access classes
            // $access = $this->access->checkAccess($permission, $cmd, $this->ref_id, $this->type);
            $access = $this->checkCommandAccess($permission, $cmd, $this->ref_id, $this->type);
 
            if ($access) {
                $access_granted = true;
                $cmd_link = $this->getCommandLink($command['cmd']);
                $cmd_frame = $this->getCommandFrame($command['cmd']);
                $cmd_image = $this->getCommandImage($command['cmd']);
            } else {
                $info_object = $this->access->getInfo();
            }
 
            if (!isset($command['default'])) {
                $command['default'] = '';
            }
            $ref_commands[] = [
                '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 ILIAS\Repository\access(), ANONYMOUS_USER_ID, and ILIAS\Repository\user().

Here is the call graph for this function:

getCommandsDropdown()

ilObjectListGUI::getCommandsDropdown ( string  $title, bool  $for_header = false  )

private

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

                                                                                 : StandardDropdown
    {
        $this->populateCommands($for_header);
        return $this->ui->factory()
            ->dropdown()
            ->standard($this->current_actions)
            ->withAriaLabel(sprintf(
                $this->lng->txt('actions_for'),
                htmlspecialchars(addslashes($title))
            ));
    }

getCommandsHTML()

ilObjectListGUI::getCommandsHTML

(

string

$title = ''

)

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

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

                                                       : string
    {
        return $this->ui->renderer()->render($this->getCommandsDropdown($title, false));
    }

getCommandsStatus()

ilObjectListGUI::getCommandsStatus

(

)

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

                                       : bool
    {
        return $this->commands_enabled;
    }

References $commands_enabled.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

getContainerObject()

ilObjectListGUI::getContainerObject

(

)

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

                                        : ?object
    {
        return $this->container_obj;
    }

References $container_obj.

getCopyStatus()

ilObjectListGUI::getCopyStatus

(

)

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

                                   : bool
    {
        return $this->copy_enabled;
    }

References $copy_enabled.

getCustomProperties()

ilObjectListGUI::getCustomProperties

(

array

$prop

)

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

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

getCutStatus()

ilObjectListGUI::getCutStatus

(

)

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

                                  : bool
    {
        return $this->cut_enabled;
    }

References $cut_enabled.

getDefaultCommand()

ilObjectListGUI::getDefaultCommand

(

)

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

                                       : array
    {
        return $this->default_command;
    }

References $default_command.

getDeleteStatus()

ilObjectListGUI::getDeleteStatus

(

)

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

                                     : bool
    {
        return $this->delete_enabled;
    }

References $delete_enabled.

getDescription()

ilObjectListGUI::getDescription

(

)

getDescription overwritten in class.ilObjLinkResourceList.php

Reimplemented in ilObjLinkResourceListGUI.

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

                                    : string
    {
        return $this->description;
    }

References $description.

getDescriptionStatus()

ilObjectListGUI::getDescriptionStatus

(

)

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

                                          : bool
    {
        return $this->description_enabled;
    }

References $description_enabled.

getDetailsLevel()

ilObjectListGUI::getDetailsLevel

(

)

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

                                     : int
    {
        return $this->details_level;
    }

References $details_level.

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

Here is the caller graph for this function:

getDownloadCheckboxState()

ilObjectListGUI::getDownloadCheckboxState

(

)

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

                                              : int
    {
        return $this->download_checkbox_state;
    }

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

getExpandStatus()

ilObjectListGUI::getExpandStatus

(

)

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

                                     : bool
    {
        return $this->expand_enabled;
    }

References $expand_enabled.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

getHeaderAction()

ilObjectListGUI::getHeaderAction

(

?ilGlobalTemplateInterface

$main_tpl = null

)

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

                                                                                : string
    {
        if ($main_tpl == null) {
            $main_tpl = $this->main_tpl;
        }
 
        $htpl = new ilTemplate('tpl.header_action.html', true, true, 'components/ILIAS/ILIASObject');
 
        $redraw_js = 'il.Object.redrawActionHeader();';
 
        // tags
        if ($this->tags_enabled) {
            $tags = ilTagging::getTagsForUserAndObject(
                $this->obj_id,
                ilObject::_lookupType($this->obj_id),
                0,
                '',
                $this->user->getId()
            );
            if (count($tags) > 0) {
                $this->lng->loadLanguageModule('tagging');
 
                $f = $this->ui->factory();
                $this->addHeaderGlyph(
                    'tags',
                    $f->symbol()->glyph()->tag()
                      ->withCounter($f->counter()->status(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) {
            $type = ($this->sub_obj_type == '') ? $this->type : $this->sub_obj_type;
            $context = $this->notes_service->data()->context($this->obj_id, $this->sub_obj_id, $type);
            $cnt[$this->obj_id][Note::PUBLIC] = $this->notes_service->domain()->getNrOfCommentsForContext($context);
            $cnt[$this->obj_id][Note::PRIVATE] = $this->notes_service->domain()->getNrOfNotesForContext($context);
            if (
                $this->notes_enabled &&
                isset($cnt[$this->obj_id][Note::PRIVATE]) &&
                $cnt[$this->obj_id][Note::PRIVATE] > 0
            ) {
                $f = $this->ui->factory();
                $this->addHeaderGlyph(
                    'notes',
                    $f->symbol()->glyph()->note()
                      ->withCounter($f->counter()->status((int) $cnt[$this->obj_id][Note::PRIVATE])),
                    ilNoteGUI::getListNotesJSCall($this->ajax_hash, $redraw_js)
                );
            }
 
            if (
                $comments_enabled &&
                isset($cnt[$this->obj_id][Note::PUBLIC]) &&
                $cnt[$this->obj_id][Note::PUBLIC] > 0
            ) {
                $this->lng->loadLanguageModule('notes');
                $f = $this->ui->factory();
                $this->addHeaderGlyph(
                    'comments',
                    $f->symbol()->glyph()->comment()
                      ->withCounter($f->counter()->status((int) $cnt[$this->obj_id][Note::PUBLIC])),
                    ilNoteGUI::getListCommentsJSCall($this->ajax_hash, $redraw_js)
                );
            }
        }
 
        // rating
        if ($this->rating_enabled) {
            $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);
            }
 
            $ajax_hash = $this->force_rate_parent
                ? ilCommonActionDispatcherGUI::removeSubObjFromAjaxHash($this->ajax_hash)
                : $this->ajax_hash;
            $this->ctrl->setParameterByClass('ilRatingGUI', 'cadh', $ajax_hash);
            $this->ctrl->setParameterByClass('ilRatingGUI', 'rnsb', true);
            if ($this->rating_ctrl_path) {
                $rating_gui->setCtrlPath($this->rating_ctrl_path);
                $ajax_url = $this->ctrl->getFormActionByClass($this->rating_ctrl_path, 'saveRating', '', true);
            } else {
                $ajax_url = $this->ctrl->getFormActionByClass('ilRatingGUI', 'saveRating', '', true);
            }
            $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) {
            $chunks = [];
            foreach ($this->header_icons as $id => $attr) {
                $id = 'headp_' . $id;
 
                if (is_array($attr)) {
                    if (isset($attr['glyph']) && $attr['glyph']) {
                        $renderer = $this->ui->renderer();
                        if (!empty($attr['onclick'])) {
                            $html = $renderer->render(
                                $this->getHeaderGlyphShyButton($attr['glyph'], $attr['onclick'])
                            );
                        } else {
                            $html = '<span class="prop">'
                                . $renderer->render($attr['glyph'])
                                . '</span>';
                        }
                        $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_SRC', $attr['img']);
                        if ($attr['href'] != '') {
                            $htpl->setVariable('PROP_HREF', ' href="' . $attr['href'] . '" ');
                        }
 
                        if ($attr['tooltip']) {
                            $htpl->setVariable('IMG_ADDITIONAL', "alt=\"{$attr['tooltip']}\" title=\"{$attr['tooltip']}\"");
                        }
                        $htpl->parseCurrentBlock();
                    }
                } else {
                    $chunks[] = $attr;
                }
            }
 
            if (sizeof($chunks)) {
                $htpl->setVariable(
                    'PROP_CHUNKS',
                    implode('&nbsp;&nbsp;&nbsp;', $chunks) . '&nbsp;&nbsp;&nbsp;'
                );
            }
        }
 
        $this->setTitle(ilObject::_lookupTitle($this->obj_id));
        $dropdown_label = '<span class="hidden-xs">' .
                $this->lng->txt('actions') .
                '</span>';
        $dropdown = $this->getCommandsDropdown($dropdown_label, true);
        $htpl->setVariable(
            'ACTION_DROP_DOWN',
            $this->ui->renderer()->render($dropdown)
        );
 
        if ($this->cust_modals !== []) {
            $htpl->setVariable('TRIGGERED_MODALS', $this->ui->renderer()->render($this->cust_modals));
        }
 
        return $htpl->get();
    }

References Vendor\Package\$f, $id, $renderer, ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\UICore\GlobalTemplate\addOnLoadCode(), ILIAS\Repository\ctrl(), ilNoteGUI\getListCommentsJSCall(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), ilTagging\getTagsForUserAndObject(), ILIAS\Repository\lng(), ilCommonActionDispatcherGUI\removeSubObjFromAjaxHash(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

getHeaderGlyphShyButton()

ilObjectListGUI::getHeaderGlyphShyButton ( ILIAS\UI\Component\Symbol\Glyph\Glyph  $glyph, string  $onclick_js  )

protected

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

     : ILIAS\UI\Component\Button\Shy {
        return $this->ui->factory()->button()
            ->shy('', '')
            ->withSymbol($glyph)
            ->withAdditionalOnLoadCode(
                static function (string $id) use ($onclick_js): string {
                    return '$("#' . $id . '").on("click", function(event) {'
                        . $onclick_js
                        . ' return false; });';
                }
            );
    }

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

                                      : string
    {
        return $this->type;
    }

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

Here is the caller graph for this function:

getIconStatus()

ilObjectListGUI::getIconStatus

(

)

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

                                   : bool
    {
        return $this->icons_enabled;
    }

References $icons_enabled.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

getInfoScreenStatus()

ilObjectListGUI::getInfoScreenStatus

(

)

Reimplemented in ilObjCategoryListGUI, ilObjContentPageListGUI, ilObjFileBasedLMListGUI, and ilObjLearningModuleListGUI.

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

                                         : bool
    {
        return $this->info_screen_enabled;
    }

References $info_screen_enabled.

getItemDetailLinkStatus()

ilObjectListGUI::getItemDetailLinkStatus

(

)

get item detail link status

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

                                             : bool
    {
        return $this->item_detail_links_enabled;
    }

References $item_detail_links_enabled.

getLinkStatus()

ilObjectListGUI::getLinkStatus

(

)

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

                                   : bool
    {
        return $this->link_enabled;
    }

References $link_enabled.

getListItemHTML()

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

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

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

     : string {
        // this variable stores whether any admin commands
        // are included in the output
        $this->adm_commands_included = false;
 
        // only for performance exploration
        $type = ilObject::_lookupType($obj_id);
 
        $this->initItem($ref_id, $obj_id, $type, $title, $description);
 
        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(
                    '',
                    $rating->getListGUIProperty($this->ref_id, $may_rate, $this->ajax_hash, $this->parent_ref_id),
                    false,
                    true
                );
            }
        }
 
        // visible check
        if (!$this->checkCommandAccess('visible', '', $ref_id, '', $obj_id)) {
            $this->resetCustomData();
            return '';
        }
 
        // BEGIN WEBDAV
        if ($type == 'file' and ilObjFileAccess::_isFileHidden($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()) {
                $dropdown = $this->getCommandsDropdown($title);
                $this->tpl->setVariable(
                    'COMMAND_SELECTION_LIST',
                    $this->ui->renderer()->render($dropdown)
                );
            }
        }
 
        if ($this->getProgressInfoStatus()) {
            $this->insertProgressInfo();
        }
 
        // insert title and describtion
        $this->insertTitle();
        if (!$this->isMode(self::IL_LIST_AS_TRIGGER)) {
            if ($this->getDescriptionStatus()) {
                $this->insertDescription();
            }
        }
 
        if ($this->getSearchFragmentStatus()) {
            $this->insertSearchFragment();
        }
 
        // 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();
 
        $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', '');
        }
 
        // if file upload is enabled the content is wrapped by a UI dropzone.
        $content = $this->tpl->get();
        $file_upload_dropzone = new ilObjFileUploadDropzone($this->ref_id, $content);
        if ($this->context === self::CONTEXT_REPOSITORY
            && ($this->requested_cmd === "view" || $this->requested_cmd === "" || $this->requested_cmd === "render")
            && $file_upload_dropzone->isUploadAllowed($this->type)
             && !(new ModeSessionRepository())->isAdminMode()
        ) {
            return $file_upload_dropzone->getDropzoneHtml();
        }
 
        return $content;
    }

getMode()

ilObjectListGUI::getMode

(

)

get output mode

Returns

string output mode (self::IL_LIST_FULL | self::IL_LIST_AS_TRIGGER)

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

                             : string
    {
        return $this->mode;
    }

getNoticeProperties()

ilObjectListGUI::getNoticeProperties

(

)

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

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

References $info.

getNoticePropertiesStatus()

ilObjectListGUI::getNoticePropertiesStatus

(

)

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

                                               : bool
    {
        return $this->notice_properties_enabled;
    }

References $notice_properties_enabled.

getPathStatus()

ilObjectListGUI::getPathStatus

(

)

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

                                   : bool
    {
        return $this->path_enabled;
    }

References $path_enabled.

getPreconditionsStatus()

ilObjectListGUI::getPreconditionsStatus

(

)

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

                                            : bool
    {
        return $this->preconditions_enabled;
    }

References $preconditions_enabled.

getProgressInfoStatus()

ilObjectListGUI::getProgressInfoStatus

(

)

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

                                           : bool
    {
        return $this->progress_enabled;
    }

References $progress_enabled.

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, ilObjCategoryReferenceListGUI, ilObjChatroomListGUI, ilObjCmiXapiListGUI, ilObjCmiXapiVerificationListGUI, ilObjContentPageListGUI, ilObjCourseListGUI, ilObjCourseVerificationListGUI, ilObjCourseReferenceListGUI, ilObjDataCollectionListGUI, ilObjExerciseListGUI, ilObjExerciseVerificationListGUI, ilObjFileListGUI, ilObjForumListGUI, ilObjGroupListGUI, ilObjGroupReferenceListGUI, ilObjFileBasedLMListGUI, ilObjItemGroupListGUI, ilObjLearningModuleListGUI, ilObjLTIConsumerListGUI, ilObjLTIConsumerVerificationListGUI, ilObjRemoteCategoryListGUI, ilObjRemoteCourseListGUI, ilObjRemoteFileListGUI, ilObjRemoteGlossaryListGUI, ilObjRemoteGroupListGUI, ilObjRemoteLearningModuleListGUI, ilObjRemoteTestListGUI, ilObjRemoteWikiListGUI, ilObjectPluginListGUI, ilObjSAHSLearningModuleListGUI, ilObjSCORMVerificationListGUI, ilObjSessionListGUI, ilObjStudyProgrammeReferenceListGUI, ilObjSurveyListGUI, ilObjTestListGUI, ilObjTestVerificationListGUI, ilObjQuestionPoolListGUI, and ilObjWikiListGUI.

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

                                   : array
    {
        $props = [];
 
        // #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' => $this->lng->txt('status'),
                        'value' => $this->lng->txt('offline')
                    ];
            }
        }
 
        return $props;
    }

References ILIAS\Repository\lng(), and ilObject\lookupOfflineStatus().

Here is the call graph for this function:

getPropertiesStatus()

ilObjectListGUI::getPropertiesStatus

(

)

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

                                         : bool
    {
        return $this->properties_enabled;
    }

References $properties_enabled.

getRelevance()

ilObjectListGUI::getRelevance

(

)

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

                                  : int
    {
        return $this->relevance;
    }

References $relevance.

getSearchFragment()

ilObjectListGUI::getSearchFragment

(

)

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

                                       : string
    {
        return $this->search_fragment;
    }

References $search_fragment.

getSearchFragmentStatus()

ilObjectListGUI::getSearchFragmentStatus

(

)

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

                                             : bool
    {
        return $this->search_fragment_enabled;
    }

References $search_fragment_enabled.

getSeparateCommands()

ilObjectListGUI::getSeparateCommands

(

)

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

                                         : bool
    {
        return $this->separate_commands;
    }

References $separate_commands.

getSubscribeStatus()

ilObjectListGUI::getSubscribeStatus

(

)

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

                                        : bool
    {
        return $this->subscribe_enabled;
    }

References $subscribe_enabled.

getSubstitutionStatus()

ilObjectListGUI::getSubstitutionStatus

(

)

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

                                           : bool
    {
        return $this->substitutions_enabled;
    }

References $substitutions_enabled.

getTileImage()

ilObjectListGUI::getTileImage ( )

private

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

                                   : Image
    {
        return $this->object_properties->getPropertyTileImage()
            ->getTileImage()->getImage($this->ui->factory()->image());
    }

getTitle()

ilObjectListGUI::getTitle

(

)

getTitle overwritten in class.ilObjLinkResourceList.php

Reimplemented in ilObjFileListGUI, ilObjSessionListGUI, and ilObjLinkResourceListGUI.

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

                              : string
    {
        return $this->title;
    }

References $title.

getTypeIcon()

ilObjectListGUI::getTypeIcon

(

)

Get object type specific type icon.

Reimplemented in ilObjOrgUnitListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

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

getUniqueItemId()

ilObjectListGUI::getUniqueItemId

(

bool

$as_div = false

)

Get unique item identifier (for js-actions)

Parameters

bool

$a_as_div

Returns

string

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

                                                         : string
    {
        // use correct id for references
        $id_ref = $this->ref_id;
        if ($this->reference_ref_id > 0) {
            $id_ref = $this->reference_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 (!$as_div) {
            return $id_ref;
        } else {
            // action menu [yellow] toggle
            return 'lg_div_' . $id_ref;
        }
    }

init()

ilObjectListGUI::init

(

)

initialisation

this method should be overwritten by derived classes

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

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

                          : void
    {
        // 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.
        $this->commands = ilObjectAccess::_getCommands();
    }

References ilObjectAccess\_getCommands().

Here is the call graph for this function:

initItem()

ilObjectListGUI::initItem	(	int	$ref_id,
		int	$obj_id,
		string	$type,
		string	$title = '',
		string	$description = ''
	)

initialize new item (is called by getItemHTML())

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

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

     : void {
        $this->access_cache = [];
        $this->ref_id = $ref_id;
        $this->obj_id = $obj_id;
        $this->object_properties = $this->object_dic['properties.aggregator']->getFor($obj_id);
        $this->setTitle($title);
        $this->setDescription($description);
 
        // checks, whether any admin commands are included in the output
        $this->adm_commands_included = false;
        $this->prevent_access_caching = false;
 
        // prepare ajax calls
        if ($this->context == self::CONTEXT_REPOSITORY) {
            $node_type = ilCommonActionDispatcherGUI::TYPE_REPOSITORY;
        } else {
            $node_type = ilCommonActionDispatcherGUI::TYPE_WORKSPACE;
        }
        $this->setAjaxHash(ilCommonActionDispatcherGUI::buildAjaxHash($node_type, $ref_id, $type, $obj_id));
    }

insertCommand()

ilObjectListGUI::insertCommand	(	string	$href,
		string	$text,
		string	$frame = '',
		string	$img = '',
		string	$cmd = '',
		string	$onclick = ''
	)

insert command button

Reimplemented in ilObjBlogListGUI.

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

     : void {
        // #11099
        $checksum = md5($href . $text);
        if ($href !== '#' && in_array($checksum, $this->prevent_duplicate_commands)) {
            return;
        }
 
        if ($href !== '#') {
            $this->prevent_duplicate_commands[] = $checksum;
        }
 
        if ($cmd === 'mount_webfolder') {
            $onclick = "triggerWebDAVModal('$href')";
            $href = '#';
            ModalGUI::maybeRenderWebDAVModalInGlobalTpl();
        }
 
        $action = $this->ui->factory()
            ->button()
            ->shy($text, $href);
 
        if ($frame !== '') {
            $action = $this->ui->factory()->link()->standard($text, $href)->withOpenInNewViewport(true);
        }
 
        if ($onclick !== '') {
            $action = $action->withAdditionalOnLoadCode(function ($id) use ($onclick): string {
                return "$('#$id').click(function(){" . $onclick . ';});';
            });
        }
 
 
 
        $this->current_actions[] = $action;
    }

Referenced by ilObjOrgUnitListGUI\insertInfoScreenCommand().

Here is the caller graph for this function:

insertCommonSocialCommands()

ilObjectListGUI::insertCommonSocialCommands

(

bool

$header_actions = false

)

Insert common social commands (comments, notes, tagging)

Reimplemented in ilObjOrgUnitListGUI, ilObjTalkTemplateAdministrationListGUI, ilObjTalkTemplateListGUI, and ilObjEmployeeTalkSeriesListGUI.

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

                                                                            : void
    {
        if ($this->std_cmd_only || $this->user->isAnonymous()) {
            return;
        }
 
        $this->lng->loadLanguageModule('notes');
        $this->lng->loadLanguageModule('tagging');
        $cmd_frame = $this->getCommandFrame('infoScreen');
 
        // 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 = $header_actions
            ? 'il.Object.redrawActionHeader();'
            : 'il.Object.redrawListItem(' . $note_ref_id . ')';
 
        $comments_enabled = $this->isCommentsActivated($this->type, $this->ref_id, $this->obj_id, $header_actions);
        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) {
            $this->insertCommand(
                '#',
                $this->lng->txt('tagging_set_tag'),
                $cmd_frame,
                '',
                '',
                ilTaggingGUI::getListTagsJSCall($this->ajax_hash, $js_updater)
            );
        }
    }

References $ref_id, ilNoteGUI\getListCommentsJSCall(), ilNoteGUI\getListNotesJSCall(), ilTaggingGUI\getListTagsJSCall(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

insertCopyCommand()

ilObjectListGUI::insertCopyCommand

(

bool

$to_repository = false

)

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

                                                                  : void
    {
        if ($this->std_cmd_only) {
            return;
        }
 
        if ($this->checkCommandAccess('copy', 'copy', $this->ref_id, $this->type) &&
            $this->obj_definition->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([get_class($this->container_obj), 'ilobjectcopygui'], 'initTargetSelection');
                $this->insertCommand($cmd_copy, $this->lng->txt('copy'));
            } else {
                $this->ctrl->setParameter(
                    $this->container_obj,
                    'ref_id',
                    $this->container_obj->getObject()->getRefId()
                );
                $this->ctrl->setParameter($this->container_obj, 'item_ref_id', $this->getCommandId());
 
                if (!$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;
        }
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertCutCommand()

ilObjectListGUI::insertCutCommand

(

bool

$to_repository = false

)

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

                                                                 : void
    {
        if ($this->std_cmd_only) {
            return;
        }
        // BEGIN PATCH Lucene search
        if (
            $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;
        }
        // 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->getObject()) {
            $this->ctrl->setParameter(
                $this->container_obj,
                'ref_id',
                $this->container_obj->getObject()->getRefId()
            );
            $this->ctrl->setParameter($this->container_obj, 'item_ref_id', $this->getCommandId());
 
            if (!$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 ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertDeleteCommand()

ilObjectListGUI::insertDeleteCommand

(

)

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

                                         : void
    {
        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;
        }
 
        if ($this->checkCommandAccess('delete', '', $this->ref_id, $this->type)) {
            $this->ctrl->setParameter(
                $this->container_obj,
                'ref_id',
                $this->container_obj->getObject()->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 ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertDescription()

ilObjectListGUI::insertDescription

(

)

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

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

insertIconsAndCheckboxes()

ilObjectListGUI::insertIconsAndCheckboxes

(

)

Reimplemented in ilObjLTIConsumerListGUI.

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

                                              : void
    {
        $cnt = 0;
        if ($this->getCheckboxStatus()) {
            $this->tpl->setCurrentBlock('check');
            $this->tpl->setVariable('VAL_ID', $this->getCommandId());
            $this->tpl->setVariable('CHECK_TITLE', $this->lng->txt('select') . ' ' . $this->getTitle());
            $this->tpl->parseCurrentBlock();
            $cnt += 1;
        } elseif ($this->getDownloadCheckboxState() != self::DOWNLOAD_CHECKBOX_NONE) {
            $this->tpl->setCurrentBlock('check_download');
            $this->tpl->setVariable('CHECK_DOWNLOAD_TITLE', $this->lng->txt('download') . ' ' . $this->getTitle());
            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('nav/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('nav/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');
            }
 
            $this->tpl->setCurrentBlock('icon');
            $this->tpl->setVariable('ALT_ICON', $this->buildTranslatedType());
 
            $this->tpl->setVariable(
                'SRC_ICON',
                $this->getTypeIcon()
            );
            $this->tpl->parseCurrentBlock();
            $cnt += 1;
        }
 
        $this->tpl->touchBlock('d_' . $cnt);
    }

insertInfoScreenCommand()

ilObjectListGUI::insertInfoScreenCommand

(

)

Reimplemented in ilObjOrgUnitListGUI.

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

                                             : void
    {
        if ($this->std_cmd_only) {
            return;
        }
        $this->insertCommand(
            $this->getCommandLink('infoScreen'),
            $this->lng->txt('info_short'),
            $this->getCommandFrame('infoScreen'),
            ilUtil::getImagePath('standard/icon_info.svg')
        );
    }

References ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertItemDetailLinks()

ilObjectListGUI::insertItemDetailLinks

(

)

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

                                           : void
    {
        if (!count($this->item_detail_links)) {
            return;
        }
        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();
    }

References $info.

insertLinkCommand()

ilObjectListGUI::insertLinkCommand

(

)

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

                                       : void
    {
        $objDefinition = $this->obj_definition;
 
        if ($this->std_cmd_only) {
            return;
        }
 
        // #17307
        if (
            !$this->checkCommandAccess('delete', '', $this->ref_id, $this->type) ||
            !$objDefinition->allowLink($this->type)
        ) {
            return;
        }
 
        // BEGIN PATCH Lucene search
        if ($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;
        }
        // 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->getObject()->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;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertLPCommand()

ilObjectListGUI::insertLPCommand

(

)

insert learning progress command

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

                                     : void
    {
        if ($this->std_cmd_only || !$this->lp_cmd_enabled) {
            return;
        }
        $relevant = ilLPStatus::hasListGUIStatus($this->obj_id);
        if ($relevant) {
            $cmd_link = $this->getCommandLink('learningProgress');
            $this->insertCommand(
                $cmd_link,
                $this->lng->txt('learning_progress')
            );
        }
    }

insertLPSettingsCommand()

ilObjectListGUI::insertLPSettingsCommand ( )

private

Deprecated:

in 9.0 (we need a better way to do this!)

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

                                              : void
    {
        if (!$this->lp_settings_cmd_enabled
            || !ilObjUserTracking::_enabledLearningProgress()
            || ilObjectLP::getTypeClass($this->type) === ''
            || ! $this->checkCommandAccess('edit_learning_progress', '', $this->ref_id, $this->type)
        ) {
            return;
        }
 
        $cmd_link = '';
        $this->ctrl->setParameterByClass(ilLearningProgressGUI::class, 'ref_id', $this->ref_id);
        switch ($this->type) {
            case 'sahs':
                switch (ilObjSAHSLearningModule::_lookupSubType($this->obj_id)) {
                    case 'scorm2004':
                        $scorm_class = ilObjSCORM2004LearningModuleGUI::class;
                        break;
                    case 'scorm':
                        $scorm_class = ilObjSCORMLearningModuleGUI::class;
                        break;
                    default:
                        $scorm_class = '';
                        break;
                }
 
                $cmd_link = $this->ctrl->getLinkTargetByClass([
                    ilSAHSEditGUI::class,
                    $scorm_class,
                    ilLearningProgressGUI::class,
                    ilLPListOfSettingsGUI::class
                ]);
                break;
 
            case 'lm':
                $cmd_link = $this->ctrl->getLinkTargetByClass([
                    ilLMEditorGUI::class,
                    ilObjLearningModuleGUI::class,
                    ilLearningProgressGUI::class,
                    ilLPListOfSettingsGUI::class
                ]);
                break;
 
            case 'lso':
                $cmd_link = $this->ctrl->getLinkTargetByClass([
                    ilObjLearningSequenceGUI::class,
                    ilLearningProgressGUI::class,
                    ilLPListOfSettingsGUI::class
                ]);
                break;
 
            case 'copa':
            case 'iass':
            case 'tst':
            case 'htlm':
            case 'exc':
            case 'svy':
            case 'mcst':
            case 'file':
            case 'crs':
                $gui_class = 'ilObj' . $this->obj_definition->getClassName($this->type) . 'GUI';
                $cmd_link = $this->ctrl->getLinkTargetByClass([
                        ilRepositoryGUI::class,
                        $gui_class,
                        ilLearningProgressGUI::class,
                        ilLPListOfSettingsGUI::class
                ]);
                break;
 
            case 'prgr':
            case 'prg':
            case 'lso':
                break;
            default:
                break;
        }
 
        $this->ctrl->setParameterByClass('ilrepositorygui', 'ref_id', $this->requested_ref_id);
        if ($cmd_link !== '') {
            $this->insertCommand(
                $cmd_link,
                $this->lng->txt('listaction_learning_progress_settings')
            );
        }
    }

insertMultiDownloadCommand()

ilObjectListGUI::insertMultiDownloadCommand

(

)

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

                                                : void
    {
        if ($this->std_cmd_only) {
            return;
        }
 
        if (!$this->obj_definition->isContainer(ilObject::_lookupType($this->obj_id))) {
            return;
        }
 
        if ($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(), $this->requested_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 = ($this->requested_cmd == 'enableAdministrationPanel')
                    ? 'render'
                    : 'enableAdministrationPanel';
            } else {
                $cmd = ($this->requested_cmd == 'enableMultiDownload')
                    ? 'render'
                    : 'enableMultiDownload';
            }
            $cmd_link = $this->ctrl->getLinkTarget($this->getContainerObject(), $cmd);
            $this->insertCommand($cmd_link, $this->lng->txt('download_multiple_objects'));
        }
    }

References $user_id, ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

insertNoticeProperties()

ilObjectListGUI::insertNoticeProperties

(

)

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

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

insertPasteCommand()

ilObjectListGUI::insertPasteCommand

(

)

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

                                        : void
    {
        if ($this->std_cmd_only) {
            return;
        }
 
        if (!$this->obj_definition->isContainer(ilObject::_lookupType($this->obj_id))) {
            return;
        }
 
        if (
            $this->getContainerObject() instanceof ilAdministrationCommandHandling &&
            $this->clipboard->hasEntries()
        ) {
            $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;
        }
    }

References ilObject\_lookupType(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertPath()

ilObjectListGUI::insertPath

(

)

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

                                : void
    {
        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 = ROOT_FOLDER_ID;
            if ($this->path_start_node) {
                $start_node = $this->path_start_node;
            }
 
            $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', $this->lng->txt('locator'));
            $this->tpl->parseCurrentBlock();
        }
    }

insertPositionField()

ilObjectListGUI::insertPositionField

(

)

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

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

insertPreconditions()

ilObjectListGUI::insertPreconditions

(

)

insert all missing preconditions

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

                                         : void
    {
        // do not show multi level conditions (messes up layout)
        if ($this->condition_depth > 0) {
            return;
        }
 
        if ($this->context == self::CONTEXT_WORKSPACE) {
            return;
        }
 
        if (isset($this->condition_target) && is_array($this->condition_target)
            && count($this->condition_target) > 0) {
            $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget(
                (int) $this->condition_target['ref_id'],
                (int) $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 = ilArrayUtil::sortArray($conditions, 'title', 'DESC');
 
            ++self::$js_unique_id;
            // Show obligatory and optional preconditions seperated
            $all_done_obl = $this->parseConditions(self::$js_unique_id, $conditions);
            $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 ilObject\_lookupTitle(), ILIAS\Repository\lng(), and ilArrayUtil\sortArray().

Here is the call graph for this function:

insertProgressInfo()

ilObjectListGUI::insertProgressInfo

(

)

Reimplemented in ilCourseObjectiveListGUI.

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

                                        : void
    {
    }

insertProperties()

ilObjectListGUI::insertProperties

(

)

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

                                      : void
    {
        $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 (isset($prop['alert']) && $prop['alert'] == true) {
                    $this->tpl->touchBlock('alert_prop');
                } else {
                    $this->tpl->touchBlock('std_prop');
                }
 
                if (isset($prop['newline']) && $prop['newline'] == true && $cnt > 1) {
                    $this->tpl->touchBlock('newline_prop');
                }
 
                //BEGIN WebDAV: Support hidden property names.
                if (
                    isset($prop['property']) &&
                    (($prop['propertyNameVisible'] ?? null) !== 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 (isset($prop['link']) && $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();
        }
    }

insertSearchFragment()

ilObjectListGUI::insertSearchFragment

(

)

Insert highlighted search fragment.

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

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

insertSubItems()

ilObjectListGUI::insertSubItems

(

)

Reimplemented in ilStudyProgrammeCourseListGUI.

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

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

insertSubscribeCommand()

ilObjectListGUI::insertSubscribeCommand

(

)

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

                                            : void
    {
        if ($this->std_cmd_only
            || $this->user->getId() === ANONYMOUS_USER_ID
            || !$this->getContainerObject() instanceof ilDesktopItemHandling
            || $this->settings->get('rep_favourites', '0') !== '1') {
            return;
        }
 
        $type = ilObject::_lookupType(ilObject::_lookupObjId($this->getCommandId()));
 
        // #17467 - add ref_id to link (in repository only!)
        if (
            is_object($this->container_obj) &&
            !($this->container_obj instanceof ilAdministrationCommandHandling) &&
            method_exists($this->container_obj, 'getObject') &&
            is_object($this->container_obj->getObject())
        ) {
            $this->ctrl->setParameter(
                $this->container_obj,
                'ref_id',
                $this->container_obj->getObject()->getRefId()
            );
        }
        if ($this->getContainerObject() instanceof ilDesktopItemHandling) {
            $this->ctrl->setParameter($this->container_obj, 'type', $type);
            $this->ctrl->setParameter($this->container_obj, 'item_ref_id', $this->getCommandId());
 
            $this->lng->loadLanguageModule('dash');
            if (!$this->fav_manager->ifIsFavourite($this->user->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)) {
                    $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, 'addToDesk');
                    $this->insertCommand($cmd_link, $this->lng->txt('add_to_favourites'));
                }
            } else {
                $cmd_link = $this->ctrl->getLinkTarget($this->container_obj, 'removeFromDesk');
                $this->insertCommand($cmd_link, $this->lng->txt('remove_from_favourites'));
            }
 
            $this->ctrl->clearParameters($this->container_obj);
        }
    }

References ilObject\_lookupObjId(), ilObject\_lookupType(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

insertSubstitutions()

ilObjectListGUI::insertSubstitutions

(

)

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

                                         : void
    {
        $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;
        }
    }

References $data.

insertTimingsCommand()

ilObjectListGUI::insertTimingsCommand

(

)

ks, 23 OCT 2023: This function is badly named and it already was before the changes made today.

I decided to keept this so, for the time being as changes would be needed in multiple child classes and as this should change anyway.

Reimplemented in ilObjCategoryReferenceListGUI, ilObjCourseReferenceListGUI, ilObjTalkTemplateAdministrationListGUI, ilObjTalkTemplateListGUI, ilObjEmployeeTalkListGUI, ilObjEmployeeTalkSeriesListGUI, ilObjGroupReferenceListGUI, ilObjOrgUnitListGUI, ilObjStudyProgrammeListGUI, and ilObjStudyProgrammeReferenceListGUI.

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

                                          : void
    {
        if (
            $this->std_cmd_only || is_null($this->container_obj) ||
            !method_exists($this->container_obj, 'getObject') ||
            !is_object($this->container_obj->getObject())
        ) {
            return;
        }
 
        $parent_ref_id = $this->container_obj->getObject()->getRefId();
        $parent_type = $this->container_obj->getObject()->getType();
 
        // #18737
        if ($this->reference_ref_id) {
            $this->ctrl->setParameterByClass('ilconditionhandlergui', '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(
                get_class($this->container_obj),
                'ref_id',
                $this->container_obj->getObject()->getRefId()
            );
            $this->ctrl->setParameterByClass(
                get_class($this->container_obj),
                'tl_id',
                $this->ref_id
            );
            $time_limit_link = $this->ctrl->getLinkTargetByClass(
                get_class($this->container_obj),
                'editAvailabilityPeriod'
            );
            $this->insertCommand($time_limit_link, $this->lng->txt('edit_availability_period'));
            $this->ctrl->clearParameterByClass(
                get_class($this->container_obj),
                'tl_id',
            );
            $this->ctrl->setParameterByClass(
                get_class($this->container_obj),
                'ref_id',
                $this->ref_id
            );
 
            $this->ctrl->setParameterByClass(
                'ilconditionhandlergui',
                'cadh',
                $this->ajax_hash
            );
            $this->ctrl->setParameterByClass(
                'ilconditionhandlergui',
                'parent_id',
                $parent_ref_id
            );
 
            $availbility_link = $this->ctrl->getLinkTargetByClass(
                [$this->gui_class_name, 'ilcommonactiondispatchergui', 'ilobjectactivationgui', 'ilconditionhandlergui'],
                'listConditions'
            );
 
            $this->insertCommand($availbility_link, $this->lng->txt('preconditions'));
        }
 
        if ($this->reference_ref_id) {
            $this->ctrl->setParameterByClass('ilconditionhandlergui', 'ref_id', $this->ref_id);
        }
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

insertTitle()

ilObjectListGUI::insertTitle

(

)

Reimplemented in ilCourseObjectiveListGUI, and ilRemoteObjectBaseListGUI.

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

                                 : void
    {
        if ($this->restrict_to_goto) {
            $this->default_command = [
                '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());
        } else {
            $this->default_command['link'] = $this->modifyTitleLink($this->default_command['link']);
 
            list($this->default_command['link'], $this->default_command['frame']) =
                $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
            $this->default_command['link'] = $this->appendRepositoryFrameParameter($this->default_command['link']);
 
            // 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']);
 
            // New Preview Implementation, File-Objects only
            if ($this->type === 'file') {
                $preview = new ilObjFilePreviewRendererGUI($this->obj_id);
                if ($preview->has()) {
                    $this->tpl->setVariable('PREVIEW_GLYPH', $preview->getRenderedTriggerComponents());
                    $this->tpl->parseCurrentBlock();
                }
            }
        }
        $this->tpl->parseCurrentBlock();
 
        if ($this->bold_title == true) {
            $this->tpl->touchBlock('bold_title_start');
            $this->tpl->touchBlock('bold_title_end');
        }
    }

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

isCommentsActivated()

ilObjectListGUI::isCommentsActivated ( string  $type, int  $ref_id, int  $obj_id, bool  $header_actions, bool  $check_write_access = true  )

protected

Check comments status against comments settings and context.

Reimplemented in ilOrgUnitExtensionListGUI.

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

     : bool {
        if ($this->comments_enabled) {
            if (!$this->comments_settings_enabled) {
                return true;
            }
            if ($check_write_access && $this->checkCommandAccess('write', '', $ref_id, $type)) {
                return true;
            }
            // fallback to single object check if no preloaded data
            // only the repository does preloadCommonProperties() yet
            if (!$header_actions && self::$preload_done) {
                if (isset(self::$comments_activation[$obj_id]) &&
                    self::$comments_activation[$obj_id]) {
                    return true;
                }
            } elseif ($this->notes_service->domain()->commentsActive($obj_id)) {
                return true;
            }
        }
        return false;
    }

isExpanded()

ilObjectListGUI::isExpanded

(

)

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

                                : bool
    {
        return $this->is_expanded;
    }

References $is_expanded.

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

Here is the caller graph for this function:

isMode()

ilObjectListGUI::isMode

(

string

$mode

)

check current output mode

Parameters

string

$mode

(self::IL_LIST_FULL | self::IL_LIST_AS_TRIGGER)

Returns

bool true if current mode is $a_mode

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

                                        : bool
    {
        return $mode === $this->mode;
    }

isSideBlock()

ilObjectListGUI::isSideBlock

(

)

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

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

                                 : bool
    {
        return false;
    }

isTitleBold()

ilObjectListGUI::isTitleBold

(

)

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

                                 : bool
    {
        return $this->bold_title;
    }

isVisibleOnlyForced()

ilObjectListGUI::isVisibleOnlyForced

(

)

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

                                         : bool
    {
        return $this->force_visible_only;
    }

modifySAHSlaunch()

ilObjectListGUI::modifySAHSlaunch	(	string	$link,
		string	$target
	)

workaround: SAHS in new javavasript-created window or iframe

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

                                                                  : array
    {
        if (strstr($link, ilSAHSPresentationGUI::class) === false) {
            return [$link, $target];
        }
 
        $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 && !$this->http->agent()->isMobile()) {
            $this->default_command['frame'] = '';
            $link =
                'javascript:void(0); onclick=startSAHS(\'' .
                $link .
                '\',\'' .
                $target .
                '\',' .
                $om .
                ',' .
                $width .
                ',' .
                $height .
                ');'
            ;
        } else {
            $target = "ilContObj" . $this->ref_id;
        }
        return [$link, $target];
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

modifyTitleLink()

ilObjectListGUI::modifyTitleLink ( string  $default_link )

protected

Reimplemented in ilObjTestListGUI.

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

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

References $params.

parseConditions()

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

protected

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

                                                                                                  : bool
    {
        $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 fulfilled
        $visible_conditions = [];
        $passed_optional = 0;
        foreach ($conditions as $condition) {
            if ($obligatory && !$condition['obligatory']) {
                continue;
            }
            if (!$obligatory && $condition['obligatory']) {
                continue;
            }
 
            if ($this->tree->isDeleted($condition['trigger_ref_id'])) {
                continue;
            }
 
            $ok = ilConditionHandler::_checkCondition($condition) && !ilMemberViewSettings::getInstance()->isActive();
 
            if (!$ok) {
                $visible_conditions[] = $condition['id'];
            }
 
            if (!$obligatory && $ok) {
                ++$passed_optional;
                // optional passed
                if ($passed_optional >= $num_optional_required) {
                    return true;
                }
            }
        }
 
        $missing_cond_exist = false;
        foreach ($conditions as $condition) {
            if (!in_array($condition['id'], $visible_conditions)) {
                continue;
            }
 
            $cond_txt = ilConditionHandlerGUI::translateOperator($condition['trigger_obj_id'], $condition['operator'], $condition['value']);
 
            // display trigger item
            $class = $this->obj_definition->getClassName($condition['trigger_type']);
            $location = $this->obj_definition->getLocation($condition['trigger_type']);
            if ($class == '' && $location == '') {
                continue;
            }
            $missing_cond_exist = true;
 
            $full_class = 'ilObj' . $class . 'ListGUI';
            $item_list_gui = new $full_class($this->context);
            $item_list_gui->setMode(self::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->ref_id);
            $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 && $obligatory) {
            $this->tpl->setCurrentBlock('preconditions');
            $this->tpl->setVariable('CONDITION_TOGGLE_ID', '_obl_' . $toggle_id);
            $this->tpl->setVariable('TXT_PRECONDITIONS', $this->lng->txt('preconditions_obligatory_hint'));
            $this->tpl->parseCurrentBlock();
        } elseif ($missing_cond_exist && !$obligatory) {
            $this->tpl->setCurrentBlock('preconditions');
            $this->tpl->setVariable('CONDITION_TOGGLE_ID', '_opt_' . $toggle_id);
            $this->tpl->setVariable(
                'TXT_PRECONDITIONS',
                sprintf(
                    $this->lng->txt('preconditions_optional_hint'),
                    $num_optional_required - $passed_optional
                )
            );
            $this->tpl->parseCurrentBlock();
        }
 
        return !$missing_cond_exist;
    }

References $location, ilConditionHandler\_checkCondition(), ilObject\_lookupTitle(), ilConditionHandler\calculateEffectiveRequiredTriggers(), ilConditionHandler\getEffectiveOptionalConditionsOfTarget(), ilMemberViewSettings\getInstance(), ILIAS\Repository\lng(), and ilConditionHandlerGUI\translateOperator().

Here is the call graph for this function:

populateCommands()

ilObjectListGUI::populateCommands ( bool  $for_header )

private

insert all commands into html code

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

     : void {
        $commands = $this->getCommands();
        if (!$this->getCommandsStatus() || $this->commandsNeedToBeHidden($for_header)) {
            foreach ($commands as $command) {
                if ($command['default'] === true) {
                    $this->default_command = $command['granted'] === true ? $this->createDefaultCommand($command) : [];
                }
                return;
            }
            return;
        }
 
        $this->ctrl->setParameterByClass($this->gui_class_name, 'ref_id', $this->ref_id);
 
        $this->current_actions = [];
        $this->default_command = [];
        $this->prevent_duplicate_commands = [];
 
        // we only allow the following commands inside the header actions
        $valid_header_commands = ['mount_webfolder'];
 
        foreach ($commands as $command) {
            if ($for_header && !in_array($command['cmd'], $valid_header_commands)
                || $command['granted'] === false) {
                continue;
            }
 
            if ($command['default'] !== true) {
                if (!$this->std_cmd_only) {
                    // 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);
            }
        }
 
        // custom commands
        if (is_array($this->cust_commands)) {
            foreach ($this->cust_commands as $command) {
                if ($command instanceof Button) {
                    $this->current_actions[] = $command;
                    continue;
                }
 
                $this->insertCommand(
                    $command['link'],
                    $this->lng->txt($command['lang_var']),
                    $command['frame'],
                    '',
                    $command['cmd'] ?? '',
                    $command['onclick']
                );
            }
        }
        $this->insertLPSettingsCommand();
 
        // info screen command
        if ($this->getInfoScreenStatus()) {
            $this->insertInfoScreenCommand();
        }
 
        $this->insertLPCommand();
 
        if (!$this->isMode(self::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 && $for_header) {
                $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 (!$this->isMode(self::IL_LIST_AS_TRIGGER)) {
            $this->insertCommonSocialCommands($for_header);
        }
    }

preloadCommonProperties()

static ilObjectListGUI::preloadCommonProperties ( array  $obj_ids, int  $context  )

static

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

                                                                                : void
    {
        global $DIC;
        $lng = $DIC->language();
        $ilSetting = $DIC->settings();
        $ilUser = $DIC->user();
        $notes_manager = $DIC->notes()->internal()->domain()->notes();
 
        if ($context == self::CONTEXT_REPOSITORY) {
            $active_notes = !$ilSetting->get('disable_notes');
            $active_comments = !$ilSetting->get('disable_comments');
 
            if ($active_comments) {
                // needed for action
                self::$comments_activation = $DIC->notes()
                    ->internal()
                    ->domain()
                    ->notes()->commentsActiveMultiple($obj_ids);
            }
 
            // properties are optional
            if ($ilSetting->get('comments_tagging_in_lists')) {
                if ($active_notes || $active_comments) {
                    // @todo: should be refactored, see comment in notes db repo
                    self::$cnt_notes = $notes_manager->countNotesAndCommentsMultipleObjects(
                        $obj_ids,
                        true
                    );
 
                    $lng->loadLanguageModule('notes');
                }
 
                $tags_set = new ilSetting('tags');
                if ($tags_set->get('enable')) {
                    $all_users = (bool) $tags_set->get('enable_all_users');
 
                    if (!$ilSetting->get('comments_tagging_in_lists_tags')) {
                        self::$cnt_tags = ilTagging::_countTags($obj_ids, $all_users);
                    } else {
                        $tag_user_id = null;
                        if (!$all_users) {
                            $tag_user_id = $ilUser->getId();
                        }
                        self::$tags = ilTagging::_getListTagsForObjects($obj_ids, $tag_user_id);
                    }
 
                    $lng->loadLanguageModule('tagging');
                }
            }
 
            $lng->loadLanguageModule('rating');
        }
 
        self::$preload_done = true;
    }

Referenced by ilObjectListGUIPreloader\preload().

Here is the caller graph for this function:

prepareJsLinks()

static ilObjectListGUI::prepareJsLinks ( string  $redraw_url, string  $notes_url, string  $tags_url, ?ilGlobalTemplateInterface  $tpl = null  )

static

Insert js/ajax links into template.

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

     : void {
        global $DIC;
 
        if (is_null($tpl)) {
            $tpl = $DIC['tpl'];
        }
 
        //if ($notes_url) {
        $DIC->notes()->gui()->initJavascript($notes_url);
        //}
 
        if ($tags_url) {
            ilTaggingGUI::initJavascript($tags_url, $tpl);
        }
 
        if ($redraw_url) {
            $tpl->addOnLoadCode('il.Object.setRedrawAHUrl("' . $redraw_url . '");');
        }
    }

References $DIC.

Referenced by ilObjDataCollectionGUI\addHeaderAction(), ilObject2GUI\initHeaderAction(), ilObjectGUI\initHeaderAction(), ilObjWorkspaceFolderGUI\render(), and ilObjRootFolderGUI\renderObject().

Here is the caller graph for this function:

resetConditionTarget()

ilObjectListGUI::resetConditionTarget

(

)

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

                                          : void
    {
        $this->condition_target = [];
    }

resetCustomData()

ilObjectListGUI::resetCustomData ( )

protected

reset properties and commands

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

                                        : void
    {
        // #15747
        $this->cust_prop = [];
        $this->cust_commands = [];
        $this->cust_modals = [];
        $this->sub_item_html = [];
        $this->position_enabled = false;
    }

restrictToGoto()

ilObjectListGUI::restrictToGoto

(

bool

$value

)

Restrict all actions/links to goto.

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

                                               : void
    {
        $this->restrict_to_goto = $value;
    }

setAdditionalInformation()

ilObjectListGUI::setAdditionalInformation

(

?string

$val

)

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

                                                          : void
    {
        $this->additional_information = $val;
    }

Referenced by ilObjStudyProgrammeListGUI\getListItemHTML().

Here is the caller graph for this function:

setAjaxHash()

ilObjectListGUI::setAjaxHash

(

string

$hash

)

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

                                             : void
    {
        $this->ajax_hash = $hash;
    }

setBoldTitle()

ilObjectListGUI::setBoldTitle

(

bool

$bold_title

)

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

                                                  : void
    {
        $this->bold_title = $bold_title;
    }

setConditionDepth()

ilObjectListGUI::setConditionDepth

(

int

$depth

)

set depth for precondition output (stops at level 5)

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

                                                 : void
    {
        $this->condition_depth = $depth;
    }

setConditionTarget()

ilObjectListGUI::setConditionTarget	(	int	$ref_id,
		int	$obj_id,
		string	$target_type
	)

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

                                                                                     : void
    {
        $this->condition_target = [
            'ref_id' => $ref_id,
            'obj_id' => $obj_id,
            'target_type' => $target_type
        ];
    }

References $ref_id.

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

setContainerObject()

ilObjectListGUI::setContainerObject

(

object

$container_obj

)

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

                                                             : void
    {
        $this->container_obj = $container_obj;
    }

References $container_obj.

setDefaultCommandParameters()

ilObjectListGUI::setDefaultCommandParameters

(

array

$params

)

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

                                                              : void
    {
        $this->default_command_params = $params;
    }

References $params.

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

setDescription()

ilObjectListGUI::setDescription

(

string

$description

)

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

                                                       : void
    {
        $this->description = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
            $description
        );
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

setDetailsLevel()

ilObjectListGUI::setDetailsLevel

(

int

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

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

                                               : void
    {
        $this->details_level = $level;
    }

setExpanded()

ilObjectListGUI::setExpanded

(

bool

$status

)

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

                                             : void
    {
        $this->is_expanded = $status;
    }

setHeaderSubObject()

ilObjectListGUI::setHeaderSubObject	(	?string	$type,
		?int	$id
	)

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

                                                               : void
    {
        $this->sub_obj_type = $type;
        $this->sub_obj_id = (int) $id;
    }

References $id, and ILIAS\Repository\int().

Here is the call graph for this function:

setItemDetailLinks()

ilObjectListGUI::setItemDetailLinks	(	array	$detail_links,
		string	$intro_txt = ''
	)

set items detail links

Parameters

array

$detail_links

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

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

                                                                                   : void
    {
        $this->item_detail_links = $detail_links;
        $this->item_detail_links_intro = $intro_txt;
    }

Referenced by ilContainerObjectiveGUI\addItemDetails().

Here is the caller graph for this function:

setMode()

ilObjectListGUI::setMode

(

string

$mode

)

set output mode

Parameters

string

$mode

output mode (self::IL_LIST_FULL | self::IL_LIST_AS_TRIGGER)

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

                                         : void
    {
        $this->mode = $mode;
    }

setParentRefId()

ilObjectListGUI::setParentRefId

(

int

$ref_id

)

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

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

                                               : void
    {
        $this->parent_ref_id = $ref_id;
    }

setPositionInputField()

ilObjectListGUI::setPositionInputField	(	string	$field_index,
		string	$position_value
	)

Parameters

string	$field_index	e.g. '[crs][34]'
string	$position_value	e.g. '2.0'

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

                                                                                      : void
    {
        $this->position_enabled = true;
        $this->position_field_index = $field_index;
        $this->position_value = $position_value;
    }

References $position_value.

setRelevance()

ilObjectListGUI::setRelevance

(

int

$rel

)

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

                                          : void
    {
        $this->relevance = $rel;
    }

setSearchFragment()

ilObjectListGUI::setSearchFragment

(

string

$text

)

Parameters

string

$text

highlighted search fragment

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

                                                   : void
    {
        $this->search_fragment = $text;
    }

References $text.

setSeparateCommands()

ilObjectListGUI::setSeparateCommands

(

bool

$val

)

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

                                                  : void
    {
        $this->separate_commands = $val;
    }

setTitle()

ilObjectListGUI::setTitle

(

string

$title

)

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

                                           : void
    {
        $this->title = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
            $title
        );
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

Field Documentation

$acache

ilListItemAccessCache ilObjectListGUI::$acache

protected

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

$access

ilAccessHandler ilObjectListGUI::$access

protected

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

$access_cache

array ilObjectListGUI::$access_cache

protected

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

$additional_information

string ilObjectListGUI::$additional_information = ''

protected

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

Referenced by getAdditionalInformation().

$adm_commands_included

bool ilObjectListGUI::$adm_commands_included

protected

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

$ajax_hash

string ilObjectListGUI::$ajax_hash

protected

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

$bold_title

bool ilObjectListGUI::$bold_title = false

protected

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

$checkboxes_enabled

bool ilObjectListGUI::$checkboxes_enabled = false

protected

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

Referenced by getCheckboxStatus().

$clipboard

ClipboardManager ilObjectListGUI::$clipboard

protected

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

$cnt_notes

array ilObjectListGUI::$cnt_notes = []

staticprotected

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

$cnt_tags

array ilObjectListGUI::$cnt_tags = []

staticprotected

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

$commands

array ilObjectListGUI::$commands = []

protected

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

Referenced by ilObjLTIConsumerListGUI\getCommandLink(), ilObjBlogListGUI\getCommands(), and ilObjFileListGUI\getCommands().

$commands_enabled

bool ilObjectListGUI::$commands_enabled = true

protected

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

Referenced by getCommandsStatus().

$comments_activation

array ilObjectListGUI::$comments_activation = []

staticprotected

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

$comments_enabled

bool ilObjectListGUI::$comments_enabled = false

protected

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

$comments_settings_enabled

bool ilObjectListGUI::$comments_settings_enabled = false

protected

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

$condition_depth

int ilObjectListGUI::$condition_depth = 0

protected

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

$condition_target

array ilObjectListGUI::$condition_target

protected

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

$container_obj

object ilObjectListGUI::$container_obj = null

protected

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

Referenced by getContainerObject(), and setContainerObject().

$context

int ilObjectListGUI::$context

protected

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

Referenced by ilObjFileListGUI\__construct().

$copy_enabled

bool ilObjectListGUI::$copy_enabled = true

protected

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

Referenced by getCopyStatus().

$ctrl

ilCtrlInterface ilObjectListGUI::$ctrl

protected

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

Referenced by ilObjBookingPoolListGUI\getCommandLink(), ilObjItemGroupListGUI\getCommandLink(), ilObjLearningModuleListGUI\getCommandLink(), and ilObjWorkspaceRootFolderListGUI\getCommandLink().

$current_actions

array ilObjectListGUI::$current_actions = []

protected

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

$cust_commands

array ilObjectListGUI::$cust_commands = []

protected

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

$cust_modals

array ilObjectListGUI::$cust_modals = []

protected

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

$cust_prop

array ilObjectListGUI::$cust_prop = []

protected

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

$cut_enabled

bool ilObjectListGUI::$cut_enabled = false

protected

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

Referenced by getCutStatus().

$default_command

array ilObjectListGUI::$default_command = []

protected

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

Referenced by getDefaultCommand().

$default_command_params

array ilObjectListGUI::$default_command_params = []

protected

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

$delete_enabled

bool ilObjectListGUI::$delete_enabled = false

protected

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

Referenced by getDeleteStatus().

$description

string ilObjectListGUI::$description = ''

protected

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

Referenced by getDescription(), and ilObjSAHSLearningModuleListGUI\initItem().

$description_enabled

bool ilObjectListGUI::$description_enabled = true

protected

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

Referenced by getDescriptionStatus().

$details_level

int ilObjectListGUI::$details_level = self::DETAILS_ALL

protected

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

Referenced by getDetailsLevel().

$download_checkbox_state

int ilObjectListGUI::$download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE

protected

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

$expand_enabled

bool ilObjectListGUI::$expand_enabled = false

protected

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

Referenced by getExpandStatus().

$fav_manager

ilFavouritesManager ilObjectListGUI::$fav_manager

protected

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

$force_rate_parent

bool ilObjectListGUI::$force_rate_parent = false

protected

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

$force_visible_only

bool ilObjectListGUI::$force_visible_only = false

protected

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

$gui_class_name

string ilObjectListGUI::$gui_class_name = ''

protected

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

$header_icons

array ilObjectListGUI::$header_icons = []

protected

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

$http

HTTPServices ilObjectListGUI::$http

protected

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

$icons_enabled

bool ilObjectListGUI::$icons_enabled = false

protected

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

Referenced by getIconStatus().

$info_screen_enabled

bool ilObjectListGUI::$info_screen_enabled = false

protected

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

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

$is_expanded

bool ilObjectListGUI::$is_expanded = true

protected

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

Referenced by isExpanded().

$item_detail_links

array ilObjectListGUI::$item_detail_links = []

protected

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

$item_detail_links_enabled

bool ilObjectListGUI::$item_detail_links_enabled = false

protected

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

Referenced by getItemDetailLinkStatus().

$item_detail_links_intro

string ilObjectListGUI::$item_detail_links_intro = ''

protected

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

$js_unique_id

int ilObjectListGUI::$js_unique_id = 0

staticprotected

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

$ldap_mapping

ilLDAPRoleGroupMapping ilObjectListGUI::$ldap_mapping

protected

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

$link_enabled

bool ilObjectListGUI::$link_enabled = false

protected

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

Referenced by getLinkStatus().

$lng

ilLanguage ilObjectListGUI::$lng

protected

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

Referenced by ilObjItemGroupListGUI\__construct(), ilObjBibliographicListGUI\getProperties(), ilObjCmiXapiVerificationListGUI\getProperties(), ilObjCourseVerificationListGUI\getProperties(), ilObjExerciseVerificationListGUI\getProperties(), ilObjFileBasedLMListGUI\getProperties(), ilObjLearningModuleListGUI\getProperties(), ilObjRemoteCourseListGUI\getProperties(), ilObjRemoteFileListGUI\getProperties(), ilObjSAHSLearningModuleListGUI\getProperties(), ilObjSCORMVerificationListGUI\getProperties(), ilObjSurveyListGUI\getProperties(), ilObjTestVerificationListGUI\getProperties(), ilObjWikiListGUI\getProperties(), and ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

$lp_cmd_enabled

bool ilObjectListGUI::$lp_cmd_enabled = false

protected

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

$lp_settings_cmd_enabled

bool ilObjectListGUI::$lp_settings_cmd_enabled = true

protected

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

$main_tpl

ilGlobalTemplateInterface ilObjectListGUI::$main_tpl

protected

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

$mode

string ilObjectListGUI::$mode

protected

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

Referenced by ilObjSurveyListGUI\getProperties().

$multi_download_enabled

bool ilObjectListGUI::$multi_download_enabled = false

protected

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

$notes_enabled

bool ilObjectListGUI::$notes_enabled = false

protected

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

$notes_service

ILIAS Notes Service ilObjectListGUI::$notes_service

private

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

$notice_prop

array ilObjectListGUI::$notice_prop = []

protected

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

$notice_properties_enabled

bool ilObjectListGUI::$notice_properties_enabled = true

protected

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

Referenced by getNoticePropertiesStatus().

$obj_definition

ilObjectDefinition ilObjectListGUI::$obj_definition

protected

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

Referenced by ilObjLTIConsumerListGUI\insertIconsAndCheckboxes().

$obj_id

int ilObjectListGUI::$obj_id

protected

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

Referenced by ilObjGroupListGUI\checkCommandAccess(), ilObjSessionListGUI\getAppointmentInfo(), ilObjFileBasedLMListGUI\getCommandFrame(), ilObjOrgUnitListGUI\getTypeIcon(), and ilObjSAHSLearningModuleListGUI\initItem().

$object_dic

LocalDIC ilObjectListGUI::$object_dic

protected

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

$object_properties

Properties ilObjectListGUI::$object_properties

protected

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

$parent_ref_id

int ilObjectListGUI::$parent_ref_id

protected

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

$path_enabled

bool ilObjectListGUI::$path_enabled

protected

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

Referenced by getPathStatus().

$path_gui

ilPathGUI ilObjectListGUI::$path_gui = null

protected

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

Referenced by enablePath().

$path_linked

bool ilObjectListGUI::$path_linked = false

protected

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

$path_start_node

int ilObjectListGUI::$path_start_node

protected

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

$position_enabled

bool ilObjectListGUI::$position_enabled = false

protected

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

$position_field_index

string ilObjectListGUI::$position_field_index = ''

protected

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

$position_value

string ilObjectListGUI::$position_value

protected

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

Referenced by setPositionInputField().

$preconditions_enabled

bool ilObjectListGUI::$preconditions_enabled = true

protected

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

Referenced by getPreconditionsStatus().

$preload_done

bool ilObjectListGUI::$preload_done = false

staticprotected

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

$prevent_access_caching

bool ilObjectListGUI::$prevent_access_caching

protected

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

$prevent_duplicate_commands

array ilObjectListGUI::$prevent_duplicate_commands = []

protected

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

$progress_enabled

bool ilObjectListGUI::$progress_enabled = false

protected

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

Referenced by getProgressInfoStatus().

$properties_enabled

bool ilObjectListGUI::$properties_enabled = true

protected

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

Referenced by getPropertiesStatus().

$rating_categories_enabled

bool ilObjectListGUI::$rating_categories_enabled = false

protected

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

$rating_ctrl_path

array ilObjectListGUI::$rating_ctrl_path = null

protected

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

$rating_enabled

bool ilObjectListGUI::$rating_enabled = false

protected

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

$rating_text

string ilObjectListGUI::$rating_text = null

protected

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

$rbacsystem

ilRbacSystem ilObjectListGUI::$rbacsystem

protected

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

Referenced by ilObjFileBasedLMListGUI\getProperties(), ilObjLearningModuleListGUI\getProperties(), and ilObjSAHSLearningModuleListGUI\getProperties().

$ref_id

int ilObjectListGUI::$ref_id

protected

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

Referenced by ilObjGroupListGUI\checkCommandAccess(), getCommandId(), ilObjGlossaryListGUI\getCommandLink(), ilObjFileBasedLMListGUI\getCommandLink(), ilObjSAHSLearningModuleListGUI\getCommandLink(), and ilObjSAHSLearningModuleListGUI\initItem().

$reference_obj_id

int ilObjectListGUI::$reference_obj_id = null

protected

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

$reference_ref_id

int ilObjectListGUI::$reference_ref_id = 0

protected

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

$refinery

ILIAS Refinery Factory ilObjectListGUI::$refinery

protected

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

$relevance

int ilObjectListGUI::$relevance = 0

protected

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

Referenced by getRelevance().

$repository_transfer_enabled

bool ilObjectListGUI::$repository_transfer_enabled = false

protected

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

$request_wrapper

ILIAS HTTP Wrapper RequestWrapper ilObjectListGUI::$request_wrapper

protected

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

$requested_base_class

string ilObjectListGUI::$requested_base_class

protected

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

$requested_cmd

string ilObjectListGUI::$requested_cmd

protected

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

$requested_ref_id

int ilObjectListGUI::$requested_ref_id

protected

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

$restrict_to_goto

bool ilObjectListGUI::$restrict_to_goto = false

protected

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

$search_fragment

string ilObjectListGUI::$search_fragment = ''

protected

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

Referenced by getSearchFragment().

$search_fragment_enabled

bool ilObjectListGUI::$search_fragment_enabled = false

protected

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

Referenced by getSearchFragmentStatus().

$search_fragments_enabled

bool ilObjectListGUI::$search_fragments_enabled = false

protected

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

$separate_commands

bool ilObjectListGUI::$separate_commands = false

protected

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

Referenced by getSeparateCommands().

$settings

ilSetting ilObjectListGUI::$settings

protected

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

$shared

bool ilObjectListGUI::$shared = false

protected

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

$static_link_enabled

bool ilObjectListGUI::$static_link_enabled = false

protected

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

$std_cmd_only

bool ilObjectListGUI::$std_cmd_only = false

protected

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

$sub_item_html

array ilObjectListGUI::$sub_item_html = []

protected

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

$sub_obj_id

int ilObjectListGUI::$sub_obj_id

protected

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

$sub_obj_type

string ilObjectListGUI::$sub_obj_type

protected

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

$subscribe_enabled

bool ilObjectListGUI::$subscribe_enabled = false

protected

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

Referenced by getSubscribeStatus().

$substitutions

ilAdvancedMDSubstitution ilObjectListGUI::$substitutions = null

protected

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

$substitutions_enabled

bool ilObjectListGUI::$substitutions_enabled = false

protected

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

Referenced by getSubstitutionStatus().

$tags

array ilObjectListGUI::$tags = []

staticprotected

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

$tags_enabled

bool ilObjectListGUI::$tags_enabled = false

protected

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

$timings_enabled

bool ilObjectListGUI::$timings_enabled = true

protected

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

$title

string ilObjectListGUI::$title = ''

protected

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

Referenced by getTitle(), and ilObjSAHSLearningModuleListGUI\initItem().

$title_link

string ilObjectListGUI::$title_link = ''

protected

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

$title_link_disabled

bool ilObjectListGUI::$title_link_disabled = false

protected

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

$tpl

ilTemplate ilObjectListGUI::$tpl

protected

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

$tpl_component

string ilObjectListGUI::$tpl_component = 'components/ILIAS/Container'

staticprotected

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

$tpl_file_name

string ilObjectListGUI::$tpl_file_name = 'tpl.container_list_item.html'

staticprotected

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

$tree

ilTree ilObjectListGUI::$tree

protected

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

$type

string ilObjectListGUI::$type

protected

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

Referenced by ilObjGroupListGUI\checkCommandAccess(), ilObjFileListGUI\getIconImageType(), ilObjSAHSLearningModuleListGUI\getProperties(), ilObjectPluginListGUI\getType(), and ilObjSAHSLearningModuleListGUI\initItem().

$ui

UIServices ilObjectListGUI::$ui

protected

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

$user

ilObjUser ilObjectListGUI::$user

protected

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

Referenced by ilObjSurveyListGUI\getProperties().

$ws_access

ilWorkspaceAccessHandler ilObjectListGUI::$ws_access

protected

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

CONTEXT_PERSONAL_DESKTOP

const ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP = 5

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

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

CONTEXT_REPOSITORY

const ilObjectListGUI::CONTEXT_REPOSITORY = 1

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

Referenced by ilClassificationBlockGUI\filterContainer(), ilObjFileListGUI\getCommandLink(), ILIAS\Container\StartObjects\Content\ObjectsContent\getData(), ilCommonActionDispatcherGUI\initHeaderAction(), and ilObjectListGUIPreloader\preload().

CONTEXT_SEARCH

const ilObjectListGUI::CONTEXT_SEARCH = 6

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

Referenced by ilObjectListGUIPreloader\preload().

CONTEXT_WORKSPACE

const ilObjectListGUI::CONTEXT_WORKSPACE = 2

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

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

CONTEXT_WORKSPACE_SHARING

const ilObjectListGUI::CONTEXT_WORKSPACE_SHARING = 4

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

DETAILS_ALL

const ilObjectListGUI::DETAILS_ALL = 30

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

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

DETAILS_MINIMAL

const ilObjectListGUI::DETAILS_MINIMAL = 10

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

Referenced by ilObjSessionListGUI\getProperties().

DETAILS_SEARCH

const ilObjectListGUI::DETAILS_SEARCH = 20

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

DOWNLOAD_CHECKBOX_DISABLED

const ilObjectListGUI::DOWNLOAD_CHECKBOX_DISABLED = 2

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

DOWNLOAD_CHECKBOX_ENABLED

const ilObjectListGUI::DOWNLOAD_CHECKBOX_ENABLED = 1

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

DOWNLOAD_CHECKBOX_NONE

const ilObjectListGUI::DOWNLOAD_CHECKBOX_NONE = 0

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

IL_LIST_AS_TRIGGER

const ilObjectListGUI::IL_LIST_AS_TRIGGER = 'trigger'

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

IL_LIST_FULL

const ilObjectListGUI::IL_LIST_FULL = 'full'

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

---

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

• components/ILIAS/ILIASObject/classes/class.ilObjectListGUI.php