Inheritance diagram for ILIAS\Calendar\Shared\Outgoing\DataRetrieval:

Collaboration diagram for ILIAS\Calendar\Shared\Outgoing\DataRetrieval:

Public Member Functions
	__construct (protected int $calendar_id, protected ilLanguage $lng, protected UIFactory $ui_factory)

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

	getAllIDs ()

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

	getAllIDs ()

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

Protected Attributes
ilCalendarShared	$shared

Detailed Description

Definition at line 34 of file DataRetrieval.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Calendar\Shared\Outgoing\DataRetrieval::__construct	(	protected int	$calendar_id,
		protected ilLanguage	$lng,
		protected UIFactory	$ui_factory
	)

Definition at line 38 of file DataRetrieval.php.

42 {

43 }

Member Function Documentation

◆ getAllIDs()

ILIAS\Calendar\Shared\Outgoing\DataRetrieval::getAllIDs ( )

Returns: int[]

Implements ILIAS\Calendar\Shared\DataRetrievalInterface.

Definition at line 112 of file DataRetrieval.php.

                               : array
    {
        $ids = [];
        foreach ($this->getShared()->getShared() as $item) {
            $ids[] = (int) $item['obj_id'];
        }
        return $ids;
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getRows()

ILIAS\Calendar\Shared\Outgoing\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.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[] $visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 50 of file DataRetrieval.php.

     : Generator {
        $data = [];
        foreach ($this->getShared()->getShared() as $item) {
            $datum = [];
            $obj_id = (int) $item['obj_id'];
            switch ($item['obj_type']) {
                case ilCalendarShared::TYPE_USR:
                    $datum[TableBuilder::TYPE_COLUMN] = 'usr';
                    $name = ilObjUser::_lookupName($obj_id);
                    $datum[TableBuilder::TITLE_COLUMN] = $name['lastname'] . ', ' . $name['firstname'];
                    $datum[TableBuilder::DESCRIPTION_COLUMN] = '';
                    break;
 
                case ilCalendarShared::TYPE_ROLE:
                    $datum[TableBuilder::TYPE_COLUMN] = 'role';
                    $datum[TableBuilder::TITLE_COLUMN] = ilObject::_lookupTitle($obj_id);
                    $datum[TableBuilder::DESCRIPTION_COLUMN] = ilObject::_lookupDescription($obj_id);
                    break;
            }
            $datum[TableBuilder::WRITABLE_COLUMN] = (bool) $item['writable'];
 
            $data[$obj_id] = $datum;
        }
 
        $order_field = array_keys($order->get())[0];
        $order_direction = $order->get()[$order_field];
        uasort($data, fn($a, $b) => strtolower((string) $a[$order_field]) <=> strtolower((string) $b[$order_field]));
        if ($order_direction === Order::DESC) {
            $data = array_reverse($data, true);
        }
        $data = array_slice($data, $range->getStart(), $range->getLength(), true);
 
        $usr_icon = $this->ui_factory->symbol()->icon()->standard('usr', $this->lng->txt('obj_usr'));
        $role_icon = $this->ui_factory->symbol()->icon()->standard('role', $this->lng->txt('obj_role'));
 
        foreach ($data as $id => $datum) {
            $datum[TableBuilder::TYPE_COLUMN] = match ($datum[TableBuilder::TYPE_COLUMN]) {
                'usr' => $usr_icon,
                'role' => $role_icon
            };
            $datum[TableBuilder::WRITABLE_COLUMN] = match ($datum[TableBuilder::WRITABLE_COLUMN]) {
                true => $this->lng->txt('cal_shared_access_read_write'),
                false => $this->lng->txt('cal_shared_access_read_only')
            };
            yield $row_builder->buildDataRow(
                (string) $id,
                $datum
            );
        }
    }

References $data, ilObject\_lookupDescription(), ilObjUser\_lookupName(), ilObject\_lookupTitle(), ILIAS\Calendar\Shared\Outgoing\TableBuilder\DESCRIPTION_COLUMN, ILIAS\Repository\int(), ILIAS\Calendar\Shared\Outgoing\TableBuilder\TITLE_COLUMN, ILIAS\Calendar\Shared\Outgoing\TableBuilder\TYPE_COLUMN, ilCalendarShared\TYPE_ROLE, ilCalendarShared\TYPE_USR, and ILIAS\Calendar\Shared\Outgoing\TableBuilder\WRITABLE_COLUMN.

Here is the call graph for this function:

◆ getShared()

ILIAS\Calendar\Shared\Outgoing\DataRetrieval::getShared ( )

protected

Definition at line 45 of file DataRetrieval.php.

                                  : ilCalendarShared
    {
        return $this->shared ??= new ilCalendarShared($this->calendar_id);
    }

◆ getTotalRowCount()

ILIAS\Calendar\Shared\Outgoing\DataRetrieval::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 121 of file DataRetrieval.php.

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

Field Documentation

◆ $shared

ilCalendarShared ILIAS\Calendar\Shared\Outgoing\DataRetrieval::$shared

protected

Definition at line 36 of file DataRetrieval.php.

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

components/ILIAS/Calendar/classes/Shared/Outgoing/DataRetrieval.php

Public Member Functions

Protected Member Functions

Protected Attributes