ILIAS\Calendar\Shared\Inbox\DataRetrieval Class Reference

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

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

Public Member Functions
	__construct (protected int $user_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...
	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
	getOpenInvitations ()

Protected Attributes
array	$open_invitations

Detailed Description

Definition at line 32 of file DataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Calendar\Shared\Inbox\DataRetrieval::__construct

(

protected int

$user_id

)

Definition at line 36 of file DataRetrieval.php.

      {
    }

Member Function Documentation

getAllIDs()

ILIAS\Calendar\Shared\Inbox\DataRetrieval::getAllIDs

(

)

Returns

int[]

Implements ILIAS\Calendar\Shared\DataRetrievalInterface.

Definition at line 90 of file DataRetrieval.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

getOpenInvitations()

ILIAS\Calendar\Shared\Inbox\DataRetrieval::getOpenInvitations ( )

protected

Definition at line 41 of file DataRetrieval.php.

                                           : array
    {
        return $this->open_invitations ??= new ilCalendarSharedStatus($this->user_id)->getOpenInvitations();
    }

References ilCalendarSharedStatus\getOpenInvitations().

Here is the call graph for this function:

getRows()

ILIAS\Calendar\Shared\Inbox\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 46 of file DataRetrieval.php.

     : Generator {
        $data = [];
        foreach ($this->getOpenInvitations() as $item) {
            $datum = [];
            $datum[TableBuilder::NAME_COLUMN] = $item['name'];
            $name = ilObjUser::_lookupName((int) $item['owner']);
            $datum[TableBuilder::OWNER_COLUMN] = $name['lastname'] . ', ' . $name['firstname'];
            $datum[TableBuilder::APPOINTMENTS_COUNT_COLUMN] = (int) $item['apps'];
            $datum[TableBuilder::CREATED_ON_COLUMN] = new DateTimeImmutable($item['create_date']);
 
            $data[(int) $item['cal_id']] = $datum;
        }
 
        $order_field = array_keys($order->get())[0];
        $order_direction = $order->get()[$order_field];
        if ($order_field === TableBuilder::CREATED_ON_COLUMN || $order_field === TableBuilder::APPOINTMENTS_COUNT_COLUMN) {
            uasort($data, fn($a, $b) => $a[$order_field] <=> $b[$order_field]);
        } else {
            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);
 
        foreach ($data as $id => $datum) {
            yield $row_builder->buildDataRow(
                (string) $id,
                $datum
            );
        }
    }

References $data, ilObjUser\_lookupName(), ILIAS\Calendar\Shared\Inbox\TableBuilder\APPOINTMENTS_COUNT_COLUMN, ILIAS\Calendar\Shared\Inbox\TableBuilder\CREATED_ON_COLUMN, ILIAS\Repository\int(), ILIAS\Calendar\Shared\Inbox\TableBuilder\NAME_COLUMN, and ILIAS\Calendar\Shared\Inbox\TableBuilder\OWNER_COLUMN.

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Calendar\Shared\Inbox\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 99 of file DataRetrieval.php.

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

Field Documentation

$open_invitations

array ILIAS\Calendar\Shared\Inbox\DataRetrieval::$open_invitations

protected

Definition at line 34 of file DataRetrieval.php.

---

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

• components/ILIAS/Calendar/classes/Shared/Inbox/DataRetrieval.php