Inheritance diagram for ILIAS\Badge\ilObjectBadgeTableGUI:

Collaboration diagram for ILIAS\Badge\ilObjectBadgeTableGUI:

Public Member Functions
	__construct (ilObjBadgeAdministrationGUI $parentObj, protected bool $has_write=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)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

	getColumns ()

	renderTable (string $url)

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
	enrichRecord (ModalBuilder $modal_builder, string $container_deleted_title_part, array $record)

	getRecords ()

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

Private Attributes
const	RECORD_RAW = '__raw__'

readonly Factory	$factory

readonly Renderer	$renderer

readonly ILIAS Refinery Factory	$refinery

readonly ServerRequestInterface RequestInterface	$request

readonly Services	$http

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly ilObjBadgeAdministrationGUI	$parent_obj

readonly ilAccessHandler	$access

readonly ILIAS ResourceStorage Services	$irss

readonly ilBadgeImage	$badge_image_service

array	$cached_records = null

array	$has_access_by_parent_cache = []

array	$first_ref_id_for_parent_cache = []

Detailed Description

Definition at line 49 of file class.ilObjectBadgeTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Badge\ilObjectBadgeTableGUI::__construct	(	ilObjBadgeAdministrationGUI	$parentObj,
		protected bool	$has_write = `false`
	)

Definition at line 82 of file class.ilObjectBadgeTableGUI.php.

