Inheritance diagram for ILIAS\Calendar\ConsultationHours\BookingTableGUI:

Collaboration diagram for ILIAS\Calendar\ConsultationHours\BookingTableGUI:

Public Member Functions
	__construct (BookingDataProvider $provider)

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

	get ()

	render ()

Data Fields
const	ACTION_TOKEN = 'action'

const	ID_TOKEN = 'id'

const	TABLE_NS = 'ch_booking_table'

const	ACTION_TOKEN_NS = self::TABLE_NS . '_' . self::ACTION_TOKEN

const	ID_TOKEN_NS = self::TABLE_NS . '_' . self::ID_TOKEN

Protected Member Functions
	getActions ()

	getColumns ()

Protected Attributes
BookingDataProvider	$provider

readonly ilLanguage	$lng

readonly ilObjUser	$user

readonly ilCtrl	$ctrl

readonly UIFactory	$ui_factory

readonly DataFactory	$data_factory

readonly ServerRequestInterface	$http_request

Renderer	$ui_renderer

Detailed Description

Definition at line 38 of file BookingTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::__construct ( BookingDataProvider $provider )

Definition at line 60 of file BookingTableGUI.php.

References $DIC, ILIAS\Calendar\ConsultationHours\BookingTableGUI\$provider, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->provider = $provider;
 
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
 
         $this->http_request = $DIC->http()->request();
         $this->ui_factory = $DIC->ui()->factory();
         $this->data_factory = new DataFactory();
         $this->ui_renderer = $DIC->ui()->renderer();
     }

Here is the call graph for this function:

Member Function Documentation

◆ get()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::get ( )

Definition at line 103 of file BookingTableGUI.php.

References ILIAS\Calendar\ConsultationHours\BookingTableGUI\getActions(), ILIAS\Calendar\ConsultationHours\BookingTableGUI\getColumns(), and ILIAS\Repository\lng().

                          : Data
     {
         return $this->ui_factory
             ->table()
             ->data(
                 $this->lng->txt('cal_ch_ch'),
                 $this->getColumns(),
                 $this
             )
             ->withId(self::class)
             ->withActions($this->getActions())
             ->withRequest($this->http_request);
     }

Here is the call graph for this function:

◆ getActions()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::getActions ( )

protected

Returns: array<string, >

Definition at line 121 of file BookingTableGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\Calendar\ConsultationHours\BookingTableGUI\get().

                                    : array
     {
         $uri_command_handler = $this->data_factory->uri(
             ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                 ilConsultationHoursGUI::class,
                 'handleBookingTableActions'
             )
         );
 
         [
             $url_builder,
             $action_parameter_token,
             $row_id_token
         ] =
             (new URLBuilder($uri_command_handler))->acquireParameters(
                 [self::TABLE_NS],
                 self::ACTION_TOKEN,
                 self::ID_TOKEN
             );
 
         return [
             'edit' => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('edit'),
                 $url_builder->withParameter($action_parameter_token, 'edit'),
                 $row_id_token
             ),
             'searchUsersForAppointments' => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('cal_ch_assign_participants'),
                 $url_builder->withParameter($action_parameter_token, 'searchUsersForAppointments'),
                 $row_id_token
             ),
             'confirmCancelBooking' => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('cal_ch_cancel_booking'),
                 $url_builder->withParameter($action_parameter_token, 'confirmCancelBooking'),
                 $row_id_token
             )->withAsync(true),
             'confirmDeleteBooking' => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('cal_ch_delete_booking'),
                 $url_builder->withParameter($action_parameter_token, 'confirmDeleteBooking'),
                 $row_id_token
             )->withAsync(true),
             'confirmDeleteAppointments' => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('delete'),
                 $url_builder->withParameter($action_parameter_token, 'confirmDeleteAppointments'),
                 $row_id_token
             )->withAsync(true),
             'sendMail' => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('cal_ch_send_mail'),
                 $url_builder->withParameter($action_parameter_token, 'sendMail'),
                 $row_id_token
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::getColumns ( )

protected

Returns: array<string, >

Definition at line 178 of file BookingTableGUI.php.

References ILIAS\Repository\lng(), ilCalendarSettings\TIME_FORMAT_12, and ILIAS\Repository\user().

