ilObjMDSettingsGUI Class Reference

Meta Data Settings. More...

Inheritance diagram for ilObjMDSettingsGUI:

Collaboration diagram for ilObjMDSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, bool $a_call_by_reference=true, bool $a_prepare_output=true)
	executeCommand ()
	getAdminTabs ()
	showGeneralSettings (?ilPropertyFormGUI $form=null)
	initGeneralSettingsForm (string $a_mode="edit")
	saveGeneralSettings ()
	showCopyrightSettings (?ilPropertyFormGUI $form=null)
	saveCopyrightSettings ()
	showCopyrightUsages ()
	editEntry (?StandardForm $form=null)
	addEntry (?StandardForm $form=null)
	saveEntry ()
	confirmDeleteEntries ()
	deleteEntries ()
	updateEntry ()
	initCopyrightEditForm (string $a_mode='edit')
	saveCopyrightPosition ()
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] don't belong to the current 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...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	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)

Protected Member Functions
	initEntryIdFromQuery ()
	initEntryIdFromPost ()
	getType ()
	getParentObjType ()
	getAdministrationFormId ()
	initSettingsForm ()
	initMDSettings ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	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...
	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...
	fillCloneTemplate (?string $tpl_name, string $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...
	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...
	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilPropertyFormGUI	$form = null
ilMDSettings	$md_settings = null
ilMDCopyrightSelectionEntry	$entry = null
GlobalHttpState	$http
Factory	$refinery
UIFactory	$ui_factory
UIRenderer	$ui_renderer
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
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 = ""

Additional Inherited Members
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)
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

Meta Data Settings.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilObjMDSettingsGUI: ilPermissionGUI, ilAdvancedMDSettingsGUI, ilMDCopyrightUsageGUI

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

Constructor & Destructor Documentation

__construct()

ilObjMDSettingsGUI::__construct	(		$a_data,
			$a_id,
		bool	$a_call_by_reference = true,
		bool	$a_prepare_output = true
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

    {
        global $DIC;
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->type = 'mds';
        $this->lng->loadLanguageModule("meta");
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
    }

Here is the call graph for this function:

Member Function Documentation

addEntry()

ilObjMDSettingsGUI::addEntry

(

?StandardForm

$form = null

)

Definition at line 288 of file class.ilObjMDSettingsGUI.php.

References ILIAS\Repository\ctrl(), initCopyrightEditForm(), and ILIAS\Repository\lng().

Referenced by saveEntry().

                                                        : void
    {
        if (!$form instanceof StandardForm) {
            $form = $this->initCopyrightEditForm('add');
        }
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('back'),
            $post_url = $this->ctrl->getLinkTarget($this, 'showCopyrightSettings')
        );
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteEntries()

ilObjMDSettingsGUI::confirmDeleteEntries

(

)

Definition at line 335 of file class.ilObjMDSettingsGUI.php.

References ILIAS\Repository\ctrl(), ilMDCopyrightSelectionEntry\getTitle(), initEntryIdFromPost(), ILIAS\Repository\lng(), and showCopyrightSettings().

                                          : void
    {
        $entry_ids = $this->initEntryIdFromPost();
        if (!count($entry_ids)) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'));
            $this->showCopyrightSettings();
            return;
        }

        $c_gui = new ilConfirmationGUI();
        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteEntries"));
        $c_gui->setHeaderText($this->lng->txt("md_delete_cp_sure"));
        $c_gui->setCancel($this->lng->txt("cancel"), "showCopyrightSettings");
        $c_gui->setConfirm($this->lng->txt("confirm"), "deleteEntries");

        // add items to delete
        foreach ($entry_ids as $entry_id) {
            $entry = new ilMDCopyrightSelectionEntry($entry_id);
            $c_gui->addItem('entry_id[]', (string) $entry_id, $entry->getTitle());
        }
        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

deleteEntries()

ilObjMDSettingsGUI::deleteEntries

(

)

Definition at line 359 of file class.ilObjMDSettingsGUI.php.

References ilMDCopyrightSelectionEntry\delete(), initEntryIdFromPost(), ILIAS\Repository\lng(), and showCopyrightSettings().

                                   : bool
    {
        $entry_ids = $this->initEntryIdFromPost();
        if (!count($entry_ids)) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'));
            $this->showCopyrightSettings();
            return true;
        }

        foreach ($entry_ids as $entry_id) {
            $entry = new ilMDCopyrightSelectionEntry($entry_id);
            $entry->delete();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('md_copyrights_deleted'));
        $this->showCopyrightSettings();
        return true;
    }

Here is the call graph for this function:

