Inheritance diagram for ILIAS\BookingManager\BookableItem\Table\BookableItemTable:

Collaboration diagram for ILIAS\BookingManager\BookableItem\Table\BookableItemTable:

Public Member Functions
	__construct (protected readonly UIFactory $ui_factory, protected readonly UIRenderer $ui_renderer, protected readonly ilLanguage $lng, protected readonly HttpService $http, protected readonly ilUIService $ui_service, protected readonly ilCtrlInterface $ctrl, protected readonly ilGlobalTemplateInterface $tpl, protected readonly Refinery $refinery, protected readonly AccessManager $access, protected readonly ilObjBookingPool $pool, protected readonly BookingProcessManager $process_manager, protected readonly Settings $settings, protected readonly ilObjUser $user, protected readonly int $ref_id, protected readonly bool $active_management, protected readonly int $booking_context_obj_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 string	ROW_ID_PARAMETER = 'bookable_item_row'

const string	ACTION_PARAMETER = 'action'

const string	ACTION_TYPE_PARAMETER = 'action_type'

Protected Member Functions
	getColumns ()

	getFilterInputs ()

	loadRecords (mixed $filter_data)

	buildRowCells (array $record)

	sortRecords (Order $order, array $records)

	getSortCallable (string $key, int $direction)

	limitRecords (Range $range, array $records)

	getFilterComponent ()

	acquireParameters (URLBuilder $url_builder)

	getTableActions ()

	loadFilteredBookingObjects (?string $title_filter, ?string $description_filter, ?array $object_ids_filter)

	getReservationsForObject (int $booking_object_id)

	buildAvailabilityCell (int $available, int $total)

Private Member Functions
	presetFilterInputs (array $filter_inputs)

Private Attributes
array	$reservation_cache = []

TableActions	$table_actions = null

Detailed Description

Definition at line 54 of file BookableItemTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::__construct	(	protected readonly UIFactory	$ui_factory,
		protected readonly UIRenderer	$ui_renderer,
		protected readonly ilLanguage	$lng,
		protected readonly HttpService	$http,
		protected readonly ilUIService	$ui_service,
		protected readonly ilCtrlInterface	$ctrl,
		protected readonly ilGlobalTemplateInterface	$tpl,
		protected readonly Refinery	$refinery,
		protected readonly AccessManager	$access,
		protected readonly ilObjBookingPool	$pool,
		protected readonly BookingProcessManager	$process_manager,
		protected readonly Settings	$settings,
		protected readonly ilObjUser	$user,
		protected readonly int	$ref_id,
		protected readonly bool	$active_management,
		protected readonly int	$booking_context_obj_id
	)

Definition at line 71 of file BookableItemTable.php.

88 {

89 }

Member Function Documentation

◆ acquireParameters()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::acquireParameters ( URLBuilder $url_builder )

protected

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

Definition at line 258 of file BookableItemTable.php.

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

References ILIAS\UI\URLBuilder\acquireParameters().

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildAvailabilityCell()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::buildAvailabilityCell	(	int	$available,
		int	$total
	)

protected

Definition at line 347 of file BookableItemTable.php.

                                                                        : string
    {
        $icon = $this->ui_factory->symbol()->icon()->custom(
            ilUtil::getImagePath($available > 0 ? 'standard/icon_ok.svg' : 'standard/icon_not_ok.svg'),
            $this->lng->txt($available > 0 ? 'book_book' : 'book_no_objects')
        );
        return "{$this->ui_renderer->render($icon)} ({$available} / {$total})";
    }

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

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable\buildRowCells(), and ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable\buildRowCells().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildRowCells()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::buildRowCells ( array $record )

abstractprotected

Returns: array<string, mixed>

Reimplemented in ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable, and ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable.

◆ getColumns()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getColumns ( )

abstractprotected

Returns: array<string, Column>

Reimplemented in ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable, and ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable.

◆ getComponents()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getComponents ( URLBuilder $url_builder )

Returns: Component[]

Implements ILIAS\BookingManager\Common\Table\Table.

Definition at line 99 of file BookableItemTable.php.

                                                          : array
    {
        $components = [];
 
        if ($this->pool->getScheduleType() === ilObjBookingPool::TYPE_NO_SCHEDULE) {
            $booking_count = ilBookingReservation::isBookingPoolLimitReachedByUser(
                $this->user->getId(),
                $this->pool->getId()
            );
 
            if ($this->pool->getOverallLimit() <= $booking_count) {
                $components[] = $this->ui_factory->messageBox()->info($this->lng->txt('book_overall_limit_warning'));
            }
        }
 
        $components[] = $filter = $this->getFilterComponent();
        $filter_data = $this->ui_service->filter()->getData($filter);
 
        $components[] = $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('book_booking_objects'),
            $this->getColumns()
        )
            ->withActions($this->getTableActions()->getEnabledActions(...$this->acquireParameters($url_builder)))
            ->withRequest($this->http->getRequest())
            ->withId($this->getTableId())
            ->withFilter($filter_data)
            ->withOrder(new Order($this instanceof BookableItemWithScheduleTable ? 'date_time' : 'title', Order::ASC));
 
        return array_filter($components);
    }

