Inheritance diagram for ILIAS\Certificate\Overview\CertificateOverviewTable:

Collaboration diagram for ILIAS\Certificate\Overview\CertificateOverviewTable:

Public Member Functions
	__construct (?Factory $ui_factory=null, ?ilUserCertificateRepository $repo=null, ?ilUIService $ui_service=null, ?ilLanguage $lng=null, ServerRequestInterface\|RequestInterface\|null $request=null, ?\ILIAS\Data\Factory $data_factory=null, ?ilCtrl $ctrl=null, ?Renderer $ui_renderer=null, ?ilAccessHandler $access=null, ?ilObjUser $user=null)

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

	render ()

Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	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...

Private Member Functions
	mapUiFilterData (array $filter_data)

	buildFilter ()

	buildTable ()

	buildTableRows (array $certificates)

Private Attributes
readonly ilUserCertificateRepository	$repo

readonly ilUIService	$ui_service

readonly Factory	$ui_factory

readonly ilLanguage	$lng

readonly ServerRequestInterface	$request

readonly ILIAS Data Factory	$data_factory

readonly ilCtrl ilCtrlInterface	$ctrl

readonly ILIAS UI Component Input Container Filter Standard	$filter

readonly Data	$table

readonly Renderer	$ui_renderer

readonly ilAccessHandler	$access

readonly ilObjUser	$user

readonly DateTimeZone	$user_timezone

Detailed Description

Definition at line 52 of file CertificateOverviewTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Certificate\Overview\CertificateOverviewTable::__construct	(	?Factory	$ui_factory = `null`,
		?ilUserCertificateRepository	$repo = `null`,
		?ilUIService	$ui_service = `null`,
		?ilLanguage	$lng = `null`,
		ServerRequestInterface\|RequestInterface\|null	$request = `null`,
		?\ILIAS\Data\Factory	$data_factory = `null`,
		?ilCtrl	$ctrl = `null`,
		?Renderer	$ui_renderer = `null`,
		?ilAccessHandler	$access = `null`,
		?ilObjUser	$user = `null`
	)

Definition at line 68 of file CertificateOverviewTable.php.

