Inheritance diagram for ILIAS\BookingManager\Participant\Table\ParticipantTable:

Collaboration diagram for ILIAS\BookingManager\Participant\Table\ParticipantTable:

Public Member Functions
	__construct (private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly ilLanguage $lng, private readonly HttpService $http, private readonly ilUIService $ui_service, private readonly ilCtrlInterface $ctrl, private readonly ilGlobalTemplateInterface $tpl, private readonly Refinery $refinery, private readonly AccessManager $access, private readonly ParticipantRepository $participant_repository, private readonly int $ref_id, private readonly int $pool_id,)
	@phpstan-type ParticipantRecord array{user_id: int, name: string, object_title: array<string>, obj_count: int, object_ids: array<int>} More...

	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 = 'bksp'

const	ROW_ID_PARAMETER = 'participant_id'

const	ACTION_PARAMETER = 'action'

const	ACTION_TYPE_PARAMETER = 'action_type'

Protected Member Functions
	sortRecords (Order $order, array $records)

	limitRecords (Range $range, array $records)

	acquireParameters (URLBuilder $url_builder)

	getTableActions ()

Private Member Functions
	getColumns ()

	loadRecords (?array $filter_data)

	getFilterComponent (string $action)

Detailed Description

Definition at line 49 of file ParticipantTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\BookingManager\Participant\Table\ParticipantTable::__construct	(	private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly ilLanguage	$lng,
		private readonly HttpService	$http,
		private readonly ilUIService	$ui_service,
		private readonly ilCtrlInterface	$ctrl,
		private readonly ilGlobalTemplateInterface	$tpl,
		private readonly Refinery	$refinery,
		private readonly AccessManager	$access,
		private readonly ParticipantRepository	$participant_repository,
		private readonly int	$ref_id,
		private readonly int	$pool_id
	)

@phpstan-type ParticipantRecord array{user_id: int, name: string, object_title: array<string>, obj_count: int, object_ids: array<int>}

Definition at line 64 of file ParticipantTable.php.

77 {

78 }

Member Function Documentation

◆ acquireParameters()

ILIAS\BookingManager\Participant\Table\ParticipantTable::acquireParameters ( URLBuilder $url_builder )

protected

Returns: array{URLBuilder, URLBuilderToken, URLBuilderToken, URLBuilderToken}

Definition at line 240 of file ParticipantTable.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\Participant\Table\ParticipantTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\BookingManager\Participant\Table\ParticipantTable::getColumns ( )

private

Returns: array<string, Column>

