ilObjFileAccessSettingsGUI Class Reference

Class ilObjFileAccessSettingsGUI. More...

Inheritance diagram for ilObjFileAccessSettingsGUI:

Collaboration diagram for ilObjFileAccessSettingsGUI:

Public Member Functions
	__construct ($a_data, int $a_id, bool $a_call_by_reference)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getAdminTabs ()
	Get tabs. More...
	editSettings (ilPropertyFormGUI $a_form=null)
	Edit settings. More...
	saveSettings ()
	Save settings. 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] 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)

Data Fields
const	CMD_EDIT_SETTINGS = 'editSettings'
const	CMD_SHOW_PREVIEW_RENDERERS = 'showPreviewRenderers'
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

Protected Member Functions
	addFileObjectsSubTabs ()
	initSettingsForm ()
	Edit settings. More...
	showPreviewRenderers ()
	setTitleAndDescription ()
	called by prepare output More...
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
ilSetting	$folderSettings
Services	$http
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)

Detailed Description

Class ilObjFileAccessSettingsGUI.

Author

Werner Randelshofer, Hochschule Luzern, werne.nosp@m.r.ra.nosp@m.ndels.nosp@m.hofe.nosp@m.r@hsl.nosp@m.u.ch

Version

$Id$

ilObjFileAccessSettingsGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

ilObjFileAccessSettingsGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference
	)

Constructor.

public

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

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

    {
        global $DIC;
        $this->type = "facs";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->folderSettings = new ilSetting('fold');
        $this->http = $DIC->http();
    }

Here is the call graph for this function:

Member Function Documentation

addFileObjectsSubTabs()

ilObjFileAccessSettingsGUI::addFileObjectsSubTabs ( )

protected

Definition at line 114 of file class.ilObjFileAccessSettingsGUI.php.

References ILIAS\Repository\ctrl().