References $DIC, ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Repository\access(), ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Certificate\Overview\CertificateOverviewTable\buildFilter(), ILIAS\Certificate\Overview\CertificateOverviewTable\buildTable(), ILIAS\Certificate\Overview\CertificateOverviewTable\buildTableRows(), ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ILIAS\UI\Component\Table\DataRetrieval\getRows(), ILIAS\Data\Order\join(), ILIAS\Repository\lng(), ILIAS\Certificate\Overview\CertificateOverviewTable\mapUiFilterData(), and ILIAS\Repository\user().

       {
         global $DIC;
         $this->ui_factory = $ui_factory ?: $DIC->ui()->factory();
         $this->repo = $repo ?: new ilUserCertificateRepository();
         $this->ui_service = $ui_service ?: $DIC->uiService();
         $this->lng = $lng ?: $DIC->language();
         $this->request = $request ?: $DIC->http()->request();
         $this->data_factory = $data_factory ?: new \ILIAS\Data\Factory();
         $this->ctrl = $ctrl ?: $DIC->ctrl();
         $this->ui_renderer = $ui_renderer ?: $DIC->ui()->renderer();
         $this->access = $access ?: $DIC->access();
         $this->user = $user ?: $DIC->user();
         $this->user_timezone = new \DateTimeZone($this->user->getTimeZone());
 
         $this->filter = $this->buildFilter();
         $this->table = $this->buildTable();
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildFilter()

ILIAS\Certificate\Overview\CertificateOverviewTable::buildFilter ( )

private

Definition at line 171 of file CertificateOverviewTable.php.

References ilObjCertificateSettingsGUI\CMD_CERTIFICATES_OVERVIEW, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\__construct().

                                   : \ILIAS\UI\Component\Input\Container\Filter\Standard
     {
         return $this->ui_service->filter()->standard(
             'certificates_overview_filter',
             $this->ctrl->getLinkTargetByClass(
                 ilObjCertificateSettingsGUI::class,
                 ilObjCertificateSettingsGUI::CMD_CERTIFICATES_OVERVIEW
             ),
             [
                 'certificate_id' => $this->ui_factory->input()->field()->text($this->lng->txt('certificate_id')),
                 'issue_date' => $this->ui_factory->input()->field()
                     ->duration($this->lng->txt('certificate_issue_date'))
                     ->withFormat($this->user->getDateTimeFormat())
                     ->withUseTime(true),
                 'object' => $this->ui_factory->input()->field()->text($this->lng->txt('obj')),
                 'obj_id' => $this->ui_factory->input()->field()->text($this->lng->txt('object_id')),
                 'owner' => $this->ui_factory->input()->field()->text($this->lng->txt('owner')),
             ],
             [true, true, true, true, true],
             true,
             true
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTable()

ILIAS\Certificate\Overview\CertificateOverviewTable::buildTable ( )

private

Definition at line 195 of file CertificateOverviewTable.php.

References ilObjCertificateSettingsGUI\CMD_DOWNLOAD_CERTIFICATE, ILIAS\Repository\ctrl(), ILIAS\Data\Order\DESC, ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\__construct().

                                  : Data
     {
         $ui_table = $this->ui_factory->table();
 
         return $ui_table->data(
             $this,
             $this->lng->txt('certificates'),
             [
                 'certificate_id' => $ui_table->column()->text($this->lng->txt('certificate_id')),
                 'issue_date' => $ui_table->column()->date($this->lng->txt('certificate_issue_date'), $this->user->getDateTimeFormat()),
                 'object' => $ui_table->column()->text($this->lng->txt('obj')),
                 'obj_id' => $ui_table->column()->text($this->lng->txt('object_id')),
                 'owner' => $ui_table->column()->text($this->lng->txt('owner'))
             ],
         )
             ->withOrder(new Order('issue_date', Order::DESC))
             ->withId('certificateOverviewTable')
             ->withRequest($this->request)
             ->withActions($this->buildTableActions());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTableRows()

ILIAS\Certificate\Overview\CertificateOverviewTable::buildTableRows ( array $certificates )

private

Parameters

ilUserCertificate[] $certificates

Returns: list<array{"id": int, "certificate": string, "issue_date": int, "object": string, "obj_id": string, "owner": string}>

Definition at line 257 of file CertificateOverviewTable.php.

References $refId, ilObject\_getAllReferences(), ilObjUser\_lookupLogin(), ilObject\_lookupTitle(), and ILIAS\Repository\access().

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\__construct().

                                                         : array
     {
         $table_rows = [];
 
         $ref_id_cache = [];
         $owner_cache = [];
         $object_title_cache = [];
 
         foreach ($certificates as $certificate) {
             if (!isset($ref_id_cache[$certificate->getObjId()])) {
                 $ref_id_cache[$certificate->getObjId()] = ilObject::_getAllReferences($certificate->getObjId());
             }
             $ref_ids = $ref_id_cache[$certificate->getObjId()];
 
             if (!isset($object_title_cache[$certificate->getObjId()])) {
                 $object_title = ilObject::_lookupTitle($certificate->getObjId());
                 foreach ($ref_ids as $refId) {
                     if ($this->access->checkAccess('read', '', $refId)) {
                         $object_title = $this->ui_renderer->render(
                             $this->ui_factory->link()->standard($object_title, ilLink::_getLink($refId))
                         );
                         break;
                     }
                 }
 
                 $object_title_cache[$certificate->getObjId()] = $object_title;
             }
 
 
 
             if (!isset($owner_cache[$certificate->getUserId()])) {
                 $owner_cache[$certificate->getUserId()] = ilObjUser::_lookupLogin($certificate->getUserId());
             }
 
             $table_rows[] = [
                 'id' => $certificate->getId(),
                 'certificate_id' => $certificate->getCertificateId()->asString(),
                 'issue_date' => $certificate->getAcquiredTimestamp(),
                 'object' => $object_title_cache[$certificate->getObjId()],
                 'obj_id' => (string) $certificate->getObjId(),
                 'owner' => $owner_cache[$certificate->getUserId()],
             ];
         }
 
         return $table_rows;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalRowCount()

ILIAS\Certificate\Overview\CertificateOverviewTable::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 163 of file CertificateOverviewTable.php.

References ILIAS\Repository\filter(), and ILIAS\Certificate\Overview\CertificateOverviewTable\mapUiFilterData().

                                                                                         : ?int
     {
         $ui_filter_data = $this->mapUiFilterData($this->ui_service->filter()->getData($this->filter));
 
         return $this->repo->fetchCertificatesForOverviewCount($ui_filter_data);
     }

Here is the call graph for this function:

◆ mapUiFilterData()

ILIAS\Certificate\Overview\CertificateOverviewTable::mapUiFilterData ( array $filter_data )

private

Parameters

array{certificate_id null|string, issue_date: string[], object: null|string, owner: null|string} $filter_data

Returns: array{certificate_id: null|string, issue_date: array{from: null|DateTimeImmutable, to: null|DateTimeImmutable}, object: null|string, owner: null|string} $filter_data

Definition at line 132 of file CertificateOverviewTable.php.

References ILIAS\Repository\int(), and null.

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\__construct(), and ILIAS\Certificate\Overview\CertificateOverviewTable\getTotalRowCount().

                                                         : array
     {
         if (isset($filter_data['issue_date']) && $filter_data['issue_date'] !== '') {
             try {
                 $from = new DateTimeImmutable($filter_data['issue_date'][0], $this->user_timezone);
             } catch (Throwable) {
                 $from = null;
             }
 
             try {
                 $to = new DateTimeImmutable($filter_data['issue_date'][1], $this->user_timezone);
                 $seconds_to_add = 59 - (int) $to->format('s');
                 $to = $to->modify("+$seconds_to_add seconds");
             } catch (Throwable) {
                 $to = null;
             }
 
             $filter_data['issue_date'] = [
                 'from' => $from,
                 'to' => $to
             ];
         } else {
             $filter_data['issue_date'] = [
                 'from' => null,
                 'to' => null
             ];
         }
 
         return $filter_data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ILIAS\Certificate\Overview\CertificateOverviewTable::render ( )

Definition at line 304 of file CertificateOverviewTable.php.

References ILIAS\Repository\filter().

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

Here is the call graph for this function:

Field Documentation

◆ $access

readonly ilAccessHandler ILIAS\Certificate\Overview\CertificateOverviewTable::$access

private

Definition at line 64 of file CertificateOverviewTable.php.

◆ $ctrl

readonly ilCtrl ilCtrlInterface ILIAS\Certificate\Overview\CertificateOverviewTable::$ctrl

private

Definition at line 60 of file CertificateOverviewTable.php.

◆ $data_factory

readonly ILIAS Data Factory ILIAS\Certificate\Overview\CertificateOverviewTable::$data_factory

private

Definition at line 59 of file CertificateOverviewTable.php.

◆ $filter

readonly ILIAS UI Component Input Container Filter Standard ILIAS\Certificate\Overview\CertificateOverviewTable::$filter

private

Definition at line 61 of file CertificateOverviewTable.php.

◆ $lng

readonly ilLanguage ILIAS\Certificate\Overview\CertificateOverviewTable::$lng

private

Definition at line 57 of file CertificateOverviewTable.php.

◆ $repo

readonly ilUserCertificateRepository ILIAS\Certificate\Overview\CertificateOverviewTable::$repo

private

Definition at line 54 of file CertificateOverviewTable.php.

◆ $request

readonly ServerRequestInterface ILIAS\Certificate\Overview\CertificateOverviewTable::$request

private

Definition at line 58 of file CertificateOverviewTable.php.

◆ $table

readonly Data ILIAS\Certificate\Overview\CertificateOverviewTable::$table

private

Definition at line 62 of file CertificateOverviewTable.php.

◆ $ui_factory

readonly Factory ILIAS\Certificate\Overview\CertificateOverviewTable::$ui_factory

private

Definition at line 56 of file CertificateOverviewTable.php.

◆ $ui_renderer

readonly Renderer ILIAS\Certificate\Overview\CertificateOverviewTable::$ui_renderer

private

Definition at line 63 of file CertificateOverviewTable.php.

◆ $ui_service

readonly ilUIService ILIAS\Certificate\Overview\CertificateOverviewTable::$ui_service

private

Definition at line 55 of file CertificateOverviewTable.php.

◆ $user

readonly ilObjUser ILIAS\Certificate\Overview\CertificateOverviewTable::$user

private

Definition at line 65 of file CertificateOverviewTable.php.

◆ $user_timezone

readonly DateTimeZone ILIAS\Certificate\Overview\CertificateOverviewTable::$user_timezone

private

Definition at line 66 of file CertificateOverviewTable.php.

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

components/ILIAS/Certificate/classes/Overview/CertificateOverviewTable.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFilter()

◆ buildTable()

◆ buildTableRows()

◆ getTotalRowCount()

◆ mapUiFilterData()

◆ render()

Field Documentation

◆ $access

◆ $ctrl

◆ $data_factory

◆ $filter

◆ $lng

◆ $repo

◆ $request

◆ $table

◆ $ui_factory

◆ $ui_renderer

◆ $ui_service

◆ $user

◆ $user_timezone