ILIAS\BookingManager\Schedule\Table\ScheduleTable Class Reference

Inheritance diagram for ILIAS\BookingManager\Schedule\Table\ScheduleTable:

Collaboration diagram for ILIAS\BookingManager\Schedule\Table\ScheduleTable:

Public Member Functions
	__construct (private readonly ilCtrlInterface $ctrl, private readonly ilLanguage $lng, private readonly ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly Refinery $refinery, private readonly AccessManager $access, private readonly HttpService $http, private readonly ScheduleManager $schedule_manager, private readonly int $ref_id,)
	getTableId ()
	getComponents (URLBuilder $url_builder)
	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...
	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...
Public Member Functions inherited from ILIAS\BookingManager\Common\Table\Table
	getTableId ()
	execute (URLBuilder $url_builder)
	getComponents (URLBuilder $url_builder)
	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...

Data Fields
const	ID = 'bksd'
const	ROW_ID_PARAMETER = 'schedule_id'
const	ACTION_PARAMETER = 'action'
const	ACTION_TYPE_PARAMETER = 'action_type'

Protected Member Functions
	loadRecords (mixed $filter_data)
	sortRecords (Order $order, array $records)
	limitRecords (Range $range, array $records)
	acquireParameters (URLBuilder $url_builder)
	getTableActions ()

Private Member Functions
	getColumns ()

Detailed Description

Definition at line 46 of file ScheduleTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::__construct	(	private readonly ilCtrlInterface	$ctrl,
		private readonly ilLanguage	$lng,
		private readonly ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly Refinery	$refinery,
		private readonly AccessManager	$access,
		private readonly HttpService	$http,
		private readonly ScheduleManager	$schedule_manager,
		private readonly int	$ref_id
	)

Definition at line 58 of file ScheduleTable.php.

      {
    }

Member Function Documentation

acquireParameters()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::acquireParameters ( URLBuilder  $url_builder )

protected

Returns

array{URLBuilder, URLBuilderToken, URLBuilderToken, URLBuilderToken}

Definition at line 184 of file ScheduleTable.php.

                                                                 : array
    {
        return $url_builder->acquireParameters(
            [self::ID],
            self::ROW_ID_PARAMETER,
            self::ACTION_PARAMETER,
            self::ACTION_TYPE_PARAMETER
        );
    }

References ILIAS\UI\URLBuilder\acquireParameters().

Referenced by ILIAS\BookingManager\Schedule\Table\ScheduleTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::getColumns ( )

private

Returns

array<string, Column>

Definition at line 161 of file ScheduleTable.php.

                                 : array
    {
        $column_factory = $this->ui_factory->table()->column();
        $icon_factory = $this->ui_factory->symbol()->icon();
        return [
            'title' => $column_factory->text($this->lng->txt('title'))->withIsSortable(true),
            'is_used' => $column_factory->boolean(
                $this->lng->txt('book_is_used'),
                $icon_factory->custom(
                    ilUtil::getImagePath('standard/icon_ok.svg'),
                    $this->lng->txt('yes')
                ),
                $icon_factory->custom(
                    ilUtil::getImagePath('standard/icon_not_ok.svg'),
                    $this->lng->txt('no')
                )
            )->withIsSortable(true),
        ];
    }

References ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getComponents()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::getComponents

(

URLBuilder

$url_builder

)

Returns

array<Component>

Implements ILIAS\BookingManager\Common\Table\Table.

Definition at line 80 of file ScheduleTable.php.

                                                          : array
    {
        return [
            $this->ui_factory->table()->data($this, $this->lng->txt('book_schedules'), $this->getColumns())
                ->withActions($this->getTableActions()->getEnabledActions(...$this->acquireParameters($url_builder)))
                ->withRequest($this->http->getRequest())
                ->withId($this->getTableId())
        ];
    }