References $DIC, ILIAS\Repository\access(), factory(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and renderer().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->factory = $DIC->ui()->factory();
         $this->renderer = $DIC->ui()->renderer();
         $this->refinery = $DIC->refinery();
         $this->request = $DIC->http()->request();
         $this->http = $DIC->http();
         $this->access = $DIC->access();
         $this->parent_obj = $parentObj;
         $this->irss = $DIC->resourceStorage();
         $this->badge_image_service = new ilBadgeImage(
             $this->irss,
             $DIC->upload(),
             $DIC->ui()->mainTemplate()
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ enrichRecord()

ILIAS\Badge\ilObjectBadgeTableGUI::enrichRecord	(	ModalBuilder	$modal_builder,
		string	$container_deleted_title_part,
		array	$record
	)

private

Parameters

array{ id: int, active: bool, type: string, title_sortable: string, container_sortable: string, raw: array{ id: int, parent_id: int, type_id: string, active: int, title: ?string, descr: ?string, conf: ?string, image: ?string, valid: ?string, crit: ?string, image_rid: ?string, parent_title: ?string, parent_type: ?string, deleted: bool } } $record

Returns: array{ id: int, active: bool, type: string, image: string, title: string, title_sortable: string, container: string, container_sortable: string }

Definition at line 210 of file class.ilObjectBadgeTableGUI.php.

References $ref_id, ilObject\_getAllReferences(), ilObject\_getIcon(), ILIAS\Repository\access(), ILIAS\Badge\ModalBuilder\constructModal(), factory(), ILIAS\Badge\ilBadgeImage\IMAGE_SIZE_XL, ILIAS\Repository\lng(), null, renderer(), ILIAS\Badge\ModalBuilder\renderModal(), and ILIAS\Badge\ModalBuilder\renderShyButton().

Referenced by ILIAS\Badge\ilObjectBadgeTableGUI\getRows().

      : array {
         $badge_item = $record[self::RECORD_RAW];
 
         $badge = new ilBadge(0);
         $badge->setId($badge_item['id']);
         $badge->setImageRid($badge_item['image_rid']);
         $badge->setImage($badge_item['image']);
 
         $images = [
             'rendered' => null,
             'large' => null,
         ];
         $image_src = $this->badge_image_service->getImageFromResourceId($badge);
         if ($image_src !== '') {
             $images['rendered'] = $this->renderer->render(
                 $this->factory->image()->responsive(
                     $image_src,
                     $badge_item['title']
                 )
             );
 
             $image_src_large = $this->badge_image_service->getImageFromResourceId(
                 $badge,
                 ilBadgeImage::IMAGE_SIZE_XL
             );
             if ($image_src_large !== '') {
                 $images['large'] = $this->factory->image()->responsive(
                     $image_src_large,
                     $badge_item['title']
                 );
             }
         }
 
         $container_title_parts = [
             'icon' => $this->renderer->render(
                 $this->factory->symbol()->icon()->custom(
                     ilObject::_getIcon($badge_item['parent_id'], 'big', $badge_item['parent_type'] ?? ''),
                     $this->lng->txt('obj_' . ($badge_item['parent_type'] ?? ''))
                 )
             ),
             'title' => $badge_item['parent_title'] ?? '',
         ];
 
         $sortable_container_title_parts = [
             'title' => $badge_item['parent_title'] ?? ''
         ];
         if ($badge_item['deleted']) {
             $container_title_parts['suffix'] = $container_deleted_title_part;
             $sortable_container_title_parts['suffix'] = $container_deleted_title_part;
         } else {
             if (isset($this->has_access_by_parent_cache[$badge_item['parent_id']])) {
                 $has_access = $this->has_access_by_parent_cache[$badge_item['parent_id']] ?? false;
                 $ref_id = $this->first_ref_id_for_parent_cache[$badge_item['parent_id']] ?? null;
             } else {
                 $ref_ids = ilObject::_getAllReferences($badge_item['parent_id']);
                 $ref_id = array_shift($ref_ids);
                 $this->first_ref_id_for_parent_cache[$badge_item['parent_id']] = $ref_id;
                 $has_access = $ref_id && $this->access->checkAccess('read', '', $ref_id);
                 $this->has_access_by_parent_cache[$badge_item['parent_id']] = $has_access;
             }
 
             if ($has_access) {
                 $container_title_parts['title'] = $this->renderer->render(
                     new Standard(
                         $container_title_parts['title'],
                         (string) new URI(
                             ilLink::_getLink(
                                 $ref_id,
                                 $badge_item['parent_type'] ?? ''
                             )
                         )
                     )
                 );
             } else {
                 $container_title_parts['suffix'] = $container_deleted_title_part;
                 $sortable_container_title_parts['suffix'] = $container_deleted_title_part;
             }
         }
 
         $modal = $modal_builder->constructModal(
             $images['large'],
             $badge_item['title'],
             [
                 'active' => $badge_item['active'] ? $this->lng->txt('yes') : $this->lng->txt('no'),
                 'type' => $record['type'],
                 'container' => implode(' ', \array_slice($container_title_parts, 1, null, true)),
             ]
         );
 
         return [
             'id' => $badge_item['id'],
             'active' => (bool) $badge_item['active'],
             'type' => $record['type'],
             'image' => $images['rendered'] ? ($modal_builder->renderShyButton(
                 $images['rendered'],
                 $modal
             ) . ' ') : '',
             'title' => implode('', [
                 $modal_builder->renderShyButton($badge_item['title'], $modal),
                 $modal_builder->renderModal($modal)
             ]),
             'title_sortable' => $badge_item['title'],
             'container' => implode(' ', $container_title_parts),
             'container_sortable' => implode(' ', $sortable_container_title_parts),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActions()

ILIAS\Badge\ilObjectBadgeTableGUI::getActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token
	)

private

Returns: array<string, Action>

Definition at line 403 of file class.ilObjectBadgeTableGUI.php.

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

Referenced by ILIAS\Badge\ilObjectBadgeTableGUI\renderTable().

      : array {
         return $this->has_write ? [
             'obj_badge_activate' => $this->factory->table()->action()->multi(
                 $this->lng->txt('activate'),
                 $url_builder->withParameter($action_parameter_token, 'obj_badge_activate'),
                 $row_id_token
             ),
             'obj_badge_deactivate' =>
                 $this->factory->table()->action()->multi(
                     $this->lng->txt('deactivate'),
                     $url_builder->withParameter($action_parameter_token, 'obj_badge_deactivate'),
                     $row_id_token
                 ),
             'obj_badge_delete' =>
                 $this->factory->table()->action()->multi(
                     $this->lng->txt('delete'),
                     $url_builder->withParameter($action_parameter_token, 'obj_badge_delete'),
                     $row_id_token
                 ),
             'obj_badge_show_users' =>
                 $this->factory->table()->action()->single(
                     $this->lng->txt('user'),
                     $url_builder->withParameter($action_parameter_token, 'obj_badge_show_users'),
                     $row_id_token
                 )
         ] : [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Badge\ilObjectBadgeTableGUI::getColumns ( )

Returns: array<string, Column>

Definition at line 382 of file class.ilObjectBadgeTableGUI.php.

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

Referenced by ILIAS\Badge\ilObjectBadgeTableGUI\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')),
             'type' => $this->factory->table()->column()->text($this->lng->txt('type')),
             'container' => $this->factory->table()->column()->text($this->lng->txt('object')),
             'active' => $this->factory->table()->column()->boolean(
                 $this->lng->txt('active'),
                 $this->lng->txt('yes'),
                 $this->lng->txt('no')
             )->withOrderingLabels(
                 $this->lng->txt('badge_sort_active_badges_first'),
                 $this->lng->txt('badge_sort_active_badges_last')
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecords()

ILIAS\Badge\ilObjectBadgeTableGUI::getRecords ( )

private

Returns: list<array{ id: int, active: bool, type: string, title_sortable: string, container_sortable: string, raw: array{ id: int, parent_id: int, type_id: string, active: int, title: ?string, descr: ?string, conf: ?string, image: ?string, valid: ?string, crit: ?string, image_rid: ?string, parent_title: ?string, parent_type: ?string, deleted: bool } }>

Definition at line 346 of file class.ilObjectBadgeTableGUI.php.

References ILIAS\Badge\ilObjectBadgeTableGUI\$cached_records, ilBadge\getExtendedTypeCaption(), ilBadgeHandler\getInstance(), ilBadge\getObjectInstances(), ILIAS\Repository\lng(), and null.

Referenced by ILIAS\Badge\ilObjectBadgeTableGUI\getRows(), and ILIAS\Badge\ilObjectBadgeTableGUI\getTotalRowCount().

                                  : array
     {
         if ($this->cached_records !== null) {
             return $this->cached_records;
         }
 
         // A filter is not implemented, yet
         $filter = [
             'type' => '',
             'title' => '',
             'object' => ''
         ];
 
         $types = ilBadgeHandler::getInstance()->getAvailableTypes(false);
         $raw_records = ilBadge::getObjectInstances($filter);
 
         $sortable_rows = array_map(function (array $badge_item) use ($types) {
             return [
                 'id' => $badge_item['id'],
                 'active' => (bool) $badge_item['active'],
                 'type' => ilBadge::getExtendedTypeCaption($types[$badge_item['type_id']]),
                 'title_sortable' => $badge_item['title'],
                 'container_sortable' => ($badge_item['parent_title'] ?? '') .
                     ($badge_item['deleted'] ? ' ' . $this->lng->txt('deleted') : ''),
                 self::RECORD_RAW => $badge_item
             ];
         }, $raw_records);
 
         $this->cached_records = $sortable_rows;
 
         return $this->cached_records;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

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

Definition at line 105 of file class.ilObjectBadgeTableGUI.php.

References ILIAS\Data\Order\DESC, ILIAS\Badge\ilObjectBadgeTableGUI\enrichRecord(), ILIAS\Data\Range\getLength(), ILIAS\Badge\ilObjectBadgeTableGUI\getRecords(), ILIAS\Data\Range\getStart(), ILIAS\Data\Order\join(), and ILIAS\Repository\lng().

      : 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, ['container', 'title', 'type'], true)) {
                     if (\in_array($order_field, ['container', 'title'], 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());
         }
 
         $identifications = [];
         foreach ($records as $record) {
             if (isset($record[self::RECORD_RAW]['image_rid']) && $record[self::RECORD_RAW]['image_rid'] !== '') {
                 $identifications[] = $record[self::RECORD_RAW]['image_rid'];
             }
         }
 
         $this->irss->preload($identifications);
 
         $modal_container = new ModalBuilder();
         $container_deleted_title_part = '<span class="il_ItemAlertProperty">' . $this->lng->txt('deleted') . '</span>';
         foreach ($records as $record) {
             yield $row_builder->buildDataRow(
                 (string) $record['id'],
                 $this->enrichRecord($modal_container, $container_deleted_title_part, $record)
             );
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Badge\ilObjectBadgeTableGUI::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 168 of file class.ilObjectBadgeTableGUI.php.

References ILIAS\Badge\ilObjectBadgeTableGUI\getRecords().

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

Here is the call graph for this function:

◆ renderTable()

ILIAS\Badge\ilObjectBadgeTableGUI::renderTable ( string $url )

Definition at line 435 of file class.ilObjectBadgeTableGUI.php.

References $id, $out, ILIAS\Data\Order\ASC, factory(), ILIAS\Badge\ilObjectBadgeTableGUI\getActions(), ILIAS\Badge\ilObjectBadgeTableGUI\getColumns(), ilBadge\getObjectInstances(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Filesystem\Stream\Streams\ofString(), ILIAS\Repository\refinery(), and renderer().

                                             : void
     {
         $df = new \ILIAS\Data\Factory();
 
         $table_uri = $df->uri($url);
         $url_builder = new URLBuilder($table_uri);
         $query_params_namespace = ['tid'];
 
         [$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_object_badges'), $this->getColumns())
             ->withId(self::class)
             ->withOrder(new Order('title', Order::ASC))
             ->withActions($this->getActions($url_builder, $action_parameter_token, $row_id_token))
             ->withRequest($this->request);
 
         $out = [$table];
 
         $query = $this->http->wrapper()->query();
         if ($query->has($action_parameter_token->getName())) {
             $action = $query->retrieve($action_parameter_token->getName(), $this->refinery->kindlyTo()->string());
             $ids = $query->retrieve($row_id_token->getName(), $this->refinery->custom()->transformation(fn($v) => $v));
 
             if ($action === 'obj_badge_delete') {
                 $items = [];
                 if (\is_array($ids) && \count($ids) > 0) {
                     if ($ids === ['ALL_OBJECTS']) {
                         $filter = [
                             'type' => '',
                             'title' => '',
                             'object' => ''
                         ];
                         $ids = [];
                         foreach (ilBadge::getObjectInstances($filter) as $badge_item) {
                             $ids[] = $badge_item['id'];
                         }
                     }
 
                     foreach ($ids as $id) {
                         $badge = new ilBadge((int) $id);
                         $items[] = $this->factory->modal()->interruptiveItem()->keyValue(
                             (string) $id,
                             (string) $badge->getId(),
                             $badge->getTitle()
                         );
                     }
 
                     $this->http->saveResponse(
                         $this->http
                             ->response()
                             ->withBody(
                                 Streams::ofString($this->renderer->renderAsync([
                                     $this->factory->modal()->interruptive(
                                         $this->lng->txt('badge_deletion'),
                                         $this->lng->txt('badge_deletion_confirmation'),
                                         '#'
                                     )->withAffectedItems($items)
                                 ]))
                             )
                     );
                     $this->http->sendResponse();
                     $this->http->close();
                 }
             }
         }
 
         $this->tpl->setContent($this->renderer->render($out));
     }