Class ilObjContentPageListGUI. More...

Inheritance diagram for ilObjContentPageListGUI:

Collaboration diagram for ilObjContentPageListGUI:

Public Member Functions

__construct ($a_context=self::CONTEXT_REPOSITORY)

ilObjContentPageListGUI constructor. More...

init ()

initialisationthis method should be overwritten by derived classes More...

getInfoScreenStatus ()

Parameters

bool

Returns: bool

More...

getProperties ()

@inheritDoc More...

checkInfoPageOnAsynchronousRendering ()

Returns: bool

More...

Public Member Functions inherited from ilObjectListGUI

__construct ($a_context=self::CONTEXT_REPOSITORY)

constructor More...

setContainerObject ($container_obj)

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

getContainerObject ()

get container object More...

init ()

initialisation More...

enableProperties ($a_status)

En/disable properties. More...

getPropertiesStatus ()

enablePreconditions ($a_status)

En/disable preconditions. More...

getNoticePropertiesStatus ()

enableNoticeProperties ($a_status)

En/disable notices. More...

getPreconditionsStatus ()

enableDescription ($a_status)

En/disable description. More...

getDescriptionStatus ()

getSearchFragmentStatus ()

Show hide search result fragments. More...

enableSearchFragments ($a_status)

En/disable description. More...

enableLinkedPath ($a_status)

Enable linked path. More...

enabledRelevance ()

enabled relevance More...

enableRelevance ($a_status)

enable relevance More...

setRelevance ($a_rel)

set relevance More...

getRelevance ()

get relevance More...

enableIcon ($a_status)

En/Dis-able icons. More...

getIconStatus ()

Are icons enabled? More...

enableCheckbox ($a_status)

En/Dis-able checkboxes. More...

getCheckboxStatus ()

Are checkboxes enabled? More...

enableExpand ($a_status)

En/Dis-able expand/collapse link. More...

getExpandStatus ()

Is expand/collapse enabled. More...

setExpanded ($a_status)

isExpanded ()

setPositionInputField ($a_field_index, $a_position_value)

Set position input field. More...

enableDelete ($a_status)

En/disable delete. More...

getDeleteStatus ()

enableCut ($a_status)

En/disable cut. More...

getCutStatus ()

enableCopy ($a_status)

En/disable copy. More...

getCopyStatus ()

enableSubscribe ($a_status)

En/disable subscribe. More...

getSubscribeStatus ()

enableLink ($a_status)

En/disable link. More...

getLinkStatus ()

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

En/disable path. More...

getPathStatus ()

enableCommands ($a_status, $a_std_only=false)

En/disable commands. More...

getCommandsStatus ()

enableInfoScreen ($a_info_screen)

En/disable path. More...

addSubItemHTML ($a_html)

Add HTML for subitem (used for sessions) More...

getInfoScreenStatus ()

enableProgressInfo ($a_status)

enable progress info More...

getProgressInfoStatus ()

get progress info status More...

enableSubstitutions ($a_status)

Enable substitutions. More...

getSubstitutionStatus ()

Get substitution status. More...

enableItemDetailLinks ($a_status)

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

getItemDetailLinkStatus ()

get item detail link status More...

setItemDetailLinks ($a_detail_links, $a_intro_txt='')

set items detail links More...

insertItemDetailLinks ()

insert item detail links More...

setTitle ($a_title)

getTitle ()

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

setDescription ($a_description)

getDescription ()

getDescription overwritten in class.ilObjLinkResourceList.php More...

setSearchFragment ($a_text)

set search fragment More...

getSearchFragment ()

get search fragment More...

setSeparateCommands ($a_val)

Set separate commands. More...

getSeparateCommands ()

Get separate commands. More...

getCommandId ()

get command id Normally the ref id. More...

setAdditionalInformation ($a_val)

Set additional information. More...

getAdditionalInformation ()

Get additional information. More...

setDetailsLevel ($a_level)

Details level Currently used in Search which shows only limited properties of forums Currently used for Sessions (switch between minimal and extended view for each session) More...

getDetailsLevel ()

Get current details level. More...

enableRepositoryTransfer ($a_value)

Enable copy/move to repository (from personal workspace) More...

restrictToGoto ($a_value)

Restrict all actions/links to goto. More...

getDefaultCommand ()