References ILIAS\BookingManager\Schedule\Table\ScheduleTable\acquireParameters(), ILIAS\BookingManager\Schedule\Table\ScheduleTable\getTableActions(), ILIAS\BookingManager\Schedule\Table\ScheduleTable\getTableId(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getRows()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::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 98 of file ScheduleTable.php.

     : Generator {
        $records = $this->limitRecords($range, $this->sortRecords($order, $this->loadRecords($filter_data)));
 
        foreach ($records as $record) {
            yield $this->getTableActions()->onDataRow(
                $row_builder->buildDataRow(
                    (string) $record['booking_schedule_id'],
                    [
                        'title' => $record['title'] ?? '',
                        'is_used' => (bool) ($record['is_used'] ?? false),
                    ]
                ),
                $record
            );
        }
    }

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), and ILIAS\BookingManager\Common\Table\getTableActions().

Here is the call graph for this function:

getTableActions()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::getTableActions ( )

protected

Definition at line 194 of file ScheduleTable.php.

                                        : TableActions
    {
        return (new ScheduleTableActionsFactory(
            $this->ctrl,
            $this->lng,
            $this->tpl,
            $this->ui_factory,
            $this->ui_renderer,
            $this->refinery,
            $this->access,
            $this->http,
            $this->schedule_manager,
            $this->ref_id,
        ))->getTableActions();
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by ILIAS\BookingManager\Schedule\Table\ScheduleTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

getTableId()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::getTableId

(

)

Implements ILIAS\BookingManager\Common\Table\Table.

Definition at line 72 of file ScheduleTable.php.

                                : string
    {
        return self::ID;
    }

References ILIAS\BookingManager\Schedule\Table\ScheduleTable\ID.

Referenced by ILIAS\BookingManager\Schedule\Table\ScheduleTable\getComponents().

Here is the caller graph for this function:

getTotalRowCount()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::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 90 of file ScheduleTable.php.

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

limitRecords()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::limitRecords ( Range  $range, array  $records  )

protected

Definition at line 153 of file ScheduleTable.php.

                                                                 : array
    {
        return array_slice($records, $range->getStart(), $range->getLength());
    }

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Here is the call graph for this function:

loadRecords()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::loadRecords ( mixed  $filter_data )

protected

Definition at line 123 of file ScheduleTable.php.

                                                      : array
    {
        return $this->schedule_manager->getScheduleData();
    }

sortRecords()

ILIAS\BookingManager\Schedule\Table\ScheduleTable::sortRecords ( Order  $order, array  $records  )

protected

Definition at line 128 of file ScheduleTable.php.

                                                                : array
    {
        $order_data = $order->get();
        if ($order_data === []) {
            return $records;
        }
 
        foreach ($order_data as $key => $value) {
            $order_direction = $value === Order::DESC ? -1 : 1;
            $callable = match ($key) {
                'title' => static fn(array $a, array $b): int => strcmp($a['title'], $b['title']) * $order_direction,
                'is_used' => static fn(array $a, array $b): int => (($a['is_used'] ?? false) <=> ($b['is_used'] ?? false)) * -$order_direction,
                default => null,
            };
 
            if ($callable === null) {
                continue;
            }
 
            usort($records, $callable);
        }
 
        return $records;
    }

References Vendor\Package\$a, Vendor\Package\$b, and ILIAS\Data\Order\get().

Here is the call graph for this function:

Field Documentation

ACTION_PARAMETER

const ILIAS\BookingManager\Schedule\Table\ScheduleTable::ACTION_PARAMETER = 'action'

Definition at line 54 of file ScheduleTable.php.

ACTION_TYPE_PARAMETER

const ILIAS\BookingManager\Schedule\Table\ScheduleTable::ACTION_TYPE_PARAMETER = 'action_type'

Definition at line 56 of file ScheduleTable.php.

ID

const ILIAS\BookingManager\Schedule\Table\ScheduleTable::ID = 'bksd'

Definition at line 50 of file ScheduleTable.php.

Referenced by ILIAS\BookingManager\Schedule\Table\ScheduleTable\getTableId().

ROW_ID_PARAMETER

const ILIAS\BookingManager\Schedule\Table\ScheduleTable::ROW_ID_PARAMETER = 'schedule_id'

Definition at line 52 of file ScheduleTable.php.

---

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

• components/ILIAS/BookingManager/src/Schedule/Table/ScheduleTable.php