ilObjAccessibilitySettingsGUI Class Reference

Accessibility Settings. More...

Inheritance diagram for ilObjAccessibilitySettingsGUI:

Collaboration diagram for ilObjAccessibilitySettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor. More...
	executeCommand ()
	Execute command. More...
	saveAccessibilitySettings ()
	Save accessibility settings form. More...
	getAdminTabs ()
	Get tabs. More...
	editAccessKeys ()
	Edit access keys. More...
	saveAccessKeys ()
	Save access keys. 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 ()

Protected Member Functions
	getSettingsForm ()
	editAccessibilitySettings (ilPropertyFormGUI $form=null)
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
	$dic
	$rbacsystem
	$error
	$access
	$tabs
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites

Additional Inherited Members
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...
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Detailed Description

Accessibility Settings.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilObjAccessibilitySettingsGUI: ilPermissionGUI, ilAccessibilityDocumentGUI ilObjAccessibilitySettingsGUI: ilAdministrationGUI

Definition at line 17 of file class.ilObjAccessibilitySettingsGUI.php.

Constructor & Destructor Documentation

__construct()

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

Contructor.

public

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

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

    {
        global $DIC;

        $this->dic = $DIC;
        $this->rbacsystem = $DIC->rbac()->system();
        $this->error = $DIC["ilErr"];
        $this->access = $DIC->access();
        $this->tabs = $DIC->tabs();
        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->type = 'accs';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->lng->loadLanguageModule('acc');
        $this->lng->loadLanguageModule('adm');
        $this->lng->loadLanguageModule('meta');
    }

Here is the call graph for this function:

Member Function Documentation

editAccessibilitySettings()

ilObjAccessibilitySettingsGUI::editAccessibilitySettings ( ilPropertyFormGUI  $form = null )

protected

Parameters

ilPropertyFormGUI

$form

Definition at line 209 of file class.ilObjAccessibilitySettingsGUI.php.