Get default command. More...

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

initItem ($a_ref_id, $a_obj_id, $type, $a_title="", $a_description="")

inititialize new item (is called by getItemHTML()) More...

setConditionTarget ($a_ref_id, $a_obj_id, $a_target_type)

resetConditionTarget ()

disableTitleLink ($a_status)

setDefaultCommandParameters (array $a_params)

createDefaultCommand ($command)

Get default command link Overwritten for e.g categories,courses => they return a goto link If search engine visibility is enabled these object type return a goto_CLIENT_ID_cat_99.html link. More...

getCommandLink ($a_cmd)

Get command link url. More...

getCommandFrame ($a_cmd)

Get command target frame. More...

getCommandImage ($a_cmd)

Get command icon image. More...

getProperties ()

Get item properties. More...

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

add custom property More...

getCustomProperties ($a_prop)

get custom properties More...

getAlertProperties ()

get all alert properties More...

getNoticeProperties ()

get notice properties More...

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

add a custom command More...

forceVisibleOnly ($a_stat)

Force visible access only. More...

isVisibleOnlyForced ()

Force unreadable. More...

getCommands ()

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

getIconImageType ()

Returns the icon image type. More...

insertTitle ()

insert item title More...

insertSubstitutions ()

Insert substitutions. More...

insertDescription ()

insert item description More...

insertSearchFragment ()

Insert highlighted search fragment. More...

insertRelevance ()

insert relevance More...

setMode ($a_mode)

set output mode More...

getMode ()

get output mode More...

setConditionDepth ($a_depth)

set depth for precondition output (stops at level 5) More...

isMode ($a_mode)

check current output mode More...

determineProperties ()

Determine properties. More...

insertProperties ()

insert properties More...

insertNoticeProperties ()

insertPreconditions ()

insert all missing preconditions More...

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

insert command button More...

insertDeleteCommand ()

insert cut command More...

insertLinkCommand ()

insert link command More...

insertCutCommand ($a_to_repository=false)

insert cut command More...

insertCopyCommand ($a_to_repository=false)

Insert copy command. More...

insertPasteCommand ()

Insert paste command. More...

insertSubscribeCommand ()

insert subscribe command More...

insertInfoScreenCommand ()

insert info screen command More...

insertCommonSocialCommands ($a_header_actions=false)

Insert common social commands (comments, notes, tagging) More...

insertTimingsCommand ()

insert edit timings command More...

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

insert all commands into html code More...

enableComments ($a_value, $a_enable_comments_settings=true)

Toogle comments action status. More...

enableNotes ($a_value)

Toogle notes action status. More...

enableTags ($a_value)

Toogle tags action status. More...

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

Toogle rating action status. More...

enableMultiDownload ($a_value)

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

insertMultiDownloadCommand ()

enableDownloadCheckbox ($a_ref_id, $a_value)

getDownloadCheckboxState ()

setHeaderSubObject ($a_type, $a_id)

Set sub object identifier. More...

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

addHeaderIconHTML ($a_id, $a_html)

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

setAjaxHash ($a_hash)

getHeaderAction (ilGlobalTemplateInterface $a_main_tpl=null)

Get header action. More...

appendRepositoryFrameParameter ($a_link)

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

modifySAHSlaunch ($a_link, $wtarget)

workaround: SAHS in new javavasript-created window or iframe More...

insertPath ()

insert path More...

insertProgressInfo ()

insert progress info More...

insertIconsAndCheckboxes ()

Insert icons and checkboxes. More...

getTypeIcon ()

Get object type specific type icon. More...

insertSubItems ()

Insert subitems. More...

insertPositionField ()

Insert field for positioning. More...

adminCommandsIncluded ()

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

storeAccessCache ()

Store access cache. More...

getListItemHTML ( $a_ref_id, $a_obj_id, $a_title, $a_description, $a_use_asynch=false, $a_get_asynch_commands=false, $a_asynch_url="")

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

setParentRefId ($a_ref_id)

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

getUniqueItemId ($a_as_div=false)

Get unique item identifier (for js-actions) More...

getCommandsHTML ()

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

isSideBlock ()

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

setBoldTitle ($a_bold_title)

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

isTitleBold ()

@access public More...

enableTimings ($a_status)

enable timings link More...

isFileUploadAllowed ()

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

