Inheritance diagram for ILIAS\components\OrgUnit\ARHelper\BaseCommands:

Collaboration diagram for ILIAS\components\OrgUnit\ARHelper\BaseCommands:

Public Member Functions
	getParentGui ()

	setParentGui (BaseCommands $parent_gui)

	executeCommand ()

	addSubTabs ()

Data Fields
const	CMD_INDEX = "index"

const	CMD_DEFAULT_PERMISSIONS = "defaultPermissions"

const	CMD_ADD = "add"

const	CMD_CREATE = "create"

const	CMD_EDIT = "edit"

const	CMD_UPDATE = "update"

const	CMD_CONFIRM = "confirm"

const	CMD_DELETE = "delete"

const	CMD_CANCEL = "cancel"

const	AR_ID = "arid"

Protected Member Functions
	__construct (protected array $query_namespace=['orgu', 'posedit'])

	index ()

	getPossibleNextClasses ()

	getActiveTabId ()

	cancel ()

	setContent (string $html)

	pushSubTab (string $subtab_id, string $url)

	activeSubTab (string $subtab_id)

	getParentRefId ()

	getRowIdFromQuery ()

Protected Attributes
ilLanguage	$lng

ilCtrl	$ctrl

ilAccess	$access

ILIAS HTTP Services	$http

ilGlobalTemplateInterface	$tpl

BaseCommands	$parent_gui = null

URLBuilder	$url_builder

URLBuilderToken	$action_token = null

URLBuilderToken	$row_id_token

DataFactory	$data_factory

Refinery	$refinery

ServerRequestInterface	$request

ILIAS HTTP Wrapper ArrayBasedRequestWrapper	$query

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Private Attributes
ilTabsGUI	$tabsGUI

Detailed Description

Interface BaseCommands.

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

Definition at line 34 of file BaseCommands.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::__construct ( protected array $query_namespace = ['orgu', 'posedit'] )

protected

Definition at line 66 of file BaseCommands.php.

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("orgu");
        $this->ctrl = $DIC->ctrl();
        $this->tabsGUI = $DIC->tabs();
        $this->access = $DIC->access();
        $this->http = $DIC->http();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->refinery = $DIC['refinery'];
        $this->query = $DIC->http()->wrapper()->query();
        $this->request = $DIC->http()->request();
        $this->data_factory = new DataFactory();
 
        $here_uri = $this->data_factory->uri(
            $this->request->getUri()->__toString()
        );
        $this->url_builder = new URLBuilder($here_uri);
        list($url_builder, $action_token, $row_id_token) =
            $this->url_builder->acquireParameters($this->query_namespace, "action", "rowid");
        $this->url_builder = $url_builder;
        $this->action_token = $action_token;
        $this->row_id_token = $row_id_token;
 
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
    }

References ILIAS\components\OrgUnit\ARHelper\BaseCommands\$action_token, $DIC, ILIAS\components\OrgUnit\ARHelper\BaseCommands\$row_id_token, ILIAS\components\OrgUnit\ARHelper\BaseCommands\$url_builder, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ activeSubTab()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::activeSubTab ( string $subtab_id )

protected

Definition at line 190 of file BaseCommands.php.

    {
        $this->tabsGUI->activateSubTab($subtab_id);
    }

Referenced by ilOrgUnitUserAssignmentGUI\assignmentsRecursive(), ilOrgUnitPositionGUI\defaultPermissions(), ilOrgUnitPositionGUI\edit(), and ilOrgUnitUserAssignmentGUI\index().

Here is the caller graph for this function:

◆ addSubTabs()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::addSubTabs ( )

Reimplemented in ilOrgUnitPositionGUI, and ilOrgUnitUserAssignmentGUI.

Definition at line 215 of file BaseCommands.php.

                                : void
    {
    }

◆ cancel()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::cancel ( )

protected

Exceptions

ilCtrlException

Reimplemented in ilOrgUnitPositionGUI, and ilOrgUnitUserAssignmentGUI.

