Inheritance diagram for ilObjFileListGUI:

Collaboration diagram for ilObjFileListGUI:

Public Member Functions
	__construct (int $context=self::CONTEXT_REPOSITORY)

	insertCommands ()
	@description This methods seems to be called by ItemRenderer More...

	init ()
	initialisation More...

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

	getCommandLink (string $cmd)
	Get command link url. More...

	getTitle ()
	getTitle overwritten in class.ilObjLinkResourceList.php More...

	stripTitleOfFileExtension (string $a_title)

	getCommandFrame (string $cmd)
	Get command target frame. More...

	getIconImageType ()
	Returns the icon image type. More...

	getProperties ()
	Get item properties. More...

	getCommandImage ($a_cmd)
	Get command icon image. More...

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

Public Member Functions inherited from ilObjectListGUI
	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...

	getCommandLink (string $cmd)
	Get command link url. 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...

Protected Member Functions
	updateContext ()

Protected Member Functions inherited from ilObjectListGUI
	enableLearningProgress (bool $enabled)

	enableLPSettingsCommand (bool $enabled)

	buildGotoLink ()

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

	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
string	$title

Protected Attributes inherited from ilObjectListGUI
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

Private Attributes
ilObjFileInfoRepository	$file_info

CapabilityBuilder	$capability_builder

CapabilityCollection	$capabilities = null

Context	$capability_context

IconDatabaseRepository	$icon_repo

Services	$irss

Additional Inherited Members
Static Public Member Functions inherited from ilObjectListGUI
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 inherited from ilObjectListGUI
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

Static Protected Attributes inherited from ilObjectListGUI
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'

Detailed Description

Class ilObjFileListGUI.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFileListGUI::__construct ( int $context = self::CONTEXT_REPOSITORY )

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

    {
        global $DIC;
        $this->capability_context = new Context(
            0,
            0,
            match($context) {
                self::CONTEXT_REPOSITORY => Context::CONTEXT_REPO,
                self::CONTEXT_WORKSPACE => Context::CONTEXT_WORKSPACE,
                self::CONTEXT_SEARCH => Context::CONTEXT_SEARCH,
                default => Context::CONTEXT_REPO,
            }
        );
 
        parent::__construct($context);
 
        $DIC->language()->loadLanguageModule('wopi');
        $this->file_info = new ilObjFileInfoRepository();
        $this->capability_builder = new CapabilityBuilder(
            $this->file_info,
            $this->access,
            $this->ctrl,
            new ActionDBRepository($DIC->database()),
            $DIC->http(),
            $DIC['static_url.uri_builder']
        );
    }

References ilObjectListGUI\$context, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

Member Function Documentation

◆ checkCommandAccess()

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

Reimplemented from ilObjectListGUI.

Definition at line 300 of file class.ilObjFileListGUI.php.

     : bool {
        $this->updateContext();
 
        $this->capability_context = $this->capability_context
            ->withCallingId($ref_id)
            ->withObjectId($obj_id ?? $this->capability_context->getObjectId());
 
        // LP settings only in repository
        if ($this->context !== self::CONTEXT_REPOSITORY && $permission === "edit_learning_progress") {
            return false;
        }
 
        $this->capabilities = $this->capability_builder->get($this->capability_context);
 
        $capability = Capabilities::fromCommand($cmd);
        $additional_check = $this->capabilities->get($capability)->isUnlocked();
 
        return $additional_check && parent::checkCommandAccess(
            $permission,
            $cmd,
            $ref_id,
            $type,
            $obj_id
        );
    }

◆ getCommandFrame()

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

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

                                                : string
    {
        $this->updateContext();
        $info = $this->file_info->getByObjectId($this->obj_id);
 
        if ($cmd === Capabilities::DOWNLOAD->value) {
            return $info->shouldDeliverInline() ? '_blank' : '';
        }
 
        return '';
    }

References $info, and updateContext().

Here is the call graph for this function:

◆ getCommandImage()

ilObjFileListGUI::getCommandImage ( $a_cmd )

Get command icon image.

Definition at line 294 of file class.ilObjFileListGUI.php.

                                           : string
    {
        return "";
    }

