ilObjLinkResourceGUI Class Reference

Class ilObjLinkResourceGUI. More...

Inheritance diagram for ilObjLinkResourceGUI:

Collaboration diagram for ilObjLinkResourceGUI:

Public Member Functions
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)
	getType ()
	executeCommand ()
	save ()
	editLink ()
	updateLink ()
	getLinkToListModal ()
	Get form to transform a single weblink to a weblink list. More...
	saveLinkList ()
	addLink ()
	saveAddLink ()
	view ()
	infoScreen ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
	infoScreenForward ()
	show information screen More...
	history ()
	callDirectLink ()
	callLink ()
	exportHTML ()
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)
	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 ()
	importFile ()
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	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)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (string $a_target, $a_additional=null)
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
	getWebLinkRepo ()
	initViewMode (?int $new_view_mode=null)
	initCreateForm (string $new_type)
	afterSave (ilObject $new_object)
	settings ()
	saveSettings ()
	initFormSettings ()
	deleteParameter ()
	deleteParameterForm ()
	updateLinks ()
	setValuesFromLink (int $a_link_id)
	initList (int $a_mode)
	checkLinkInput (int $a_mode, bool $a_valid, ?int $a_link_id=null)
	initFormLink (int $a_mode)
	addLinkInputToForm (int $mode)
	switchViewMode (?int $force_view_mode=null)
	Switch between "View" "Manage" and "Sort". More...
	editLinks ()
	Start with manage mode. More...
	manage ()
	showLinks ()
	sort ()
	saveSorting ()
	showToolbar (string $a_tpl_var)
	confirmDeleteLink ()
	deleteLinks ()
	deactivateLink ()
	activateTabs (string $a_active_tab, string $a_active_subtab='')
	Activate tab and subtabs. More...
	setTabs ()
	addLocatorItems ()
	redirectToLink (int $a_ref_id, int $a_obj_id, string $a_url)
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="")
	setTargetFrame (string $cmd, string $target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId (int $ref_id, string $cmd="")
	addAdminLocatorItems (bool $do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...
	setReturnLocation (string $cmd, string $location)
	showActions ()
	getTabs ()
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms (string $new_type)
	Init creation forms. 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...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	addAdoptContentLinkToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	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...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	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 ()
	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...

Protected Attributes
const	VIEW_MODE_VIEW = 1
const	VIEW_MODE_MANAGE = 2
const	VIEW_MODE_SORT = 3
const	LINK_MOD_CREATE = 1
const	LINK_MOD_EDIT = 2
const	LINK_MOD_ADD = 3
const	LINK_MOD_SET_LIST = 4
const	LINK_MOD_EDIT_LIST = 5
const	LINK_MOD_ASYNC = 6
HTTPService	$http
ilNavigationHistory	$navigationHistory
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
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
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
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
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
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 = ""

Private Member Functions
	__prepareOutput ()

Private Attributes
int	$view_mode = self::VIEW_MODE_VIEW
ilPropertyFormGUI	$form = null
ilWebLinkDraftItem	$draft_item = null
ilWebLinkDraftParameter	$draft_parameter = null
ilWebLinkDraftList	$draft_list = null

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	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
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

Detailed Description

Class ilObjLinkResourceGUI.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e ilObjLinkResourceGUI: ilObjectMetaDataGUI, ilPermissionGUI, ilInfoScreenGUI, ilObjectCopyGUI ilObjLinkResourceGUI: ilExportGUI, ilWorkspaceAccessGUI, ilCommonActionDispatcherGUI ilObjLinkResourceGUI: ilPropertyFormGUI, ilInternalLinkGUI

Definition at line 31 of file class.ilObjLinkResourceGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjLinkResourceGUI::__construct	(	int	$id = 0,
		int	$id_type = self::REPOSITORY_NODE_ID,
		int	$parent_node_id = 0
	)

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

References $DIC, ilObjectGUI\$id, ilObject2GUI\$id_type, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\navigationHistory(), and settings().

      {
        global $DIC;

        parent::__construct($id, $id_type, $parent_node_id);

        $this->lng->loadLanguageModule("webr");
        $this->http = $DIC->http();
        $this->navigationHistory = $DIC['ilNavigationHistory'];
        $this->settings = $DIC->settings();
    }

Here is the call graph for this function:

Member Function Documentation

__prepareOutput()

ilObjLinkResourceGUI::__prepareOutput ( )

private

Definition at line 1621 of file class.ilObjLinkResourceGUI.php.

Referenced by executeCommand().

                                      : void
    {
        $this->tpl->setLocator();
    }

Here is the caller graph for this function:

_goto()

static ilObjLinkResourceGUI::_goto ( string  $a_target,   $a_additional = null  )

static

Definition at line 1732 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\$ctrl, $DIC, $ilErr, ilObject2GUI\$lng, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilUtil\redirect(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilCtrl\setParameterByClass(), ilCtrl\setTargetScript(), and ilLanguage\txt().

Referenced by ILIAS\StaticURL\Handler\LegacyGotoHandler\handle().

                                                                        : void
    {
        global $DIC;

        $main_tpl = $DIC->ui()->mainTemplate();
        $ilAccess = $DIC->access();
        $lng = $DIC->language();
        $ctrl = $DIC->ctrl();
        $ilErr = $DIC['ilErr'];

        if ($a_additional && substr($a_additional, -3) == "wsp") {
            $ctrl->setTargetScript('ilias.php');
            $ctrl->setParameterByClass(
                ilSharedResourceGUI::class,
                'wsp_id',
                $a_target
            );
            $ctrl->redirectByClass(
                [
                    ilSharedResourceGUI::class
                ],
                'edit'
            );
            return;
        }

        // Will be replaced in future releases by ilAccess::checkAccess()
        if ($ilAccess->checkAccess("read", "", (int) $a_target)) {
            ilUtil::redirect(
                "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=" . $a_target
            );
        } else {
            // to do: force flat view
            if ($ilAccess->checkAccess("visible", "", (int) $a_target)) {
                ilUtil::redirect(
                    "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=" . $a_target . "&cmd=infoScreen"
                );
            } else {
                if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
                    $main_tpl->setOnScreenMessage(
                        'failure',
                        sprintf(
                            $lng->txt("msg_no_perm_read_item"),
                            ilObject::_lookupTitle(
                                ilObject::_lookupObjId(
                                    (int) $a_target
                                )
                            )
                        ),
                        true
                    );
                    ilObjectGUI::_gotoRepositoryRoot();
                }
            }
        }

        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

activateTabs()

ilObjLinkResourceGUI::activateTabs ( string  $a_active_tab, string  $a_active_subtab = ''  )

protected

Activate tab and subtabs.

Definition at line 1502 of file class.ilObjLinkResourceGUI.php.

References ilContainerSortingSettings\_lookupSortMode(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilContainer\SORT_MANUAL.

Referenced by addLink(), confirmDeleteLink(), editLink(), manage(), saveAddLink(), showLinks(), sort(), and updateLinks().

     : void {
        switch ($a_active_tab) {
            case 'content':
                if ($this->checkPermissionBool('write')) {
                    $this->lng->loadLanguageModule('cntr');

                    $this->ctrl->setParameter(
                        $this,
                        'switch_mode',
                        self::VIEW_MODE_VIEW
                    );
                    $this->tabs_gui->addSubTab(
                        'id_content_view',
                        $this->lng->txt('view'),
                        $this->ctrl->getLinkTarget($this, 'switchViewMode')
                    );
                    $this->ctrl->setParameter(
                        $this,
                        'switch_mode',
                        self::VIEW_MODE_MANAGE
                    );
                    $this->tabs_gui->addSubTab(
                        'id_content_manage',
                        $this->lng->txt('cntr_manage'),
                        $this->ctrl->getLinkTarget($this, 'switchViewMode')
                    );
                    if (!$this->getWebLinkRepo()->doesOnlyOneItemExist() and
                        ilContainerSortingSettings::_lookupSortMode(
                            $this->object->getId()
                        ) == ilContainer::SORT_MANUAL) {
                        $this->ctrl->setParameter(
                            $this,
                            'switch_mode',
                            self::VIEW_MODE_SORT
                        );
                        $this->tabs_gui->addSubTab(
                            'id_content_ordering',
                            $this->lng->txt('cntr_ordering'),
                            $this->ctrl->getLinkTarget($this, 'switchViewMode')
                        );
                    }

                    $this->ctrl->clearParameters($this);
                    $this->tabs_gui->activateSubTab($a_active_subtab);
                }
        }

        $this->tabs_gui->activateTab('id_content');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLink()

ilObjLinkResourceGUI::addLink

(

)

Definition at line 544 of file class.ilObjLinkResourceGUI.php.

References activateTabs(), ilObject2GUI\checkPermission(), ilPropertyFormGUI\getHTML(), and initFormLink().

                             : void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_view');

        $form = $this->initFormLink(self::LINK_MOD_ADD);
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

addLinkInputToForm()

ilObjLinkResourceGUI::addLinkInputToForm ( int  $mode )

protected

Definition at line 1117 of file class.ilObjLinkResourceGUI.php.

References ILIAS\Repository\form(), ilLinkInputGUI\LIST, ILIAS\Repository\lng(), and ilLinkInputGUI\setAllowedLinkTypes().

Referenced by initFormLink().

                                                    : void
    {
        $tar = new ilLinkInputGUI(
            $this->lng->txt('type'),
            'tar'
        ); // lng var
        if ($mode == self::LINK_MOD_CREATE) {
            $tar->setAllowedLinkTypes(ilLinkInputGUI::LIST);
        }
        $tar->setInternalLinkFilterTypes(
            [
                "PageObject",
                "GlossaryItem",
                "RepositoryItem",
                'WikiPage'
            ]
        );
        $tar->setExternalLinkMaxLength(1000);
        $tar->setInternalLinkFilterTypes(
            ["PageObject", "GlossaryItem", "RepositoryItem"]
        );
        $tar->setRequired(true);
        $this->form->addItem($tar);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLocatorItems()

ilObjLinkResourceGUI::addLocatorItems ( )

protected

Todo:

is this required?

Definition at line 1629 of file class.ilObjLinkResourceGUI.php.

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

                                        : void
    {
        global $DIC;

        $ilLocator = $DIC['ilLocator'];
        if (is_object($this->object)) {
            $ilLocator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTarget($this),
                "",
                $this->object->getRefId(),
                "webr"
            );
        }
    }

Here is the call graph for this function:

afterSave()

ilObjLinkResourceGUI::afterSave ( ilObject  $new_object )

protected

Definition at line 210 of file class.ilObjLinkResourceGUI.php.

References ilWebLinkDatabaseRepository\createItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilObject\getId(), ilObject\getRefId(), ILIAS\Repository\lng(), and ilUtil\redirect().

                                                      : void
    {
        $new_web_link_repo = new ilWebLinkDatabaseRepository($new_object->getId());

        if ($this->form->getInput('tar_mode_type') === 'single') {
            // Save link
            $new_web_link_repo->createItem($this->draft_item);
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_link_added')
            );
        }

        if ($this->form->getInput('tar_mode_type') === 'list') {
            // Save list
            $new_web_link_repo->createList($this->draft_list);
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_list_added')
            );
        }

        // personal workspace
        if ($this->id_type == self::WORKSPACE_NODE_ID) {
            $this->ctrl->redirect($this, "editLinks");
        } // repository
        else {
            ilUtil::redirect(
                "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=" .
                $new_object->getRefId() . "&cmd=switchViewMode&switch_mode=2"
            );
        }
    }

Here is the call graph for this function:

callDirectLink()

ilObjLinkResourceGUI::callDirectLink

(

)

Definition at line 1645 of file class.ilObjLinkResourceGUI.php.

References ilObjectGUI\$obj_id, ilObjLinkResourceAccess\_getFirstLink(), getWebLinkRepo(), and redirectToLink().

                                    : void
    {
        $obj_id = $this->object->getId();

        if ($this->getWebLinkRepo()->doesOnlyOneItemExist(true)) {
            $item = ilObjLinkResourceAccess::_getFirstLink($obj_id);

            $this->redirectToLink(
                $this->ref_id,
                $obj_id,
                $item->getResolvedLink((bool) $this->settings->get('links_dynamic'))
            );
        }
    }

Here is the call graph for this function:

callLink()

ilObjLinkResourceGUI::callLink

(

)

Definition at line 1660 of file class.ilObjLinkResourceGUI.php.

References getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\object(), redirectToLink(), ILIAS\Repository\refinery(), and settings().

                              : void
    {
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );

            $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);

            $this->redirectToLink(
                $this->ref_id,
                $this->object->getId(),
                $item->getResolvedLink((bool) $this->settings->get('links_dynamic'))
            );
        }
    }

