ilLTIConsumerProviderUsageTableGUI Class Reference

Inheritance diagram for ilLTIConsumerProviderUsageTableGUI:

Collaboration diagram for ilLTIConsumerProviderUsageTableGUI:

Public Member Functions
	__construct ()
	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...
	setData (array $data)
	getHTML ()
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
	$request
array	$records

Private Member Functions
	getColumns ()

Detailed Description

Definition at line 38 of file class.ilLTIConsumerProviderUsageTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumerProviderUsageTableGUI::__construct

(

)

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
    }

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

Here is the call graph for this function:

Member Function Documentation

applyOrdering()

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

protected

Definition at line 102 of file class.ilLTIConsumerProviderUsageTableGUI.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()

ilLTIConsumerProviderUsageTableGUI::getColumns ( )

private

Definition at line 137 of file class.ilLTIConsumerProviderUsageTableGUI.php.

                                 : array
    {
        return [
            "icon" => $this->ui_factory->table()->column()->statusIcon($this->lng->txt('tbl_lti_prov_icon')),
            "title" => $this->ui_factory->table()->column()->text($this->lng->txt('tbl_lti_prov_title')),
            "usedByIsTrashed" => $this->ui_factory->table()->column()->boolean(
                $this->lng->txt('tbl_lti_prov_usages_trashed'),
                $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_ok.svg', $this->lng->txt('icon_ok'), Icon::SMALL),
                $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_not_ok.svg', $this->lng->txt('icon_not_ok'), Icon::SMALL)
            ),
            "used_by" => $this->ui_factory->table()->column()->link($this->lng->txt('tbl_lti_prov_used_by'))
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getHTML()

ilLTIConsumerProviderUsageTableGUI::getHTML

(

)

Definition at line 126 of file class.ilLTIConsumerProviderUsageTableGUI.php.

                             : string
    {
        $table = $this->ui_factory->table()
            ->data($this, $this->lng->txt('tbl_provider_usage_header'), $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:

getTotalRowCount()

ilLTIConsumerProviderUsageTableGUI::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 89 of file class.ilLTIConsumerProviderUsageTableGUI.php.

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

setData()

ilLTIConsumerProviderUsageTableGUI::setData

(

array

$data

)

Definition at line 97 of file class.ilLTIConsumerProviderUsageTableGUI.php.

                                        : void
    {
        $this->records = $data;
    }

References $data.

Field Documentation

$lng

ilLanguage ilLTIConsumerProviderUsageTableGUI::$lng

protected

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

$records

array ilLTIConsumerProviderUsageTableGUI::$records

protected

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

$request

ilLTIConsumerProviderUsageTableGUI::$request

protected

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

$ui_factory

Factory ilLTIConsumerProviderUsageTableGUI::$ui_factory

protected

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

$ui_renderer

ILIAS UI Renderer ilLTIConsumerProviderUsageTableGUI::$ui_renderer

protected

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

---

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

• components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerProviderUsageTableGUI.php