◆ getCommandLink()

ilObjFileListGUI::getCommandLink ( string $cmd )

Get command link url.

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

Reimplemented from ilObjectListGUI.

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

                                               : string
    {
        $this->updateContext();
        $this->capabilities = $this->capability_builder->get($this->capability_context);
 
        $needed_capability = Capabilities::fromCommand($cmd);
        $capability = $this->capabilities->get($needed_capability);
        if ($capability === false || !$capability->isUnlocked()) {
            return '';
        }
 
        switch ($this->context) {
            case self::CONTEXT_REPOSITORY:
                return (string) $capability->getURI();
            case self::CONTEXT_WORKSPACE:
                $this->ctrl->setParameterByClass(ilObjFileGUI::class, 'wsp_id', $this->ref_id);
                if ($cmd === "sendfile" && !ilObjFileAccess::_shouldDownloadDirectly($this->obj_id)) {
                    return $this->ctrl->getLinkTargetByClass(
                        ilObjFileGUI::class,
                        Capabilities::INFO_PAGE->value
                    );
                }
                break;
        }
 
        return parent::getCommandLink($cmd);
    }

References ilObjFileAccess\_shouldDownloadDirectly(), ilObjectListGUI\CONTEXT_REPOSITORY, ilObjectListGUI\CONTEXT_WORKSPACE, ILIAS\Repository\ctrl(), and updateContext().

Referenced by getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommands()

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

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

                                 : array
    {
        $this->updateContext();
        $this->capabilities = $this->capability_builder->get($this->capability_context);
 
        $best = $this->capabilities->getBest();
 
        $default_key = null;
 
        foreach ($this->commands as $key => $command) {
            if ($command['cmd'] === $best->getCapability()->value) {
                $default_key = $key;
                $this->commands[$key]['default'] = true;
            }
        }
 
        // we put a copy of the default command to the array, since otherwise its not rendered in the dropdown
        if ($default_key !== null) {
            $command_copy = $this->commands[$default_key];
            $command_copy['default'] = false;
 
            $commands = [];
 
            foreach ($this->commands as $key => $command) {
                if ($key === $default_key) {
                    $commands[] = $command_copy;
                }
                $commands[] = $command;
            }
            $this->commands = $commands;
        }
 
        return parent::getCommands();
    }

References ilObjectListGUI\$commands, and updateContext().

Here is the call graph for this function:

◆ getIconImageType()

ilObjFileListGUI::getIconImageType ( )

Returns the icon image type.

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

Reimplemented from ilObjectListGUI.

Definition at line 213 of file class.ilObjFileListGUI.php.

                                      : string
    {
        return $this->file_info->getByObjectId($this->obj_id)->shouldDeliverInline()
            ? $this->type . '_inline'
            : $this->type;
    }

References ilObjectListGUI\$type.

◆ getProperties()

ilObjFileListGUI::getProperties ( )

Get item properties.

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

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

                                   : array
    {
        global $DIC;
 
        $this->capabilities = $this->capability_builder->get($this->capability_context);
 
        $props = parent::getProperties();
 
        $info = $this->file_info->getByObjectId($this->obj_id);
 
        $props[] = [
            "alert" => false,
            "property" => $DIC->language()->txt("type"),
            "value" => $info->getSuffix(),
            'propertyNameVisible' => false,
        ];
 
        $props[] = [
            "alert" => false,
            "property" => $DIC->language()->txt("size"),
            "value" => (string) $info->getFileSize(),
            'propertyNameVisible' => false,
        ];
 
        $version = $info->getVersion();
        if ($version > 1) {
            // add versions link
            if ($this->capabilities->get(Capabilities::MANAGE_VERSIONS)->isUnlocked()) {
                $link = $this->getCommandLink("versions");
                $value = "<a href=\"$link\">" . $DIC->language()->txt("version") . ": $version</a>";
            } else {
                $value = $DIC->language()->txt("version") . ": $version";
            }
            $props[] = [
                "alert" => false,
                "property" => $DIC->language()->txt("version"),
                "value" => $value,
                "propertyNameVisible" => false
            ];
        }
 
        $props[] = [
            "alert" => false,
            "property" => $DIC->language()->txt("last_update"),
            "value" => ilDatePresentation::formatDate(
                new ilDateTime($info->getCreationDate()->format('U'), IL_CAL_UNIX)
            ),
            'propertyNameVisible' => false,
        ];
 
        if ($info->getPageCount() !== null && $info->getPageCount() > 0) {
            $props[] = [
                "alert" => false,
                "property" => $DIC->language()->txt("page_count"),
                "value" => $info->getPageCount(),
                'propertyNameVisible' => true,
            ];
        }
 
        return $props;
    }

