ilLTIConsumerGradeSynchronizationTableGUI Class Reference

Inheritance diagram for ilLTIConsumerGradeSynchronizationTableGUI:

Collaboration diagram for ilLTIConsumerGradeSynchronizationTableGUI:

Public Member Functions
	__construct (bool $isMultiActorReport)
	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...
	setRecords (array $records)
	getHTML ()
	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
bool	$isMultiActorReport

Private Member Functions
	getColumns ()

Private Attributes
array	$records = []

Detailed Description

Definition at line 35 of file class.ilLTIConsumerGradeSynchronizationTableGUI.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumerGradeSynchronizationTableGUI::__construct

(

bool

$isMultiActorReport

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

applyOrdering()

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

protected

Definition at line 94 of file class.ilLTIConsumerGradeSynchronizationTableGUI.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] ?? '';
 
            if ($left_val instanceof DateTimeImmutable) {
                $left_val = $left_val->getTimestamp();
            }
            if ($right_val instanceof DateTimeImmutable) {
                $right_val = $right_val->getTimestamp();
            }
 
            return $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(), and ILIAS\Data\Order\join().

Here is the call graph for this function:

getColumns()

ilLTIConsumerGradeSynchronizationTableGUI::getColumns ( )

private

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

                                 : array
    {
        global $DIC;
        $df = new \ILIAS\Data\Factory();
 
 
        return [
            "lti_timestamp" => $this->ui_factory->table()->column()->date($this->lng->txt('tbl_grade_date'), $df->dateFormat()->withTime24($DIC->user()->getDateFormat())),
            "actor" => $this->ui_factory->table()->column()->text($this->lng->txt('tbl_grade_actor')),
            "score_given" => $this->ui_factory->table()->column()->text($this->lng->txt('tbl_grade_score')),
            "activity_progress" => $this->ui_factory->table()->column()->text($this->lng->txt('tbl_grade_activity_progress')),
            "grading_progress" => $this->ui_factory->table()->column()->text($this->lng->txt('tbl_grade_grading_progress')),
            "stored" => $this->ui_factory->table()->column()->date($this->lng->txt('tbl_grade_stored'), $df->dateFormat()->withTime24($DIC->user()->getDateFormat()))
        ];
    }

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

Here is the call graph for this function:

getHTML()

ilLTIConsumerGradeSynchronizationTableGUI::getHTML

(

)

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

                             : string
    {
        $table = $this->ui_factory->table()
            ->data($this, "", $this->getColumns())
            ->withOrder(new Order("lti_timestamp", Order::DESC))
            ->withRange(new Range(0, 20))
            ->withRequest($this->request);
 
        return $this->ui_renderer->render($table);
    }

getRows()

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

Exceptions

DateMalformedStringException

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 60 of file class.ilLTIConsumerGradeSynchronizationTableGUI.php.

     : Generator {
        $records = $this->applyOrdering($this->records, $order, $range);
        foreach ($records as $record) {
            $record['lti_timestamp'] = new DateTimeImmutable($record['lti_timestamp']);
            $record['score_given'] = $record['score_given'] . ' / ' . $record['score_maximum'];
            $record['activity_progress'] = $this->lng->txt('grade_activity_progress_' . strtolower($record['activity_progress']));
            $record['grading_progress'] = $this->lng->txt('grade_grading_progress_' . strtolower($record['grading_progress']));
            $record['stored'] = new DateTimeImmutable($record['stored']);
 
            yield $row_builder->buildDataRow((string) $record['id'], $record);
        }
    }

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getTotalRowCount()

ilLTIConsumerGradeSynchronizationTableGUI::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 81 of file class.ilLTIConsumerGradeSynchronizationTableGUI.php.

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

setRecords()

ilLTIConsumerGradeSynchronizationTableGUI::setRecords

(

array

$records

)

Definition at line 89 of file class.ilLTIConsumerGradeSynchronizationTableGUI.php.

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

Field Documentation

$isMultiActorReport

bool ilLTIConsumerGradeSynchronizationTableGUI::$isMultiActorReport

protected

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

Referenced by __construct().

$lng

ilLanguage ilLTIConsumerGradeSynchronizationTableGUI::$lng

protected

Definition at line 37 of file class.ilLTIConsumerGradeSynchronizationTableGUI.php.

$records

array ilLTIConsumerGradeSynchronizationTableGUI::$records = []

private

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

$request

ilLTIConsumerGradeSynchronizationTableGUI::$request

protected

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

$ui_factory

Factory ilLTIConsumerGradeSynchronizationTableGUI::$ui_factory

protected

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

$ui_renderer

ILIAS UI Renderer ilLTIConsumerGradeSynchronizationTableGUI::$ui_renderer

protected

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

---

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

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