TableGUI class for LTI consumer listing. More...

Inheritance diagram for ilObjectConsumerTableGUI:

Collaboration diagram for ilObjectConsumerTableGUI:

Public Member Functions
	__construct ()

	getColumns ()

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)

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

	getHtml ()

	isEditable ()

	setEditable (bool $a_editable)

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

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

Protected Member Functions
	applyOrdering (array $records, Order $order, ?Range $range=null)

Protected Attributes
ilLanguage	$lng

Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

ILIAS Data Factory	$data_factory

ilCtrlInterface	$ctrl

WrapperFactory	$wrapper

ILIAS Refinery Factory	$refinery

Private Member Functions
	getRecords ()

	getActions ()

Private Attributes
ServerRequestInterface RequestInterface	$request

array	$records

bool	$editable = false

Detailed Description

TableGUI class for LTI consumer listing.

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectConsumerTableGUI::__construct ( )

Definition at line 53 of file class.ilObjectConsumerTableGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
        $this->data_factory = new \ILIAS\Data\Factory();
        $this->ctrl = $DIC->ctrl();
        $this->wrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
 
        $this->records = $this->getRecords();
    }

References $DIC, ILIAS\Repository\ctrl(), getRecords(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ applyOrdering()

ilObjectConsumerTableGUI::applyOrdering	(	array	$records,
		Order	$order,
		?Range	$range = `null`
	)

protected

Definition at line 241 of file class.ilObjectConsumerTableGUI.php.

                                                                                        : array
    {
        [$order_field, $order_direction] = $order->join(
            [],
            fn($ret, $key, $value) => [$key, $value]
        );
 
        usort($records, static function (array $left, array $right) use ($order_field): int {
            $left_val = $left[$order_field] ?? '';
            $right_val = $right[$order_field] ?? '';
            return ilStr::strCmp($left_val, $right_val);
        });
 
        if ($order_direction === Order::DESC) {
            $records = array_reverse($records);
        }
 
        if ($range !== null) {
            $records = array_slice($records, $range->getStart(), $range->getLength());
        }
 
        return $records;
    }

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), ILIAS\Data\Order\join(), and ilStr\strCmp().

Here is the call graph for this function:

◆ getActions()

ilObjectConsumerTableGUI::getActions ( )

private

Exceptions

ilCtrlException

Definition at line 108 of file class.ilObjectConsumerTableGUI.php.

                                 : array
    {
        if (!$this->isEditable()) {
            return [];
        }
 
        $df = new \ILIAS\Data\Factory();
        $here_uri = $df->uri($this->request->getUri()->__toString());
        $url_builder = new URLBuilder($here_uri);
 
        $query_params_namespace = ['lti_consumer_table'];
        list($url_builder, $id_token, $action_token) = $url_builder->acquireParameters(
            $query_params_namespace,
            "consumer_id",
            "action"
        );
 
        $query = $this->wrapper->query();
        if ($query->has($action_token->getName())) {
            $action = $query->retrieve($action_token->getName(), $this->refinery->to()->string());
            $ids = $query->retrieve($id_token->getName(), $this->refinery->custom()->transformation(fn($v) => $v));
            $id = $ids[0] ?? null;
 
            switch ($action) {
                case "edit":
                    $this->ctrl->setParameterByClass(ilObjLTIAdministrationGUI::class, 'cid', $id);
                    $this->ctrl->redirectByClass(ilObjLTIAdministrationGUI::class, 'editConsumer');
                    break;
                case "delete":
                    $this->ctrl->setParameterByClass(ilObjLTIAdministrationGUI::class, 'cid', $id);
                    $this->ctrl->redirectByClass(ilObjLTIAdministrationGUI::class, 'deleteLTIConsumer');
                    break;
                case "status":
                    $this->ctrl->setParameterByClass(ilObjLTIAdministrationGUI::class, 'cid', $id);
                    $this->ctrl->redirectByClass(ilObjLTIAdministrationGUI::class, 'changeStatusLTIConsumer');
                    break;
            }
        }
 
        return [
            $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $url_builder->withParameter($action_token, "edit"),
                $id_token
            ),
            $this->ui_factory->table()->action()->single(
                $this->lng->txt('delete'),
                $url_builder->withParameter($action_token, "delete"),
                $id_token
            ),
            $this->ui_factory->table()->action()->single(
                $this->lng->txt('activate') . " / " . $this->lng->txt('deactivate'),
                $url_builder->withParameter($action_token, "status"),
                $id_token
            )
        ];
    }