References $DIC, $info, $version, ilDatePresentation\formatDate(), getCommandLink(), and IL_CAL_UNIX.

Here is the call graph for this function:

◆ getTitle()

ilObjFileListGUI::getTitle ( )

getTitle overwritten in class.ilObjLinkResourceList.php

Reimplemented from ilObjectListGUI.

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

                              : string
    {
        return $this->file_info->getByObjectId($this->obj_id)->getListTitle();
    }

◆ init()

ilObjFileListGUI::init ( )

initialisation

Reimplemented from ilObjectListGUI.

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

                          : void
    {
        $this->delete_enabled = true;
        $this->cut_enabled = true;
        $this->copy_enabled = true;
        $this->subscribe_enabled = true;
        $this->link_enabled = true;
        $this->info_screen_enabled = false;
        $this->type = ilObjFile::OBJECT_TYPE;
        $this->gui_class_name = ilObjFileGUI::class;
        $this->icon_repo = new IconDatabaseRepository();
 
        $this->substitutions = ilAdvancedMDSubstitution::_getInstanceByObjectType($this->type);
        if ($this->substitutions->isActive()) {
            $this->substitutions_enabled = true;
        }
 
        $this->commands = ilObjFileAccess::_getCommands();
        $this->updateContext();
    }

References ilObjFileAccess\_getCommands(), ilAdvancedMDSubstitution\_getInstanceByObjectType(), ilObjFile\OBJECT_TYPE, and updateContext().

Here is the call graph for this function:

◆ insertCommands()

ilObjFileListGUI::insertCommands ( )

@description This methods seems to be called by ItemRenderer

Deprecated:

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

                                    : void
    {
    }

◆ stripTitleOfFileExtension()

ilObjFileListGUI::stripTitleOfFileExtension ( string $a_title )

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

                                                              : string
    {
        return $this->secure(preg_replace('/\.[^.]*$/', '', $a_title));
    }

◆ updateContext()

ilObjFileListGUI::updateContext ( )

protected

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

                                      : void
    {
        $this->capability_context = $this->capability_context
            ->withCallingId($this->ref_id ?? 0)
            ->withObjectId($this->obj_id ?? 0);
    }

Referenced by getCommandFrame(), getCommandLink(), getCommands(), and init().

Here is the caller graph for this function:

Field Documentation

◆ $capabilities

CapabilityCollection ilObjFileListGUI::$capabilities = null

private

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

◆ $capability_builder

CapabilityBuilder ilObjFileListGUI::$capability_builder

private

Definition at line 39 of file class.ilObjFileListGUI.php.

◆ $capability_context

Context ilObjFileListGUI::$capability_context

private

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

◆ $file_info

ilObjFileInfoRepository ilObjFileListGUI::$file_info

private

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

◆ $icon_repo

IconDatabaseRepository ilObjFileListGUI::$icon_repo

private

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

◆ $irss

Services ilObjFileListGUI::$irss

private

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

◆ $title

string ilObjFileListGUI::$title

protected

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

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

components/ILIAS/File/classes/class.ilObjFileListGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkCommandAccess()

◆ getCommandFrame()

◆ getCommandImage()

◆ getCommandLink()

◆ getCommands()

◆ getIconImageType()

◆ getProperties()

◆ getTitle()

◆ init()

◆ insertCommands()

◆ stripTitleOfFileExtension()

◆ updateContext()

Field Documentation

◆ $capabilities

◆ $capability_builder

◆ $capability_context

◆ $file_info

◆ $icon_repo

◆ $irss

◆ $title