Definition at line 122 of file BaseCommands.php.

                               : void
    {
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ executeCommand()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::executeCommand ( )

Exceptions

ilCtrlException

Reimplemented in ilOrgUnitUserAssignmentGUI.

Definition at line 135 of file BaseCommands.php.

    {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->access = $DIC->access();
        $this->tabsGUI = $DIC->tabs();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng->loadLanguageModule("orgu");
 
        $cmd = $this->ctrl->getCmd(self::CMD_INDEX);
 
        if ($this->action_token &&
            $this->query->has($this->action_token->getName())
        ) {
            $cmd = $this->query->retrieve(
                $this->action_token->getName(),
                $this->refinery->to()->string()
            );
        }
 
        $next_class = $this->ctrl->getNextClass();
        if ($next_class) {
            foreach ($this->getPossibleNextClasses() as $class) {
                if (strtolower($class) === $next_class) {
                    $instance = new $class();
                    if ($instance instanceof BaseCommands) {
                        $instance->setParentGui($this);
                        $this->ctrl->forwardCommand($instance);
                    }
 
                    return;
                }
            }
        }
 
        if ($this->getActiveTabId()) {
            $this->tabsGUI->activateTab($this->getActiveTabId());
        }
 
        switch ($cmd) {
            default:
                if ($this->checkRequestReferenceId()) {
                    $this->{$cmd}();
                }
                break;
        }
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getActiveTabId(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getPossibleNextClasses(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getActiveTabId()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::getActiveTabId ( )

protected

Reimplemented in ilOrgUnitPositionGUI.

Definition at line 114 of file BaseCommands.php.

                                       : ?string
    {
        return null;
    }

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseCommands\executeCommand().

Here is the caller graph for this function:

◆ getParentGui()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::getParentGui ( )

Definition at line 97 of file BaseCommands.php.

                                  : ?BaseCommands
    {
        return $this->parent_gui;
    }

References ILIAS\components\OrgUnit\ARHelper\BaseCommands\$parent_gui.

◆ getParentRefId()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::getParentRefId ( )

protected

Definition at line 208 of file BaseCommands.php.

                                       : ?int
    {
        $ref_id = $this->http->request()->getQueryParams()["ref_id"];
 
        return $ref_id;
    }

References $ref_id, and ILIAS\FileDelivery\http().

Referenced by ilOrgUnitUserAssignmentGUI\assignmentsRecursive(), ilOrgUnitPermissionGUI\index(), ilOrgUnitUserAssignmentGUI\index(), and ilOrgUnitUserAssignmentGUI\remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleNextClasses()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::getPossibleNextClasses ( )

protected

Reimplemented in ilOrgUnitPositionGUI.

Definition at line 109 of file BaseCommands.php.

                                               : array
    {
        return array();
    }

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseCommands\executeCommand().

Here is the caller graph for this function:

◆ getRowIdFromQuery()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::getRowIdFromQuery ( )

protected

Definition at line 219 of file BaseCommands.php.

                                          : int
    {
        if ($this->query->has($this->row_id_token->getName())) {
            return $this->query->retrieve(
                $this->row_id_token->getName(),
                $this->refinery->custom()->transformation(fn($v) => (int) array_shift($v))
            );
        }
        throw new \Exception('no position-id in query');
    }

Referenced by ilOrgUnitPositionGUI\defaultPermissions(), ilOrgUnitPositionGUI\getPositionFromRequest(), ilOrgUnitPositionGUI\getSinglePosLinkTarget(), and ilOrgUnitPositionGUI\updateDefaultPermissions().

Here is the caller graph for this function:

◆ index()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::index ( )

abstractprotected

Reimplemented in ilOrgUnitPositionGUI, ilOrgUnitPermissionGUI, and ilOrgUnitUserAssignmentGUI.

◆ pushSubTab()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::pushSubTab	(	string	$subtab_id,
		string	$url
	)

protected

Definition at line 185 of file BaseCommands.php.

    {
        $this->tabsGUI->addSubTab($subtab_id, $this->lng->txt($subtab_id), $url);
    }

References $url, and ILIAS\Repository\lng().

Referenced by ilOrgUnitPositionGUI\addSubTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContent()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::setContent ( string $html )

protected

Definition at line 127 of file BaseCommands.php.

    {
        $this->tpl->setContent($html);
    }

Referenced by ilOrgUnitUserAssignmentGUI\assignmentsRecursive(), and ilOrgUnitUserAssignmentGUI\index().

Here is the caller graph for this function:

◆ setParentGui()

ILIAS\components\OrgUnit\ARHelper\BaseCommands::setParentGui ( BaseCommands $parent_gui )

Definition at line 102 of file BaseCommands.php.

    {
        $this->parent_gui = $parent_gui;
    }

References ILIAS\components\OrgUnit\ARHelper\BaseCommands\$parent_gui.

Field Documentation

◆ $access

ilAccess ILIAS\components\OrgUnit\ARHelper\BaseCommands::$access

protected

Definition at line 50 of file BaseCommands.php.

◆ $action_token

URLBuilderToken ILIAS\components\OrgUnit\ARHelper\BaseCommands::$action_token = null

protected

Definition at line 56 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseCommands\__construct().

◆ $ctrl

ilCtrl ILIAS\components\OrgUnit\ARHelper\BaseCommands::$ctrl

protected

Definition at line 48 of file BaseCommands.php.

◆ $data_factory

DataFactory ILIAS\components\OrgUnit\ARHelper\BaseCommands::$data_factory

protected

Definition at line 58 of file BaseCommands.php.

◆ $http

ILIAS HTTP Services ILIAS\components\OrgUnit\ARHelper\BaseCommands::$http

protected

Definition at line 51 of file BaseCommands.php.

◆ $lng

ilLanguage ILIAS\components\OrgUnit\ARHelper\BaseCommands::$lng

protected

Definition at line 47 of file BaseCommands.php.

Referenced by ilOrgUnitPositionGUI\getAuthorityDescription().

◆ $parent_gui

BaseCommands ILIAS\components\OrgUnit\ARHelper\BaseCommands::$parent_gui = null

protected

Definition at line 53 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentGui(), and ILIAS\components\OrgUnit\ARHelper\BaseCommands\setParentGui().

◆ $query

ILIAS HTTP Wrapper ArrayBasedRequestWrapper ILIAS\components\OrgUnit\ARHelper\BaseCommands::$query

protected

Definition at line 61 of file BaseCommands.php.

◆ $refinery

Refinery ILIAS\components\OrgUnit\ARHelper\BaseCommands::$refinery

protected

Definition at line 59 of file BaseCommands.php.

◆ $request

ServerRequestInterface ILIAS\components\OrgUnit\ARHelper\BaseCommands::$request

protected

Definition at line 60 of file BaseCommands.php.

◆ $row_id_token

URLBuilderToken ILIAS\components\OrgUnit\ARHelper\BaseCommands::$row_id_token

protected

Definition at line 57 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseCommands\__construct().

◆ $tabsGUI

ilTabsGUI ILIAS\components\OrgUnit\ARHelper\BaseCommands::$tabsGUI

private

Definition at line 49 of file BaseCommands.php.

◆ $tpl

ilGlobalTemplateInterface ILIAS\components\OrgUnit\ARHelper\BaseCommands::$tpl

protected

Definition at line 52 of file BaseCommands.php.

◆ $ui_factory

UIFactory ILIAS\components\OrgUnit\ARHelper\BaseCommands::$ui_factory

protected

Definition at line 63 of file BaseCommands.php.

◆ $ui_renderer

UIRenderer ILIAS\components\OrgUnit\ARHelper\BaseCommands::$ui_renderer

protected

Definition at line 64 of file BaseCommands.php.

◆ $url_builder

URLBuilder ILIAS\components\OrgUnit\ARHelper\BaseCommands::$url_builder

protected

Definition at line 55 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseCommands\__construct().

◆ AR_ID

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::AR_ID = "arid"

Definition at line 45 of file BaseCommands.php.

◆ CMD_ADD

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_ADD = "add"

Definition at line 38 of file BaseCommands.php.

◆ CMD_CANCEL

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_CANCEL = "cancel"

Definition at line 44 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseForm\initButtons().

◆ CMD_CONFIRM

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_CONFIRM = "confirm"

Definition at line 42 of file BaseCommands.php.

◆ CMD_CREATE

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_CREATE = "create"

Definition at line 39 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseForm\initButtons().

◆ CMD_DEFAULT_PERMISSIONS

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_DEFAULT_PERMISSIONS = "defaultPermissions"

Definition at line 37 of file BaseCommands.php.

◆ CMD_DELETE

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_DELETE = "delete"

Definition at line 43 of file BaseCommands.php.

◆ CMD_EDIT

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_EDIT = "edit"

Definition at line 40 of file BaseCommands.php.

◆ CMD_INDEX

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_INDEX = "index"

Definition at line 36 of file BaseCommands.php.

Referenced by ilObjOrgUnitGUI\executeCommand(), and ilObjOrgUnitGUI\getTabs().

◆ CMD_UPDATE

const ILIAS\components\OrgUnit\ARHelper\BaseCommands::CMD_UPDATE = "update"

Definition at line 41 of file BaseCommands.php.

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseForm\initButtons().

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

components/ILIAS/OrgUnit/classes/ARHelper/BaseCommands.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activeSubTab()

◆ addSubTabs()

◆ cancel()

◆ executeCommand()

◆ getActiveTabId()

◆ getParentGui()

◆ getParentRefId()

◆ getPossibleNextClasses()

◆ getRowIdFromQuery()

◆ index()

◆ pushSubTab()

◆ setContent()

◆ setParentGui()

Field Documentation

◆ $access

◆ $action_token

◆ $ctrl

◆ $data_factory

◆ $http

◆ $lng

◆ $parent_gui

◆ $query

◆ $refinery

◆ $request

◆ $row_id_token

◆ $tabsGUI

◆ $tpl

◆ $ui_factory

◆ $ui_renderer

◆ $url_builder

◆ AR_ID

◆ CMD_ADD

◆ CMD_CANCEL

◆ CMD_CONFIRM

◆ CMD_CREATE

◆ CMD_DEFAULT_PERMISSIONS

◆ CMD_DELETE

◆ CMD_EDIT

◆ CMD_INDEX

◆ CMD_UPDATE