References getSettingsForm().

    {
        $this->tabs_gui->setTabActive('acc_settings');
        if (!$form) {
            $this->form = $this->getSettingsForm();
        }
        
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

editAccessKeys()

ilObjAccessibilitySettingsGUI::editAccessKeys

(

)

Edit access keys.

Definition at line 264 of file class.ilObjAccessibilitySettingsGUI.php.

References ilObjectGUI\$tpl.

    {
        $tpl = $this->tpl;

        $this->tabs_gui->setTabActive('acc_access_keys');
        
        include_once("./Services/Accessibility/classes/class.ilAccessKeyTableGUI.php");
        $table = new ilAccessKeyTableGUI($this, "editAccessKeys");
        
        $tpl->setContent($table->getHTML());
    }

executeCommand()

ilObjAccessibilitySettingsGUI::executeCommand

(

)

Execute command.

public

Definition at line 75 of file class.ilObjAccessibilitySettingsGUI.php.

References $access, $error, ilObjectGUI\$ilErr, $rbacsystem, $ret, and ilObjectGUI\prepareOutput().

    {
        $rbacsystem = $this->rbacsystem;
        $ilErr = $this->error;
        $ilAccess = $this->access;

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

        $this->prepareOutput();

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

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilaccessibilitydocumentgui':
                $this->tabs_gui->activateTab('acc_ctrl_cpt');

                $tableDataProviderFactory = new ilAccessibilityTableDataProviderFactory();
                $tableDataProviderFactory->setDatabaseAdapter($this->dic->database());

                $documentGui = new ilAccessibilityDocumentGUI(
                    $this->object,
                    $this->dic['acc.criteria.type.factory'],
                    $this->dic->ui()->mainTemplate(),
                    $this->dic->user(),
                    $this->dic->ctrl(),
                    $this->dic->language(),
                    $this->dic->rbac()->system(),
                    $this->dic['ilErr'],
                    $this->dic->logger()->acc(),
                    $this->dic->toolbar(),
                    $this->dic->http(),
                    $this->dic->ui()->factory(),
                    $this->dic->ui()->renderer(),
                    $this->dic->filesystem(),
                    $this->dic->upload(),
                    $tableDataProviderFactory,
                    new ilAccessibilityTrimmedDocumentPurifier(new ilAccessibilityDocumentHtmlPurifier())
                );

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

            default:
                if (!$cmd || $cmd == 'view') {
                    $cmd = "editAccessibilitySettings";
                }

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

Here is the call graph for this function:

getAdminTabs()

ilObjAccessibilitySettingsGUI::getAdminTabs

(

)

Get tabs.

public

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

References $access, $rbacsystem, and $tabs.

    {
        $rbacsystem = $this->rbacsystem;
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;

        if ($rbacsystem->checkAccess("read", $this->object->getRefId())) {
            $ilTabs->addTab('acc_settings', $this->lng->txt('settings'), $this->ctrl->getLinkTarget($this, 'editAccessibilitySettings'));
        }

        if ($rbacsystem->checkAccess("read", $this->object->getRefId())) {
            $ilTabs->addTarget(
                "acc_access_keys",
                $this->ctrl->getLinkTarget($this, "editAccessKeys"),
                array("editAccessKeys", "view")
            );
        }

        if ($rbacsystem->checkAccess("read", $this->object->getRefId())) {
            $ilTabs->addTab(
                'acc_ctrl_cpt',
                $this->lng->txt('acc_ctrl_cpt_txt'),
                $this->ctrl->getLinkTargetByClass('ilaccessibilitydocumentgui')
            );
        }

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

getSettingsForm()

ilObjAccessibilitySettingsGUI::getSettingsForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 141 of file class.ilObjAccessibilitySettingsGUI.php.

References ilAdministrationSettingsFormHandler\addFieldsToForm(), ilAdministrationSettingsFormHandler\FORM_ACCESSIBILITY, ilObjAccessibilitySettings\getControlConceptStatus(), ilAccessibilitySupportContacts\getList(), and ilCheckboxInputGUI\setValue().

Referenced by editAccessibilitySettings(), and saveAccessibilitySettings().

    {
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $this->form = new ilPropertyFormGUI();
        $this->form->setTitle($this->lng->txt('settings'));

        $cb = new ilCheckboxInputGUI($this->lng->txt('adm_acc_ctrl_cpt_enable'), 'acc_ctrl_cpt_status');
        $cb->setValue(1);
        $cb->setChecked(ilObjAccessibilitySettings::getControlConceptStatus());
        $cb->setInfo($this->lng->txt('adm_acc_ctrl_cpt_desc'));
        $this->form->addItem($cb);

        $ti = new ilTextInputGUI($this->lng->txt("adm_accessibility_contacts"), "accessibility_support_contacts");
        $ti->setMaxLength(500);
        $ti->setValue(ilAccessibilitySupportContacts::getList());
        $ti->setInfo($this->lng->txt("adm_accessibility_contacts_info"));
        $this->form->addItem($ti);

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

        require_once 'Services/Administration/classes/class.ilAdministrationSettingsFormHandler.php';
        ilAdministrationSettingsFormHandler::addFieldsToForm(
            ilAdministrationSettingsFormHandler::FORM_ACCESSIBILITY,
            $this->form,
            $this
        );

        $this->form->addCommandButton("saveAccessibilitySettings", $this->lng->txt("save"));
        $this->form->setFormAction($this->ctrl->getFormAction($this));

        return $this->form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAccessibilitySettings()

ilObjAccessibilitySettingsGUI::saveAccessibilitySettings

(

)

Save accessibility settings form.

Definition at line 179 of file class.ilObjAccessibilitySettingsGUI.php.

References $_POST, ilObjectGUI\$ctrl, $error, $ilCtrl, ilObjectGUI\$ilErr, ilObjectGUI\$lng, $rbacsystem, ilObjectGUI\$tpl, getSettingsForm(), ilObjAccessibilitySettings\saveControlConceptStatus(), and ilAccessibilitySupportContacts\setList().

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $rbacsystem = $this->rbacsystem;
        $ilErr = $this->error;

        if (!$rbacsystem->checkAccess("write", $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->MESSAGE);
        }

        $this->getSettingsForm();
        if ($this->form->checkInput()) {
            // Accessibility Control Concept status
            ilObjAccessibilitySettings::saveControlConceptStatus((bool) $this->form->getInput('acc_ctrl_cpt_status'));
            // Accessibility support contacts
            ilAccessibilitySupportContacts::setList($_POST["accessibility_support_contacts"]);

            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "editAccessibilitySettings");
        } else {
            $this->form->setValuesByPost();
            $tpl->setContent($this->form->getHtml());
        }
    }

Here is the call graph for this function:

saveAccessKeys()

ilObjAccessibilitySettingsGUI::saveAccessKeys

(

)

Save access keys.

Definition at line 279 of file class.ilObjAccessibilitySettingsGUI.php.

References $_GET, $_POST, $access, ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, ilUtil\stripSlashesArray(), and ilAccessKey\writeKeys().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        
        if ($ilAccess->checkAccess("write", "", $_GET["ref_id"])) {
            include_once("./Services/Accessibility/classes/class.ilAccessKey.php");
            ilAccessKey::writeKeys(ilUtil::stripSlashesArray($_POST["acckey"]));
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "editAccessKeys");
    }

Here is the call graph for this function:

Field Documentation

$access

ilObjAccessibilitySettingsGUI::$access

protected

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

Referenced by executeCommand(), getAdminTabs(), and saveAccessKeys().

$dic

ilObjAccessibilitySettingsGUI::$dic

protected

Definition at line 22 of file class.ilObjAccessibilitySettingsGUI.php.

$error

ilObjAccessibilitySettingsGUI::$error

protected

Definition at line 32 of file class.ilObjAccessibilitySettingsGUI.php.

Referenced by executeCommand(), and saveAccessibilitySettings().

$rbacsystem

ilObjAccessibilitySettingsGUI::$rbacsystem

protected

Definition at line 27 of file class.ilObjAccessibilitySettingsGUI.php.

Referenced by executeCommand(), getAdminTabs(), and saveAccessibilitySettings().

$tabs

ilObjAccessibilitySettingsGUI::$tabs

protected

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

Referenced by getAdminTabs().

---

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

• Services/Accessibility/classes/class.ilObjAccessibilitySettingsGUI.php