Inheritance diagram for ILIAS\Conditions\Configuration\ConditionTriggerTableGUI:

Collaboration diagram for ILIAS\Conditions\Configuration\ConditionTriggerTableGUI:

Public Member Functions
	__construct (ConditionTriggerProvider $provider, bool $allow_optional_conditions)

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

	get ()

	render ()

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Data Fields
const string	ACTION_TOKEN = 'action'

const string	ID_TOKEN = 'id'

const string	TABLE_NS = 'cond_trigger_table'

const string	ACTION_TOKEN_NS = self::TABLE_NS . '_' . self::ACTION_TOKEN

const string	ID_TOKEN_NS = self::TABLE_NS . '_' . self::ID_TOKEN

Protected Member Functions
	getColumns ()

	getActions ()

Protected Attributes
Psr Http Message ServerRequestInterface	$http_request

ILIAS UI Renderer	$ui_renderer

ILIAS UI Factory	$ui_factory

DataFactory	$data_factory

ConditionTriggerProvider	$provider

bool	$allow_optional_conditions

readonly ilLanguage	$lng

readonly ilObjUser	$user

readonly ilCtrl	$ctrl

Detailed Description

Definition at line 36 of file ConditionTriggerTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::__construct	(	ConditionTriggerProvider	$provider,
		bool	$allow_optional_conditions
	)

Definition at line 59 of file ConditionTriggerTableGUI.php.

    {
        global $DIC;
 
        $this->provider = $provider;
        $this->allow_optional_conditions = $allow_optional_conditions;
 
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('rbac');
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->ui_factory = $DIC->ui()->factory();
        $this->data_factory = new DataFactory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->http_request = $DIC->http()->request();
    }

References ILIAS\Conditions\Configuration\ConditionTriggerTableGUI\$allow_optional_conditions, $DIC, ILIAS\Conditions\Configuration\ConditionTriggerTableGUI\$provider, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ get()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::get ( )

Definition at line 160 of file ConditionTriggerTableGUI.php.

                         : Data
    {
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->lng->txt('active_preconditions'),
                $this->getColumns(),
            )
            ->withId(self::class)
            ->withActions($this->getActions())
            ->withRequest($this->http_request);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getActions()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::getActions ( )

protected

Returns: array<string, \ILIAS\UI\Component\Table\Action\Action>

Definition at line 120 of file ConditionTriggerTableGUI.php.

                                   : array
    {
        $uri_command_handler = $this->data_factory->uri(
            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                ilConditionHandlerGUI::class,
                'handleConditionTriggerTableActions'
            )
        );
        [
            $url_builder,
            $action_parameter_token,
            $row_id_token
        ] =
            (new URLBuilder($uri_command_handler))->acquireParameters(
                [self::TABLE_NS],
                self::ACTION_TOKEN,
                self::ID_TOKEN
            );
 
        $actions['edit'] = $this->ui_factory->table()->action()->single(
            $this->lng->txt('edit'),
            $url_builder->withParameter($action_parameter_token, 'editConditionTrigger'),
            $row_id_token
        );
        if ($this->allow_optional_conditions) {
            $actions['saveCompulsory'] = $this->ui_factory->table()->action()->multi(
                $this->lng->txt('rbac_precondition_save_obligatory'),
                $url_builder->withParameter($action_parameter_token, 'saveCompulsory'),
                $row_id_token
            );
        }
        $actions['confirmDeleteConditionTrigger'] = $this->ui_factory->table()->action()->standard(
            $this->lng->txt('delete'),
            $url_builder->withParameter($action_parameter_token, 'confirmDeleteConditionTrigger'),
            $row_id_token
        )->withAsync(true);
        return $actions;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getColumns()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::getColumns ( )

protected