insertFileUpload ()

Inserts a file upload component. More...

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

Get list item ui object. More...

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

Get card object. More...

checkInfoPageOnAsynchronousRendering ()

Private Attributes
	$pageMetricsService
	PageMetricsService. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObjectListGUI
static	prepareJsLinks ($a_redraw_url, $a_notes_url, $a_tags_url, $a_tpl=null)
	Insert js/ajax links into template. More...

static	preloadCommonProperties ($a_obj_ids, $a_context)
	Preload common properties. More...

Data Fields inherited from ilObjectListGUI
const	DETAILS_MINIMAL = 10

const	DETAILS_SEARCH = 20

const	DETAILS_ALL = 30

const	CONTEXT_REPOSITORY = 1

const	CONTEXT_WORKSPACE = 2

const	CONTEXT_WORKSPACE_SHARING = 4

const	CONTEXT_PERSONAL_DESKTOP = 5

const	CONTEXT_SEARCH = 6

const	DOWNLOAD_CHECKBOX_NONE = 0

const	DOWNLOAD_CHECKBOX_ENABLED = 1

const	DOWNLOAD_CHECKBOX_DISABLED = 2

	$ctrl

	$description_enabled = true

	$preconditions_enabled = true

	$properties_enabled = true

	$notice_properties_enabled = true

	$commands_enabled = true

	$cust_prop = array()

	$cust_commands = array()

	$info_screen_enabled = false

	$condition_depth = 0

	$std_cmd_only = false

	$sub_item_html = array()

	$multi_download_enabled = false

	$download_checkbox_state = self::DOWNLOAD_CHECKBOX_NONE

Data Fields inherited from ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'

const	HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT = 'page_editor_style'

const	UI_CMD_VIEW = 'view'

const	UI_CMD_EDIT = 'edit'

const	UI_CMD_UPDATE = 'update'

const	UI_CMD_COPAGE_EDIT = 'edit'

const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'

const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'

const	UI_CMD_COPAGE_DISPLAY_MEDIA = 'displayMedia'

const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

const	UI_CMD_STYLES_EDIT = 'editStyleProperties'

const	UI_TAB_ID_CONTENT = 'content'

const	UI_TAB_ID_INFO = 'info_short'

const	UI_TAB_ID_SETTINGS = 'settings'

const	UI_TAB_ID_ICON = 'icon'

const	UI_TAB_ID_STYLE = 'style'

const	UI_TAB_ID_I18N = 'i18n'

const	UI_TAB_ID_LP = 'learning_progress'

const	UI_TAB_ID_EXPORT = 'export'

const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Protected Member Functions inherited from ilObjectListGUI
	buildGotoLink ()

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

	modifyTitleLink ($a_default_link)

	resetCustomData ()
	reset properties and commands More...

	isCommentsActivated ($a_type, $a_ref_id, $a_obj_id, $a_header_actions, $a_check_write_access=true)
	Check comments status against comments settings and context. More...

	getTileImagePath ()

Protected Attributes inherited from ilObjectListGUI
	$access

	$lng

	$user

	$obj_definition

	$tree

	$settings

	$tpl

	$obj_id

	$ref_id

	$type

	$sub_obj_id

	$sub_obj_type

	$substitutions = null

	$substitutions_enabled = false

	$icons_enabled = false

	$checkboxes_enabled = false

	$position_enabled = false

	$progress_enabled = false

	$item_detail_links_enabled = false

	$item_detail_links = array()

	$item_detail_links_intro = ''

	$search_fragments_enabled = false

	$search_fragment = ''

	$path_linked = false

	$enabled_relevance = false

	$relevance = 0

	$expand_enabled = false

	$is_expanded = true

	$bold_title = false

	$copy_enabled = true

	$details_level = self::DETAILS_ALL

	$reference_ref_id = false

	$separate_commands = false

	$search_fragment_enabled = false

	$additional_information = false

	$static_link_enabled = false

	$repository_transfer_enabled = false

	$shared = false

	$restrict_to_goto = false

	$comments_enabled = false

	$comments_settings_enabled = false

	$notes_enabled = false

	$tags_enabled = false

	$rating_enabled = false

	$rating_categories_enabled = false

	$rating_text = false

	$rating_ctrl_path = false

	$timings_enabled = true

	$force_visible_only = false

	$prevent_duplicate_commands = array()

	$parent_ref_id

	$context

	$title_link = ''

	$title_link_disabled = false

	$path_gui = null

	$ui

	$object_service

	$fav_manager

