Inheritance diagram for ILIAS\Registration\RegistrationCodesTable:

Collaboration diagram for ILIAS\Registration\RegistrationCodesTable:

Public Member Functions
	__construct (private readonly ServerRequestInterface $http_request, private readonly ilLanguage $lng, private readonly UIFactory $ui_factory, private readonly DataFactory $data_factory, private readonly ilRbacReview $rbac_review, private readonly string $action, private readonly ilObjUser $actor, private readonly RegistrationCodeRepository $code_repository, private readonly bool $has_permission_to_delete=false,)

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters,)

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)

	getActions (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token)

Private Member Functions
	getRecords (Range $range, Order $order, ?array $filter_data)

	getColumns ()

Detailed Description

Definition at line 44 of file RegistrationCodesTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Registration\RegistrationCodesTable::__construct	(	private readonly ServerRequestInterface	$http_request,
		private readonly ilLanguage	$lng,
		private readonly UIFactory	$ui_factory,
		private readonly DataFactory	$data_factory,
		private readonly ilRbacReview	$rbac_review,
		private readonly string	$action,
		private readonly ilObjUser	$actor,
		private readonly RegistrationCodeRepository	$code_repository,
		private readonly bool	$has_permission_to_delete = `false`
	)

Definition at line 46 of file RegistrationCodesTable.php.

56 {

57 }

Member Function Documentation

◆ getActions()

ILIAS\Registration\RegistrationCodesTable::getActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token
	)

Returns: array<string, Action>

Definition at line 247 of file RegistrationCodesTable.php.

References ILIAS\Repository\lng(), and ILIAS\UI\URLBuilder\withParameter().

