ilObjFileAccessSettingsGUI Class Reference

Class ilObjFileAccessSettingsGUI. More...

Inheritance diagram for ilObjFileAccessSettingsGUI:

Collaboration diagram for ilObjFileAccessSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $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...
	setTitleAndDescription ()
	called by prepare output More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from 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	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	addFileObjectsSubTabs ()
	initSettingsForm ()
	Edit settings. More...
	showPreviewRenderers ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$folderSettings
Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites
	$request

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

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 36 of file class.ilObjFileAccessSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

public

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

References ILIAS\GlobalScreen\Provider\__construct().

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

Here is the call graph for this function:

Member Function Documentation

addFileObjectsSubTabs()

ilObjFileAccessSettingsGUI::addFileObjectsSubTabs ( )

protected

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

Referenced by editSettings(), and showPreviewRenderers().

    {
        $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 caller graph for this function:

editSettings()

ilObjFileAccessSettingsGUI::editSettings

(

ilPropertyFormGUI

$a_form = null

)

Edit settings.

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

References $DIC, ilObjectGUI\$ilErr, addFileObjectsSubTabs(), and initSettingsForm().

Referenced by saveSettings().

    {
        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) {
            $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 66 of file class.ilObjFileAccessSettingsGUI.php.

References $DIC, ilObjectGUI\$lng, $ret, and ilObjectGUI\prepareOutput().

    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $ilias = $DIC['ilias'];
        $lng = $DIC['lng'];

        $lng->loadLanguageModule("file");

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

        $this->prepareOutput();

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

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

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

        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjFileAccessSettingsGUI::getAdminTabs

(

)

Get tabs.

public

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

References $DIC, $GLOBALS, and ilObjectGUI\$rbacsystem.

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

        $GLOBALS['DIC']['lng']->loadLanguageModule('fm');

        if ($rbacsystem->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 ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget("perm_settings", $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"), array(), 'ilpermissiongui');
        }
    }

initSettingsForm()

ilObjFileAccessSettingsGUI::initSettingsForm ( )

protected

Edit settings.

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

References $DIC, ilObjectGUI\$lng, ilPreviewSettings\getMaximumPreviews(), ilPreviewSettings\isPreviewEnabled(), ilPreviewSettings\MAX_PREVIEWS_MAX, ilNumberInputGUI\setDecimals(), ilFormPropertyGUI\setInfo(), ilCheckboxInputGUI\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by editSettings(), and saveSettings().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];

        require_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        require_once("./Services/Form/classes/class.ilCheckboxInputGUI.php");
        require_once("./Services/Form/classes/class.ilRadioGroupInputGUI.php");
        require_once("./Services/Form/classes/class.ilRadioOption.php");
        require_once("./Services/Form/classes/class.ilTextAreaInputGUI.php");

        $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);

        require_once("Services/Preview/classes/class.ilPreviewSettings.php");

        // 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 248 of file class.ilObjFileAccessSettingsGUI.php.

References $_POST, $DIC, ilObjectGUI\$rbacsystem, editSettings(), initSettingsForm(), ilUtil\sendFailure(), ilPreviewSettings\setMaximumPreviews(), ilPreviewSettings\setPreviewEnabled(), and ilUtil\stripSlashes().

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

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

        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            $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"]);

            require_once("Services/Preview/classes/class.ilPreviewSettings.php");
            ilPreviewSettings::setPreviewEnabled($_POST["enable_preview"] == 1);
            ilPreviewSettings::setMaximumPreviews($_POST["max_previews_per_object"]);

            ilUtil::sendSuccess($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

(

)

called by prepare output

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

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

showPreviewRenderers()

ilObjFileAccessSettingsGUI::showPreviewRenderers ( )

protected

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

References $DIC, ilObjectGUI\$ilErr, ilObjectGUI\$lng, ilObjectGUI\$rbacsystem, ilObjectGUI\$tpl, addFileObjectsSubTabs(), ilRendererFactory\getRenderers(), ilGhostscriptRenderer\isGhostscriptInstalled(), and ilUtil\sendInfo().

                                              {
        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()) {
            ilUtil::sendInfo($lng->txt("ghostscript_not_configured"));
        }

        // build renderer HTML
        require_once("Services/Preview/classes/class.ilRendererFactory.php");
        require_once("Services/Preview/classes/class.ilRendererTableGUI.php");

        $renderers = ilRendererFactory::getRenderers();

        $table = new ilRendererTableGUI($this, array(self::CMD_SHOW_PREVIEW_RENDERERS, "view"));
        $table->setMaxCount(sizeof($renderers));
        $table->setData($renderers);

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

Here is the call graph for this function:

Field Documentation

$folderSettings

ilObjFileAccessSettingsGUI::$folderSettings

protected

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

CMD_EDIT_SETTINGS

const ilObjFileAccessSettingsGUI::CMD_EDIT_SETTINGS = 'editSettings'

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

CMD_SHOW_PREVIEW_RENDERERS

const ilObjFileAccessSettingsGUI::CMD_SHOW_PREVIEW_RENDERERS = 'showPreviewRenderers'

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

---

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

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