Class ilOrgUnitDefaultPermissionFormGUI. More...

Inheritance diagram for ilOrgUnitDefaultPermissionFormGUI:

Collaboration diagram for ilOrgUnitDefaultPermissionFormGUI:

Public Member Functions
	__construct (BaseCommands $parent_gui, array $ilOrgUnitPermissionsFilter, ilObjectDefinition $objectDefinition)
	ilOrgUnitDefaultPermissionFormGUI constructor. More...

	saveObject ()

	fillForm ()

	getIlOrgUnitPermissions ()

	setIlOrgUnitPermissions (array $ilOrgUnitPermissions)

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()

	executeCommand ()

	setTableWidth (string $a_width)

	getTableWidth ()

	setMode (string $a_mode)

	getMode ()

	setTitle (string $a_title)

	getTitle ()

	setTitleIcon (string $a_titleicon)

	getTitleIcon ()

	setDescription (string $a_val)

	getDescription ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setShowTopButtons (bool $a_val)

	getShowTopButtons ()

	setForceTopButtons (bool $a_val)

	getForceTopButtons ()

	addItem ($a_item)

	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)

	getItemByPostVar (string $a_post_var)

	setItems (array $a_items)

	getItems ()

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage (bool $a_val)

	getDisableStandardMessage ()

	getHideLabels ()

	setHideLabels (bool $a_value=true)

	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)

	setValuesByPost ()

	checkInput ()

	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...

	addCommandButton (string $a_cmd, string $a_text, string $a_id="")

	getCommandButtons ()

	clearCommandButtons ()

	getContent ()

	insertItem ( $item, bool $a_sub_item=false)

	addAsyncOnloadCode (string $code)

	getHTML ()

	getHTMLAsync ()

	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)

	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)

	getFormAction ()

	setTarget (string $a_target)

	getTarget ()

	setMultipart (bool $a_multipart)

	getMultipart ()

	setId (string $a_id)

	getId ()

	setName (string $a_name)

	getName ()

	setKeepOpen (bool $a_keepopen)

	getKeepOpen ()

	setOpenTag (bool $a_open)

	getOpenTag ()

	setCloseTag (bool $a_val)

	getCloseTag ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	getHTML ()

	getContent ()

Data Fields
const	F_OPERATIONS = 'operations'

Protected Member Functions
	getTitleForFormHeaderByContext (string $context)

Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

Protected Attributes
BaseCommands	$parent_gui

array	$ilOrgUnitPermissions = []

ilObjectDefinition	$objectDefinition

ilLanguage	$language

Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false

ilLanguage	$lng

ilCtrl	$ctrl

ilTemplate	$tpl

ilObjUser	$user = null

ilSetting	$settings = null

string	$mode = "std"

bool	$check_input_called = false

bool	$disable_standard_message = false

string	$top_anchor = "il_form_top"

string	$title = ''

string	$titleicon = ""

string	$description = ""

string	$tbl_width = ""

bool	$show_top_buttons = true

bool	$hide_labels = false

bool	$force_top_buttons = false

HTTP Services	$http

Refinery Factory	$refinery = null

ilGlobalTemplateInterface	$global_tpl = null

	$onload_code = []

Protected Attributes inherited from ilFormGUI
string	$formaction = ""

bool	$multipart = false

bool	$keepopen = false

bool	$opentag = true

string	$id = ''

string	$name = ''

string	$target = ''

bool	$prevent_double_submission = false

Private Member Functions
	initButtons ()

	initFormElements ()

	fillObject ()

	dic ()

	txt (string $key)

Detailed Description

Class ilOrgUnitDefaultPermissionFormGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 25 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitDefaultPermissionFormGUI::__construct	(	BaseCommands	$parent_gui,
		array	$ilOrgUnitPermissionsFilter,
		ilObjectDefinition	$objectDefinition
	)

ilOrgUnitDefaultPermissionFormGUI constructor.

Parameters