References $components, ILIAS\BookingManager\BookableItem\Table\BookableItemTable\acquireParameters(), ILIAS\Data\Order\ASC, ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getFilterComponent(), ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getTableActions(), ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getTableId(), ILIAS\FileDelivery\http(), ilBookingReservation\isBookingPoolLimitReachedByUser(), ILIAS\Repository\lng(), ilObjBookingPool\TYPE_NO_SCHEDULE, and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getFilterComponent()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getFilterComponent ( )

protected

Definition at line 225 of file BookableItemTable.php.

                                           : FilterComponent
    {
        $filter_inputs = $this->getFilterInputs();
 
        $filter_inputs = $this->presetFilterInputs($filter_inputs);
 
        return $this->ui_service->filter()->standard(
            "bookable_item_filter_{$this->pool->getId()}",
            $this->ctrl->getLinkTargetByClass(ilBookingObjectGUI::class),
            $filter_inputs,
            array_fill(0, count($filter_inputs), true),
            true,
            true
        );
    }

References ILIAS\Repository\ctrl().

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterInputs()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getFilterInputs ( )

abstractprotected

Returns: array<string, mixed>

Reimplemented in ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable, and ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable.

◆ getReservationsForObject()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getReservationsForObject ( int $booking_object_id )

protected

Returns: array{user_id: int, status: ?int, date_from: int, date_to: int}[]

Definition at line 327 of file BookableItemTable.php.

                                                                       : array
    {
        if (isset($this->reservation_cache[$booking_object_id])) {
            return $this->reservation_cache[$booking_object_id];
        }
 
        $list = ilBookingReservation::getList([$booking_object_id], 1000, 0, []);
        $this->reservation_cache[$booking_object_id] = array_values(array_map(
            static fn(array $row): array => [
                'user_id' => (int) $row['user_id'],
                'status' => isset($row['status']) ? (int) $row['status'] : null,
                'date_from' => (int) $row['date_from'],
                'date_to' => (int) $row['date_to'],
            ],
            $list['data'] ?? []
        ));
 
        return $this->reservation_cache[$booking_object_id];
    }

References ilBookingReservation\getList().

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable\hasActiveReservations(), and ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable\loadRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::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 139 of file BookableItemTable.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['row_id'], $this->buildRowCells($record)),
                $record
            );
        }
    }

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

Here is the call graph for this function:

◆ getSortCallable()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getSortCallable	(	string	$key,
		int	$direction
	)

protected

Reimplemented in ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable.

Definition at line 203 of file BookableItemTable.php.

                                                                   : ?callable
    {
        return match ($key) {
            'availability' => static fn(array $a, array $b): int
                => ((int) $a['available'] <=> (int) $b['available']) * $direction,
            'title' => static fn(array $a, array $b): int
                => strcasecmp((string) $a['title'], (string) $b['title']) * $direction,
            'description' => static fn(array $a, array $b): int
                => strcasecmp((string) $a['description'], (string) $b['description']) * $direction,
            default => null,
        };
    }

References Vendor\Package\$a, Vendor\Package\$b, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getTableActions()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getTableActions ( )

protected