Referenced by ILIAS\Registration\RegistrationCodesTable\getRows().

      : array {
         $actions = [
             $this->ui_factory->table()->action()->multi(
                 $this->lng->txt('registration_codes_export'),
                 $url_builder->withParameter($action_parameter_token, 'exportCodes'),
                 $row_id_token
             ),
         ];
         if ($this->has_permission_to_delete) {
             $actions[] = $this->ui_factory->table()->action()->multi(
                 $this->lng->txt('delete'),
                 $url_builder->withParameter($action_parameter_token, 'deleteConfirmation'),
                 $row_id_token
             );
         }
 
         return $actions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Registration\RegistrationCodesTable::getColumns ( )

private

Returns: array<string, Column>

Definition at line 273 of file RegistrationCodesTable.php.

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

Referenced by ILIAS\Registration\RegistrationCodesTable\getRows().

                                  : array
     {
         if ((int) $this->actor->getTimeFormat() === ilCalendarSettings::TIME_FORMAT_12) {
             $date_format = $this->data_factory->dateFormat()->withTime12($this->actor->getDateFormat());
         } else {
             $date_format = $this->data_factory->dateFormat()->withTime24($this->actor->getDateFormat());
         }
 
         return [
             'code' => $this->ui_factory->table()->column()
                 ->text($this->lng->txt('registration_code')),
             'role' => $this->ui_factory->table()->column()
                 ->text($this->lng->txt('registration_codes_roles')),
             'role_local' => $this->ui_factory->table()->column()
                 ->text($this->lng->txt('registration_codes_roles_local'))
                 ->withIsSortable(false),
             'alimit' => $this->ui_factory->table()->column()
                 ->text($this->lng->txt('reg_access_limitations'))
                 ->withIsSortable(false),
             'generated' => $this->ui_factory->table()->column()
                 ->date($this->lng->txt('registration_generated'), $date_format),
             'used' => $this->ui_factory->table()->column()
                 ->text($this->lng->txt('registration_used')),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecords()

ILIAS\Registration\RegistrationCodesTable::getRecords	(	Range	$range,
		Order	$order,
		?array	$filter_data
	)

private

Parameters

array{code string, role: int, generated: string, access_limitation: string} $filter_data

Returns: list<array{ code: string, code_id: int, generated: DateTimeImmutable, used: string|null, role: string, role_local: string|null, alimit: string|null }>

Definition at line 125 of file RegistrationCodesTable.php.

References ilObject\_lookupTitle(), ANONYMOUS_ROLE_ID, ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), ILIAS\Repository\int(), ILIAS\Data\Order\join(), ILIAS\Repository\lng(), null, ILIAS\UI\examples\Symbol\Glyph\Sort\sort(), SYSTEM_ROLE_ID, and ilCalendarSettings\TIME_FORMAT_12.

Referenced by ILIAS\Registration\RegistrationCodesTable\getRows().

                                                                                 : array
     {
         [$order_field, $order_direction] = $order->join(
             [],
             fn(array $ret, string $key, string $value): array => [$key, $value]
         );
         $filter = (new CodeFilter())->withData($filter_data);
 
         $codes_data = $this->code_repository->getCodesData(
             $order_field,
             $order_direction,
             $range->getStart(),
             $range->getLength(),
             $filter
         );
 
         if (\count($codes_data) === 0 && $range->getStart() > 0) {
             $codes_data = $this->code_repository->getCodesData(
                 $order_field,
                 $order_direction,
                 0,
                 $range->getLength(),
                 $filter
             );
         }
 
         if ((int) $this->actor->getTimeFormat() === ilCalendarSettings::TIME_FORMAT_12) {
             $date_format = $this->data_factory->dateFormat()->withTime12($this->actor->getDateFormat());
         } else {
             $date_format = $this->data_factory->dateFormat()->withTime24($this->actor->getDateFormat());
         }
 
         $role_map = [];
         foreach ($this->rbac_review->getGlobalRoles() as $role_id) {
             if (!\in_array($role_id, [SYSTEM_ROLE_ID, ANONYMOUS_ROLE_ID], true)) {
                 $role_map[$role_id] = ilObject::_lookupTitle($role_id);
             }
         }
 
         $result = [];
         foreach ($codes_data as $k => $code) {
             $result[$k]['code'] = $code['code'];
             $result[$k]['code_id'] = (int) $code['code_id'];
 
             $result[$k]['generated'] = (new DateTimeImmutable('@' . $code['generated']))->setTimezone(
                 new DateTimeZone($this->actor->getTimeZone())
             );
             if ($code['used']) {
                 $result[$k]['used'] = $date_format->applyTo(
                     (new DateTimeImmutable('@' . $code['used']))->setTimezone(
                         new DateTimeZone($this->actor->getTimeZone())
                     )
                 );
             } else {
                 $result[$k]['used'] = null;
             }
 
             if ($code['role']) {
                 $result[$k]['role'] = $role_map[$code['role']] ?? $this->lng->txt('deleted');
             } else {
                 $result[$k]['role'] = '';
             }
 
             if (\is_string($code['role_local'])) {
                 $local = [];
                 foreach (explode(';', $code['role_local']) as $role_id) {
                     $role = ilObject::_lookupTitle((int) $role_id);
                     if ($role) {
                         $local[] = $role;
                     }
                 }
                 if (\count($local)) {
                     sort($local);
                     $result[$k]['role_local'] = implode('<br />', $local);
                 }
             } else {
                 $result[$k]['role_local'] = '';
             }
 
             if ($code['alimit']) {
                 switch ($code['alimit']) {
                     case 'unlimited':
                         $result[$k]['alimit'] = $this->lng->txt('reg_access_limitation_none');
                         break;
 
                     case 'absolute':
                         $result[$k]['alimit'] = $this->lng->txt('reg_access_limitation_mode_absolute_target') .
                             ': ' .
                             $date_format->applyTo(
                                 (new DateTimeImmutable('@' . $code['alimitdt']))->setTimezone(
                                     new DateTimeZone($this->actor->getTimeZone())
                                 )
                             );
                         break;
 
                     case 'relative':
                         $limit_caption = [];
                         $limit = unserialize($code['alimitdt'], ['allowed_classes' => false]);
                         if ((int) $limit['d']) {
                             $limit_caption[] = (int) $limit['d'] . ' ' . $this->lng->txt('days');
                         }
                         if ((int) $limit['m']) {
                             $limit_caption[] = (int) $limit['m'] . ' ' . $this->lng->txt('months');
                         }
                         if ((int) $limit['y']) {
                             $limit_caption[] = (int) $limit['y'] . ' ' . $this->lng->txt('years');
                         }
                         if (\count($limit_caption)) {
                             $result[$k]['alimit'] = $this->lng->txt('reg_access_limitation_mode_relative_target') .
                                 ': ' . implode(', ', $limit_caption);
                         }
                         break;
                 }
             }
         }
 
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\Registration\RegistrationCodesTable::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Parameters

array{code string, role: int, generated: string, access_limitation: string} $filter_data

Definition at line 62 of file RegistrationCodesTable.php.

References ILIAS\Data\Order\DESC, ILIAS\Registration\RegistrationCodesTable\getActions(), ILIAS\Registration\RegistrationCodesTable\getColumns(), ILIAS\Registration\RegistrationFilterComponent\getFilterData(), ILIAS\Registration\RegistrationCodesTable\getRecords(), and ILIAS\UI\Implementation\Component\Table\withOrder().

      : Generator {
         $records = $this->getRecords($range, $order, $filter_data);
         foreach ($records as $record) {
             yield $row_builder->buildDataRow((string) $record['code_id'], $record);
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Registration\RegistrationCodesTable::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Parameters

array{code string, role: int, generated: string, access_limitation: string} $filter_data

Definition at line 106 of file RegistrationCodesTable.php.

                                                                                         : ?int
     {
         return $this->code_repository->getTotalCodeCount(
             (new CodeFilter())->withData($filter_data)
         );
     }

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

components/ILIAS/Registration/src/RegistrationCodesTable.php

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActions()

◆ getColumns()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()