Inheritance diagram for ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable:

Collaboration diagram for ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable:

Public Member Functions
	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\Bookings\Table\BookingsTable
	__construct (protected readonly UIFactory $ui_factory, protected readonly UIRenderer $ui_renderer, protected readonly AccessManager $access, protected readonly ilGlobalTemplateInterface $tpl, protected readonly Refinery $refinery, protected readonly Language $lng, protected readonly HttpService $http, protected readonly ilObjUser $user, protected readonly ReservationDBRepository $reservation_repository, protected readonly ilCtrlInterface $ctrl, protected readonly ilUIService $ui_service, protected readonly Settings $settings, protected readonly ilObjBookingPool $booking_pool)

	getTableId ()

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

	getFilter ()

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

	getComponents (URLBuilder $url_builder)

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	ID = 'bkbws'

Data Fields inherited from ILIAS\BookingManager\Bookings\Table\BookingsTable
const	ROW_ID_PARAMETER = 'booking_id'

const	ACTION_PARAMETER = 'action'

const	ACTION_TYPE_PARAMETER = 'action_type'

Protected Member Functions
	getColumns ()

	getFilterInputs ()

	getTimeSlots ()

	getBookingTimeSlotFilterLabel (array $booking)

Protected Member Functions inherited from ILIAS\BookingManager\Bookings\Table\BookingsTable
	getUserPresentationName (int $user_id)

	getColumns ()

	getFilterInputs ()

	loadRecords (mixed $filter_data)

	sortRecords (Order $order, array $records)

	limitRecords (Range $range, array $records)

	acquireParameters (URLBuilder $url_builder)

	getUsers (?int $user_id=null)

	getStatuses ()

	getTableActions ()

	getUserComponent (int $user_id)

	getBookingTimeSlotFilterLabel (array $booking)

Private Member Functions
	isAllDayBooking (array $booking)

	getSchedule (int $schedule_id)

Private Attributes
array	$schedule_cache = []

Additional Inherited Members
Protected Attributes inherited from ILIAS\BookingManager\Bookings\Table\BookingsTable
readonly array	$booking_items

readonly array	$bookings

readonly array	$participants

readonly ColumnFactory	$column_factory

readonly InputFactory	$input_factory

Detailed Description

Definition at line 34 of file BookingsWithScheduleTable.php.

Member Function Documentation

◆ getBookingTimeSlotFilterLabel()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::getBookingTimeSlotFilterLabel ( array $booking )

protected

Reimplemented from ILIAS\BookingManager\Bookings\Table\BookingsTable.