Here is the call graph for this function:

checkLinkInput()

ilObjLinkResourceGUI::checkLinkInput ( int  $a_mode, bool  $a_valid, ?int  $a_link_id = null  )

protected

Definition at line 834 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\$error, $valid, ILIAS\Repository\form(), ilLinkInputGUI\isInternalLink(), ilWebLinkDraftParameter\LINKS_ERR_NO_NAME, ilWebLinkDraftParameter\LINKS_ERR_NO_VALUE, ILIAS\Repository\lng(), and settings().

Referenced by save(), saveAddLink(), and updateLink().

     : bool {
        $valid = $a_valid;

        $link_input = $this->form->getInput('tar');
        $active = false;

        if ($a_mode == self::LINK_MOD_CREATE) {
            $active = true;
        } else {
            $active = (bool) $this->form->getInput('act');
        }

        $this->draft_item = new ilWebLinkDraftItem(
            ilLinkInputGUI::isInternalLink($link_input),
            $this->form->getInput('title'),
            $this->form->getInput('desc'),
            str_replace('"', '', $link_input),
            $active,
            []
        );

        if (!$this->settings->get('links_dynamic')) {
            return $valid;
        }

        $this->draft_parameter = new ilWebLinkDraftParameter(
            (int) $this->form->getInput('val'),
            $this->form->getInput('nam')
        );

        $error = $this->draft_parameter->validate();
        if (!$error) {
            return $valid;
        }

        $this->draft_parameter = null;

        switch ($error) {
            case ilWebLinkDraftParameter::LINKS_ERR_NO_NAME:
                $this->form->getItemByPostVar('nam')->setAlert(
                    $this->lng->txt('links_no_name_given')
                );
                return false;

            case ilWebLinkDraftParameter::LINKS_ERR_NO_VALUE:
                $this->form->getItemByPostVar('val')->setAlert(
                    $this->lng->txt('links_no_value_given')
                );
                return false;

            default:
                // Nothing entered => no error
                return $valid;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteLink()

ilObjLinkResourceGUI::confirmDeleteLink ( )

protected

Definition at line 1332 of file class.ilObjLinkResourceGUI.php.

References activateTabs(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and view().

                                          : void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_view');

        $link_ids = [];
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_ids = (array) $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        } else {
            if ($this->http->wrapper()->post()->has('link_ids')) {
                $link_ids = $this->http->wrapper()->post()->retrieve(
                    'link_ids',
                    $this->refinery->kindlyTo()->dictOf(
                        $this->refinery->kindlyTo()->int()
                    )
                );
            }
        }
        if ($link_ids === []) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one')
            );
            $this->view();
            return;
        }

        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this, 'view'));
        $confirm->setHeaderText($this->lng->txt('webr_sure_delete_items'));
        $confirm->setConfirm($this->lng->txt('delete'), 'deleteLinks');
        $confirm->setCancel($this->lng->txt('cancel'), 'view');

        $items = $this->getWebLinkRepo()->getAllItemsAsContainer()->getItems();

        foreach ($items as $item) {
            if (!in_array($item->getLinkId(), $link_ids)) {
                continue;
            }
            $confirm->addItem(
                'link_ids[]',
                (string) $item->getLinkId(),
                $item->getTitle()
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

deactivateLink()

ilObjLinkResourceGUI::deactivateLink ( )

protected

Definition at line 1409 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

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

        $link_id = 0;
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if (!$link_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);
        $draft = new ilWebLinkDraftItem(
            $item->isInternal(),
            $item->getTitle(),
            $item->getDescription(),
            $item->getTarget(),
            false,
            $item->getParameters()
        );

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('webr_inactive_success'),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

Here is the call graph for this function:

deleteLinks()

ilObjLinkResourceGUI::deleteLinks ( )

protected

Definition at line 1383 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

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

        $link_ids = [];
        if ($this->http->wrapper()->post()->has('link_ids')) {
            $link_ids = $this->http->wrapper()->post()->retrieve(
                'link_ids',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        foreach ($link_ids as $link_id) {
            $this->getWebLinkRepo()->deleteItemByLinkID($link_id);
        }

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('webr_deleted_items'),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

Here is the call graph for this function:

deleteParameter()

ilObjLinkResourceGUI::deleteParameter ( )

protected

Definition at line 589 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

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

        $link_id = $this->http->wrapper()->query()->retrieve(
            'link_id',
            $this->refinery->kindlyTo()->int()
        );
        $this->ctrl->setParameter($this, 'link_id', $link_id);

        $param_id = $this->http->wrapper()->query()->retrieve(
            'param_id',
            $this->refinery->kindlyTo()->int()
        );

        if (!$param_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $this->getWebLinkRepo()->deleteParameterByLinkIdAndParamId($link_id, $param_id);

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt(
                'links_parameter_deleted'
            ),
            true
        );
        $this->ctrl->redirect($this, 'editLinks');
    }

Here is the call graph for this function:

deleteParameterForm()

ilObjLinkResourceGUI::deleteParameterForm ( )

protected

Definition at line 625 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

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

        $link_id = $this->http->wrapper()->query()->retrieve(
            'link_id',
            $this->refinery->kindlyTo()->int()
        );

        $param_id = $this->http->wrapper()->query()->retrieve(
            'param_id',
            $this->refinery->kindlyTo()->int()
        );
        if (!$param_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $this->getWebLinkRepo()->deleteParameterByLinkIdAndParamId($link_id, $param_id);

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt(
                'links_parameter_deleted'
            ),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

Here is the call graph for this function:

editLink()

ilObjLinkResourceGUI::editLink

(

)

Definition at line 395 of file class.ilObjLinkResourceGUI.php.

References activateTabs(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ILIAS\FileDelivery\http(), initFormLink(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and setValuesFromLink().

                              : void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_view');

        $link_id = 0;
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if (!$link_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $form = $this->initFormLink(self::LINK_MOD_EDIT);
        $this->setValuesFromLink($link_id);
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

editLinks()

ilObjLinkResourceGUI::editLinks ( )

protected

Start with manage mode.

Definition at line 1165 of file class.ilObjLinkResourceGUI.php.

References switchViewMode().

                                  : void
    {
        $this->switchViewMode(self::VIEW_MODE_MANAGE);
    }

Here is the call graph for this function:

executeCommand()

ilObjLinkResourceGUI::executeCommand

(

)

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

References __prepareOutput(), ilMDUtils\_fillHTMLMetaTags(), ilObjectGUI\addHeaderAction(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ILIAS\FileDelivery\http(), infoScreenForward(), initFormLink(), initViewMode(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObject2GUI\prepareOutput(), and ILIAS\Repository\refinery().

                                    : void
    {
        $this->initViewMode();

        $base_class = $this->http->wrapper()->query()->retrieve(
            'baseClass',
            $this->refinery->kindlyTo()->string()
        );
        if ($base_class === ilLinkResourceHandlerGUI::class) {
            $this->__prepareOutput();
        }
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        switch ($next_class) {
            case "ilinfoscreengui":
                $this->prepareOutput();
                $this->infoScreenForward();    // forwards command
                break;

            case 'ilobjectmetadatagui':
                $this->checkPermission('write'); // #18563
                $this->prepareOutput();
                $this->tabs_gui->activateTab('id_meta_data');
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;

            case 'ilpermissiongui':
                $this->prepareOutput();
                $this->tabs_gui->activateTab('id_permissions');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilobjectcopygui':
                $this->prepareOutput();
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('webr');
                $this->ctrl->forwardCommand($cp);
                break;

            case 'ilexportgui':
                $this->prepareOutput();
                $this->tabs_gui->setTabActive('export');
                $exp = new ilExportGUI($this);
                $exp->addFormat('xml');
                $this->ctrl->forwardCommand($exp);
                break;

            case "ilcommonactiondispatchergui":
                $this->prepareOutput();
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case "ilpropertyformgui":
                $mode = $this->ctrl->isAsynch() ?
                    self::LINK_MOD_ASYNC : self::LINK_MOD_EDIT;
                $this->initFormLink($mode);
                $this->ctrl->forwardCommand($this->form);
                break;

            case "ilinternallinkgui":
                $this->lng->loadLanguageModule("content");
                $link_gui = new ilInternalLinkGUI("RepositoryItem", 0);
                $link_gui->filterLinkType("PageObject");
                $link_gui->filterLinkType("GlossaryItem");
                $link_gui->filterLinkType("RepositoryItem");
                $link_gui->setFilterWhiteList(true);
                $this->ctrl->forwardCommand($link_gui);
                break;

            default:
                if (!$cmd) {
                    $this->ctrl->setCmd("view");
                }
                parent::executeCommand();
        }

        if (!$this->getCreationMode()) {
            ilMDUtils::_fillHTMLMetaTags(
                $this->object->getId(),
                $this->object->getId(),
                'webr'
            );
            $this->addHeaderAction();
        }
    }

Here is the call graph for this function:

exportHTML()

ilObjLinkResourceGUI::exportHTML

(

)

Definition at line 1694 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\$tpl, ilUtil\deliverData(), ilGlobalTemplateInterface\get(), getWebLinkRepo(), ILIAS\Repository\object(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), settings(), and ilGlobalTemplateInterface\setVariable().

                                : void
    {
        $tpl = new ilTemplate(
            "tpl.export_html.html",
            true,
            true,
            "Modules/WebResource"
        );

        $items = $this->getWebLinkRepo()->getAllItemsAsContainer(true)
                                        ->getItems();
        foreach ($items as $item) {
            $tpl->setCurrentBlock("link_bl");
            $tpl->setVariable("LINK_URL", $item->getResolvedLink(false));
            $tpl->setVariable("LINK_TITLE", $item->getTitle());
            $tpl->setVariable("LINK_DESC", $item->getDescription() ?? '');
            $tpl->setVariable("LINK_CREATE", $item->getCreateDate()
                                                          ->format('Y-m-d H-i-s'));
            $tpl->setVariable("LINK_UPDATE", $item->getLastUpdate()
                                                          ->format('Y-m-d H-i-s'));
            $tpl->parseCurrentBlock();
        }

        $tpl->setVariable("CREATE_DATE", $this->object->getCreateDate());
        $tpl->setVariable("LAST_UPDATE", $this->object->getLastUpdateDate());
        $tpl->setVariable("TXT_TITLE", $this->object->getTitle());
        $tpl->setVariable("TXT_DESC", $this->object->getLongDescription());

        $tpl->setVariable(
            "INST_ID",
            ($this->settings->get('short_inst_name') != "")
            ? $this->settings->get('short_inst_name')
            : "ILIAS"
        );

        ilUtil::deliverData($tpl->get(), "bookmarks.html");
    }

Here is the call graph for this function:

getLinkToListModal()

ilObjLinkResourceGUI::getLinkToListModal

(

)

Get form to transform a single weblink to a weblink list.

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

References $DIC, Vendor\Package\$f, ilObjectGUI\$id, $r, ILIAS\Repository\form(), ILIAS\FileDelivery\http(), initFormLink(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Referenced by showToolbar().

                                        : Component
    {
        global $DIC;

        $f = $DIC->ui()->factory();
        $r = $DIC->ui()->renderer();

        // check if form was already set
        if ($this->form == null) {
            $this->initFormLink(self::LINK_MOD_SET_LIST);
        }

        $form_id = 'form_' . $this->form->getId();

        $submit = $f->button()->primary($this->lng->txt('save'), '#')
                    ->withOnLoadCode(
                        function ($id) use ($form_id) {
                            return "$('#{$id}').click(function() { $('#{$form_id}').submit(); return false; });";
                        }
                    );
        $info = $f->messageBox()->info($this->lng->txt('webr_new_list_info'));

        $modal = $f->modal()->roundtrip(
            $this->lng->txt('webr_new_list'),
            $f->legacy($r->render($info) . $this->form->getHTML())
        )
                   ->withActionButtons([$submit]);

        $submit = '';
        if ($this->http->wrapper()->post()->has('sbmt')) {
            $submit = $this->http->wrapper()->post()->retrieve(
                'sbmt',
                $this->refinery->kindlyTo()->string()
            );
        }
        // modal triggers its show signal on load if form validation failed
        if ($submit === 'submit') {
            $modal = $modal->withOnLoad($modal->getShowSignal());
        }
        return $modal;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

ilObjLinkResourceGUI::getType

(

)

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

                             : string
    {
        return "webr";
    }

getWebLinkRepo()

ilObjLinkResourceGUI::getWebLinkRepo ( )

protected

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

References ILIAS\Repository\object().

Referenced by activateTabs(), callDirectLink(), callLink(), confirmDeleteLink(), deactivateLink(), deleteLinks(), deleteParameter(), deleteParameterForm(), exportHTML(), initFormLink(), initFormSettings(), saveAddLink(), saveLinkList(), saveSettings(), setValuesFromLink(), showToolbar(), updateLink(), and updateLinks().

                                       : ilWebLinkRepository
    {
        return new ilWebLinkDatabaseRepository($this->object->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

history()

ilObjLinkResourceGUI::history

(

)

Definition at line 1484 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\checkPermission(), ilHistoryTableGUI\initTable(), and ILIAS\Repository\object().

                             : void
    {
        $this->checkPermission('write');
        $this->tabs_gui->activateTab('id_history');

        $hist_gui = new ilHistoryTableGUI(
            $this,
            "history",
            $this->object->getId(),
            $this->object->getType()
        );
        $hist_gui->initTable();
        $this->tpl->setContent($hist_gui->getHTML());
    }

Here is the call graph for this function:

infoScreen()

ilObjLinkResourceGUI::infoScreen

(

)

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 1452 of file class.ilObjLinkResourceGUI.php.

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

                                : void
    {
        $this->ctrl->setCmd("showSummary");
        $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->infoScreenForward();
    }

Here is the call graph for this function:

infoScreenForward()

ilObjLinkResourceGUI::infoScreenForward

(

)

show information screen

Definition at line 1462 of file class.ilObjLinkResourceGUI.php.

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

Referenced by executeCommand(), and infoScreen().

                                       : void
    {
        if (!$this->checkPermissionBool('visible')) {
            $this->checkPermission('read');
        }
        $this->tabs_gui->activateTab('id_info');

        $info = new ilInfoScreenGUI($this);

        $info->enablePrivateNotes();

        // standard meta data
        $info->addMetaDataSections(
            $this->object->getId(),
            0,
            $this->object->getType()
        );

        // forward the command
        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreateForm()

ilObjLinkResourceGUI::initCreateForm ( string  $new_type )

protected

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

References $form, and initFormLink().

                                                       : ilPropertyFormGUI
    {
        $this->initFormLink(self::LINK_MOD_CREATE);
        return $this->form;
    }

Here is the call graph for this function:

initFormLink()

ilObjLinkResourceGUI::initFormLink ( int  $a_mode )

protected

Definition at line 894 of file class.ilObjLinkResourceGUI.php.

References $form, $param, $params, addLinkInputToForm(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilWebLinkBaseParameter\SESSION_ID_NAME, ilTextAreaInputGUI\setRows(), settings(), ilWebLinkBaseParameter\VALUES, and ilWebLinkBaseParameter\VALUES_TEXT.

Referenced by addLink(), editLink(), executeCommand(), getLinkToListModal(), initCreateForm(), save(), saveAddLink(), saveLinkList(), and updateLink().

                                                : ilPropertyFormGUI
    {
        $this->tabs_gui->activateTab("id_content");

        $this->form = new ilPropertyFormGUI();
        switch ($a_mode) {
            case self::LINK_MOD_CREATE:
                // Header
                $this->ctrl->setParameter($this, 'new_type', 'webr');
                $this->form->setTitle($this->lng->txt('webr_new_link'));
                $this->form->setTableWidth('600px');

                // Buttons
                $this->form->addCommandButton(
                    'save',
                    $this->lng->txt('webr_add')
                );
                $this->form->addCommandButton(
                    'cancel',
                    $this->lng->txt('cancel')
                );
                break;

            case self::LINK_MOD_ADD:
                // Header
                $this->form->setTitle($this->lng->txt('webr_new_link'));

                // Buttons
                $this->form->addCommandButton(
                    'saveAddLink',
                    $this->lng->txt('webr_add')
                );
                $this->form->addCommandButton(
                    'view',
                    $this->lng->txt('cancel')
                );
                break;

            case self::LINK_MOD_EDIT:
                // Header
                $this->ctrl->setParameter(
                    $this,
                    'link_id',
                    // TODO PHP8 Review: Remove/Replace SuperGlobals
                    (int) $_REQUEST['link_id']
                );
                $this->form->setTitle($this->lng->txt('webr_edit'));

                // Buttons
                $this->form->addCommandButton(
                    'updateLink',
                    $this->lng->txt('save')
                );
                $this->form->addCommandButton(
                    'view',
                    $this->lng->txt('cancel')
                );
                break;

                /*
                 * The async call for displaying the object explorer for
                 * internal links goes through ilPropertyFormGUI to get
                 * to the right ilLinkInputGUI, so we only add that field
                 * to the form here.
                 */
            case self::LINK_MOD_ASYNC:
                $this->addLinkInputToForm($a_mode);
                return $this->form;
        }

        if ($a_mode == self::LINK_MOD_SET_LIST) {
            $this->form->setValuesByPost();
            $this->form->setFormAction(
                $this->ctrl->getFormAction($this, 'saveLinkList')
            );
            $this->form->setId(uniqid('form'));

            // List Title
            $title = new ilTextInputGUI(
                $this->lng->txt('webr_list_title'),
                'lti'
            );
            $title->setRequired(true);
            $title->setSize(40);
            $title->setMaxLength(127);
            $this->form->addItem($title);

            // List Description
            $desc = new ilTextAreaInputGUI(
                $this->lng->txt('webr_list_desc'),
                'tde'
            );
            $desc->setRows(3);
            $desc->setCols(40);
            $this->form->addItem($desc);

            $item = new ilHiddenInputGUI('sbmt');
            $item->setValue('submit');
            $this->form->addItem($item);
        } else {
            $this->form->setFormAction($this->ctrl->getFormAction($this));

            $this->addLinkInputToForm($a_mode);

            // Title
            $tit = new ilTextInputGUI(
                $this->lng->txt('webr_link_title'),
                'title'
            );
            $tit->setRequired(true);
            $tit->setSize(40);
            $tit->setMaxLength(127);
            $this->form->addItem($tit);

            // Description
            $des = new ilTextAreaInputGUI(
                $this->lng->txt('description'),
                'desc'
            );
            $des->setRows(3);
            $des->setCols(40);
            $this->form->addItem($des);

            if ($a_mode != self::LINK_MOD_CREATE) {
                // Active
                $act = new ilCheckboxInputGUI($this->lng->txt('active'), 'act');
                $act->setChecked(true);
                $act->setValue('1');
                $this->form->addItem($act);
            }

            if ($this->settings->get('links_dynamic') &&
                $a_mode != self::LINK_MOD_CREATE
            ) {
                $dyn = new ilNonEditableValueGUI(
                    $this->lng->txt('links_dyn_parameter')
                );
                $dyn->setInfo($this->lng->txt('links_dynamic_info'));

                if ($this->http->wrapper()->query()->has('link_id')) {
                    $link_id = $this->http->wrapper()->query()->retrieve(
                        'link_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                if (
                    isset($link_id) &&
                    $link_id > 0 &&
                    ($params = $this->getWebLinkRepo()->getItemByLinkId($link_id)->getParameters()) !== []
                ) {
                    $ex = new ilCustomInputGUI(
                        $this->lng->txt('links_existing_params'),
                        'ex'
                    );
                    $dyn->addSubItem($ex);

                    foreach ($params as $param) {
                        $p = new ilCustomInputGUI();

                        $ptpl = new ilTemplate(
                            'tpl.link_dyn_param_edit.html',
                            true,
                            true,
                            'Modules/WebResource'
                        );
                        $ptpl->setVariable(
                            'INFO_TXT',
                            $param->getInfo()
                        );
                        $this->ctrl->setParameter($this, 'param_id', $param->getParamId());
                        $this->ctrl->setParameter($this, 'link_id', $link_id);
                        $ptpl->setVariable(
                            'LINK_DEL',
                            $this->ctrl->getLinkTarget(
                                $this,
                                'deleteParameterForm'
                            )
                        );
                        $ptpl->setVariable(
                            'LINK_TXT',
                            $this->lng->txt('delete')
                        );
                        $p->setHtml($ptpl->get());
                        $dyn->addSubItem($p);
                    }
                }

                // Dynyamic name
                $nam = new ilTextInputGUI($this->lng->txt('links_name'), 'nam');
                $nam->setSize(12);
                $nam->setMaxLength(128);
                $dyn->addSubItem($nam);

                // Dynamic value
                $val = new ilSelectInputGUI(
                    $this->lng->txt('links_value'),
                    'val'
                );
                /*
                $val->setOptions(array_map(
                    function ($s) {
                        return $this->lng->txt($s);
                    },
                    ilWebLinkBaseParameter::VALUES_TEXT
                ));
                */
                $options = [];
                foreach (ilWebLinkBaseParameter::VALUES as $name => $identifier) {
                    if ($name === ilWebLinkBaseParameter::SESSION_ID_NAME) {
                        continue;
                    }
                    $options[] = ilWebLinkBaseParameter::VALUES_TEXT[$identifier];
                }
                $val->setOptions($options);
                $val->setValue(0);
                $dyn->addSubItem($val);

                $this->form->addItem($dyn);
            }
        }
        return $this->form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormSettings()

ilObjLinkResourceGUI::initFormSettings ( )

protected

Definition at line 303 of file class.ilObjLinkResourceGUI.php.

References $form, ilObjectGUI\$object_service, ilContainerSortingSettings\_lookupSortMode(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getWebLinkRepo(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilFormPropertyGUI\setRequired(), ilTextAreaInputGUI\setValue(), ilContainer\SORT_MANUAL, and ilContainer\SORT_TITLE.

Referenced by saveSettings(), and settings().

                                         : ilPropertyFormGUI
    {
        $obj_service = $this->object_service;

        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction(
            $this->ctrl->getFormAction($this, 'saveSettings')
        );

        if ($this->getWebLinkRepo()->doesListExist()) {
            $this->form->setTitle($this->lng->txt('webr_edit_settings'));

            // Title
            $tit = new ilTextInputGUI(
                $this->lng->txt('webr_list_title'),
                'title'
            );
            $tit->setValue($this->object->getTitle());
            $tit->setRequired(true);
            $tit->setSize(40);
            $tit->setMaxLength(127);
            $this->form->addItem($tit);

            // Description
            $des = new ilTextAreaInputGUI(
                $this->lng->txt('webr_list_desc'),
                'desc'
            );
            $des->setValue($this->object->getDescription());
            $des->setCols(40);
            $des->setRows(3);
            $this->form->addItem($des);

            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($this->lng->txt('obj_presentation'));
            $this->form->addItem($section);

            // tile image
            $obj_service->commonSettings()->legacyForm(
                $this->form,
                $this->object
            )->addTileImage();

            // Sorting
            $sor = new ilRadioGroupInputGUI(
                $this->lng->txt('webr_sorting'),
                'sor'
            );
            $sor->setRequired(true);
            $sor->setValue(
                (string) ilContainerSortingSettings::_lookupSortMode(
                    $this->object->getId()
                )
            );

            $opt = new ilRadioOption(
                $this->lng->txt('webr_sort_title'),
                (string) ilContainer::SORT_TITLE
            );
            $sor->addOption($opt);

            $opm = new ilRadioOption(
                $this->lng->txt('webr_sort_manual'),
                (string) ilContainer::SORT_MANUAL
            );
            $sor->addOption($opm);
            $this->form->addItem($sor);
        } else {
            $this->form->setTitle($this->lng->txt('obj_presentation'));

            // hidden title
            $tit = new ilHiddenInputGUI('title');
            $tit->setValue($this->object->getTitle());
            $this->form->addItem($tit);

            // hidden description
            $des = new ilHiddenInputGUI('desc');
            $des->setValue($this->object->getDescription());
            $this->form->addItem($des);

            // tile image
            $obj_service->commonSettings()->legacyForm(
                $this->form,
                $this->object
            )->addTileImage();
        }

        $this->form->addCommandButton('saveSettings', $this->lng->txt('save'));
        $this->form->addCommandButton('view', $this->lng->txt('cancel'));
        return $this->form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initList()

ilObjLinkResourceGUI::initList ( int  $a_mode )

protected

Definition at line 817 of file class.ilObjLinkResourceGUI.php.

References ILIAS\Repository\form().

Referenced by save(), saveLinkList(), and saveSettings().

                                            : void
    {
        if ($a_mode == self::LINK_MOD_CREATE || $a_mode == self::LINK_MOD_EDIT_LIST) {
            $this->draft_list = new ilWebLinkDraftList(
                $this->form->getInput('title'),
                $this->form->getInput('desc')
            );
        }

        if ($a_mode == self::LINK_MOD_SET_LIST) {
            $this->draft_list = new ilWebLinkDraftList(
                $this->form->getInput('lti'),
                $this->form->getInput('tde')
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initViewMode()

ilObjLinkResourceGUI::initViewMode ( ?int  $new_view_mode = null )

protected

Todo:

no view mode for workspace?

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

References ilSession\get(), ilSession\has(), ILIAS\Repository\int(), and ilSession\set().

Referenced by executeCommand(), and switchViewMode().

                                                               : void
    {
        if ($new_view_mode !== null) {
            ilSession::set('webr_view_mode', $new_view_mode);
        }
        if (ilSession::has('webr_view_mode')) {
            $this->view_mode = (int) ilSession::get('webr_view_mode');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

manage()

ilObjLinkResourceGUI::manage ( )

protected

Definition at line 1210 of file class.ilObjLinkResourceGUI.php.

References activateTabs(), ilObject2GUI\checkPermission(), ilInternalLinkGUI\getInitHTML(), and showToolbar().

Referenced by view().

                               : void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_manage');

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.webr_manage.html',
            'Modules/WebResource'
        );
        $this->showToolbar('ACTION_BUTTONS');

        $table = new ilWebResourceEditableLinkTableGUI($this, 'view');
        $table->parse();

        $js = ilInternalLinkGUI::getInitHTML("");

        $this->tpl->addJavaScript("Modules/WebResource/js/intLink.js");
        $this->tpl->addJavascript("Services/Form/js/Form.js");

        $this->tpl->setVariable('TABLE_LINKS', $table->getHTML() . $js);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToLink()

ilObjLinkResourceGUI::redirectToLink ( int  $a_ref_id, int  $a_obj_id, string  $a_url  )

protected

Definition at line 1678 of file class.ilObjLinkResourceGUI.php.

References ilChangeEvent\_recordReadEvent(), ilUtil\redirect(), and ILIAS\Repository\user().

Referenced by callDirectLink(), and callLink().

     : void {
        if ($a_url) {
            ilChangeEvent::_recordReadEvent(
                "webr",
                $a_ref_id,
                $a_obj_id,
                $this->user->getId()
            );
            ilUtil::redirect($a_url);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilObjLinkResourceGUI::save

(

)

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

References $valid, checkLinkInput(), ILIAS\Repository\form(), initFormLink(), initList(), and ILIAS\Repository\lng().

                          : void
    {
        $this->initFormLink(self::LINK_MOD_CREATE);
        $valid = $this->form->checkInput();
        if (
            $this->checkLinkInput(self::LINK_MOD_CREATE, $valid, 0) &&
            $this->form->getInput('tar_mode_type') === 'single'
        ) {
            parent::save();
        } elseif ($valid && $this->form->getInput('tar_mode_type') == 'list') {
            $this->initList(self::LINK_MOD_CREATE);
            parent::save();
        } else {
            // Data incomplete or invalid
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('err_check_input')
            );
            $this->form->setValuesByPost();
            $this->tpl->setContent($this->form->getHTML());
        }
    }

Here is the call graph for this function:

saveAddLink()

ilObjLinkResourceGUI::saveAddLink

(

)

Definition at line 553 of file class.ilObjLinkResourceGUI.php.

References $valid, activateTabs(), ilPropertyFormGUI\checkInput(), checkLinkInput(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilPropertyFormGUI\getHTML(), getWebLinkRepo(), initFormLink(), ILIAS\Repository\lng(), and settings().

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

        $form = $this->initFormLink(self::LINK_MOD_ADD);
        $valid = $form->checkInput();
        if ($this->checkLinkInput(
            self::LINK_MOD_ADD,
            $valid,
            0
        )
        ) {
            if (
                $this->settings->get('links_dynamic') &&
                $this->draft_parameter !== null
            ) {
                $this->draft_item->addParameter($this->draft_parameter);
            }
            $this->getWebLinkRepo()->createItem($this->draft_item);

            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_link_added'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input')
        );
        $this->form->setValuesByPost();
        $this->activateTabs('content', 'id_content_view');
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveLinkList()

ilObjLinkResourceGUI::saveLinkList

(

)

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

References $valid, ilPropertyFormGUI\checkInput(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getInput(), getWebLinkRepo(), initFormLink(), initList(), ILIAS\Repository\lng(), ilPropertyFormGUI\setValuesByPost(), and view().

                                  : void
    {
        $this->checkPermission('write');
        $form = $this->initFormLink(self::LINK_MOD_SET_LIST);
        $valid = $form->checkInput();
        if ($valid) {
            $this->object->setTitle($form->getInput('lti'));
            $this->object->setDescription($form->getInput('tde'));
            $this->object->update();

            $this->initList(self::LINK_MOD_SET_LIST);
            $this->getWebLinkRepo()->createList($this->draft_list);
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_list_set'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input'),
            true
        );
        $form->setValuesByPost();
        $this->view();
    }

Here is the call graph for this function:

saveSettings()

ilObjLinkResourceGUI::saveSettings ( )

protected

Definition at line 253 of file class.ilObjLinkResourceGUI.php.

References Vendor\Package\$e, ilObjectGUI\$object_service, $valid, ilPropertyFormGUI\checkInput(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), getWebLinkRepo(), initFormSettings(), initList(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilContainerSortingSettings\setSortMode(), and ilPropertyFormGUI\setValuesByPost().

                                     : void
    {
        $obj_service = $this->object_service;

        $this->checkPermission('write');
        $this->tabs_gui->activateTab('id_settings');

        $form = $this->initFormSettings();
        $valid = $form->checkInput();
        if ($valid) {
            // update list
            $this->initList(self::LINK_MOD_EDIT_LIST);
            try {
                $list = $this->getWebLinkRepo()->getList();
                $this->getWebLinkRepo()->updateList($list, $this->draft_list);
            } catch (ilWebLinkDatabaseRepositoryException $e) {
                // no weblink list here => update tile image, title, description, sorting
            }

            // update object
            $this->object->setTitle($form->getInput('title'));
            $this->object->setDescription((string) $form->getInput('desc'));
            $this->object->update();

            // update sorting
            $sort = new ilContainerSortingSettings($this->object->getId());
            $sort->setSortMode((int) $form->getInput('sor'));
            $sort->update();

            // tile image
            $obj_service->commonSettings()->legacyForm(
                $form,
                $this->object
            )->saveTileImage();
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('settings_saved'),
                true
            );
            $this->ctrl->redirect($this, 'settings');
        }

        $form->setValuesByPost();
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input')
        );
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveSorting()

ilObjLinkResourceGUI::saveSorting ( )

protected

Definition at line 1270 of file class.ilObjLinkResourceGUI.php.

References ilContainerSorting\_getInstance(), ilObject2GUI\checkPermission(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\refinery(), and view().

                                    : void
    {
        $this->checkPermission('write');
        $sort = ilContainerSorting::_getInstance($this->object->getId());

        $position = [];
        if ($this->http->wrapper()->post()->has('position')) {
            $position = $this->http->wrapper()->post()->retrieve(
                'position',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
        $sort->savePost($position);
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('settings_saved'),
            true
        );
        $this->view();
    }

Here is the call graph for this function:

setTabs()

ilObjLinkResourceGUI::setTabs ( )

protected

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

References $DIC, ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilObject2GUI\getCreationMode(), and ILIAS\Repository\lng().

                                : void
    {
        global $DIC;

        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent("webr");

        if ($this->checkPermissionBool('read')) {
            $this->tabs_gui->addTab(
                "id_content",
                $this->lng->txt("content"),
                $this->ctrl->getLinkTarget($this, "view")
            );
        }

        if (
            $this->checkPermissionBool('visible') ||
            $this->checkPermissionBool('read')
        ) {
            $this->tabs_gui->addTab(
                "id_info",
                $this->lng->txt("info_short"),
                $this->ctrl->getLinkTarget($this, "infoScreen")
            );
        }

        if ($this->checkPermissionBool('write') and !$this->getCreationMode()) {
            $this->tabs_gui->addTab(
                "id_settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "settings")
            );
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                "id_history",
                $this->lng->txt("history"),
                $this->ctrl->getLinkTarget($this, "history")
            );
        }

        if ($this->checkPermissionBool('write')) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "id_meta_data",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }
        }

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

        // will add permission tab if needed
        parent::setTabs();
    }

Here is the call graph for this function:

settings()

ilObjLinkResourceGUI::settings ( )

protected

Definition at line 244 of file class.ilObjLinkResourceGUI.php.

References ilObject2GUI\checkPermission(), ilPropertyFormGUI\getHTML(), and initFormSettings().

Referenced by __construct(), callLink(), checkLinkInput(), exportHTML(), initFormLink(), saveAddLink(), and updateLink().

                                 : void
    {
        $this->checkPermission('write');
        $this->tabs_gui->activateTab('id_settings');

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

Here is the call graph for this function:

Here is the caller graph for this function:

setValuesFromLink()

ilObjLinkResourceGUI::setValuesFromLink ( int  $a_link_id )

protected

Definition at line 804 of file class.ilObjLinkResourceGUI.php.

References ILIAS\Repository\form(), getWebLinkRepo(), and ILIAS\Repository\int().

Referenced by editLink().

                                                        : void
    {
        $item = $this->getWebLinkRepo()->getItemByLinkId($a_link_id);
        $this->form->setValuesByArray(
            array(
                'title' => $item->getTitle(),
                'tar' => $item->getTarget(),
                'desc' => $item->getDescription(),
                'act' => (int) $item->isActive()
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLinks()

ilObjLinkResourceGUI::showLinks ( )

protected

Definition at line 1234 of file class.ilObjLinkResourceGUI.php.

References activateTabs(), ilObject2GUI\checkPermission(), and showToolbar().

Referenced by view().

                                  : void
    {
        $this->checkPermission('read');
        $this->activateTabs('content', 'id_content_view');

        $table = new ilWebResourceLinkTableGUI($this, 'showLinks');
        $table->parse();

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.webr_view.html',
            'Modules/WebResource'
        );
        $this->showToolbar('ACTION_BUTTONS');
        $this->tpl->setVariable('LINK_TABLE', $table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showToolbar()

ilObjLinkResourceGUI::showToolbar ( string  $a_tpl_var )

protected

Definition at line 1293 of file class.ilObjLinkResourceGUI.php.

References $DIC, Vendor\Package\$f, $r, ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), getLinkToListModal(), getWebLinkRepo(), and ILIAS\Repository\lng().

Referenced by manage(), showLinks(), and sort().

                                                     : void
    {
        global $DIC;

        $tool = new ilToolbarGUI();
        $tool->setFormAction($this->ctrl->getFormAction($this));

        $f = $DIC->ui()->factory();
        $r = $DIC->ui()->renderer();

        if (
            $this->getWebLinkRepo()->doesListExist() &&
            $this->checkPermissionBool('write')
        ) {
            $tool->addButton(
                $this->lng->txt('webr_add'),
                $this->ctrl->getLinkTarget($this, 'addLink')
            );
        } elseif ($this->checkPermissionBool('write')) {
            $modal = $this->getLinkToListModal();
            $button = $f->button()->standard(
                $this->lng->txt('webr_set_to_list'),
                '#'
            )
                        ->withOnClick($modal->getShowSignal());

            $this->tpl->setVariable("MODAL", $r->render([$modal]));

            $tool->addComponent($button);
        }

        $download_button = $f->button()->standard(
            $this->lng->txt('export_html'),
            $this->ctrl->getLinkTarget($this, 'exportHTML')
        );
        $tool->addComponent($download_button);
        $this->tpl->setVariable($a_tpl_var, $tool->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sort()

ilObjLinkResourceGUI::sort ( )

protected

Definition at line 1252 of file class.ilObjLinkResourceGUI.php.

References activateTabs(), ilObject2GUI\checkPermission(), and showToolbar().

Referenced by view().

                             : void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_ordering');

        $table = new ilWebResourceLinkTableGUI($this, 'sort', true);
        $table->parse();

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.webr_view.html',
            'Modules/WebResource'
        );
        $this->showToolbar('ACTION_BUTTONS');
        $this->tpl->setVariable('LINK_TABLE', $table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

switchViewMode()

ilObjLinkResourceGUI::switchViewMode ( ?int  $force_view_mode = null )

protected

Switch between "View" "Manage" and "Sort".

Definition at line 1145 of file class.ilObjLinkResourceGUI.php.

References $view_mode, ILIAS\FileDelivery\http(), initViewMode(), ILIAS\Repository\refinery(), and view().

Referenced by editLinks().

                                                                   : void
    {
        $new_view_mode = $this->view_mode;
        if ($force_view_mode !== null) {
            $new_view_mode = $force_view_mode;
        } else {
            if ($this->http->wrapper()->query()->has('switch_mode')) {
                $new_view_mode = $this->http->wrapper()->query()->retrieve(
                    'switch_mode',
                    $this->refinery->kindlyTo()->int()
                );
            }
        }
        $this->initViewMode($new_view_mode);
        $this->view();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateLink()

ilObjLinkResourceGUI::updateLink

(

)

Definition at line 420 of file class.ilObjLinkResourceGUI.php.

References $valid, ilPropertyFormGUI\checkInput(), checkLinkInput(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), getWebLinkRepo(), ILIAS\FileDelivery\http(), initFormLink(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), settings(), and ilPropertyFormGUI\setValuesByPost().

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

        $form = $this->initFormLink(self::LINK_MOD_EDIT);
        $valid = $form->checkInput();
        $link_id = 0;
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($this->checkLinkInput(
            self::LINK_MOD_EDIT,
            $valid,
            $link_id
        )) {
            $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);
            foreach ($item->getParameters() as $parameter) {
                $this->draft_item->addParameter($parameter);
            }

            if (
                $this->settings->get('links_dynamic') &&
                $this->draft_parameter !== null
            ) {
                $this->draft_item->addParameter($this->draft_parameter);
            }
            $this->getWebLinkRepo()->updateItem($item, $this->draft_item);

            if (!$this->getWebLinkRepo()->doesListExist()) {
                $this->object->setTitle($form->getInput('title'));
                $this->object->setDescription($form->getInput('desc'));
                $this->object->update();
            }
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('settings_saved'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input')
        );
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

updateLinks()

ilObjLinkResourceGUI::updateLinks ( )

protected

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

References ilObjectGUI\$data, $param, activateTabs(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getWebLinkRepo(), ILIAS\FileDelivery\http(), ilLinkInputGUI\isInternalLink(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

                                    : void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', '');

        $ids = [];
        if ($this->http->wrapper()->post()->has('ids')) {
            $ids = $this->http->wrapper()->post()->retrieve(
                'ids',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        if ($ids === []) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $link_post = (array) ($this->http->request()->getParsedBody(
        )['links'] ?? []);

        // Validate
        $invalid = [];
        foreach ($ids as $link_id) {
            $data = $link_post[$link_id];

            if (
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_type'
                ) &&
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_id'
                )
            ) {
                $data['tar'] =
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_type',
                        $this->refinery->kindlyTo()->string()
                    ) . '|' .
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_id',
                        $this->refinery->kindlyTo()->string()
                    );
            }
            if (!strlen($data['title'] ?? '')) {
                $invalid[] = $link_id;
                continue;
            }
            if (!strlen($data['tar'] ?? '')) {
                $invalid[] = $link_id;
                continue;
            }
            if (($data['nam'] ?? false) && !($data['val'] ?? false)) {
                $invalid[] = $link_id;
                continue;
            }
            if (!($data['nam'] ?? false) && ($data['val'] ?? false)) {
                $invalid[] = $link_id;
            }
        }

        if ($invalid !== []) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('err_check_input')
            );
            $this->tpl->addBlockFile(
                'ADM_CONTENT',
                'adm_content',
                'tpl.webr_manage.html',
                'Modules/WebResource'
            );
            $table = new ilWebResourceEditableLinkTableGUI($this, 'view');
            $table->setInvalidLinks($invalid);
            $table->parseSelectedLinks($ids);
            $table->updateFromPost();
            $this->tpl->setVariable('TABLE_LINKS', $table->getHTML());
            return;
        }

        // Save Settings
        foreach ($ids as $link_id) {
            $data = $link_post[$link_id];

            if (
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_type'
                ) &&
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_id'
                )
            ) {
                $data['tar'] =
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_type',
                        $this->refinery->kindlyTo()->string()
                    ) . '|' .
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_id',
                        $this->refinery->kindlyTo()->string()
                    );
            }

            $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);
            $draft = new ilWebLinkDraftItem(
                ilLinkInputGUI::isInternalLink($data['tar'] ?? ''),
                ilUtil::stripSlashes($data['title'] ?? ''),
                ilUtil::stripSlashes($data['desc'] ?? ''),
                str_replace('"', '', ilUtil::stripSlashes($data['tar'] ?? '')),
                (bool) ($data['act'] ?? false),
                $item->getParameters()
            );

            if (strlen($data['nam'] ?? '') && $data['val'] ?? '') {
                $param = new ilWebLinkDraftParameter(
                    (int) ($data['val'] ?? 0),
                    ilUtil::stripSlashes($data['nam'] ?? '')
                );
                $draft->addParameter($param);
            }

            $this->getWebLinkRepo()->updateItem($item, $draft);

            if (!$this->getWebLinkRepo()->doesListExist()) {
                $this->object->setTitle(ilUtil::stripSlashes($data['title'] ?? ''));
                $this->object->setDescription(
                    ilUtil::stripSlashes($data['desc'] ?? '')
                );
                $this->object->update();
            }
        }
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('settings_saved'),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

Here is the call graph for this function:

view()

ilObjLinkResourceGUI::view

(

)

Definition at line 1170 of file class.ilObjLinkResourceGUI.php.

References ilContainerSortingSettings\_lookupSortMode(), ilObject2GUI\checkPermission(), ILIAS\FileDelivery\http(), manage(), ILIAS\Repository\object(), ILIAS\Repository\refinery(), showLinks(), sort(), and ilContainer\SORT_MANUAL.

Referenced by confirmDeleteLink(), saveLinkList(), saveSorting(), and switchViewMode().

                          : void
    {
        $this->tabs_gui->activateTab("id_content");
        $this->checkPermission('read');

        $base_class = $this->http->wrapper()->query()->retrieve(
            'baseClass',
            $this->refinery->kindlyTo()->string()
        );
        if (strcasecmp($base_class, ilAdministrationGUI::class) === 0) {
            parent::view();
            return;
        } else {
            switch ($this->view_mode) {
                case self::VIEW_MODE_MANAGE:
                    $this->manage();
                    break;

                case self::VIEW_MODE_SORT:
                    // #14638
                    if (ilContainerSortingSettings::_lookupSortMode(
                        $this->object->getId()
                    ) == ilContainer::SORT_MANUAL) {
                        $this->sort();
                        break;
                    }
                    $this->showLinks();
                    break;

                default:
                    $this->showLinks();
                    break;
            }
        }
        $this->tpl->setPermanentLink(
            $this->object->getType(),
            $this->object->getRefId()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$draft_item

ilWebLinkDraftItem ilObjLinkResourceGUI::$draft_item = null

private

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

$draft_list

ilWebLinkDraftList ilObjLinkResourceGUI::$draft_list = null

private

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

$draft_parameter

ilWebLinkDraftParameter ilObjLinkResourceGUI::$draft_parameter = null

private

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

$form

ilPropertyFormGUI ilObjLinkResourceGUI::$form = null

private

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

Referenced by initCreateForm(), initFormLink(), and initFormSettings().

$http

HTTPService ilObjLinkResourceGUI::$http

protected

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

$navigationHistory

ilNavigationHistory ilObjLinkResourceGUI::$navigationHistory

protected

Definition at line 45 of file class.ilObjLinkResourceGUI.php.

$view_mode

int ilObjLinkResourceGUI::$view_mode = self::VIEW_MODE_VIEW

private

Definition at line 47 of file class.ilObjLinkResourceGUI.php.

Referenced by switchViewMode().

LINK_MOD_ADD

const ilObjLinkResourceGUI::LINK_MOD_ADD = 3

protected

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

LINK_MOD_ASYNC

const ilObjLinkResourceGUI::LINK_MOD_ASYNC = 6

protected

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

LINK_MOD_CREATE

const ilObjLinkResourceGUI::LINK_MOD_CREATE = 1

protected

Definition at line 37 of file class.ilObjLinkResourceGUI.php.

LINK_MOD_EDIT

const ilObjLinkResourceGUI::LINK_MOD_EDIT = 2

protected

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

LINK_MOD_EDIT_LIST

const ilObjLinkResourceGUI::LINK_MOD_EDIT_LIST = 5

protected

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

LINK_MOD_SET_LIST

const ilObjLinkResourceGUI::LINK_MOD_SET_LIST = 4

protected

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

VIEW_MODE_MANAGE

const ilObjLinkResourceGUI::VIEW_MODE_MANAGE = 2

protected

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

VIEW_MODE_SORT

const ilObjLinkResourceGUI::VIEW_MODE_SORT = 3

protected

Definition at line 35 of file class.ilObjLinkResourceGUI.php.

VIEW_MODE_VIEW

const ilObjLinkResourceGUI::VIEW_MODE_VIEW = 1

protected

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

---

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

• Modules/WebResource/classes/class.ilObjLinkResourceGUI.php