References $id, ILIAS\Repository\ctrl(), isEditable(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getColumns()

ilObjectConsumerTableGUI::getColumns ( )

Definition at line 69 of file class.ilObjectConsumerTableGUI.php.

                                : array
    {
        return [
            'active' => $this->ui_factory->table()->column()->statusIcon($this->lng->txt('active')),
            'title' => $this->ui_factory->table()->column()->text($this->lng->txt('title')),
            'description' => $this->ui_factory->table()->column()->text($this->lng->txt('description')),
            'prefix' => $this->ui_factory->table()->column()->text($this->lng->txt('prefix')),
            'language' => $this->ui_factory->table()->column()->text($this->lng->txt('in_use')),
            'objects' => $this->ui_factory->table()->column()->text($this->lng->txt('objects')),
            'role' => $this->ui_factory->table()->column()->text($this->lng->txt('role'))
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getHtml()

ilObjectConsumerTableGUI::getHtml ( )

Exceptions

ilCtrlException

Definition at line 219 of file class.ilObjectConsumerTableGUI.php.

                             : string
    {
        $table = $this->ui_factory->table()
            ->data($this, $this->lng->txt('lti_object_consumer'), $this->getColumns())
            ->withOrder(new Order('title', Order::ASC))
            ->withRange(new Range(0, 20))
            ->withActions($this->getActions())
            ->withRequest($this->request);
 
        return $this->ui_renderer->render($table);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getRecords()

ilObjectConsumerTableGUI::getRecords ( )

private

Definition at line 82 of file class.ilObjectConsumerTableGUI.php.

                                 : array
    {
        $dataConnector = new ilLTIDataConnector();
 
        $consumer_data = $dataConnector->getGlobalToolConsumerSettings();
 
        $result = array();
 
        foreach ($consumer_data as $cons) {
            $result[] = array(
                "id" => $cons->getExtConsumerId(),
                "active" => $cons->getActive(),
                "title" => $cons->getTitle(),
                "description" => $cons->getDescription(),
                "prefix" => $cons->getPrefix(),
                "language" => $cons->getLanguage(),
                "role" => $cons->getRole(),
            );
        }
 
        return $result;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ getRows()

ilObjectConsumerTableGUI::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Exceptions

ilObjectNotFoundException
ilDatabaseException

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 170 of file class.ilObjectConsumerTableGUI.php.

     : Generator {
        $records = $this->applyOrdering($this->records, $order, $range);
        foreach ($records as $record) {
            $record["active"] = $this->ui_factory->symbol()->icon()->custom(
                $record["active"] ?
                    'assets/images/standard/icon_ok.svg' :
                    'assets/images/standard/icon_not_ok.svg',
                $record["active"] ? $this->lng->txt('active') : $this->lng->txt('inactive'),
                Icon::MEDIUM
            );
 
            $role = ilObjectFactory::getInstanceByObjId($record['role'], false);
            if ($role instanceof ilObjRole) {
                $record['role'] = $role->getTitle();
            } else {
                $record['role'] = '';
            }
 
            $record["objects"] = '';
            $obj_types = ilObjLTIAdministration::getActiveObjectTypes($record["id"]);
            if ($obj_types) {
                foreach ($obj_types as $obj_type) {
                    $record["objects"] .= $GLOBALS['DIC']->language()->txt('objs_' . $obj_type) . '<br/>';
                }
            }
 
            yield $row_builder->buildDataRow((string) $record["id"], $record);
        }
    }

References $GLOBALS, ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ilObjLTIAdministration\getActiveObjectTypes(), ilObjectFactory\getInstanceByObjId(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getTotalRowCount()

ilObjectConsumerTableGUI::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 208 of file class.ilObjectConsumerTableGUI.php.

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

◆ isEditable()

ilObjectConsumerTableGUI::isEditable ( )

Definition at line 231 of file class.ilObjectConsumerTableGUI.php.

                                : bool
    {
        return $this->editable;
    }

Referenced by getActions().

Here is the caller graph for this function:

◆ setEditable()

ilObjectConsumerTableGUI::setEditable ( bool $a_editable )

Definition at line 236 of file class.ilObjectConsumerTableGUI.php.

                                                 : void
    {
        $this->editable = $a_editable;
    }

Field Documentation

◆ $ctrl

ilCtrlInterface ilObjectConsumerTableGUI::$ctrl

protected

Definition at line 47 of file class.ilObjectConsumerTableGUI.php.

◆ $data_factory

ILIAS Data Factory ilObjectConsumerTableGUI::$data_factory

protected

Definition at line 46 of file class.ilObjectConsumerTableGUI.php.

◆ $editable

bool ilObjectConsumerTableGUI::$editable = false

private

Definition at line 51 of file class.ilObjectConsumerTableGUI.php.

◆ $lng

ilLanguage ilObjectConsumerTableGUI::$lng

protected

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

◆ $records

array ilObjectConsumerTableGUI::$records

private

Definition at line 50 of file class.ilObjectConsumerTableGUI.php.

◆ $refinery

ILIAS Refinery Factory ilObjectConsumerTableGUI::$refinery

protected

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

◆ $request

ServerRequestInterface RequestInterface ilObjectConsumerTableGUI::$request

private

Definition at line 45 of file class.ilObjectConsumerTableGUI.php.

◆ $ui_factory

Factory ilObjectConsumerTableGUI::$ui_factory

protected

Definition at line 43 of file class.ilObjectConsumerTableGUI.php.

◆ $ui_renderer

ILIAS UI Renderer ilObjectConsumerTableGUI::$ui_renderer

protected

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

◆ $wrapper

WrapperFactory ilObjectConsumerTableGUI::$wrapper

protected

Definition at line 48 of file class.ilObjectConsumerTableGUI.php.

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

components/ILIAS/LTIProvider/classes/Consumer/class.ilObjectConsumerTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyOrdering()

◆ getActions()

◆ getColumns()

◆ getHtml()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

◆ isEditable()

◆ setEditable()

Field Documentation

◆ $ctrl

◆ $data_factory

◆ $editable

◆ $lng

◆ $records

◆ $refinery

◆ $request

◆ $ui_factory

◆ $ui_renderer

◆ $wrapper