Referenced by editSettings(), and showPreviewRenderers().

                                              : void
    {
        $this->tabs_gui->addSubTabTarget(
            "settings",
            $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
            array(self::CMD_EDIT_SETTINGS, "view")
        );
        $this->tabs_gui->addSubTabTarget(
            "preview_renderers",
            $this->ctrl->getLinkTarget($this, self::CMD_SHOW_PREVIEW_RENDERERS),
            array(self::CMD_SHOW_PREVIEW_RENDERERS, "view")
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editSettings()

ilObjFileAccessSettingsGUI::editSettings

(

ilPropertyFormGUI

$a_form = null

)

Edit settings.

Definition at line 202 of file class.ilObjFileAccessSettingsGUI.php.

References $DIC, $ilErr, addFileObjectsSubTabs(), initSettingsForm(), and ILIAS\Repository\object().

Referenced by saveSettings().

                                                                  : void
    {
        global $DIC, $ilErr;

        $this->tabs_gui->setTabActive('file_objects');
        $this->addFileObjectsSubTabs();
        $this->tabs_gui->setSubTabActive('settings');

        if (!$DIC->rbac()->system()->checkAccess("visible,read", $this->object->getRefId())) {
            $ilErr->raiseError($DIC->language()->txt("no_permission"), $ilErr->WARNING);
        }

        if ($a_form === null) {
            $a_form = $this->initSettingsForm();
        }

        $DIC->ui()->mainTemplate()->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjFileAccessSettingsGUI::executeCommand

(

)

Execute command.

public

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().

                                    : void
    {
        $this->lng->loadLanguageModule("file");

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

        $this->prepareOutput();

        if (!$this->access->checkAccess('read', '', $this->object->getRefId())) {
            $this->ilias->raiseError(
                $this->lng->txt('no_permission'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            default:
                if (!$cmd || $cmd == 'view') {
                    $cmd = self::CMD_EDIT_SETTINGS;
                }

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

Here is the call graph for this function:

getAdminTabs()

ilObjFileAccessSettingsGUI::getAdminTabs

(

)

Get tabs.

public

Definition at line 99 of file class.ilObjFileAccessSettingsGUI.php.

References ILIAS\Repository\ctrl().

                                  : void
    {
        if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'file_objects',
                $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS),
                array(self::CMD_EDIT_SETTINGS, "view")
            );
        }
        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:

initSettingsForm()

ilObjFileAccessSettingsGUI::initSettingsForm ( )

protected

Edit settings.

Definition at line 132 of file class.ilObjFileAccessSettingsGUI.php.

References $DIC, ilObjectGUI\$lng, ilPreviewSettings\getMaximumPreviews(), ilPreviewSettings\isPreviewEnabled(), ilLanguage\loadLanguageModule(), ilPreviewSettings\MAX_PREVIEWS_MAX, ILIAS\Repository\object(), ilNumberInputGUI\setDecimals(), ilFormPropertyGUI\setInfo(), ilCheckboxInputGUI\setValue(), ilTextAreaInputGUI\setValue(), and ilLanguage\txt().

Referenced by editSettings(), and saveSettings().

                                         : \ilPropertyFormGUI
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        $form->setTitle($lng->txt("settings"));

        // Backwards compatibility with ILIAS 3.9: Use the name of the
        // uploaded file as the filename for the downloaded file instead
        // of the title of the file object.
        $dl_prop = new ilCheckboxInputGUI($lng->txt("download_with_uploaded_filename"), "download_with_uploaded_filename");
        $dl_prop->setValue('1');
        // default value should reflect previous behaviour (-> 0)
        $dl_prop->setChecked($this->object->isDownloadWithUploadedFilename() == 1);
        $dl_prop->setInfo($lng->txt('download_with_uploaded_filename_info'));
        $form->addItem($dl_prop);

        // download limit
        $lng->loadLanguageModule("bgtask");
        $dl_prop = new ilNumberInputGUI($lng->txt("bgtask_setting_limit"), "bg_limit");
        $dl_prop->setInfo($lng->txt("bgtask_setting_limit_info"));
        $dl_prop->setRequired(true);
        $dl_prop->setSize(10);
        $dl_prop->setMinValue(1);
        $dl_prop->setSuffix($lng->txt("lang_size_mb"));
        $dl_prop->setValue($this->folderSettings->get("bgtask_download_limit", null));
        $form->addItem($dl_prop);

        // Inline file extensions
        $tai_prop = new ilTextAreaInputGUI($lng->txt('inline_file_extensions'), 'inline_file_extensions');
        $tai_prop->setValue($this->object->getInlineFileExtensions());
        $tai_prop->setInfo($lng->txt('inline_file_extensions_info'));
        $tai_prop->setCols(80);
        $tai_prop->setRows(5);
        $form->addItem($tai_prop);

        // enable preview
        $chk_prop = new ilCheckboxInputGUI($lng->txt("enable_preview"), "enable_preview");
        $chk_prop->setValue('1');
        $chk_prop->setChecked(ilPreviewSettings::isPreviewEnabled());
        $chk_prop->setInfo($lng->txt('enable_preview_info'));
        $form->addItem($chk_prop);

        // max preview images
        $num_prop = new ilNumberInputGUI($lng->txt("max_previews_per_object"), "max_previews_per_object");
        $num_prop->setDecimals(0);
        $num_prop->setMinValue(1);
        $num_prop->setMinvalueShouldBeGreater(false);
        $num_prop->setMaxValue(ilPreviewSettings::MAX_PREVIEWS_MAX);
        $num_prop->setMaxvalueShouldBeLess(false);
        $num_prop->setMaxLength(5);
        $num_prop->setSize(10);
        $num_prop->setValue(ilPreviewSettings::getMaximumPreviews());
        $num_prop->setInfo($lng->txt('max_previews_per_object_info'));
        $form->addItem($num_prop);

        // command buttons
        $form->addCommandButton('saveSettings', $lng->txt('save'));
        $form->addCommandButton('view', $lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveSettings()

ilObjFileAccessSettingsGUI::saveSettings

(

)

Save settings.

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

References $DIC, $post, editSettings(), ILIAS\FileDelivery\http(), initSettingsForm(), ILIAS\Repository\int(), ilPreviewSettings\setMaximumPreviews(), ilPreviewSettings\setPreviewEnabled(), and ilUtil\stripSlashes().

                                  : void
    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];

        if (!$rbacsystem->checkAccess("write", $this->object->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $DIC->language()->txt("no_permission"), true);
            $DIC->ctrl()->redirect($this, self::CMD_EDIT_SETTINGS);
        }

        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            // TODO switch to new forms
            $post = (array) $this->http->request()->getParsedBody();
            $this->object->setDownloadWithUploadedFilename(
                ilUtil::stripSlashes($post['download_with_uploaded_filename'] ?? '')
            );
            $this->object->setInlineFileExtensions(
                ilUtil::stripSlashes($post['inline_file_extensions'] ?? '')
            );
            $this->object->update();
            $this->folderSettings->set("bgtask_download_limit", (int) $post["bg_limit"]);
            $enable_preview = (int) ($post["enable_preview"] ?? 0);
            ilPreviewSettings::setPreviewEnabled($enable_preview === 1);
            ilPreviewSettings::setMaximumPreviews($post["max_previews_per_object"]);

            $this->tpl->setOnScreenMessage('success', $DIC->language()->txt('settings_saved'), true);
            $DIC->ctrl()->redirect($this, self::CMD_EDIT_SETTINGS);
        }

        $form->setValuesByPost();
        $this->editSettings($form);
    }

Here is the call graph for this function:

setTitleAndDescription()

ilObjFileAccessSettingsGUI::setTitleAndDescription ( )

protected

called by prepare output

Definition at line 306 of file class.ilObjFileAccessSettingsGUI.php.

References ILIAS\Repository\object().

                                               : void
    {
        parent::setTitleAndDescription();
        $this->tpl->setDescription($this->object->getDescription());
    }

Here is the call graph for this function:

showPreviewRenderers()

ilObjFileAccessSettingsGUI::showPreviewRenderers ( )

protected

Definition at line 260 of file class.ilObjFileAccessSettingsGUI.php.

References $DIC, $factory, $ilErr, ilObjectGUI\$lng, ilObjectGUI\$tpl, addFileObjectsSubTabs(), ilPreviewRenderer\getName(), ilFilePreviewRenderer\getSupportedFileFormats(), ilFilePreviewRenderer\getSupportedRepositoryTypes(), ilGhostscriptRenderer\isGhostscriptInstalled(), ilPreviewRenderer\isPlugin(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                             : void
    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];
        $ilErr = $DIC['ilErr'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];

        $this->tabs_gui->setTabActive('file_objects');
        $this->addFileObjectsSubTabs();
        $this->tabs_gui->setSubTabActive('preview_renderers');

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

        // set warning if ghostscript not installed
        if (!ilGhostscriptRenderer::isGhostscriptInstalled()) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("ghostscript_not_configured"));
        }

        $factory = new ilRendererFactory();
        $renderers = $factory->getRenderers();
        $array_wrapper = array_map(function (ilFilePreviewRenderer $renderer): array {
            return [
                'name' => $renderer->getName(),
                'is_plugin' => $renderer->isPlugin(),
                'supported_repo_types' => $renderer->getSupportedRepositoryTypes(),
                'supported_file_formats' => $renderer->getSupportedFileFormats(),
                'object' => $renderer
            ];
        }, $renderers);


        $table = new ilRendererTableGUI($this, self::CMD_SHOW_PREVIEW_RENDERERS);
        $table->setMaxCount(count($renderers));
        $table->setData($array_wrapper);

        // set content
        $tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$folderSettings

ilSetting ilObjFileAccessSettingsGUI::$folderSettings

protected

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

$http

Services ilObjFileAccessSettingsGUI::$http

protected

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

CMD_EDIT_SETTINGS

const ilObjFileAccessSettingsGUI::CMD_EDIT_SETTINGS = 'editSettings'

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

CMD_SHOW_PREVIEW_RENDERERS

const ilObjFileAccessSettingsGUI::CMD_SHOW_PREVIEW_RENDERERS = 'showPreviewRenderers'

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

---

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

• Modules/File/classes/class.ilObjFileAccessSettingsGUI.php