Definition at line 172 of file BookingsWithScheduleTable.php.

                                                                    : string
    {
        return $this->isAllDayBooking($booking)
            ? $this->lng->txt('book_all_day')
            : parent::getBookingTimeSlotFilterLabel($booking);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getColumns()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::getColumns ( )

protected

Reimplemented from ILIAS\BookingManager\Bookings\Table\BookingsTable.

Definition at line 90 of file BookingsWithScheduleTable.php.

                                   : array
    {
        $columns = [
            'title' => $this->column_factory->text($this->lng->txt('title')),
            'status' => $this->column_factory->text($this->lng->txt('status')),
            'date' => $this->column_factory->date(
                $this->lng->txt('date'),
                new DateFormat([
                    DateFormat::DAY,
                    DateFormat::DOT,
                    DateFormat::SPACE,
                    DateFormat::MONTH_SPELLED_SHORT,
                    DateFormat::SPACE,
                    DateFormat::YEAR
                ])
            ),
            'week' => $this->column_factory->date($this->lng->txt('week'), new DateFormat([DateFormat::WEEK]))
                ->withIsOptional(true, true),
            'weekday' => $this->column_factory->date($this->lng->txt('cal_weekday'), new DateFormat([DateFormat::WEEKDAY_SHORT]))
                ->withIsOptional(true, true),
            'time_slot' => $this->column_factory->text($this->lng->txt('book_schedule_slot')),
            'unit_count' => $this->column_factory->number($this->lng->txt('book_no_of_objects')),
            'message' => $this->column_factory->text($this->lng->txt('book_message'))->withIsSortable(false),
            'user' => $this->column_factory->link($this->lng->txt('user'))
        ];
 
        if (!$this->booking_pool->usesMessages()) {
            unset($columns['message']);
        }
 
        return $columns;
    }

References ILIAS\Data\DateFormat\DateFormat\DAY, ILIAS\Data\DateFormat\DateFormat\DOT, ILIAS\Repository\lng(), ILIAS\Data\DateFormat\DateFormat\MONTH_SPELLED_SHORT, ILIAS\Data\DateFormat\DateFormat\SPACE, ILIAS\Data\DateFormat\DateFormat\WEEK, ILIAS\Data\DateFormat\DateFormat\WEEKDAY_SHORT, and ILIAS\Data\DateFormat\DateFormat\YEAR.

Here is the call graph for this function:

◆ getFilterInputs()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::getFilterInputs ( )

protected

Reimplemented from ILIAS\BookingManager\Bookings\Table\BookingsTable.

Definition at line 123 of file BookingsWithScheduleTable.php.

                                        : array
    {
        $txt_user = $this->lng->txt('user');
        if (
            $this->access->canManageAllReservations($this->booking_pool->getRefId())
            || $this->access->canReadPublicLog($this->booking_pool->getRefId())
        ) {
            $user_input = $this->input_factory->select($txt_user, $this->getUsers());
        } else {
            $user_input = $this->input_factory
                ->select($txt_user, $this->getUsers($this->user->getId()))
                ->withValue($this->user->getId())
                ->withDisabled(true);
        }
 
        return [
            'object' => $this->input_factory->select(
                $this->lng->txt('object'),
                array_column($this->booking_items, 'title', 'booking_object_id')
            ),
            'object_title_or_description' => $this->input_factory->text($this->lng->txt('book_object_title_or_description')),
            'period' => $this->input_factory->duration($this->lng->txt('book_filter_period'))
                ->withUseTime(true)
                ->withFormat($this->user->getDateTimeFormat()),
            'time_slot' => $this->input_factory->select($this->lng->txt('book_schedule_slot'), $this->getTimeSlots()),
            'past_bookings' => $this->input_factory->select(
                $this->lng->txt('book_show_past_bookings'),
                [1 => $this->lng->txt('book_past_bookings'), 2 => $this->lng->txt('book_present_bookings')]
            ),
            'status' => $this->input_factory->select($this->lng->txt('status'), $this->getStatuses()),
            'user' => $user_input
        ];
    }

References ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getRows()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::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

Reimplemented from ILIAS\BookingManager\Bookings\Table\BookingsTable.

Definition at line 43 of file BookingsWithScheduleTable.php.

     : Generator {
        $records = $this->limitRecords($range, $this->sortRecords($order, $this->loadRecords($filter_data)));
 
        foreach ($records as $record) {
            $user_id = $record['user_id'];
 
            $record['date_to']++;
 
            $date_from = new DateTimeImmutable("@{$record['date_from']}");
            $time_slot = $this->isAllDayBooking($record)
                ? $this->lng->txt('book_all_day')
                : ilDatePresentation::formatPeriod(
                    new ilDateTime($record['date_from'], IL_CAL_UNIX),
                    new ilDateTime($record['date_to'], IL_CAL_UNIX),
                    true
                );
 
            yield $this->getTableActions()->onDataRow(
                $row_builder->buildDataRow(
                    (string) $record['booking_reservation_id'],
                    [
                        'title' => (string) $record['title'],
                        'status' => $record['status'] === ilBookingReservation::STATUS_CANCELLED
                            ? $this->lng->txt('book_reservation_status_5')
                            : '',
                        'date' => $date_from,
                        'week' => $date_from,
                        'weekday' => $date_from,
                        'time_slot' => $time_slot,
                        'unit_count' => 1,
                        'message' => (string) ($record['message'] ?? ''),
                        'user' => $this->getUserComponent($user_id)
                    ]
                ),
                $record
            );
        }
    }

References $user_id, ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ilDatePresentation\formatPeriod(), ILIAS\BookingManager\Bookings\Table\BookingsTable\getTableActions(), IL_CAL_UNIX, ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable\isAllDayBooking(), ILIAS\Repository\lng(), and ilBookingReservation\STATUS_CANCELLED.

Here is the call graph for this function:

◆ getSchedule()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::getSchedule ( int $schedule_id )

private

Definition at line 189 of file BookingsWithScheduleTable.php.

                                                  : ilBookingSchedule
    {
        return $this->schedule_cache[$schedule_id] ??= new ilBookingSchedule($schedule_id);
    }

◆ getTimeSlots()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::getTimeSlots ( )

protected

Returns: string[]

Definition at line 160 of file BookingsWithScheduleTable.php.

                                     : array
    {
        $time_slots = [];
 
        foreach ($this->bookings as $booking) {
            $time_slot = $this->getBookingTimeSlotFilterLabel($booking);
            $time_slots[$time_slot] ??= $time_slot;
        }
 
        return $time_slots;
    }

◆ isAllDayBooking()

ILIAS\BookingManager\Bookings\Table\BookingsWithScheduleTable::isAllDayBooking ( array $booking )

private

Definition at line 179 of file BookingsWithScheduleTable.php.

                                                    : bool
    {
        $object_id = (int) $booking['object_id'];
        $schedule_id = (int) ($this->booking_items[$object_id]['schedule_id'] ?? 0);
 
        return
            $schedule_id !== 0
            && $this->getSchedule($schedule_id)->getScheduleType() === ilBookingSchedule::SCHEDULE_TYPE_ALL_DAY;
    }