ilObjContentPageGUI Class Reference

Class ilObjContentPageGUI ilObjContentPageGUI: ilRepositoryGUI ilObjContentPageGUI: ilAdministrationGUI ilObjContentPageGUI: ilPermissionGUI ilObjContentPageGUI: ilInfoScreenGUI ilObjContentPageGUI: ilObjectCopyGUI ilObjContentPageGUI: ilExportGUI ilObjContentPageGUI: ilLearningProgressGUI ilObjContentPageGUI: ilCommonActionDispatcherGUI ilObjContentPageGUI: ilContentPagePageGUI ilObjContentPageGUI: ilObjectCustomIconConfigurationGUI ilObjContentPageGUI: ilObjStyleSheetGUI. More...

Inheritance diagram for ilObjContentPageGUI:

Collaboration diagram for ilObjContentPageGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	getType ()
	setTabs ()
	executeCommand ()
	addToNavigationHistory ()
	renderHeaderActions ()
	infoScreenForward ()
	addLocatorItems ()
	infoScreen ()
	view ()
	Shows the content of the object. More...
	getContent (string $ctrlLink='')
Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	executeCommand ()
	execute command More...
	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 ($a_mode=true)
	getCreationMode ()
	prepareOutput ($a_show_subobjects=true)
	isVisible ($a_ref_id, $a_type)
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	Deleted in ilObject. More...
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ilDesktopItemHandling
	addToDeskObject ()
	Add desktop item public. More...
	removeFromDeskObject ()
	Remove from desktop public. More...