Definition at line 97 of file ConditionTriggerTableGUI.php.

                                   : array
    {
        return [
            'trigger' => $this->ui_factory
                ->table()
                ->column()
                ->link($this->lng->txt('rbac_precondition_source')),
            'condition' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('rbac_precondition_condition'))
                ->withIsSortable(true),
            'obligatory' => $this->ui_factory
                ->table()
                ->column()
                ->statusIcon($this->lng->txt('precondition_obligatory'))
                ->withIsSortable(false)
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getRows()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[] $visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 77 of file ConditionTriggerTableGUI.php.

     : Generator {
        $records = $this->provider->limitData($range, $order);
        foreach ($records as $row) {
            $id = $row['id'];
            yield $row_builder->buildDataRow((string) $id, $row);
        }
    }

References $id, and ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 92 of file ConditionTriggerTableGUI.php.

                                                                                        : ?int
    {
        return count($this->provider->getData());
    }

◆ render()

ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::render ( )

Definition at line 175 of file ConditionTriggerTableGUI.php.

                            : string
    {
        return $this->ui_renderer->render(
            [
                $this->get()
            ]
        );
    }

Field Documentation

◆ $allow_optional_conditions

bool ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$allow_optional_conditions

protected

Definition at line 52 of file ConditionTriggerTableGUI.php.

Referenced by ILIAS\Conditions\Configuration\ConditionTriggerTableGUI\__construct().

◆ $ctrl

readonly ilCtrl ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$ctrl

protected

Definition at line 56 of file ConditionTriggerTableGUI.php.

◆ $data_factory

DataFactory ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$data_factory

protected

Definition at line 49 of file ConditionTriggerTableGUI.php.

◆ $http_request

Psr Http Message ServerRequestInterface ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$http_request

protected

Definition at line 46 of file ConditionTriggerTableGUI.php.

◆ $lng

readonly ilLanguage ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$lng

protected

Definition at line 54 of file ConditionTriggerTableGUI.php.

◆ $provider

ConditionTriggerProvider ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$provider

protected

Definition at line 51 of file ConditionTriggerTableGUI.php.

Referenced by ILIAS\Conditions\Configuration\ConditionTriggerTableGUI\__construct().

◆ $ui_factory

ILIAS UI Factory ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$ui_factory

protected

Definition at line 48 of file ConditionTriggerTableGUI.php.

◆ $ui_renderer

ILIAS UI Renderer ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$ui_renderer

protected

Definition at line 47 of file ConditionTriggerTableGUI.php.

◆ $user

readonly ilObjUser ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::$user

protected

Definition at line 55 of file ConditionTriggerTableGUI.php.

◆ ACTION_TOKEN

const string ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::ACTION_TOKEN = 'action'

Definition at line 38 of file ConditionTriggerTableGUI.php.

◆ ACTION_TOKEN_NS

const string ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::ACTION_TOKEN_NS = self::TABLE_NS . '_' . self::ACTION_TOKEN

Definition at line 42 of file ConditionTriggerTableGUI.php.

◆ ID_TOKEN

const string ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::ID_TOKEN = 'id'

Definition at line 39 of file ConditionTriggerTableGUI.php.

◆ ID_TOKEN_NS

const string ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::ID_TOKEN_NS = self::TABLE_NS . '_' . self::ID_TOKEN

Definition at line 44 of file ConditionTriggerTableGUI.php.

◆ TABLE_NS

const string ILIAS\Conditions\Configuration\ConditionTriggerTableGUI::TABLE_NS = 'cond_trigger_table'

Definition at line 40 of file ConditionTriggerTableGUI.php.

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

components/ILIAS/Conditions/classes/Configuration/ConditionTriggerTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ getActions()

◆ getColumns()

◆ getRows()

◆ getTotalRowCount()

◆ render()

Field Documentation

◆ $allow_optional_conditions

◆ $ctrl

◆ $data_factory

◆ $http_request

◆ $lng

◆ $provider

◆ $ui_factory

◆ $ui_renderer

◆ $user

◆ ACTION_TOKEN

◆ ACTION_TOKEN_NS

◆ ID_TOKEN

◆ ID_TOKEN_NS

◆ TABLE_NS