Inheritance diagram for ilObjContentPageGUI:

Collaboration diagram for ilObjContentPageGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)

	getType ()
	Functions that must be overwritten. More...

	addToNavigationHistory ()

	renderHeaderActions ()

	infoScreenForward ()

	infoScreen ()

	view ()
	view object content (repository/workspace switch) More...

	getContent (string $ctrlLink='')

	editStyleProperties ()

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Public Member Functions inherited from ilDesktopItemHandling
	addToDeskObject ()

	removeFromDeskObject ()

Static Public Member Functions
static	_goto (string $target)

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions
	setTabs ()
	create tabs (repository/workspace switch) More...

	addToDesk ()

	removeFromDesk ()

	setSettingsSubTabs (string $activeTab)

	addLocatorItems ()
	Functions to be overwritten. More...

	populateContentToolbar ()

	initStyleSheets ()

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	setTitleAndDescription ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	showActions ()

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	addLocatorItems ()
	Functions to be overwritten. More...

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Private Member Functions
	addAvailabilitySection (ilPropertyFormGUI $form)

Private Attributes
ILIAS Style Content Object ObjectFacade	$content_style_domain = null

readonly ILIAS Style Content GUIService	$content_style_gui

readonly ilNavigationHistory	$navHistory

readonly Container	$dic

bool	$infoScreenEnabled = false

readonly PageMetricsService	$pageMetricsService

readonly ilHelpGUI	$help

readonly ILIAS DI UIServices	$uiServices

readonly bool	$in_page_editor_style_context

readonly LOMServices	$lom_services

readonly Translations	$translation

Additional Inherited Members
Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

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_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_COPAGE_EDIT = 'edit'

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

const	UI_TAB_ID_MD = 'meta_data'

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = []

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

GlobalHttpState	$http

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

CustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjContentPageGUI::__construct	(	int	$a_id = `0`,
		int	$a_id_type = `self::REPOSITORY_NODE_ID`,
		int	$a_parent_node_id = `0`
	)

Reimplemented from ilObject2GUI.

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

    {
        global $DIC;
 
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
 
        $this->dic = $DIC;
        $this->settings = $this->dic->settings();
        $this->navHistory = $this->dic['ilNavigationHistory'];
        $this->help = $DIC['ilHelp'];
        $this->uiServices = $DIC->ui();
        $this->lom_services = $DIC->learningObjectMetadata();
 
        $this->lng->loadLanguageModule('copa');
        $this->lng->loadLanguageModule('style');
        $this->lng->loadLanguageModule('content');
        $this->lng->loadLanguageModule('rep');
 
        if ($this->object instanceof ilObjContentPage) {
            $this->infoScreenEnabled = (bool) ilContainer::_lookupContainerSetting(
                $this->object->getId(),
                ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                '1'
            );
        }
 
        $this->pageMetricsService = new PageMetricsService(
            new PageMetricsRepositoryImp($DIC->database()),
            $DIC->refinery()
        );
        $cs = $DIC->contentStyle();
        $this->content_style_gui = $cs->gui();
        if (is_object($this->object)) {
            $this->content_style_domain = $cs->domain()->styleForRefId($this->object->getRefId());
            $this->translation = $this->object->getObjectProperties()->getPropertyTranslations();
        }
 
        $this->in_page_editor_style_context = $this->http->wrapper()->query()->has(
            self::HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT
        );
        $this->ctrl->saveParameterByClass(
            ilObjectContentStyleSettingsGUI::class,
            self::HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT
        );
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilContainer\_lookupContainerSetting(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjContentPageGUI::_goto ( string $target )

static

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

                                                : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $targetAttributes = explode('_', $target);
        $refId = (int) $targetAttributes[0];
 
        if ($refId <= 0) {
            $DIC['ilErr']->raiseError($DIC->language()->txt('msg_no_perm_read'), $DIC['ilErr']->FATAL);
        }
 
        if ($DIC->access()->checkAccess('read', '', $refId)) {
            $DIC->ctrl()->setTargetScript('ilias.php');
            $DIC->ctrl()->setParameterByClass(self::class, 'ref_id', $refId);
            $DIC->ctrl()->redirectByClass([
                ilRepositoryGUI::class,
                self::class,
            ], self::UI_CMD_VIEW);
        } elseif ($DIC->access()->checkAccess('visible', '', $refId)) {
            ilObjectGUI::_gotoRepositoryNode($refId, 'infoScreen');
        } elseif ($DIC->access()->checkAccess('read', '', ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage(
                'info',
                sprintf(
                    $DIC->language()->txt('msg_no_perm_read_item'),
                    ilObject::_lookupTitle(ilObject::_lookupObjId($refId))
                ),
                true
            );
 
            $DIC->ctrl()->setTargetScript('ilias.php');
            $DIC->ctrl()->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
            $DIC->ctrl()->redirectByClass(ilRepositoryGUI::class);
        }
 
        $DIC['ilErr']->raiseError($DIC->language()->txt('msg_no_perm_read'), $DIC['ilErr']->FATAL);
    }

References $DIC, $refId, ilObjectGUI\_gotoRepositoryNode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\int(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

◆ addAvailabilitySection()

ilObjContentPageGUI::addAvailabilitySection ( ilPropertyFormGUI $form )

private

Definition at line 648 of file class.ilObjContentPageGUI.php.

                                                                    : void
    {
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('rep_activation_availability'));
        $form->addItem($section);
 
        $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'activation_online');
        $online->setInfo($this->lng->txt('copa_activation_online_info'));
        $form->addItem($online);
    }

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by initEditCustomForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addLocatorItems()

ilObjContentPageGUI::addLocatorItems ( )

protected

Functions to be overwritten.

Reimplemented from ilObject2GUI.

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

                                        : void
    {
        if ($this->object instanceof ilObject) {
            $this->locator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTarget($this, self::UI_CMD_VIEW),
                '',
                $this->object->getRefId()
            );
        }
    }