Definition at line 139 of file ParticipantTable.php.

                                 : array
    {
        $column_factory = $this->ui_factory->table()->column();
        return [
            'name' => $column_factory->text($this->lng->txt('name'))->withIsSortable(true),
            'bookable_item' => $column_factory->text($this->lng->txt('book_bobj'))->withIsSortable(false),
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getComponents()

ILIAS\BookingManager\Participant\Table\ParticipantTable::getComponents ( URLBuilder $url_builder )

Returns: array<Component>

Implements ILIAS\BookingManager\Common\Table\Table.

Definition at line 88 of file ParticipantTable.php.

                                                          : array
    {
        $filter = $this->getFilterComponent($url_builder->buildURI()->__toString());
 
        $table = $this->ui_factory->table()->data($this, $this->lng->txt('participants'), $this->getColumns())
            ->withActions($this->getTableActions()->getEnabledActions(...$this->acquireParameters($url_builder)))
            ->withRequest($this->http->getRequest())
            ->withId($this->getTableId())
            ->withFilter($this->ui_service->filter()->getData($filter));
 
        return [$filter, $table];
    }

References ILIAS\BookingManager\Participant\Table\ParticipantTable\acquireParameters(), ILIAS\UI\URLBuilder\buildURI(), ILIAS\BookingManager\Participant\Table\ParticipantTable\getFilterComponent(), ILIAS\BookingManager\Participant\Table\ParticipantTable\getTableActions(), ILIAS\BookingManager\Participant\Table\ParticipantTable\getTableId(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getFilterComponent()

ILIAS\BookingManager\Participant\Table\ParticipantTable::getFilterComponent ( string $action )

private

Definition at line 205 of file ParticipantTable.php.

                                                       : FilterComponent
    {
        $bookable_items = [];
        foreach (ilBookingObject::getList($this->pool_id) as $item) {
            $bookable_items[$item['booking_object_id']] = $item['title'];
        }
 
        $field_factory = $this->ui_factory->input()->field();
        $filter_inputs = [
            'bookable_item_id' => $field_factory->select(
                $this->lng->txt('book_bobj'),
                array_replace(['-1' => $this->lng->txt('book_no_objects')], $bookable_items)
            ),
            'bookable_item_title' => $field_factory->text(
                "{$this->lng->txt('book_bobj')} {$this->lng->txt('title')}/{$this->lng->txt('description')}"
            ),
            'participant_id' => $field_factory->select(
                $this->lng->txt('book_participant'),
                ilBookingParticipant::getUserFilter($this->pool_id)
            ),
        ];
 
        return $this->ui_service->filter()->standard(
            "participant_filter_{$this->pool_id}",
            $action,
            $filter_inputs,
            array_fill(0, count($filter_inputs), true),
            true,
            true
        );
    }

References ilBookingObject\getList(), ilBookingParticipant\getUserFilter(), and ILIAS\Repository\lng().

Referenced by ILIAS\BookingManager\Participant\Table\ParticipantTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\Test\Participants\ParticipantTable::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 109 of file ParticipantTable.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['user_id'],
                    [
                        'name' => $record['name'] ?? '',
                        'bookable_item' => $this->ui_renderer->render(
                            $this->ui_factory->listing()->unordered($record['object_title'] ?? [])
                        ),
                    ]
                ),
                $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\Participant\Table\ParticipantTable::getTableActions ( )

protected

Definition at line 250 of file ParticipantTable.php.

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

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

Referenced by ILIAS\BookingManager\Participant\Table\ParticipantTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableId()

ILIAS\BookingManager\Participant\Table\ParticipantTable::getTableId ( )

Implements ILIAS\BookingManager\Common\Table\Table.

Definition at line 80 of file ParticipantTable.php.

                                : string
    {
        return self::ID;
    }

References ILIAS\BookingManager\Participant\Table\ParticipantTable\ID.

Referenced by ILIAS\BookingManager\Participant\Table\ParticipantTable\getComponents().

Here is the caller graph for this function:

◆ getTotalRowCount()

ILIAS\BookingManager\Participant\Table\ParticipantTable::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 101 of file ParticipantTable.php.

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

◆ limitRecords()

ILIAS\BookingManager\Participant\Table\ParticipantTable::limitRecords	(	Range	$range,
		array	$records
	)

protected

Definition at line 200 of file ParticipantTable.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\Participant\Table\ParticipantTable::loadRecords ( ?array $filter_data )

private

Definition at line 148 of file ParticipantTable.php.

                                                     : array
    {
        $filter = [];
 
        if (isset($filter_data['bookable_item_id']) && $filter_data['bookable_item_id'] !== '') {
            $filter['object'] = (int) $filter_data['bookable_item_id'];
        }
 
        if (isset($filter_data['bookable_item_title']) && $filter_data['bookable_item_title'] !== '') {
            $filter['title'] = (string) $filter_data['bookable_item_title'];
        }
 
        if (isset($filter_data['participant_id']) && $filter_data['participant_id'] !== '') {
            $filter['user_id'] = (int) $filter_data['participant_id'];
        }
 
        $filter_object = isset($filter['object']) ? (int) $filter['object'] : null;
        if ($filter_object === -1) {
            return array_filter(
                ilBookingParticipant::getList($this->pool_id, $filter),
                static fn(array $item): bool => ($item['obj_count'] ?? 0) === 0
            );
        }
 
        return ilBookingParticipant::getList($this->pool_id, $filter, $filter_object);
    }

References ilBookingParticipant\getList(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ sortRecords()

ILIAS\BookingManager\Participant\Table\ParticipantTable::sortRecords	(	Order	$order,
		array	$records
	)

protected

Definition at line 175 of file ParticipantTable.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) {
                'name' => static fn(array $a, array $b): int => strcmp($a['name'], $b['name']) * $order_direction,
                'bookable_item' => static fn(array $a, array $b): int => strcmp($a['bookable_item'], $b['bookable_item']) * $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\Participant\Table\ParticipantTable::ACTION_PARAMETER = 'action'

Definition at line 57 of file ParticipantTable.php.

◆ ACTION_TYPE_PARAMETER

const ILIAS\BookingManager\Participant\Table\ParticipantTable::ACTION_TYPE_PARAMETER = 'action_type'

Definition at line 59 of file ParticipantTable.php.

◆ ID

const ILIAS\BookingManager\Participant\Table\ParticipantTable::ID = 'bksp'

Definition at line 53 of file ParticipantTable.php.

Referenced by ILIAS\BookingManager\Participant\Table\ParticipantTable\getTableId().

◆ ROW_ID_PARAMETER

const ILIAS\BookingManager\Participant\Table\ParticipantTable::ROW_ID_PARAMETER = 'participant_id'

Definition at line 55 of file ParticipantTable.php.

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

components/ILIAS/BookingManager/src/Participant/Table/ParticipantTable.php
components/ILIAS/Test/src/Participants/ParticipantTable.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireParameters()

◆ getColumns()

◆ getComponents()

◆ getFilterComponent()

◆ getRows()

◆ getTableActions()

◆ getTableId()

◆ getTotalRowCount()

◆ limitRecords()

◆ loadRecords()

◆ sortRecords()

Field Documentation

◆ ACTION_PARAMETER

◆ ACTION_TYPE_PARAMETER

◆ ID

◆ ROW_ID_PARAMETER