Inheritance diagram for ilBadgePersonalTableGUI:

Collaboration diagram for ilBadgePersonalTableGUI:

Public Member Functions
	__construct ()

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

	renderTable (string $url)

Protected Member Functions
	getActions (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token)

Private Member Functions
	enrichRecord (array $record, array &$access_cache, array &$ref_id_cache)

	getRecords ()

	getColumns (\ILIAS\Data\DateFormat\DateFormat $date_format)

Private Attributes
readonly Factory	$factory

readonly Renderer	$renderer

readonly ServerRequestInterface RequestInterface	$request

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly ILIAS DI Container	$dic

readonly ilObjUser	$user

readonly ilAccessHandler	$access

readonly Tile	$tile

readonly IRSS	$irss

array	$cached_records = null

ilObjectDataCache	$object_data_cache

	$parent_metadata_cache = []

Detailed Description

Definition at line 39 of file class.ilBadgePersonalTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBadgePersonalTableGUI::__construct ( )

Definition at line 72 of file class.ilBadgePersonalTableGUI.php.

References $DIC, ILIAS\Repository\access(), factory(), ILIAS\Repository\lng(), renderer(), and ILIAS\Repository\user().

     {
         global $DIC;
         $this->dic = $DIC;
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->factory = $DIC->ui()->factory();
         $this->renderer = $DIC->ui()->renderer();
         $this->request = $DIC->http()->request();
         $this->user = $DIC->user();
         $this->access = $DIC->access();
         $this->tile = new Tile($DIC);
         $this->irss = $DIC['resource_storage'];
         $this->object_data_cache = $DIC['ilObjDataCache'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ enrichRecord()

ilBadgePersonalTableGUI::enrichRecord	(	array	$record,
		array &	$access_cache,
		array &	$ref_id_cache
	)

private

Parameters

array{	id: int, title_sortable: string, awarded_by_sortable: string, badge_issued_on: DateTimeImmutable, active: bool, assignment: ilBadgeAssignment, badge: ilBadge } $record
array<int,bool>	$access_cache
array<int,int>	$ref_id_cache

Returns: array

Definition at line 168 of file class.ilBadgePersonalTableGUI.php.

References $access, $ref_id, ilObject\_getAllReferences(), ILIAS\Repository\access(), null, and renderer().

Referenced by getRows().

      : array {
         $badge = $record['badge'];
         $ass = $record['assignment'];
 
         $parent = null;
         if ($badge->getParentId()) {
             if (isset($this->parent_metadata_cache[$badge->getParentId()])) {
                 $parent = $this->parent_metadata_cache[$badge->getParentId()];
             } else {
                 $parent = $badge->getParentMeta();
                 $this->parent_metadata_cache[$badge->getParentId()] = $parent;
             }
             if ($parent['type'] === 'bdga') {
                 $parent = null;
             }
         }
 
         $awarded_by = '';
         if ($parent !== null) {
             if (isset($ref_id_cache[$parent['id']])) {
                 $ref_id = $ref_id_cache[$parent['id']];
             } else {
                 $ref_id = current(ilObject::_getAllReferences($parent['id']));
                 $ref_id_cache[$parent['id']] = $ref_id;
             }
 
             $awarded_by = $parent['title'];
             if ($ref_id) {
                 $access = $access_cache[$ref_id] ?? $this->access->checkAccess('read', '', $ref_id);
                 if (!isset($access_cache[$ref_id])) {
                     $access_cache[$ref_id] = $access;
                 }
             }
             if ($ref_id && $access) {
                 $awarded_by = $this->renderer->render(
                     new Standard(
                         $awarded_by,
                         (string) new URI(ilLink::_getLink($ref_id, $parent['type']))
                     )
                 );
             }
 
             $awarded_by = implode(' ', [
                 $this->renderer->render(
                     $this->factory->symbol()->icon()->standard(
                         $parent['type'],
                         $parent['title']
                     )
                 ),
                 $awarded_by
             ]);
         }
 
         $record += [
             'image' => $this->renderer->render(
                 $this->tile->asImage(
                     $this->tile->modalContentWithAssignment($badge, $ass),
                     ilBadgeImage::IMAGE_SIZE_XS
                 )
             ),
             'title' => $this->renderer->render(
                 $this->tile->asTitle(
                     $this->tile->modalContentWithAssignment($badge, $ass)
                 )
             ),
             'awarded_by' => $awarded_by,
         ];
 
         return $record;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActions()

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

protected

Returns: array<string,>

Definition at line 336 of file class.ilBadgePersonalTableGUI.php.

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

Referenced by renderTable().

      : array {
         return [
             'obj_badge_activate' => $this->factory->table()->action()->multi(
                 $this->lng->txt('badge_add_to_profile'),
                 $url_builder->withParameter($action_parameter_token, 'obj_badge_activate'),
                 $row_id_token
             ),
             'obj_badge_deactivate' =>
                 $this->factory->table()->action()->multi(
                     $this->lng->txt('badge_remove_from_profile'),
                     $url_builder->withParameter($action_parameter_token, 'obj_badge_deactivate'),
                     $row_id_token
                 )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ilBadgePersonalTableGUI::getColumns ( \ILIAS\Data\DateFormat\DateFormat $date_format )

private

Returns: array<string, Column>

Definition at line 312 of file class.ilBadgePersonalTableGUI.php.

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

Referenced by renderTable().

                                                                                : array
     {
         return [
             'image' => $this->factory->table()->column()->text($this->lng->txt('image'))->withIsSortable(false),
             'title' => $this->factory->table()->column()->text($this->lng->txt('title')),
             'awarded_by' => $this->factory->table()->column()->text($this->lng->txt('awarded_by')),
             'badge_issued_on' => $this->factory->table()->column()->date(
                 $this->lng->txt('badge_issued_on'),
                 $date_format
             ),
             'active' => $this->factory->table()->column()->boolean(
                 $this->lng->txt('badge_in_profile'),
                 $this->lng->txt('yes'),
                 $this->lng->txt('no')
             )->withOrderingLabels(
                 $this->lng->txt('badge_sort_added_to_profile_first'),
                 $this->lng->txt('badge_sort_excluded_from_profile_first')
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecords()

ilBadgePersonalTableGUI::getRecords ( )

private

Returns: list<array{ id: int, title_sortable: string, awarded_by_sortable: string, badge_issued_on: DateTimeImmutable, active: bool, assignment: ilBadgeAssignment, badge: ilBadge }>

Definition at line 261 of file class.ilBadgePersonalTableGUI.php.

References $cached_records, ilBadgeAssignment\getInstancesByUserId(), ilBadge\getParentMeta(), null, and ILIAS\Repository\user().

Referenced by getRows(), and getTotalRowCount().

                                  : array
     {
         if ($this->cached_records !== null) {
             return $this->cached_records;
         }
 
         $rows = [];
         $a_user_id = $this->user->getId();
 
         foreach (ilBadgeAssignment::getInstancesByUserId($a_user_id) as $ass) {
             $badge = new ilBadge($ass->getBadgeId());
 
             $parent = null;
             if ($badge->getParentId()) {
                 if (isset($this->parent_metadata_cache[$badge->getParentId()])) {
                     $parent = $this->parent_metadata_cache[$badge->getParentId()];
                 } else {
                     $parent = $badge->getParentMeta();
                     $this->parent_metadata_cache[$badge->getParentId()] = $parent;
                 }
                 if ($parent['type'] === 'bdga') {
                     $parent = null;
                 }
             }
 
             $awarded_by_sortable = '';
             if ($parent !== null) {
                 $awarded_by_sortable = $parent['title'];
             }
 
             $rows[] = [
                 'id' => $badge->getId(),
                 'title_sortable' => $badge->getTitle(),
                 'awarded_by_sortable' => $awarded_by_sortable,
                 'badge_issued_on' => (new DateTimeImmutable())
                     ->setTimestamp($ass->getTimestamp())
                     ->setTimezone(new DateTimeZone($this->user->getTimeZone())),
                 'active' => (bool) $ass->getPosition(),
                 'assignment' => $ass,
                 'badge' => $badge
             ];
         }
 
         $this->cached_records = $rows;
 
         return $rows;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ilBadgePersonalTableGUI::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 88 of file class.ilBadgePersonalTableGUI.php.

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), enrichRecord(), ILIAS\Data\Range\getLength(), getRecords(), ILIAS\Data\Range\getStart(), ILIAS\Data\Order\join(), and ilStr\strCmp().

      : Generator {
         $records = $this->getRecords();
 
         if ($order) {
             [$order_field, $order_direction] = $order->join(
                 [],
                 fn($ret, $key, $value) => [$key, $value]
             );
 
             usort($records, static function (array $left, array $right) use ($order_field): int {
                 if (in_array($order_field, ['title', 'awarded_by'], true)) {
                     if (in_array($order_field, ['title', 'awarded_by'], true)) {
                         $order_field .= '_sortable';
                     }
 
                     return ilStr::strCmp(
                         $left[$order_field],
                         $right[$order_field]
                     );
                 }
 
                 if ($order_field === 'active') {
                     return $right[$order_field] <=> $left[$order_field];
                 }
 
                 return $left[$order_field] <=> $right[$order_field];
             });
 
             if ($order_direction === Order::DESC) {
                 $records = array_reverse($records);
             }
         }
 
         if ($range) {
             $records = \array_slice($records, $range->getStart(), $range->getLength());
         }
 
         $access_cache = [];
         $ref_id_cache = [];
         $parent_obj_ids = [];
         $identifications = [];
 
         foreach ($records as $record) {
             $badge = $record['badge'];
             $parent_obj_ids[] = $badge->getParentId();
             $identifications[] = $badge->getImageRid();
         }
         $this->irss->preload(array_filter($identifications));
         $this->object_data_cache->preloadObjectCache(array_unique($parent_obj_ids));
 
         foreach ($records as $record) {
             yield $row_builder->buildDataRow((string) $record['id'], $this->enrichRecord(
                 $record,
                 $access_cache,
                 $ref_id_cache
             ));
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ilBadgePersonalTableGUI::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 243 of file class.ilBadgePersonalTableGUI.php.

References getRecords().

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

Here is the call graph for this function:

◆ renderTable()

ilBadgePersonalTableGUI::renderTable ( string $url )

Definition at line 356 of file class.ilBadgePersonalTableGUI.php.

References factory(), getActions(), getColumns(), ILIAS\Repository\lng(), renderer(), and ILIAS\Repository\user().

                                             : void
     {
         $df = new \ILIAS\Data\Factory();
 
         $table_uri = $df->uri($url);
         $url_builder = new URLBuilder($table_uri);
         $query_params_namespace = ['badge'];
 
         [$url_builder, $action_parameter_token, $row_id_token] = $url_builder->acquireParameters(
             $query_params_namespace,
             'table_action',
             'id',
         );
 
         $table = $this->factory
             ->table()
             ->data(
                 $this,
                 $this->lng->txt('badge_personal_badges'),
                 $this->getColumns($this->user->getDateTimeFormat()),
             )
             ->withId(self::class)
             ->withOrder(new Order('title', Order::ASC))
             ->withActions($this->getActions($url_builder, $action_parameter_token, $row_id_token))
             ->withRequest($this->request);
 
         $pres = new PresentationHeader($this->dic, ilBadgeProfileGUI::class);
         $pres->show($this->lng->txt('table_view'));
 
         $this->tpl->setContent($this->renderer->render($table));
     }

Here is the call graph for this function:

Field Documentation

◆ $access

readonly ilAccessHandler ilBadgePersonalTableGUI::$access

private

Definition at line 48 of file class.ilBadgePersonalTableGUI.php.

Referenced by enrichRecord().

◆ $cached_records

array ilBadgePersonalTableGUI::$cached_records = null

private

Returns: null|list<array{ id: int, active: bool, image: string, awarded_by: string, awarded_by_sortable: string, badge_issued_on: DateTimeImmutable, title: string, title_sortable: string }>

Definition at line 64 of file class.ilBadgePersonalTableGUI.php.

Referenced by getRecords().