References ILIAS\Repository\locator(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ addToDesk()

ilObjContentPageGUI::addToDesk ( )

protected

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

                                  : void
    {
        $this->addToDeskObject();
    }

References ilDesktopItemHandling\addToDeskObject().

Here is the call graph for this function:

◆ addToNavigationHistory()

ilObjContentPageGUI::addToNavigationHistory ( )

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

                                            : void
    {
        if (!$this->getCreationMode() && $this->checkPermissionBool('read')) {
            $this->navHistory->addItem(
                $this->object->getRefId(),
                ilLink::_getLink($this->object->getRefId(), $this->object->getType()),
                $this->object->getType()
            );
        }
    }

References ilObject2GUI\checkPermissionBool(), ilObject2GUI\getCreationMode(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ afterSave()

ilObjContentPageGUI::afterSave ( ilObject $new_object )

protected

Post (successful) object creation hook.

Reimplemented from ilObjectGUI.

Definition at line 580 of file class.ilObjContentPageGUI.php.

                                                      : void
    {
        $new_object->getObjectProperties()->storePropertyTranslations(
            $new_object->getObjectTranslation()->withLanguage(
                new Language(
                    $this->lng->getDefaultLanguage(),
                    $new_object->getTitle(),
                    $new_object->getDescription(),
                    true
                )
            )
        );
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('object_added'), true);
        $this->ctrl->redirect($this, 'edit');
    }

References ILIAS\Repository\ctrl(), ilObject\getDescription(), ilObject\getObjectProperties(), ilObject\getTitle(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ editStyleProperties()

ilObjContentPageGUI::editStyleProperties ( )

Definition at line 686 of file class.ilObjContentPageGUI.php.

                                         : void
    {
        $this->content_style_gui->redirectToObjectSettings();
    }

◆ getContent()

ilObjContentPageGUI::getContent ( string $ctrlLink = '' )

Parameters

string $ctrlLink A link which describes the target controller for all page object links/actions

Exceptions

ilException

Definition at line 546 of file class.ilObjContentPageGUI.php.

                                                     : string
    {
        if ($this->checkPermissionBool('read')) {
            $this->object->trackProgress($this->user->getId());
 
            $this->initStyleSheets();
 
            $forwarder = new ilContentPagePageCommandForwarder(
                $this->http,
                $this->ctrl,
                $this->tabs_gui,
                $this->lng,
                $this->object,
                $this->translation,
                $this->user,
                $this->refinery,
                $this->content_style_domain
            );
            $forwarder->setPresentationMode(ilContentPagePageCommandForwarder::PRESENTATION_MODE_PRESENTATION);
 
            return $forwarder->forward($ctrlLink);
        }
 
        return '';
    }

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initStyleSheets(), ILIAS\Repository\lng(), ilContentPagePageCommandForwarder\PRESENTATION_MODE_PRESENTATION, ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditFormCustomValues()

ilObjContentPageGUI::getEditFormCustomValues ( array & $a_values )

protected

Add values to custom edit fields.

Reimplemented from ilObjectGUI.

Definition at line 659 of file class.ilObjContentPageGUI.php.

                                                                : void
    {
        if (count($this->object->getObjectTranslation()->getLanguages()) > 1) {
            $a_values['title'] = $this->object->getObjectTranslation()->getDefaultTitle();
            $a_values['desc'] = $this->object->getObjectTranslation()->getDefaultDescription();
        }
 
        $a_values['activation_online'] = $this->object->getOfflineStatus() === false;
        $a_values[ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY] = $this->infoScreenEnabled;
    }

References $infoScreenEnabled, ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, and ILIAS\Repository\object().

Here is the call graph for this function:

◆ getType()

ilObjContentPageGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

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

                             : string
    {
        return self::OBJ_TYPE;
    }

References ilContentPageObjectConstants\OBJ_TYPE.

◆ infoScreen()

ilObjContentPageGUI::infoScreen ( )

Definition at line 511 of file class.ilObjContentPageGUI.php.

                                : void
    {
        $this->infoScreenForward();
    }

References infoScreenForward().

Here is the call graph for this function:

◆ infoScreenForward()

ilObjContentPageGUI::infoScreenForward ( )

Definition at line 450 of file class.ilObjContentPageGUI.php.

                                       : void
    {
        if (!$this->infoScreenEnabled) {
            return;
        }
 
        if (!$this->checkPermissionBool('visible') && !$this->checkPermissionBool('read')) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        if (strtolower($this->ctrl->getCmd() ?? '') === 'infoscreen') {
            $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
        }
 
        $this->tabs_gui->activateTab(self::UI_TAB_ID_INFO);
 
        $info = new ilInfoScreenGUI($this);
        $info->enableLearningProgress();
        $info->enablePrivateNotes();
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
 
        $this->ctrl->forwardCommand($info);
    }

References $info, ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by infoScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditCustomForm()

ilObjContentPageGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Add custom fields to update form.

Reimplemented from ilObjectGUI.

Definition at line 605 of file class.ilObjContentPageGUI.php.

                                                                    : void
    {
        $this->addAvailabilitySection($a_form);
 
        $presentationHeader = new ilFormSectionHeaderGUI();
        $presentationHeader->setTitle($this->lng->txt('settings_presentation_header'));
        $a_form->addItem($presentationHeader);
 
        $this->object_service->commonSettings()->legacyForm($a_form, $this->object)->addIcon();
        $this->object_service->commonSettings()->legacyForm($a_form, $this->object)->addTileImage();
 
        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt('obj_features'));
        $a_form->addItem($sh);
 
        ilObjectServiceSettingsGUI::initServiceSettingsForm(
            $this->object->getId(),
            $a_form,
            [
                ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY
            ]
        );
 
        if ($this->getCreationMode() !== true && count($this->object->getObjectTranslation()->getLanguages()) > 1) {
            $language = '';
            foreach ($this->lom_services->dataHelper()->getAllLanguages() as $lom_lang) {
                if ($lom_lang->value() === $this->object->getObjectTranslation()->getDefaultLanguage()) {
                    $language = $lom_lang->presentableLabel();
                }
            }
            $a_form->getItemByPostVar('title')
                   ->setInfo(
                       implode(
                           ': ',
                           [
                               $this->lng->txt('language'),
                               $language
                           ]
                       )
                   );
        }
    }

References addAvailabilitySection(), ilPropertyFormGUI\addItem(), ilObject2GUI\getCreationMode(), ilPropertyFormGUI\getItemByPostVar(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectServiceSettingsGUI\initServiceSettingsForm(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ initStyleSheets()

ilObjContentPageGUI::initStyleSheets ( )

protected

Definition at line 572 of file class.ilObjContentPageGUI.php.

                                        : void
    {
        $this->content_style_gui->addCss($this->tpl, $this->object->getRefId());
        $this->tpl->setCurrentBlock('SyntaxStyle');
        $this->tpl->setVariable('LOCATION_SYNTAX_STYLESHEET', ilObjStyleSheet::getSyntaxStylePath());
        $this->tpl->parseCurrentBlock();
    }

References ilObjStyleSheet\getSyntaxStylePath(), and ILIAS\Repository\object().

Referenced by getContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateContentToolbar()

ilObjContentPageGUI::populateContentToolbar ( )

protected

Definition at line 529 of file class.ilObjContentPageGUI.php.

                                               : void
    {
        if (!$this->user->isAnonymous() && $this->checkPermissionBool('write')) {
            $this->lng->loadLanguageModule('cntr');
            $this->toolbar->addComponent(
                $this->uiServices->factory()->button()->primary(
                    $this->lng->txt('cntr_text_media_editor'),
                    $this->ctrl->getLinkTargetByClass(ilContentPagePageGUI::class, 'edit')
                )
            );
        }
    }

References ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromDesk()

ilObjContentPageGUI::removeFromDesk ( )

protected

Definition at line 427 of file class.ilObjContentPageGUI.php.

                                       : void
    {
        $this->removeFromDeskObject();
    }

References ilDesktopItemHandling\removeFromDeskObject().

Here is the call graph for this function:

◆ renderHeaderActions()

ilObjContentPageGUI::renderHeaderActions ( )

Definition at line 443 of file class.ilObjContentPageGUI.php.

                                         : void
    {
        if (!$this->getCreationMode() && $this->checkPermissionBool('read')) {
            $this->addHeaderAction();
        }
    }

References ilObjectGUI\addHeaderAction(), ilObject2GUI\checkPermissionBool(), and ilObject2GUI\getCreationMode().

Here is the call graph for this function:

◆ setSettingsSubTabs()

ilObjContentPageGUI::setSettingsSubTabs ( string $activeTab )

protected

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

                                                            : void
    {
        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addSubTab(
                self::UI_TAB_ID_SETTINGS,
                $this->lng->txt('general'),
                $this->ctrl->getLinkTarget($this, self::UI_CMD_EDIT)
            );
 
            $this->tabs_gui->addSubTab(
                self::UI_TAB_ID_STYLE,
                $this->lng->txt('cont_style'),
                $this->ctrl->getLinkTargetByClass("ilobjectcontentstylesettingsgui", "")
            );
 
            $this->tabs_gui->addSubTab(
                self::UI_TAB_ID_I18N,
                $this->lng->txt('obj_multilinguality'),
                $this->ctrl->getLinkTargetByClass(TranslationGUI::class)
            );
 
            $this->tabs_gui->activateSubTab($activeTab);
        }
    }

References ilObject2GUI\checkPermissionBool(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setTabs()

ilObjContentPageGUI::setTabs ( )

protected

create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

Reimplemented from ilObject2GUI.

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

                                : void
    {
        if ($this->in_page_editor_style_context) {
            return;
        }
 
        $this->help->setScreenIdComponent($this->object->getType());
 
        if ($this->checkPermissionBool('read')) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_CONTENT,
                $this->lng->txt('content'),
                $this->ctrl->getLinkTarget($this, self::UI_CMD_VIEW)
            );
        }
 
        if ($this->infoScreenEnabled && ($this->checkPermissionBool('visible') || $this->checkPermissionBool('read'))) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_INFO,
                $this->lng->txt('info_short'),
                $this->ctrl->getLinkTargetByClass(ilInfoScreenGUI::class, 'showSummary')
            );
        }
 
        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_SETTINGS,
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, self::UI_CMD_EDIT)
            );
        }
 
        if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_LP,
                $this->lng->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass(ilLearningProgressGUI::class)
            );
        }
 
        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_MD,
                $this->lng->txt('meta_data'),
                $this->ctrl->getLinkTargetByClass(ilMDEditorGUI::class)
            );
        }
 
        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_EXPORT,
                $this->lng->txt('export'),
                $this->ctrl->getLinkTargetByClass(ilExportGUI::class)
            );
        }
 
        if ($this->checkPermissionBool('edit_permission')) {
            $this->tabs_gui->addTab(
                self::UI_TAB_ID_PERMISSIONS,
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, 'perm')
            );
        }
    }