editEntry()

ilObjMDSettingsGUI::editEntry

(

?StandardForm

$form = null

)

Definition at line 274 of file class.ilObjMDSettingsGUI.php.

References ILIAS\Repository\ctrl(), initCopyrightEditForm(), and ILIAS\Repository\lng().

Referenced by updateEntry().

                                                         : void
    {
        $this->ctrl->saveParameter($this, 'entry_id');
        if (!$form instanceof StandardForm) {
            $form = $this->initCopyrightEditForm();
        }
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('back'),
            $post_url = $this->ctrl->getLinkTarget($this, 'showCopyrightSettings')
        );
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjMDSettingsGUI::executeCommand

(

)

Definition at line 83 of file class.ilObjMDSettingsGUI.php.

References ilAdvancedMDSettingsGUI\CONTEXT_ADMINISTRATION, ILIAS\Repository\ctrl(), initEntryIdFromQuery(), initMDSettings(), ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        if (!$this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }

        switch ($next_class) {
            case 'iladvancedmdsettingsgui':
                $this->tabs_gui->setTabActive('md_advanced');
                $adv_md = new ilAdvancedMDSettingsGUI(
                    ilAdvancedMDSettingsGUI::CONTEXT_ADMINISTRATION,
                    $this->ref_id
                );
                $ret = $this->ctrl->forwardCommand($adv_md);
                break;

            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');

                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilmdcopyrightusagegui':
                // this command is used if copyrightUsageGUI calls getParentReturn (see ...UsageGUI->setTabs)
                $this->ctrl->setReturn($this, 'showCopyrightSettings');
                $copyright_id = $this->initEntryIdFromQuery();
                $gui = new ilMDCopyrightUsageGUI($copyright_id);
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                $this->initMDSettings();
                if (!$cmd || $cmd === 'view') {
                    $cmd = "showGeneralSettings";
                }

                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAdministrationFormId()

ilObjMDSettingsGUI::getAdministrationFormId ( )

protected

Definition at line 140 of file class.ilObjMDSettingsGUI.php.

References ilAdministrationSettingsFormHandler\FORM_META_COPYRIGHT.

Referenced by initSettingsForm().

                                                : int
    {
        return ilAdministrationSettingsFormHandler::FORM_META_COPYRIGHT;
    }

Here is the caller graph for this function:

getAdminTabs()

ilObjMDSettingsGUI::getAdminTabs

(

)

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

References ILIAS\Repository\ctrl().

                                  : void
    {
        if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "md_general_settings",
                $this->ctrl->getLinkTarget($this, "showGeneralSettings"),
                array("showGeneralSettings", "view")
            );

            $this->tabs_gui->addTarget(
                "md_copyright",
                $this->ctrl->getLinkTarget($this, "showCopyrightSettings"),
                array("showCopyrightSettings")
            );

            $this->tabs_gui->addTarget(
                "md_advanced",
                $this->ctrl->getLinkTargetByClass('iladvancedmdsettingsgui', ""),
                '',
                'iladvancedmdsettingsgui'
            );
        }

        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"),
                array(),
                'ilpermissiongui'
            );
        }
    }

Here is the call graph for this function:

getParentObjType()

ilObjMDSettingsGUI::getParentObjType ( )

protected

Definition at line 135 of file class.ilObjMDSettingsGUI.php.

                                         : string
    {
        return 'meta';
    }

getType()

ilObjMDSettingsGUI::getType ( )

protected

Definition at line 130 of file class.ilObjMDSettingsGUI.php.

References ilObjectGUI\$type.

                                : string
    {
        return $this->type;
    }

initCopyrightEditForm()

ilObjMDSettingsGUI::initCopyrightEditForm