Static Public Member Functions
static	_goto ($target)
	Deep link. More...
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Protected Member Functions
	setSettingsSubTabs ($activeTab)
	Sub tab configuration of the settings area. More...
	setContentSubTabs ()
	Sub tab configuration of the content area. More...
	initStyleSheets ()
	afterSave (\ilObject $a_new_object)
	setTitleAndDescription ()
	initEditCustomForm (\ilPropertyFormGUI $a_form)
	getEditFormCustomValues (array &$a_values)
	updateCustom (\ilPropertyFormGUI $a_form)
	editStyleProperties ()
	buildStylePropertiesForm ()
	createStyle ()
	Create Style. More...
	editStyle ()
	Edit Style. More...
	deleteStyle ()
	Delete Style. More...
	saveStyleSettings ()
	Save style settings. 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 ()
	Get access handler. More...
	setLocator ()
	set Locator More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings (ilColumnGUI $column_gui)
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	fillCloneTemplate ($a_tpl_varname, $a_type)
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ($a_do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...
	setReturnLocation ($a_cmd, $a_location)
	showActions ()
	getTabs ()
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	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 public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$request
	$ctrl
	$access
	$settings
	$tabs
	$user
	$obj_service
	$navHistory
	$error
	$dic
	$infoScreenEnabled = false
	$help
Protected Attributes inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites

Additional Inherited Members
Data Fields inherited from ilObject2GUI
	$tree
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	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
Data Fields inherited from ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'
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_DOWNLOAD_PARAGRAPH = 'download_paragraph'
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_LP = 'learning_progress'
const	UI_TAB_ID_EXPORT = 'export'
const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Detailed Description

Class ilObjContentPageGUI ilObjContentPageGUI: ilRepositoryGUI ilObjContentPageGUI: ilAdministrationGUI ilObjContentPageGUI: ilPermissionGUI ilObjContentPageGUI: ilInfoScreenGUI ilObjContentPageGUI: ilObjectCopyGUI ilObjContentPageGUI: ilExportGUI ilObjContentPageGUI: ilLearningProgressGUI ilObjContentPageGUI: ilCommonActionDispatcherGUI ilObjContentPageGUI: ilContentPagePageGUI ilObjContentPageGUI: ilObjectCustomIconConfigurationGUI ilObjContentPageGUI: ilObjStyleSheetGUI.

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilContainer\_lookupContainerSetting(), help(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, settings(), and user().

    {
        global $DIC;

        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->dic = $DIC;
        $this->request = $this->dic->http()->request();
        $this->settings = $this->dic->settings();
        $this->access = $this->dic->access();
        $this->ctrl = $this->dic->ctrl();
        $this->tabs = $this->dic->tabs();
        $this->user = $this->dic->user();
        $this->obj_service = $this->dic->object();
        $this->navHistory = $this->dic['ilNavigationHistory'];
        $this->error = $this->dic['ilErr'];
        $this->help = $DIC['ilHelp'];

        $this->lng->loadLanguageModule('copa');
        $this->lng->loadLanguageModule('style');
        $this->lng->loadLanguageModule('content');

        if ($this->object instanceof \ilObjContentPage) {
            $this->infoScreenEnabled = \ilContainer::_lookupContainerSetting(
                $this->object->getId(),
                \ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                true
            );
        }
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjContentPageGUI::_goto (   $target )

static

Deep link.

Parameters

string

$target

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

References $DIC, $refId, ilObjectGUI\_gotoRepositoryNode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilUtil\sendInfo().

    {
        global $DIC;

        $targetAttributes = explode('_', $target);
        $refId = (int) $targetAttributes[0];

        if ((int) $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()->initBaseClass('ilRepositoryGUI');
            if (isset($DIC->http()->request()->getQueryParams()['gotolp'])) {
                $DIC->ctrl()->setParameterByClass(__CLASS__, 'gotolp', 1);
            }
            $DIC->ctrl()->setParameterByClass(__CLASS__, 'ref_id', $refId);
            $DIC->ctrl()->redirectByClass(array(
                'ilRepositoryGUI',
                __CLASS__,
            ), self::UI_CMD_VIEW);
        } elseif ($DIC->access()->checkAccess("visible", "", $target)) {
            ilObjectGUI::_gotoRepositoryNode($target, "infoScreen");
        } elseif ($DIC->access()->checkAccess('read', '', ROOT_FOLDER_ID)) {
            \ilUtil::sendInfo(sprintf(
                $DIC->language()->txt('msg_no_perm_read_item'),
                \ilObject::_lookupTitle(\ilObject::_lookupObjId($refId))
            ), true);

            $DIC->ctrl()->setTargetScript('ilias.php');
            $DIC->ctrl()->initBaseClass('ilRepositoryGUI');
            $DIC->ctrl()->setParameterByClass('ilRepositoryGUI', 'ref_id', ROOT_FOLDER_ID);
            $DIC->ctrl()->redirectByClass('ilRepositoryGUI');
        }

        $DIC['ilErr']->raiseError($DIC->language()->txt('msg_no_perm_read'), $DIC['ilErr']->FATAL);
    }

Here is the call graph for this function:

addLocatorItems()

ilObjContentPageGUI::addLocatorItems

(

)

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

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

addToNavigationHistory()

ilObjContentPageGUI::addToNavigationHistory

(

)

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

References ilLink\_getLink(), ilObject2GUI\checkPermissionBool(), and ilObject2GUI\getCreationMode().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

afterSave()

ilObjContentPageGUI::afterSave ( \ilObject  $a_new_object )

protected

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

    {
        \ilUtil::sendSuccess($this->lng->txt('object_added'), true);
        $this->ctrl->redirect($this, 'edit');
    }

buildStylePropertiesForm()

ilObjContentPageGUI::buildStylePropertiesForm ( )

protected

Returns

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

References $_GET, ilObjStyleSheet\_getStandardStyles(), ilObjStyleSheet\_lookupStandard(), ilObject\_lookupTitle(), settings(), and ilNonEditableValueGUI\setValue().

Referenced by editStyleProperties().

                                                  : \ilPropertyFormGUI
    {
        $form = new \ilPropertyFormGUI();

        $fixedStyle = $this->settings->get('fixed_content_style_id');
        $defaultStyle = $this->settings->get('default_content_style_id');
        $styleId = $this->object->getStyleSheetId();

        if ($fixedStyle > 0) {
            $st = new ilNonEditableValueGUI($this->lng->txt("cont_current_style"));
            $st->setValue(
                \ilObject::_lookupTitle($fixedStyle) . " (" . $this->lng->txt("global_fixed") . ")"
            );
            $form->addItem($st);
        } else {
            $st_styles = \ilObjStyleSheet::_getStandardStyles(
                true,
                false,
                (int) $_GET["ref_id"]
            );

            if ($defaultStyle > 0) {
                $st_styles[0] = \ilObject::_lookupTitle($defaultStyle) . ' (' . $this->lng->txt('default') . ')';
            } else {
                $st_styles[0] = $this->lng->txt('default');
            }
            ksort($st_styles);

            if ($styleId > 0) {
                if (!\ilObjStyleSheet::_lookupStandard($styleId)) {
                    $st = new \ilNonEditableValueGUI($this->lng->txt('cont_current_style'));
                    $st->setValue(ilObject::_lookupTitle($styleId));
                    $form->addItem($st);

                    $form->addCommandButton('editStyle', $this->lng->txt('cont_edit_style'));
                    $form->addCommandButton('deleteStyle', $this->lng->txt('cont_delete_style'));
                }
            }

            if ($styleId <= 0 || \ilObjStyleSheet::_lookupStandard($styleId)) {
                $style_sel = new \ilSelectInputGUI($this->lng->txt('cont_current_style'), 'style_id');
                $style_sel->setOptions($st_styles);
                $style_sel->setValue($styleId);
                $form->addItem($style_sel);
                $form->addCommandButton('saveStyleSettings', $this->lng->txt('save'));
                $form->addCommandButton('createStyle', $this->lng->txt('sty_create_ind_style'));
            }
        }

        $form->setTitle($this->lng->txt("cont_style"));
        $form->setFormAction($this->ctrl->getFormAction($this));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createStyle()

ilObjContentPageGUI::createStyle ( )

protected

Create Style.

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

    {
        $this->ctrl->redirectByClass('ilobjstylesheetgui', 'create');
    }

deleteStyle()

ilObjContentPageGUI::deleteStyle ( )

protected

Delete Style.

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

    {
        $this->ctrl->redirectByClass('ilobjstylesheetgui', 'delete');
    }

editStyle()

ilObjContentPageGUI::editStyle ( )

protected

Edit Style.

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

    {
        $this->ctrl->redirectByClass('ilobjstylesheetgui', 'edit');
    }

editStyleProperties()

ilObjContentPageGUI::editStyleProperties ( )

protected

Exceptions

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

References buildStylePropertiesForm(), ilObject2GUI\checkPermission(), and setSettingsSubTabs().

    {
        $this->checkPermission('write');

        $this->tabs->activateTab(self::UI_TAB_ID_SETTINGS);
        $this->setSettingsSubTabs(self::UI_TAB_ID_STYLE);

        $form = $this->buildStylePropertiesForm();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilObjContentPageGUI::executeCommand

(

)

Exceptions

ilObjectException
ilCtrlException
ilException

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

References $_GET, $ret, addToNavigationHistory(), ilLearningProgressAccess\checkAccess(), ilObject2GUI\checkPermission(), ilObject2GUI\checkPermissionBool(), ilObjStyleSheet\getContentStylePath(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObjStyleSheet\getSyntaxStylePath(), infoScreenForward(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ilObject2GUI\prepareOutput(), renderHeaderActions(), ilObject2GUI\setLocator(), setSettingsSubTabs(), settings(), and user().

    {
        $nextClass = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd(self::UI_CMD_VIEW);

        $this->addToNavigationHistory();

        if (strtolower($nextClass) !== 'ilobjstylesheetgui') {
            $this->renderHeaderActions();
        }

        switch (strtolower($nextClass)) {
            case 'ilobjstylesheetgui':
                $this->checkPermission('write');

                $this->setLocator();

                $this->ctrl->setReturn($this, 'editStyleProperties');
                $style_gui = new \ilObjStyleSheetGUI(
                    '',
                    $this->object->getStyleSheetId(),
                    false,
                    false
                );
                $style_gui->omitLocator();
                if ($cmd === 'create' || $_GET['new_type'] === 'sty') {
                    $style_gui->setCreationMode(true);
                }

                if ($cmd === 'confirmedDelete') {
                    $this->object->setStyleSheetId(0);
                    $this->object->update();
                }

                $ret = $this->ctrl->forwardCommand($style_gui);

                if ($cmd === 'save' || $cmd === 'copyStyle' || $cmd === 'importStyle') {
                    $styleId = $ret;
                    $this->object->setStyleSheetId($styleId);
                    $this->object->update();
                    $this->ctrl->redirectByClass('ilobjstylesheetgui', 'edit');
                }
                break;

            case 'ilcontentpagepagegui':
                if (in_array(strtolower($cmd), array_map('strtolower', [
                    self::UI_CMD_COPAGE_DOWNLOAD_FILE,
                    self::UI_CMD_COPAGE_DISPLAY_FULLSCREEN,
                    self::UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH,
                ]))
                ) {
                    if (!$this->checkPermissionBool('read')) {
                        $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
                    }
                } elseif (!$this->checkPermissionBool('write') || $this->user->isAnonymous()) {
                    $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
                }

                $this->prepareOutput();

                $this->tpl->setVariable(
                    'LOCATION_CONTENT_STYLESHEET',
                    \ilObjStyleSheet::getContentStylePath($this->object->getStyleSheetId())
                );
                $this->tpl->setCurrentBlock('SyntaxStyle');
                $this->tpl->setVariable('LOCATION_SYNTAX_STYLESHEET', \ilObjStyleSheet::getSyntaxStylePath());
                $this->tpl->parseCurrentBlock();

                $forwarder = new \ilContentPagePageCommandForwarder(
                    $this->request,
                    $this->ctrl,
                    $this->tabs,
                    $this->lng,
                    $this->object
                );
                $pageContent = $forwarder->forward();
                if (strlen($pageContent) > 0) {
                    $this->tpl->setContent($pageContent);
                }
                break;

            case 'ilinfoscreengui':
                if (!$this->infoScreenEnabled) {
                    return null;
                }
                $this->prepareOutput();

                $this->infoScreenForward();
                break;

            case 'ilcommonactiondispatchergui':
                $this->ctrl->forwardCommand(\ilCommonActionDispatcherGUI::getInstanceFromAjaxCall());
                break;

            case 'ilpermissiongui':
                $this->checkPermission('edit_permission');

                $this->prepareOutput();
                $this->tabs->activateTab(self::UI_TAB_ID_PERMISSIONS);

                $this->ctrl->forwardCommand(new \ilPermissionGUI($this));
                break;

            case 'illearningprogressgui':
                if (!\ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
                    $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
                }

                $this->prepareOutput();
                $this->tabs->activateTab(self::UI_TAB_ID_LP);

                $this->ctrl->forwardCommand(new \ilLearningProgressGUI(
                    \ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    isset(
                        $this->request->getQueryParams()['user_id']) &&
                        is_numeric(
                            $this->request->getQueryParams()['user_id']
                    ) ?
                        (int) $this->request->getQueryParams()['user_id'] :
                        $this->user->getId()
                ));
                break;

            case 'ilexportgui':
                $this->checkPermission('write');

                $this->prepareOutput();
                $this->tabs->activateTab(self::UI_TAB_ID_EXPORT);

                $gui = new \ilExportGUI($this);
                $gui->addFormat('xml');
                $this->ctrl->forwardCommand($gui);
                break;

            case 'ilobjectcustomiconconfigurationgui':
                if (!$this->checkPermissionBool('write') || !$this->settings->get('custom_icons')) {
                    $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
                }

                $this->prepareOutput();
                $this->tabs->activateTab(self::UI_TAB_ID_SETTINGS);
                $this->setSettingsSubTabs(self::UI_TAB_ID_ICON);

                require_once 'Services/Object/Icon/classes/class.ilObjectCustomIconConfigurationGUI.php';
                $gui = new \ilObjectCustomIconConfigurationGUI($this->dic, $this, $this->object);
                $this->ctrl->forwardCommand($gui);
                break;

            case 'ilobjectcopygui':
                $this->tpl->loadStandardTemplate();

                $gui = new \ilObjectCopyGUI($this);
                $gui->setType(self::OBJ_TYPE);

                $this->ctrl->forwardCommand($gui);
                break;

            default:
                switch (true) {
                    case in_array(strtolower($cmd), array_map('strtolower', [self::UI_CMD_EDIT, self::UI_CMD_UPDATE])):
                        $this->setSettingsSubTabs(self::UI_TAB_ID_SETTINGS);
                        break;
                }

                if (in_array(strtolower($cmd), array_map('strtolower', ['addToDesk', 'removeFromDesk']))) {
                    $this->ctrl->setCmd($cmd . 'Object');
                }

                return parent::executeCommand();
        }
        return null;
    }

Here is the call graph for this function:

getContent()

ilObjContentPageGUI::getContent

(

string

$ctrlLink = ''

)

Parameters

string

$ctrlLink

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

Returns

string

Exceptions

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

References ilObject2GUI\checkPermissionBool(), initStyleSheets(), ilContentPagePageCommandForwarder\PRESENTATION_MODE_PRESENTATION, and user().

Referenced by view().

                                                      : string
    {
        if ($this->checkPermissionBool('read')) {
            $this->object->trackProgress((int) $this->user->getId());

            $this->initStyleSheets();

            $forwarder = new \ilContentPagePageCommandForwarder(
                $this->request,
                $this->ctrl,
                $this->tabs,
                $this->lng,
                $this->object
            );
            $forwarder->setPresentationMode(ilContentPagePageCommandForwarder::PRESENTATION_MODE_PRESENTATION);

            return $forwarder->forward($ctrlLink);
        }

        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEditFormCustomValues()

ilObjContentPageGUI::getEditFormCustomValues ( array &  $a_values )

protected

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

References $infoScreenEnabled, and ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY.

    {
        $a_values[\ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY] = $this->infoScreenEnabled;
    }

getType()

ilObjContentPageGUI::getType

(

)

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

    {
        return self::OBJ_TYPE;
    }

infoScreen()

ilObjContentPageGUI::infoScreen

(

)

Exceptions

ilCtrlException

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

References infoScreenForward().

    {
        $this->ctrl->setCmd('showSummary');
        $this->ctrl->setCmdClass('ilinfoscreengui');

        $this->infoScreenForward();
    }

Here is the call graph for this function:

infoScreenForward()

ilObjContentPageGUI::infoScreenForward

(

)

Exceptions

ilCtrlException

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

References ilObject2GUI\checkPermissionBool().

Referenced by executeCommand(), and infoScreen().

    {
        if (!$this->infoScreenEnabled) {
            return;
        }

        if (!$this->checkPermissionBool('visible') && !$this->checkPermissionBool('read')) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->tabs->activateTab(self::UI_TAB_ID_INFO);

        $info = new \ilInfoScreenGUI($this);
        $info->enableLearningProgress(true);
        $info->enablePrivateNotes();
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initEditCustomForm()

ilObjContentPageGUI::initEditCustomForm ( \ilPropertyFormGUI  $a_form )

protected

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

References ilPropertyFormGUI\addItem(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, and ilObjectServiceSettingsGUI\initServiceSettingsForm().

    {
        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt('obj_features'));
        $a_form->addItem($sh);

        \ilObjectServiceSettingsGUI::initServiceSettingsForm(
            $this->object->getId(),
            $a_form,
            array(
                \ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY
            )
        );

        $presentationHeader = new ilFormSectionHeaderGUI();
        $presentationHeader->setTitle($this->lng->txt('settings_presentation_header'));
        $a_form->addItem($presentationHeader);
        $this->obj_service->commonSettings()->legacyForm($a_form, $this->object)->addTileImage();
    }

Here is the call graph for this function:

initStyleSheets()

ilObjContentPageGUI::initStyleSheets ( )

protected

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

References ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

Referenced by getContent().

    {
        $this->tpl->setVariable(
            'LOCATION_CONTENT_STYLESHEET',
            \ilObjStyleSheet::getContentStylePath($this->object->getStyleSheetId())
        );
        $this->tpl->setCurrentBlock('SyntaxStyle');
        $this->tpl->setVariable('LOCATION_SYNTAX_STYLESHEET', \ilObjStyleSheet::getSyntaxStylePath());
        $this->tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderHeaderActions()

ilObjContentPageGUI::renderHeaderActions

(

)

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

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

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

saveStyleSettings()

ilObjContentPageGUI::saveStyleSettings ( )

protected

Save style settings.

Exceptions

ilObjectException

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

References $_POST, ilObjStyleSheet\_lookupStandard(), ilObject2GUI\checkPermission(), settings(), and ilUtil\stripSlashes().

    {
        $this->checkPermission('write');

        if (
            $this->settings->get('fixed_content_style_id') <= 0 &&
            (
                \ilObjStyleSheet::_lookupStandard(
                    $this->object->getStyleSheetId()
            ) ||
                $this->object->getStyleSheetId() == 0
            )
        ) {
            $this->object->setStyleSheetId(ilUtil::stripSlashes($_POST['style_id']));
            $this->object->update();
            ilUtil::sendSuccess($this->lng->txt('msg_obj_modified'), true);
        }

        $this->ctrl->redirect($this, 'editStyleProperties');
    }

Here is the call graph for this function:

setContentSubTabs()

ilObjContentPageGUI::setContentSubTabs ( )

protected

Sub tab configuration of the content area.

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

References ilObject2GUI\checkPermissionBool(), and user().

Referenced by view().

    {
        if ($this->checkPermissionBool('write')) {
            $this->tabs->addSubTab(
                self::UI_TAB_ID_CONTENT,
                $this->lng->txt('view'),
                $this->ctrl->getLinkTarget($this, self::UI_CMD_VIEW)
            );

            if (!$this->user->isAnonymous()) {
                $this->lng->loadLanguageModule('cntr');
                $this->tabs->addSubTab(
                    'page_editor',
                    $this->lng->txt('cntr_text_media_editor'),
                    $this->ctrl->getLinkTargetByClass('ilContentPagePageGUI', 'edit')
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSettingsSubTabs()

ilObjContentPageGUI::setSettingsSubTabs (   $activeTab )

protected

Sub tab configuration of the settings area.

Parameters

string

$activeTab

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

References ilObject2GUI\checkPermissionBool(), and settings().

Referenced by editStyleProperties(), and executeCommand().

    {
        if ($this->checkPermissionBool('write')) {
            $this->tabs->addSubTab(
                self::UI_TAB_ID_SETTINGS,
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, self::UI_CMD_EDIT)
            );

            if ($this->settings->get('custom_icons')) {
                $this->tabs_gui->addSubTab(
                    self::UI_TAB_ID_ICON,
                    $this->lng->txt('icon_settings'),
                    $this->ctrl->getLinkTargetByClass('ilObjectCustomIconConfigurationGUI')
                );
            }

            $this->tabs_gui->addSubTab(
                self::UI_TAB_ID_STYLE,
                $this->lng->txt('cont_style'),
                $this->ctrl->getLinkTarget($this, 'editStyleProperties')
            );

            $this->tabs->activateSubTab($activeTab);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilObjContentPageGUI::setTabs

(

)

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

References ilLearningProgressAccess\checkAccess(), ilObject2GUI\checkPermissionBool(), and help().

    {
        $this->help->setScreenIdComponent($this->object->getType());

        if ($this->checkPermissionBool('read')) {
            $this->tabs->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->addTab(
                self::UI_TAB_ID_INFO,
                $this->lng->txt('info_short'),
                $this->ctrl->getLinkTargetByClass('ilinfoscreengui', 'showSummary')
            );
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs->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->addTab(
                self::UI_TAB_ID_LP,
                $this->lng->txt('learning_progress'),
                $this->ctrl->getLinkTargetByClass('illearningprogressgui')
            );
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs->addTab(
                self::UI_TAB_ID_EXPORT,
                $this->lng->txt('export'),
                $this->ctrl->getLinkTargetByClass('ilexportgui')
            );
        }

        if ($this->checkPermissionBool('edit_permission')) {
            $this->tabs->addTab(
                self::UI_TAB_ID_PERMISSIONS,
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm')
            );
        }
    }

Here is the call graph for this function:

setTitleAndDescription()

ilObjContentPageGUI::setTitleAndDescription ( )

protected

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

    {
        parent::setTitleAndDescription();

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

updateCustom()

ilObjContentPageGUI::updateCustom ( \ilPropertyFormGUI  $a_form )

protected

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

References ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

    {
        \ilObjectServiceSettingsGUI::updateServiceSettingsForm(
            $this->object->getId(),
            $a_form,
            array(
                \ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY
            )
        );
        $this->obj_service->commonSettings()->legacyForm($a_form, $this->object)->saveTileImage();
    }

Here is the call graph for this function:

view()

ilObjContentPageGUI::view

(

)

Shows the content of the object.

Exceptions

ilException
ilObjectException

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

References ilObject2GUI\checkPermission(), getContent(), and setContentSubTabs().

    {
        $this->checkPermission('read');

        $this->setContentSubTabs();

        $this->tabs->activateTab(self::UI_TAB_ID_CONTENT);
        $this->tabs->activateSubTab(self::UI_TAB_ID_CONTENT);

        $this->tpl->setPermanentLink($this->object->getType(), $this->object->getRefId(), '', '_top');

        $this->tpl->setContent($this->getContent());
    }

Here is the call graph for this function:

Field Documentation

$access

ilObjContentPageGUI::$access

protected

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

$ctrl

ilObjContentPageGUI::$ctrl

protected

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

$dic

ilObjContentPageGUI::$dic

protected

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

$error

ilObjContentPageGUI::$error

protected

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

$help

ilObjContentPageGUI::$help

protected

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

$infoScreenEnabled

ilObjContentPageGUI::$infoScreenEnabled = false

protected

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

Referenced by getEditFormCustomValues().

$navHistory

ilObjContentPageGUI::$navHistory

protected

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

$obj_service

ilObjContentPageGUI::$obj_service

protected

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

$request

ilObjContentPageGUI::$request

protected

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

$settings

ilObjContentPageGUI::$settings

protected

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

$tabs

ilObjContentPageGUI::$tabs

protected

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

$user

ilObjContentPageGUI::$user

protected

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

---

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

• Modules/ContentPage/classes/class.ilObjContentPageGUI.php