\ILIAS\Modules\OrgUnit\ARHelper\BaseCommands	$parent_gui
ilOrgUnitPermission[]	$ilOrgUnitPermissionsFilter
ilObjectDefinition	$objectDefinition

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

      {
        global $DIC;
        $this->parent_gui = $parent_gui;
        $this->language = $DIC->language();
        $this->ilOrgUnitPermissions = $ilOrgUnitPermissionsFilter;
        $this->dic()->ctrl()->saveParameter($parent_gui, 'arid');
        $this->setFormAction($this->dic()->ctrl()->getFormAction($this->parent_gui));
        $this->objectDefinition = $objectDefinition;
        $this->initFormElements();
        $this->initButtons();
        $this->setTarget('_top');
        parent::__construct();
    }

References $DIC, $objectDefinition, $parent_gui, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), dic(), ilFormGUI\getFormAction(), initButtons(), initFormElements(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\objectDefinition(), ilFormGUI\setFormAction(), and ilFormGUI\setTarget().

Here is the call graph for this function:

Member Function Documentation

◆ dic()

ilOrgUnitDefaultPermissionFormGUI::dic ( )

private

Definition at line 157 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                          : \ILIAS\DI\Container
    {
        return $GLOBALS["DIC"];
    }

References $GLOBALS.

Referenced by __construct().

Here is the caller graph for this function:

◆ fillForm()

ilOrgUnitDefaultPermissionFormGUI::fillForm ( )

Definition at line 101 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                              : void
    {
        $operations = array();
        foreach ($this->ilOrgUnitPermissions as $ilOrgUnitPermission) {
            $ilOrgUnitPermission->afterObjectLoad();
            if ($ilOrgUnitPermission->getContext() !== null) {
                $context = $ilOrgUnitPermission->getContext()->getContext();
                foreach ($ilOrgUnitPermission->getPossibleOperations() as $operation) {
                    $id = $operation->getOperationId();
                    $operations["operations[{$context}][{$id}]"] = $ilOrgUnitPermission->isOperationIdSelected($operation->getOperationId());
                }
            }
        }
        $this->setValuesByArray($operations);
    }

References $context, ilFormGUI\$id, and ilPropertyFormGUI\setValuesByArray().

Here is the call graph for this function:

◆ fillObject()

ilOrgUnitDefaultPermissionFormGUI::fillObject ( )

private

Definition at line 117 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                 : bool
    {
        if (!$this->checkInput()) {
            return false;
        }
        $sent_operation_ids = ($this->getInput(self::F_OPERATIONS) != '') ? $this->getInput(self::F_OPERATIONS) : [];
        foreach ($this->ilOrgUnitPermissions as $ilOrgUnitPermission) {
            $operations = [];
            $ilOrgUnitPermission->afterObjectLoad();
            if ($ilOrgUnitPermission->getContext()) {
                $context = $ilOrgUnitPermission->getContext()->getContext();
                foreach ($ilOrgUnitPermission->getPossibleOperations() as $operation) {
                    $id = $operation->getOperationId();
                    if (isset($sent_operation_ids[$context][$id])) {
                        $operations[] = ilOrgUnitOperation::find($id);
                    }
                }
                $ilOrgUnitPermission->setOperations($operations);
            }
        }
 
        return true;
    }

References $context, ilFormGUI\$id, ilPropertyFormGUI\checkInput(), and ilPropertyFormGUI\getInput().

Referenced by saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIlOrgUnitPermissions()

ilOrgUnitDefaultPermissionFormGUI::getIlOrgUnitPermissions ( )

Returns: ilOrgUnitPermission[]

Definition at line 144 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                             : array
    {
        return $this->ilOrgUnitPermissions;
    }

References $ilOrgUnitPermissions.

◆ getTitleForFormHeaderByContext()

ilOrgUnitDefaultPermissionFormGUI::getTitleForFormHeaderByContext ( string $context )

protected

Definition at line 167 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

    {
        $lang_code = "obj_{$context}";
        if ($this->objectDefinition->isPlugin($context)) {
            return ilObjectPlugin::lookupTxtById($context, $lang_code);
        }
 
        return $this->txt($lang_code);
    }

References $context, ilObjectPlugin\lookupTxtById(), ILIAS\Repository\objectDefinition(), and txt().

Referenced by initFormElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initButtons()

ilOrgUnitDefaultPermissionFormGUI::initButtons ( )

private

Definition at line 70 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                  : void
    {
        $this->setTitle($this->txt("form_title_org_default_permissions_"
            . BaseCommands::CMD_UPDATE));
        $this->addCommandButton(BaseCommands::CMD_UPDATE, $this->txt('save', true));
        $this->addCommandButton(BaseCommands::CMD_CANCEL, $this->txt(BaseCommands::CMD_CANCEL));
    }

References ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\setTitle(), and txt().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormElements()

ilOrgUnitDefaultPermissionFormGUI::initFormElements ( )

private

Definition at line 78 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                       : void
    {
        foreach ($this->ilOrgUnitPermissions as $ilOrgUnitPermission) {
            $ilOrgUnitPermission->afterObjectLoad();
            if ($ilOrgUnitPermission->getContext() !== null) {
                $header = new ilFormSectionHeaderGUI();
                $context = $ilOrgUnitPermission->getContext()->getContext();
                $header->setTitle($this->getTitleForFormHeaderByContext($context));
                $this->addItem($header);
            }
 
 
 
            // Checkboxes
            foreach ($ilOrgUnitPermission->getPossibleOperations() as $operation) {
                $title = $this->txt("org_op_{$operation->getOperationString()}");
                $id = $operation->getOperationId();
                $cb = new ilCheckboxInputGUI($title, "operations[{$context}][{$id}]");
                $this->addItem($cb);
            }
        }
    }

References $context, ilFormGUI\$id, ilPropertyFormGUI\$title, ilPropertyFormGUI\addItem(), getTitleForFormHeaderByContext(), and txt().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveObject()

ilOrgUnitDefaultPermissionFormGUI::saveObject ( )

Definition at line 58 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                : bool
    {
        if ($this->fillObject() === false) {
            return false;
        }
        foreach ($this->ilOrgUnitPermissions as $ilOrgUnitPermission) {
            $ilOrgUnitPermission->update();
        }
 
        return true;
    }

References fillObject().

Here is the call graph for this function:

◆ setIlOrgUnitPermissions()

ilOrgUnitDefaultPermissionFormGUI::setIlOrgUnitPermissions ( array $ilOrgUnitPermissions )

Parameters

ilOrgUnitPermission[] $ilOrgUnitPermissions

Definition at line 152 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                                                        : void
    {
        $this->ilOrgUnitPermissions = $ilOrgUnitPermissions;
    }

References $ilOrgUnitPermissions.

◆ txt()

ilOrgUnitDefaultPermissionFormGUI::txt ( string $key )

private

Definition at line 162 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

                                     : string
    {
        return $this->language->txt($key);
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by getTitleForFormHeaderByContext(), initButtons(), and initFormElements().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ilOrgUnitPermissions

array ilOrgUnitDefaultPermissionFormGUI::$ilOrgUnitPermissions = []

protected

Definition at line 30 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

Referenced by getIlOrgUnitPermissions(), and setIlOrgUnitPermissions().

◆ $language

ilLanguage ilOrgUnitDefaultPermissionFormGUI::$language

protected

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

◆ $objectDefinition

ilObjectDefinition ilOrgUnitDefaultPermissionFormGUI::$objectDefinition

protected

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

Referenced by __construct().

◆ $parent_gui

BaseCommands ilOrgUnitDefaultPermissionFormGUI::$parent_gui

protected

Definition at line 28 of file class.ilOrgUnitDefaultPermissionFormGUI.php.

Referenced by __construct().

◆ F_OPERATIONS

const ilOrgUnitDefaultPermissionFormGUI::F_OPERATIONS = 'operations'

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

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

Modules/OrgUnit/classes/Positions/Permissions/class.ilOrgUnitDefaultPermissionFormGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ dic()

◆ fillForm()

◆ fillObject()

◆ getIlOrgUnitPermissions()

◆ getTitleForFormHeaderByContext()

◆ initButtons()

◆ initFormElements()

◆ saveObject()

◆ setIlOrgUnitPermissions()

◆ txt()

Field Documentation

◆ $ilOrgUnitPermissions

◆ $language

◆ $objectDefinition

◆ $parent_gui

◆ F_OPERATIONS