(

string

$a_mode = 'edit'

)

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

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), initEntryIdFromQuery(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by addEntry(), editEntry(), saveEntry(), and updateEntry().

                                                                  : StandardForm
    {
        if (!is_object($this->entry)) {
            $this->entry = new ilMDCopyrightSelectionEntry($this->initEntryIdFromQuery());
        }

        $inputs = [];
        $ff = $this->ui_factory->input()->field();

        $title = $ff
            ->text($this->lng->txt('title'))
            ->withValue($this->entry->getTitle())
            ->withRequired(true)
            ->withMaxLength(255);
        $inputs['title'] = $title;

        $des = $ff
            ->textarea($this->lng->txt('description'))
            ->withValue($this->entry->getDescription());
        $inputs['description'] = $des;

        $usage = $ff
            ->radio($this->lng->txt('meta_copyright_usage'))
            ->withOption('0', $this->lng->txt('meta_copyright_in_use'))
            ->withOption('1', $this->lng->txt('meta_copyright_outdated'))
            ->withValue((int) $this->entry->getOutdated());
        $inputs['outdated'] = $usage;

        $cp_data = $this->entry->getCopyrightData();

        $full_name = $ff
            ->text($this->lng->txt('md_copyright_full_name'))
            ->withValue($cp_data->fullName());

        $link = $ff
            ->url(
                $this->lng->txt('md_copyright_link'),
                $this->lng->txt('md_copyright_link_info')
            )
            ->withValue((string) $cp_data->link())
            ->withAdditionalTransformation(
                $this->refinery->custom()->transformation(fn ($v) => $v instanceof URI ? $v : null)
            );

        $image_link = $ff
            ->url($this->lng->txt('md_copyright_image_link'))
            ->withValue((string) $cp_data->imageLink())
            ->withAdditionalTransformation($this->refinery->custom()->transformation(
                fn ($v) => $v instanceof URI ? $v : null
            ));

        $alt_text = $ff
            ->text(
                $this->lng->txt('md_copyright_alt_text'),
                $this->lng->txt('md_copyright_alt_text_info')
            )
            ->withValue($cp_data->altText());

        $cop = $ff
            ->section(
                [
                    'full_name' => $full_name,
                    'link' => $link,
                    'image_link' => $image_link,
                    'alt_text' => $alt_text
                ],
                $this->lng->txt('md_copyright_value')
            );
        $inputs['copyright'] = $cop;

        $form_title = '';
        $post_url = '';
        switch ($a_mode) {
            case 'edit':
                $form_title = $this->lng->txt('md_copyright_edit');
                $post_url = $this->ctrl->getLinkTarget($this, 'updateEntry');
                break;

            case 'add':
                $form_title = $this->lng->txt('md_copyright_add');
                $post_url = $this->ctrl->getLinkTarget($this, 'saveEntry');
                break;
        }
        return $this->ui_factory->input()->container()->form()->standard(
            $post_url,
            [$ff->section($inputs, $form_title)]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initEntryIdFromPost()

ilObjMDSettingsGUI::initEntryIdFromPost ( )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmDeleteEntries(), and deleteEntries().

                                            : array
    {
        $entries = [];
        if ($this->http->wrapper()->post()->has('entry_id')) {
            return $this->http->wrapper()->post()->retrieve(
                'entry_id',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initEntryIdFromQuery()

ilObjMDSettingsGUI::initEntryIdFromQuery ( )

protected

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand(), initCopyrightEditForm(), showCopyrightUsages(), and updateEntry().

                                             : int
    {
        $entry_id = 0;
        if ($this->http->wrapper()->query()->has('entry_id')) {
            $entry_id = $this->http->wrapper()->query()->retrieve(
                'entry_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return $entry_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initGeneralSettingsForm()

ilObjMDSettingsGUI::initGeneralSettingsForm

(

string

$a_mode = "edit"

)

Definition at line 186 of file class.ilObjMDSettingsGUI.php.

References $form, ILIAS\Repository\access(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by saveGeneralSettings(), and showGeneralSettings().

                                                                    : ilPropertyFormGUI
    {
        $this->tabs_gui->setTabActive('md_general_settings');
        $form = new ilPropertyFormGUI();
        $ti = new ilTextInputGUI($this->lng->txt("md_delimiter"), "delimiter");
        $ti->setInfo($this->lng->txt("md_delimiter_info"));
        $ti->setMaxLength(1);
        $ti->setSize(1);
        $ti->setValue($this->md_settings->getDelimiter());
        $form->addItem($ti);

        if ($this->access->checkAccess('write', '', $this->object->getRefId())) {
            $form->addCommandButton("saveGeneralSettings", $this->lng->txt("save"));
            $form->addCommandButton("showGeneralSettings", $this->lng->txt("cancel"));
        }
        $form->setTitle($this->lng->txt("md_general_settings"));
        $form->setFormAction($this->ctrl->getFormAction($this));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initMDSettings()

ilObjMDSettingsGUI::initMDSettings ( )

protected

Definition at line 521 of file class.ilObjMDSettingsGUI.php.

References ilMDSettings\_getInstance().

Referenced by executeCommand().

                                       : void
    {
        $this->md_settings = ilMDSettings::_getInstance();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSettingsForm()

ilObjMDSettingsGUI::initSettingsForm ( )

protected

Definition at line 407 of file class.ilObjMDSettingsGUI.php.

References $check, $form, ILIAS\Repository\access(), ilPropertyFormGUI\addCommandButton(), ilAdministrationSettingsFormHandler\addFieldsToForm(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), getAdministrationFormId(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by saveCopyrightSettings(), and showCopyrightSettings().

                                         : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('md_copyright_settings'));

        if ($this->access->checkAccess('write', '', $this->object->getRefId())) {
            $form->addCommandButton('saveCopyrightSettings', $this->lng->txt('save'));
            $form->addCommandButton('showCopyrightSettings', $this->lng->txt('cancel'));
        }

        $check = new ilCheckboxInputGUI($this->lng->txt('md_copyright_enabled'), 'active');
        $check->setChecked($this->md_settings->isCopyrightSelectionActive());
        $check->setValue('1');
        $check->setInfo($this->lng->txt('md_copyright_enable_info'));
        $form->addItem($check);

        ilAdministrationSettingsFormHandler::addFieldsToForm(
            $this->getAdministrationFormId(),
            $form,
            $this
        );
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveCopyrightPosition()

ilObjMDSettingsGUI::saveCopyrightPosition

(

)

Definition at line 526 of file class.ilObjMDSettingsGUI.php.

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

                                           : bool
    {
        if (!$this->http->wrapper()->post()->has('order')) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_select_one'), true);
            $this->ctrl->redirect($this, 'showCopyrightSettings');
            return false;
        }
        $positions = $this->http->wrapper()->post()->retrieve(
            'order',
            $this->refinery->kindlyTo()->dictOf(
                $this->refinery->kindlyTo()->string()
            )
        );
        asort($positions);
        $position = 0;
        foreach ($positions as $entry_id => $position_ignored) {
            $copyright = new ilMDCopyrightSelectionEntry($entry_id);
            $copyright->setOrderPosition($position++);
            $copyright->update();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
        $this->ctrl->redirect($this, 'showCopyrightSettings');
        return false;
    }

Here is the call graph for this function:

saveCopyrightSettings()

ilObjMDSettingsGUI::saveCopyrightSettings

(

)

Definition at line 252 of file class.ilObjMDSettingsGUI.php.

References ILIAS\Repository\access(), ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getInput(), initSettingsForm(), ILIAS\Repository\lng(), and showCopyrightSettings().

                                           : void
    {
        if (!$this->access->checkAccess('write', '', $this->object->getRefId())) {
            $this->ctrl->redirect($this, "showCopyrightSettings");
        }
        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            $this->md_settings->activateCopyrightSelection((bool) $form->getInput('active'));
            $this->md_settings->save();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'showCopyrightSettings');
        }
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'), true);
        $this->showCopyrightSettings($form);
    }

Here is the call graph for this function:

saveEntry()

ilObjMDSettingsGUI::saveEntry

(

)

Definition at line 301 of file class.ilObjMDSettingsGUI.php.

References ilObjectGUI\$data, addEntry(), ILIAS\Repository\ctrl(), initCopyrightEditForm(), and ILIAS\Repository\lng().

                               : bool
    {
        $form = $this->initCopyrightEditForm('add')->withRequest($this->request);
        if ($data = $form->getData()) {
            $data = $data[0];
            $this->entry = new ilMDCopyrightSelectionEntry(0);
            $this->entry->setTitle($data['title']);
            $this->entry->setDescription($data['description']);
            $this->entry->setCopyrightData(
                $data['copyright']['full_name'],
                $data['copyright']['link'],
                $data['copyright']['image_link'],
                $data['copyright']['alt_text']
            );
            $this->entry->setOutdated((bool) $data['outdated']);
            $this->entry->setLanguage('en');
            $this->entry->setCopyrightAndOtherRestrictions(true);
            $this->entry->setCosts(false);

            if (!$this->entry->validate()) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('fill_out_all_required_fields'));
                $this->addEntry($form);
                return false;
            }
            $this->entry->add();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'showCopyrightSettings');
            return true;
        }
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'), true);
        $this->addEntry($form);
        return false;
    }

Here is the call graph for this function:

saveGeneralSettings()

ilObjMDSettingsGUI::saveGeneralSettings

(

)

Definition at line 206 of file class.ilObjMDSettingsGUI.php.

References ILIAS\Repository\access(), ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getInput(), initGeneralSettingsForm(), ILIAS\Repository\lng(), ilPropertyFormGUI\setValuesByPost(), and showGeneralSettings().

                                         : void
    {
        if (!$this->access->checkAccess('write', '', $this->object->getRefId())) {
            $this->ctrl->redirect($this, "showGeneralSettings");
        }
        $form = $this->initGeneralSettingsForm();
        if ($form->checkInput()) {
            $delim = $form->getInput('delimiter');
            $delim = (
                trim($delim) === '' ?
                ',' :
                trim($delim)
            );
            $this->md_settings->setDelimiter($delim);
            $this->md_settings->save();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, "showGeneralSettings");
        }
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'), true);
        $form->setValuesByPost();
        $this->showGeneralSettings($form);
    }

Here is the call graph for this function:

showCopyrightSettings()

ilObjMDSettingsGUI::showCopyrightSettings

(

?ilPropertyFormGUI

$form = null

)

Definition at line 229 of file class.ilObjMDSettingsGUI.php.

References ILIAS\Repository\access(), ilPropertyFormGUI\getHTML(), initSettingsForm(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by confirmDeleteEntries(), deleteEntries(), and saveCopyrightSettings().

                                                                          : void
    {
        $this->tabs_gui->setTabActive('md_copyright');
        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.settings.html', 'Services/MetaData');

        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initSettingsForm();
        }
        $this->tpl->setVariable('SETTINGS_TABLE', $form->getHTML());

        $has_write = $this->access->checkAccess('write', '', $this->object->getRefId());
        $table_gui = new ilMDCopyrightTableGUI($this, 'showCopyrightSettings', $has_write);
        $table_gui->setTitle($this->lng->txt("md_copyright_selection"));
        $table_gui->parseSelections();

        if ($has_write) {
            $table_gui->addCommandButton('addEntry', $this->lng->txt('add'));
            $table_gui->addMultiCommand("confirmDeleteEntries", $this->lng->txt("delete"));
            $table_gui->setSelectAllCheckbox("entry_id");
        }
        $this->tpl->setVariable('COPYRIGHT_TABLE', $table_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCopyrightUsages()

ilObjMDSettingsGUI::showCopyrightUsages

(

)

Definition at line 268 of file class.ilObjMDSettingsGUI.php.

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

                                         : void
    {
        $this->ctrl->setParameterByClass('ilmdcopyrightusagegui', 'entry_id', $this->initEntryIdFromQuery());
        $this->ctrl->redirectByClass('ilmdcopyrightusagegui', "showUsageTable");
    }

Here is the call graph for this function:

showGeneralSettings()

ilObjMDSettingsGUI::showGeneralSettings

(

?ilPropertyFormGUI

$form = null

)

Definition at line 178 of file class.ilObjMDSettingsGUI.php.

References ilPropertyFormGUI\getHTML(), and initGeneralSettingsForm().

Referenced by saveGeneralSettings().

                                                                        : void
    {
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initGeneralSettingsForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateEntry()

ilObjMDSettingsGUI::updateEntry

(

)

Definition at line 377 of file class.ilObjMDSettingsGUI.php.

References ilObjectGUI\$data, ILIAS\Repository\ctrl(), editEntry(), initCopyrightEditForm(), initEntryIdFromQuery(), and ILIAS\Repository\lng().

                                 : bool
    {
        $this->entry = new ilMDCopyrightSelectionEntry($this->initEntryIdFromQuery());
        $form = $this->initCopyrightEditForm()->withRequest($this->request);
        if ($data = $form->getData()) {
            $data = $data[0];
            $this->entry->setTitle($data['title']);
            $this->entry->setDescription($data['description']);
            $this->entry->setCopyrightData(
                $data['copyright']['full_name'],
                $data['copyright']['link'],
                $data['copyright']['image_link'],
                $data['copyright']['alt_text']
            );
            $this->entry->setOutdated((bool) $data['outdated']);
            if (!$this->entry->validate()) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('fill_out_all_required_fields'));
                $this->editEntry($form);
                return false;
            }
            $this->entry->update();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'showCopyrightSettings');
            return true;
        }
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
        $this->editEntry($form);
        return false;
    }

Here is the call graph for this function:

Field Documentation

$entry

ilMDCopyrightSelectionEntry ilObjMDSettingsGUI::$entry = null

protected

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

$form

ilPropertyFormGUI ilObjMDSettingsGUI::$form = null

protected

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

Referenced by initGeneralSettingsForm(), and initSettingsForm().

$http

GlobalHttpState ilObjMDSettingsGUI::$http

protected

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

$md_settings

ilMDSettings ilObjMDSettingsGUI::$md_settings = null

protected

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

$refinery

Factory ilObjMDSettingsGUI::$refinery

protected

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

$ui_factory

UIFactory ilObjMDSettingsGUI::$ui_factory

protected

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

$ui_renderer

UIRenderer ilObjMDSettingsGUI::$ui_renderer

protected

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

---

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

• Services/MetaData/classes/class.ilObjMDSettingsGUI.php