Definition at line 268 of file BookableItemTable.php.

                                        : TableActions
    {
        return $this->table_actions ??= (new BookableItemTableActionsFactory(
            $this->ctrl,
            $this->lng,
            $this->tpl,
            $this->ui_factory,
            $this->ui_renderer,
            $this->refinery,
            $this->http,
            $this->access,
            $this->pool,
            $this->process_manager,
            $this->user,
            $this->ref_id,
            $this->active_management,
            $this->booking_context_obj_id,
            array_column($this->loadRecords([]), null, 'row_id'),
        ))->getTableActions();
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\BookingManager\Common\Table\getTableActions(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getComponents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableId()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::getTableId ( )

Implements ILIAS\BookingManager\Common\Table\Table.

Definition at line 91 of file BookableItemTable.php.

                                : string
    {
        return static::ID;
    }

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemTable\getComponents().

Here is the caller graph for this function:

◆ getTotalRowCount()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::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 131 of file BookableItemTable.php.

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

◆ limitRecords()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::limitRecords	(	Range	$range,
		array	$records
	)

protected

Parameters

array<string,mixed>[] $records

Returns: array<string, mixed>[]

Definition at line 220 of file BookableItemTable.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:

◆ loadFilteredBookingObjects()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::loadFilteredBookingObjects	(	?string	$title_filter,
		?string	$description_filter,
		?array	$object_ids_filter
	)

protected

Returns: array<string, mixed>[]

Definition at line 292 of file BookableItemTable.php.

     : array {
        $items = ilBookingObject::getList($this->pool->getId());
        $title_filter = mb_strtolower($title_filter ?? '') ?: null;
        $description_filter = mb_strtolower($description_filter ?? '') ?: null;
        $object_ids_filter = $object_ids_filter ?: null;
 
        $filtered = [];
        foreach ($items as $item) {
            $object_id = (int) $item['booking_object_id'];
 
            if ($object_ids_filter !== null && !in_array($object_id, $object_ids_filter, true)) {
                continue;
            }
 
            if ($title_filter !== null && !str_contains(mb_strtolower((string) $item['title']), $title_filter)) {
                continue;
            }
 
            if ($description_filter !== null && !str_contains(mb_strtolower((string) ($item['description'] ?? '')), $description_filter)) {
                continue;
            }
 
            $filtered[] = $item;
        }
 
        return $filtered;
    }

References ILIAS\Repository\int().

Referenced by ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable\loadRecords(), and ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable\loadRecords().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRecords()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::loadRecords ( mixed $filter_data )

abstractprotected

Returns: array<string, mixed>[]

Reimplemented in ILIAS\BookingManager\BookableItem\Table\BookableItemWithoutScheduleTable, and ILIAS\BookingManager\BookableItem\Table\BookableItemWithScheduleTable.

◆ presetFilterInputs()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::presetFilterInputs ( array $filter_inputs )

private

Definition at line 241 of file BookableItemTable.php.

                                                             : array
    {
        if ($this->settings->getReservationPeriod() > 0) {
            $filter_inputs['period'] = $filter_inputs['period']->withValue(
                [
                    new DateTimeImmutable('today 00:00:00'),
                    new DateTimeImmutable("today +{$this->settings->getReservationPeriod()} days 23:59:59")
                ]
            );
        }
 
        return $filter_inputs;
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ sortRecords()

ILIAS\BookingManager\BookableItem\Table\BookableItemTable::sortRecords	(	Order	$order,
		array	$records
	)

protected

Parameters

array<string,mixed>[] $records

Returns: array<string, mixed>[]

Definition at line 182 of file BookableItemTable.php.

                                                                : array
    {
        $order_data = $order->get();
        if ($order_data === []) {
            return $records;
        }
 
        foreach ($order_data as $key => $direction) {
            $order_direction = $direction === Order::DESC ? -1 : 1;
            $callable = $this->getSortCallable($key, $order_direction);
 
            if ($callable === null) {
                continue;
            }
 
            usort($records, $callable);
        }
 
        return $records;
    }

References ILIAS\Data\Order\get().

Here is the call graph for this function:

Field Documentation

◆ $reservation_cache

array ILIAS\BookingManager\BookableItem\Table\BookableItemTable::$reservation_cache = []

private

Definition at line 67 of file BookableItemTable.php.

◆ $table_actions

TableActions ILIAS\BookingManager\BookableItem\Table\BookableItemTable::$table_actions = null

private

Definition at line 69 of file BookableItemTable.php.

◆ ACTION_PARAMETER

const string ILIAS\BookingManager\BookableItem\Table\BookableItemTable::ACTION_PARAMETER = 'action'

Definition at line 60 of file BookableItemTable.php.

◆ ACTION_TYPE_PARAMETER

const string ILIAS\BookingManager\BookableItem\Table\BookableItemTable::ACTION_TYPE_PARAMETER = 'action_type'

Definition at line 62 of file BookableItemTable.php.

◆ ROW_ID_PARAMETER

const string ILIAS\BookingManager\BookableItem\Table\BookableItemTable::ROW_ID_PARAMETER = 'bookable_item_row'

Definition at line 58 of file BookableItemTable.php.

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

components/ILIAS/BookingManager/src/BookableItem/Table/BookableItemTable.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acquireParameters()

◆ buildAvailabilityCell()

◆ buildRowCells()

◆ getColumns()

◆ getComponents()

◆ getFilterComponent()

◆ getFilterInputs()

◆ getReservationsForObject()

◆ getRows()

◆ getSortCallable()

◆ getTableActions()

◆ getTableId()

◆ getTotalRowCount()

◆ limitRecords()

◆ loadFilteredBookingObjects()

◆ loadRecords()

◆ presetFilterInputs()

◆ sortRecords()

Field Documentation

◆ $reservation_cache

◆ $table_actions

◆ ACTION_PARAMETER

◆ ACTION_TYPE_PARAMETER

◆ ROW_ID_PARAMETER