References ilLearningProgressAccess\checkAccess(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ setTitleAndDescription()

ilObjContentPageGUI::setTitleAndDescription ( )

protected

Reimplemented from ilObject2GUI.

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

                                               : void
    {
        parent::setTitleAndDescription();
 
        $icon = ilObject::_getIcon($this->object->getId(), 'big', $this->object->getType());
        $this->tpl->setTitleIcon($icon, $this->lng->txt('obj_' . $this->object->getType()));
    }

References ilObject\_getIcon(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ updateCustom()

ilObjContentPageGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Insert custom update form values into object.

Reimplemented from ilObjectGUI.

Definition at line 670 of file class.ilObjContentPageGUI.php.

                                                            : void
    {
        $this->object->setOfflineStatus(!(bool) $form->getInput('activation_online'));
        $this->object->update();
 
        ilObjectServiceSettingsGUI::updateServiceSettingsForm(
            $this->object->getId(),
            $form,
            [
                ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY
            ]
        );
        $this->object_service->commonSettings()->legacyForm($form, $this->object)->saveIcon();
        $this->object_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();
    }

References ilPropertyFormGUI\getInput(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ILIAS\Repository\object(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

Here is the call graph for this function:

◆ view()

ilObjContentPageGUI::view ( )

view object content (repository/workspace switch)

Reimplemented from ilObject2GUI.

Definition at line 516 of file class.ilObjContentPageGUI.php.

                          : void
    {
        $this->checkPermission('read');
 
        $this->populateContentToolbar();
 
        $this->tabs_gui->activateTab(self::UI_TAB_ID_CONTENT);
 
        $this->tpl->setPermanentLink($this->object->getType(), $this->object->getRefId(), '', '_top');
 
        $this->tpl->setContent($this->getContent());
    }

References ilObject2GUI\checkPermission(), getContent(), ILIAS\Repository\object(), and populateContentToolbar().

Here is the call graph for this function:

Field Documentation

◆ $content_style_domain

ILIAS Style Content Object ObjectFacade ilObjContentPageGUI::$content_style_domain = null

private

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

◆ $content_style_gui

readonly ILIAS Style Content GUIService ilObjContentPageGUI::$content_style_gui

private

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

◆ $dic

readonly Container ilObjContentPageGUI::$dic

private

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

◆ $help

readonly ilHelpGUI ilObjContentPageGUI::$help

private

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

◆ $in_page_editor_style_context

readonly bool ilObjContentPageGUI::$in_page_editor_style_context

private

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

◆ $infoScreenEnabled

bool ilObjContentPageGUI::$infoScreenEnabled = false

private

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

Referenced by getEditFormCustomValues().

◆ $lom_services

readonly LOMServices ilObjContentPageGUI::$lom_services

private

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

◆ $navHistory

readonly ilNavigationHistory ilObjContentPageGUI::$navHistory

private

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

◆ $pageMetricsService

readonly PageMetricsService ilObjContentPageGUI::$pageMetricsService

private

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

◆ $translation

readonly Translations ilObjContentPageGUI::$translation

private

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

◆ $uiServices

readonly ILIAS DI UIServices ilObjContentPageGUI::$uiServices

private

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

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

components/ILIAS/ContentPage/classes/class.ilObjContentPageGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addAvailabilitySection()

◆ addLocatorItems()

◆ addToDesk()

◆ addToNavigationHistory()

◆ afterSave()

◆ editStyleProperties()

◆ getContent()

◆ getEditFormCustomValues()

◆ getType()

◆ infoScreen()

◆ infoScreenForward()

◆ initEditCustomForm()

◆ initStyleSheets()

◆ populateContentToolbar()

◆ removeFromDesk()

◆ renderHeaderActions()

◆ setSettingsSubTabs()

◆ setTabs()

◆ setTitleAndDescription()

◆ updateCustom()

◆ view()

Field Documentation

◆ $content_style_domain

◆ $content_style_gui

◆ $dic

◆ $help

◆ $in_page_editor_style_context

◆ $infoScreenEnabled

◆ $lom_services

◆ $navHistory

◆ $pageMetricsService

◆ $translation

◆ $uiServices