Inheritance diagram for ILIAS\Course\Table\TimingsView\DataRetrieval:

Collaboration diagram for ILIAS\Course\Table\TimingsView\DataRetrieval:

Public Member Functions
	__construct (protected readonly UIServices $ui, protected readonly ilObjUser $user, protected readonly int $user_id, protected readonly int $parent_object_ref_id,)

	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...

	getUsername ()

	getDateFormat ()

	getUsername ()

	getDateFormat ()

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

Protected Attributes
const string	KEY_SUGGESTION = 'suggestion'

const string	KEY_PLANNED = 'planned'

const string	KEY_ROW_ID = 'row_id'

const string	KEY_TITLE_LINK = 'title_link'

const string	KEY_TITLE = 'title'

const string	OBJECT_GROUP_TYPE = 'obgr'

array	$rows

string	$username

Detailed Description

Definition at line 39 of file DataRetrieval.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Course\Table\TimingsView\DataRetrieval::__construct	(	protected readonly UIServices	$ui,
		protected readonly ilObjUser	$user,
		protected readonly int	$user_id,
		protected readonly int	$parent_object_ref_id
	)

Definition at line 50 of file DataRetrieval.php.

      {
        $this->initRows();
    }

References ILIAS\Course\Table\TimingsView\DataRetrieval\initRows().

Here is the call graph for this function:

Member Function Documentation

◆ getDateFormat()

ILIAS\Course\Table\TimingsView\DataRetrieval::getDateFormat ( )

final

Implements ILIAS\Course\I\Table\TimingsView\DataRetrievalInterface.