Referenced by ILIAS\Calendar\ConsultationHours\BookingTableGUI\get().

                                    : array
     {
         if ($this->user->getTimeFormat() === \ilCalendarSettings::TIME_FORMAT_12) {
             $format = $this->data_factory->dateFormat()->withTime12($this->user->getDateFormat());
         } else {
             $format = $this->data_factory->dateFormat()->withTime24($this->user->getDateFormat());
         }
 
         return [
             'booking_start' => $this->ui_factory
                 ->table()
                 ->column()
                 ->date($this->lng->txt('cal_ch_booking_start'), $format)
                 ->withIsSortable(true),
             'booking_duration' => $this->ui_factory
                 ->table()
                 ->column()
                 ->number($this->lng->txt('cal_ch_minutes'))
                 ->withIsSortable(true),
             'booking_title' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('title'))
                 ->withIsSortable(true),
             'booking_participant' => $this->ui_factory
                     ->table()
                     ->column()
                     ->linkListing($this->lng->txt('cal_ch_booking_participants')),
             'booking_comment' => $this->ui_factory
                 ->table()
                 ->column()
                 ->linkListing($this->lng->txt('cal_ch_booking_col_comments')),
             'booking_location' => $this->ui_factory
                 ->table()
                 ->column()
                 ->linkListing($this->lng->txt('cal_ch_target_object'))
         ];
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$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 76 of file BookingTableGUI.php.

References $id, and ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

      : Generator {
         $records = $this->provider->limitData($range, $order);
         foreach ($records as $row) {
             $id = $row['id'];
             $records_row = $row_builder->buildDataRow($id, $row);
             if (count($row['booking_participant']->getItems()) === 0) {
                 $records_row = $records_row
                     ->withDisabledAction('confirmCancelBooking')
                     ->withDisabledAction('confirmDeleteBooking')
                     ->withDisabledAction('sendMail');
             }
             yield $records_row;
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::getTotalRowCount	(	?array	$filter_data,
		?array	$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 98 of file BookingTableGUI.php.

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

◆ render()

ILIAS\Calendar\ConsultationHours\BookingTableGUI::render ( )

Definition at line 218 of file BookingTableGUI.php.

                             : string
     {
         return $this->ui_renderer->render(
             [
                 $this->get()
             ]
         );
     }

Field Documentation

◆ $ctrl

readonly ilCtrl ILIAS\Calendar\ConsultationHours\BookingTableGUI::$ctrl

protected

Definition at line 53 of file BookingTableGUI.php.

◆ $data_factory

readonly DataFactory ILIAS\Calendar\ConsultationHours\BookingTableGUI::$data_factory

protected

Definition at line 55 of file BookingTableGUI.php.

◆ $http_request

readonly ServerRequestInterface ILIAS\Calendar\ConsultationHours\BookingTableGUI::$http_request

protected

Definition at line 56 of file BookingTableGUI.php.

◆ $lng

readonly ilLanguage ILIAS\Calendar\ConsultationHours\BookingTableGUI::$lng

protected

Definition at line 51 of file BookingTableGUI.php.

◆ $provider

BookingDataProvider ILIAS\Calendar\ConsultationHours\BookingTableGUI::$provider

protected

Definition at line 49 of file BookingTableGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingTableGUI\__construct().

◆ $ui_factory

readonly UIFactory ILIAS\Calendar\ConsultationHours\BookingTableGUI::$ui_factory

protected

Definition at line 54 of file BookingTableGUI.php.

◆ $ui_renderer

Renderer ILIAS\Calendar\ConsultationHours\BookingTableGUI::$ui_renderer

protected

Definition at line 57 of file BookingTableGUI.php.

◆ $user

readonly ilObjUser ILIAS\Calendar\ConsultationHours\BookingTableGUI::$user

protected

Definition at line 52 of file BookingTableGUI.php.

◆ ACTION_TOKEN

const ILIAS\Calendar\ConsultationHours\BookingTableGUI::ACTION_TOKEN = 'action'

Definition at line 40 of file BookingTableGUI.php.

◆ ACTION_TOKEN_NS

const ILIAS\Calendar\ConsultationHours\BookingTableGUI::ACTION_TOKEN_NS = self::TABLE_NS . '_' . self::ACTION_TOKEN

Definition at line 44 of file BookingTableGUI.php.

◆ ID_TOKEN

const ILIAS\Calendar\ConsultationHours\BookingTableGUI::ID_TOKEN = 'id'

Definition at line 41 of file BookingTableGUI.php.

◆ ID_TOKEN_NS

const ILIAS\Calendar\ConsultationHours\BookingTableGUI::ID_TOKEN_NS = self::TABLE_NS . '_' . self::ID_TOKEN

Definition at line 46 of file BookingTableGUI.php.

◆ TABLE_NS

const ILIAS\Calendar\ConsultationHours\BookingTableGUI::TABLE_NS = 'ch_booking_table'

Definition at line 42 of file BookingTableGUI.php.

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

components/ILIAS/Calendar/classes/ConsultationHours/BookingTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ get()

◆ getActions()

◆ getColumns()

◆ getRows()

◆ getTotalRowCount()

◆ render()

Field Documentation

◆ $ctrl

◆ $data_factory

◆ $http_request

◆ $lng

◆ $provider

◆ $ui_factory

◆ $ui_renderer

◆ $user

◆ ACTION_TOKEN

◆ ACTION_TOKEN_NS

◆ ID_TOKEN

◆ ID_TOKEN_NS

◆ TABLE_NS