Description of class ilLTIProviderReleasedObjectsTableGUI. More...

Inheritance diagram for ilLTIProviderReleasedObjectsTableGUI:

Collaboration diagram for ilLTIProviderReleasedObjectsTableGUI:

Public Member Functions
	__construct (string $a_id='')

	getColumns ()

	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 ()

	getId ()

Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	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 ()

Private Attributes
ServerRequestInterface RequestInterface	$request

array	$records

string	$id

Detailed Description

Description of class ilLTIProviderReleasedObjectsTableGUI.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 39 of file class.ilLTIProviderReleasedObjectsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIProviderReleasedObjectsTableGUI::__construct ( string $a_id = '' )

Definition at line 52 of file class.ilLTIProviderReleasedObjectsTableGUI.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->id = $a_id ?: 'lti_released_objects';
 
        $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()

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

protected

Definition at line 164 of file class.ilLTIProviderReleasedObjectsTableGUI.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:

◆ getColumns()

ilLTIProviderReleasedObjectsTableGUI::getColumns ( )

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

                                : array
    {
        return [
            'type' => $this->ui_factory->table()->column()->statusIcon($this->lng->txt('type')),
            'title' => $this->ui_factory->table()->column()->link($this->lng->txt('title')),
            'consumer' => $this->ui_factory->table()->column()->text($this->lng->txt('lti_consumer'))
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getHtml()

ilLTIProviderReleasedObjectsTableGUI::getHtml ( )

Definition at line 148 of file class.ilLTIProviderReleasedObjectsTableGUI.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilLTIProviderReleasedObjectsTableGUI::getId ( )

Definition at line 159 of file class.ilLTIProviderReleasedObjectsTableGUI.php.

                           : string
    {
        return $this->id;
    }

References $id.

◆ getRecords()

ilLTIProviderReleasedObjectsTableGUI::getRecords ( )

private

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

                                 : array
    {
        $rows = ilObjLTIAdministration::readReleaseObjects();
 
        $result = array();
        foreach ($rows as $row) {
            $ref_id = (int) $row['ref_id'];
 
            $type = ilObject::_lookupType(ilObject::_lookupObjId($ref_id));
            if ($type == 'rolf') {
                continue;
            }
 
            $result[] = array(
                'id' => $ref_id,
                'ref_id' => $ref_id,
                'obj_id' => ilObject::_lookupObjId($ref_id),
                'type' => $type,
                'title' => ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)),
                'consumer' => $row['title']
            );
        }
 
        return $result;
    }

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Repository\int(), and ilObjLTIAdministration\readReleaseObjects().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalRowCount()

ilLTIProviderReleasedObjectsTableGUI::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 138 of file class.ilLTIProviderReleasedObjectsTableGUI.php.

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

Field Documentation

◆ $ctrl

ilCtrlInterface ilLTIProviderReleasedObjectsTableGUI::$ctrl

protected

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

◆ $data_factory

ILIAS Data Factory ilLTIProviderReleasedObjectsTableGUI::$data_factory

protected

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

◆ $id

string ilLTIProviderReleasedObjectsTableGUI::$id

private

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

◆ $lng

ilLanguage ilLTIProviderReleasedObjectsTableGUI::$lng

protected

Definition at line 41 of file class.ilLTIProviderReleasedObjectsTableGUI.php.

◆ $records

array ilLTIProviderReleasedObjectsTableGUI::$records

private

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

◆ $refinery

ILIAS Refinery Factory ilLTIProviderReleasedObjectsTableGUI::$refinery

protected

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

◆ $request

ServerRequestInterface RequestInterface ilLTIProviderReleasedObjectsTableGUI::$request

private

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

◆ $ui_factory

Factory ilLTIProviderReleasedObjectsTableGUI::$ui_factory

protected

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

◆ $ui_renderer

ILIAS UI Renderer ilLTIProviderReleasedObjectsTableGUI::$ui_renderer

protected

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

◆ $wrapper

WrapperFactory ilLTIProviderReleasedObjectsTableGUI::$wrapper

protected

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

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

components/ILIAS/LTIProvider/classes/InternalProvider/class.ilLTIProviderReleasedObjectsTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyOrdering()

◆ getColumns()

◆ getHtml()

◆ getId()

◆ getRecords()

◆ getTotalRowCount()

Field Documentation

◆ $ctrl

◆ $data_factory

◆ $id

◆ $lng

◆ $records

◆ $refinery

◆ $request

◆ $ui_factory

◆ $ui_renderer

◆ $wrapper