Static Protected Attributes inherited from ilObjectListGUI
static	$cnt_notes = array()

static	$cnt_tags = array()

static	$tags = array()

static	$comments_activation = array()

static	$preload_done = false

static	$js_unique_id = 0

static	$tpl_file_name = "tpl.container_list_item.html"

static	$tpl_component = "Services/Container"

Detailed Description

Class ilObjContentPageListGUI.

Definition at line 13 of file class.ilObjContentPageListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjContentPageListGUI::__construct ( $a_context = self::CONTEXT_REPOSITORY )

ilObjContentPageListGUI constructor.

Parameters

int $a_context

Reimplemented from ilObjectListGUI.

Definition at line 22 of file class.ilObjContentPageListGUI.php.

    {
        global $DIC;
 
        parent::__construct($a_context);
        $this->pageMetricsService = new PageMetricsService(
            new PageMetricsRepositoryImp($DIC->database()),
            $DIC->refinery()
        );
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ checkInfoPageOnAsynchronousRendering()

ilObjContentPageListGUI::checkInfoPageOnAsynchronousRendering ( )

Returns: bool

Reimplemented from ilObjectListGUI.

Definition at line 118 of file class.ilObjContentPageListGUI.php.

                                                           : bool
    {
        return true;
    }

◆ getInfoScreenStatus()

ilObjContentPageListGUI::getInfoScreenStatus ( )

Parameters

bool

Returns: bool

Reimplemented from ilObjectListGUI.

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

    {
        if (ilContainer::_lookupContainerSetting(
            $this->obj_id,
            ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
            true
        )) {
            return $this->info_screen_enabled;
        }
 
        return false;
    }

References ilObjectListGUI\$info_screen_enabled, ilContainer\_lookupContainerSetting(), and ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY.

Here is the call graph for this function:

◆ getProperties()

ilObjContentPageListGUI::getProperties ( )

@inheritDoc

Reimplemented from ilObjectListGUI.

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

    {
        $properties = [];
 
        $settingsStorage = new StorageImpl($this->settings);
        if (!$settingsStorage->getSettings()->isReadingTimeEnabled()) {
            return $properties;
        }
 
        if (!$this->access->checkAccess('read', '', $this->ref_id)) {
            return $properties;
        }
 
        try {
            $ot = ilObjectTranslation::getInstance($this->obj_id);
            $language = $ot->getEffectiveContentLang($this->user->getCurrentLanguage(), $this->type);
 
            $pageMetrics = $this->pageMetricsService->get(
                new GetPageMetricsCommand($this->obj_id, $language)
            );
 
            $readingTimePropertyValue = sprintf(
                $this->lng->txt('copa_value_reading_time_f_p'),
                (string) $pageMetrics->readingTime()->minutes()
            );
            if (1 === $pageMetrics->readingTime()->minutes()) {
                $readingTimePropertyValue = sprintf(
                    $this->lng->txt('copa_value_reading_time_f_s'),
                    (string) $pageMetrics->readingTime()->minutes()
                );
            }
 
            $properties[] = [
                'alert' => false,
                'property' => $this->lng->txt('copa_prop_reading_time'),
                'value' => $readingTimePropertyValue,
            ];
        } catch (CouldNotFindPageMetrics $e) {
        }
 
        return $properties;
    }

References Vendor\Package\$e, ilObjectTranslation\getInstance(), settings(), and user().

Here is the call graph for this function:

◆ init()

ilObjContentPageListGUI::init ( )

initialisationthis method should be overwritten by derived classes

Reimplemented from ilObjectListGUI.

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

    {
        $this->static_link_enabled = true;
        $this->delete_enabled = true;
        $this->cut_enabled = true;
        $this->copy_enabled = true;
        $this->subscribe_enabled = true;
        $this->link_enabled = true;
        $this->info_screen_enabled = true;
        $this->type = self::OBJ_TYPE;
        $this->gui_class_name = 'ilObjContentPageGUI';
 
        $this->commands = ilObjContentPageAccess::_getCommands();
 
        $this->lng->loadLanguageModule('copa');
    }