Definition at line 178 of file DataRetrieval.php.

                                         : DateFormat
    {
        return $this->user->getDateFormat();
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

◆ getRows()

ILIAS\Course\Table\TimingsView\DataRetrieval::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

final

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 124 of file DataRetrieval.php.

     : Generator {
        [$column_name, $direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        $comparator = match ($column_name) {
            HandlerInterface::TABLE_COL_TITLE => fn(array $a, array $b) => strcmp($a[self::KEY_TITLE], $b[self::KEY_TITLE]),
            HandlerInterface::TABLE_COL_TIMINGS_PLANNED, HandlerInterface::TABLE_COL_SUGGESTION => fn(array $a, array $b) => $a[self::KEY_PLANNED][0]->getTimestamp() <=> $b[self::KEY_PLANNED][0]->getTimestamp(),
            default => fn(array $a, array $b) => 0
        };
        $rows = $this->rows;
        uasort($rows, $comparator);
        if ($direction === "DESC") {
            $rows = array_reverse($rows, true);
        }
        $rows = array_slice($rows, $range->getStart(), $range->getLength(), true);
        foreach ($rows as $row) {
            yield $row_builder->buildDataRow(
                $row[self::KEY_ROW_ID] . '',
                [
                    HandlerInterface::TABLE_COL_TITLE => $this->ui->factory()->link()->standard(
                        $row[self::KEY_TITLE],
                        $row[self::KEY_TITLE_LINK]
                    )
                        ->withDisabled(strcmp($row[self::KEY_TITLE_LINK], '') === 0),
                    HandlerInterface::TABLE_COL_SUGGESTION => $row[self::KEY_SUGGESTION],
                    HandlerInterface::TABLE_COL_TIMINGS_PLANNED => $row[self::KEY_PLANNED],
                ]
            );
        }
    }

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\Course\Table\TimingsView\DataRetrieval\KEY_PLANNED, ILIAS\Course\I\Table\TimingsView\HandlerInterface\TABLE_COL_SUGGESTION, ILIAS\Course\I\Table\TimingsView\HandlerInterface\TABLE_COL_TIMINGS_PLANNED, and ILIAS\Course\I\Table\TimingsView\HandlerInterface\TABLE_COL_TITLE.

◆ getTotalRowCount()

ILIAS\Course\Table\TimingsView\DataRetrieval::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

final

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 161 of file DataRetrieval.php.

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

◆ getUsername()

ILIAS\Course\Table\TimingsView\DataRetrieval::getUsername ( )

final

Implements ILIAS\Course\I\Table\TimingsView\DataRetrievalInterface.

Definition at line 169 of file DataRetrieval.php.

                                       : string
    {
        if (!isset($this->username)) {
            $name = ilObjUser::_lookupName($this->user_id);
            $this->username = $name['lastname'] . ', ' . $name['firstname'];
        }
        return $this->username;
    }

References ilObjUser\_lookupName().

Here is the call graph for this function:

◆ initRows()

ILIAS\Course\Table\TimingsView\DataRetrieval::initRows ( )

finalprotected

Definition at line 59 of file DataRetrieval.php.

                                       : void
    {
        if (isset($this->rows)) {
            return;
        }
        $this->rows = [];
        $items = ilObjectActivation::getItems($this->parent_object_ref_id, false);
        foreach ($items as $item) {
            // hide objects without timings
            if ($item['timing_type'] != ilObjectActivation::TIMINGS_PRESETTING) {
                continue;
            }
            // no object groups
            if ($item['type'] == self::OBJECT_GROUP_TYPE) {
                continue;
            }
            # Title
            $sess_values = ilSessionAppointment::_lookupAppointment(ilObject::_lookupObjId($item['ref_id']));
            $title = (
                count($sess_values) > 0 &&
                $item['type'] == 'sess' &&
                !strlen($item['title'])
            )
                ? ilSessionAppointment::_appointmentToString(
                    $sess_values['start'],
                    $sess_values['end'],
                    (bool) $sess_values['fullday']
                )
                : $item['title'];
 
            # Title Link
            $title_link = (in_array($item['type'], ['fold', 'grp', 'sess']))
                ? ilLink::_getLink($item['ref_id'], $item['type'])
                : '';
 
            # Suggested Timing
            $suggested = [
                DateTimeImmutable::createFromTimestamp($item['suggestion_start']),
                DateTimeImmutable::createFromTimestamp($item['suggestion_end']),
            ];
 
            # Planned Timing
            $timing_user = new ilTimingUser($item['child'], $this->user_id);
 
            $planned = (
                ((int) $item['timing_type']) === ilObjectActivation::TIMINGS_PRESETTING &&
                !is_null($timing_user->getStart()->get(IL_CAL_UNIX)) &&
                !is_null($timing_user->getEnd()->get(IL_CAL_UNIX))
            )
                ? [
                    DateTimeImmutable::createFromTimestamp($timing_user->getStart()->get(IL_CAL_UNIX)),
                    DateTimeImmutable::createFromTimestamp($timing_user->getEnd()->get(IL_CAL_UNIX))
                ]
                : $suggested;
 
            $this->rows[] = [
                self::KEY_ROW_ID => $item['ref_id'],
                self::KEY_TITLE => $title,
                self::KEY_TITLE_LINK => $title_link,
                self::KEY_PLANNED => $planned,
                self::KEY_SUGGESTION => $suggested,
            ];
        }
    }

References ilSessionAppointment\_appointmentToString(), ilSessionAppointment\_lookupAppointment(), ilObject\_lookupObjId(), ilObjectActivation\getItems(), IL_CAL_UNIX, ILIAS\Repository\int(), and ilObjectActivation\TIMINGS_PRESETTING.

Referenced by ILIAS\Course\Table\TimingsView\DataRetrieval\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $rows

array ILIAS\Course\Table\TimingsView\DataRetrieval::$rows

protected

Definition at line 47 of file DataRetrieval.php.

◆ $username

string ILIAS\Course\Table\TimingsView\DataRetrieval::$username

protected

Definition at line 48 of file DataRetrieval.php.

◆ KEY_PLANNED

const string ILIAS\Course\Table\TimingsView\DataRetrieval::KEY_PLANNED = 'planned'

protected

Definition at line 42 of file DataRetrieval.php.

Referenced by ILIAS\Course\Table\TimingsView\DataRetrieval\getRows().

◆ KEY_ROW_ID

const string ILIAS\Course\Table\TimingsView\DataRetrieval::KEY_ROW_ID = 'row_id'

protected

Definition at line 43 of file DataRetrieval.php.

◆ KEY_SUGGESTION

const string ILIAS\Course\Table\TimingsView\DataRetrieval::KEY_SUGGESTION = 'suggestion'

protected

Definition at line 41 of file DataRetrieval.php.

◆ KEY_TITLE

const string ILIAS\Course\Table\TimingsView\DataRetrieval::KEY_TITLE = 'title'

protected

Definition at line 45 of file DataRetrieval.php.

◆ KEY_TITLE_LINK

const string ILIAS\Course\Table\TimingsView\DataRetrieval::KEY_TITLE_LINK = 'title_link'

protected

Definition at line 44 of file DataRetrieval.php.

◆ OBJECT_GROUP_TYPE

const string ILIAS\Course\Table\TimingsView\DataRetrieval::OBJECT_GROUP_TYPE = 'obgr'

protected

Definition at line 46 of file DataRetrieval.php.

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

components/ILIAS/Course/classes/Table/TimingsView/DataRetrieval.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDateFormat()

◆ getRows()

◆ getTotalRowCount()

◆ getUsername()

◆ initRows()

Field Documentation

◆ $rows

◆ $username

◆ KEY_PLANNED

◆ KEY_ROW_ID

◆ KEY_SUGGESTION

◆ KEY_TITLE

◆ KEY_TITLE_LINK

◆ OBJECT_GROUP_TYPE