Inheritance diagram for ILIAS\Badge\ilBadgeTableGUI:

Collaboration diagram for ILIAS\Badge\ilBadgeTableGUI:

Public Member Functions
	__construct (int $parent_obj_id, string $parent_obj_type, 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...

	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
	getRecords ()

	enrichRecord (ModalBuilder $modal_builder, array $record)

	getColumns ()

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

Private Attributes
readonly Factory	$factory

readonly Renderer	$renderer

readonly ILIAS Refinery Factory	$refinery

readonly ServerRequestInterface RequestInterface	$request

readonly Services	$http

readonly int	$parent_id

readonly string	$parent_type

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly ILIAS ResourceStorage Services	$irss

readonly ilBadgeImage	$badge_image_service

array	$cached_records = null

Detailed Description

Definition at line 42 of file class.ilBadgeTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Badge\ilBadgeTableGUI::__construct	(	int	$parent_obj_id,
		string	$parent_obj_type,
		protected bool	$has_write = `false`
	)

Definition at line 69 of file class.ilBadgeTableGUI.php.

References $DIC, 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->irss = $DIC->resourceStorage();
 
         $this->parent_id = $parent_obj_id;
         $this->parent_type = $parent_obj_type;
         $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\ilBadgeTableGUI::enrichRecord	(	ModalBuilder	$modal_builder,
		array	$record
	)

private

Parameters

array{ id: int, badge: ilBadge, active: bool, type: string, manual: bool, title_sortable: string } $record

Returns: array{ id: int, badge: ilBadge, active: bool, type: string, manual: bool, title_sortable: string, title: string, image: string }

Definition at line 146 of file class.ilBadgeTableGUI.php.

References ILIAS\Badge\ModalBuilder\constructModal(), factory(), ILIAS\Badge\ilBadgeImage\IMAGE_SIZE_XL, null, renderer(), ILIAS\Badge\ModalBuilder\renderModal(), and ILIAS\Badge\ModalBuilder\renderShyButton().

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

                                                                              : array
     {
         $badge = $record['badge'];
 
         $images = [
             'rendered' => null,
             'large' => null,
         ];
 
         $image_src = $this->badge_image_service->getImageFromBadge($badge);
         if ($image_src !== '') {
             $images['rendered'] = $this->renderer->render(
                 $this->factory->image()->responsive(
                     $image_src,
                     $badge->getTitle()
                 )
             );
 
             $image_src_large = $this->badge_image_service->getImageFromBadge(
                 $badge,
                 ilBadgeImage::IMAGE_SIZE_XL
             );
             if ($image_src_large !== '') {
                 $images['large'] = $this->factory->image()->responsive(
                     $image_src_large,
                     $badge->getTitle()
                 );
             }
         }
 
         $modal = $modal_builder->constructModal(
             $images['large'],
             $badge->getTitle(),
             [
                 'description' => $badge->getDescription(),
                 'badge_criteria' => $badge->getCriteria(),
             ]
         );
 
         $record['image'] = $images['rendered']
             ? $modal_builder->renderShyButton($images['rendered'], $modal) . ' '
             : '';
         $record['title'] = implode('', [
             $modal_builder->renderShyButton($badge->getTitle(), $modal),
             $modal_builder->renderModal($modal)
         ]);
 
         return $record;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActions()

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

private

Returns: array<string, >

Definition at line 293 of file class.ilBadgeTableGUI.php.

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

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

      : array {
         return $this->has_write ? [
             'badge_table_activate' =>
                 $this->factory->table()->action()->multi(
                     $this->lng->txt('activate'),
                     $url_builder->withParameter($action_parameter_token, 'badge_table_activate'),
                     $row_id_token
                 ),
             'badge_table_deactivate' =>
                 $this->factory->table()->action()->multi(
                     $this->lng->txt('deactivate'),
                     $url_builder->withParameter($action_parameter_token, 'badge_table_deactivate'),
                     $row_id_token
                 ),
             'badge_table_edit' => $this->factory->table()->action()->single(
                 $this->lng->txt('edit'),
                 $url_builder->withParameter($action_parameter_token, 'badge_table_edit'),
                 $row_id_token
             ),
             'badge_table_delete' =>
                 $this->factory->table()->action()->standard(
                     $this->lng->txt('delete'),
                     $url_builder->withParameter($action_parameter_token, 'badge_table_delete'),
                     $row_id_token
                 ),
             'award_revoke_badge' =>
                 $this->factory->table()->action()->single(
                     $this->lng->txt('badge_award_revoke'),
                     $url_builder->withParameter($action_parameter_token, 'award_revoke_badge'),
                     $row_id_token
                 )
         ] : [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Badge\ilBadgeTableGUI::getColumns ( )

private

Returns: array<string, Column>

Definition at line 273 of file class.ilBadgeTableGUI.php.

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

Referenced by ILIAS\Badge\ilBadgeTableGUI\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')),
             '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\ilBadgeTableGUI::getRecords ( )

private

Returns: list<array{ id: int, badge: ilBadge, active: bool, type: string, manual: bool, title_sortable: string }>

Definition at line 101 of file class.ilBadgeTableGUI.php.

References ILIAS\Badge\ilBadgeTableGUI\$cached_records, ilBadge\getExtendedTypeCaption(), ilBadge\getInstancesByParentId(), and null.

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

                                  : array
     {
         if ($this->cached_records !== null) {
             return $this->cached_records;
         }
 
         $rows = [];
         foreach (ilBadge::getInstancesByParentId($this->parent_id) as $badge) {
             $rows[] = [
                 'id' => $badge->getId(),
                 'badge' => $badge,
                 'active' => $badge->isActive(),
                 'type' => $this->parent_type !== 'bdga'
                     ? ilBadge::getExtendedTypeCaption($badge->getTypeInstance())
                     : $badge->getTypeInstance()->getCaption(),
                 'manual' => !$badge->getTypeInstance() instanceof ilBadgeAuto,
                 'title_sortable' => $badge->getTitle()
             ];
         }
 
         $this->cached_records = $rows;
 
         return $rows;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

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

Definition at line 197 of file class.ilBadgeTableGUI.php.

References ILIAS\Data\Order\DESC, ILIAS\Badge\ilBadgeTableGUI\enrichRecord(), ILIAS\Data\Range\getLength(), ILIAS\Badge\ilBadgeTableGUI\getRecords(), ILIAS\Data\Range\getStart(), ILIAS\Data\Order\join(), and null.

      : 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', 'type'], true)) {
                     if ($order_field === 'title') {
                         $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 ($record['badge']->getImageRid() !== null && $record['badge']->getImageRid() !== '') {
                 $identifications[] = $record['badge']->getImageRid();
             }
         }
 
         $this->irss->preload($identifications);
 
         $modal_container = new ModalBuilder();
         foreach ($records as $record) {
             $record = $this->enrichRecord($modal_container, $record);
 
             yield $row_builder
                 ->buildDataRow((string) $record['id'], $record)
                 ->withDisabledAction(
                     'award_revoke_badge',
                     !$record['manual'] || !$record['active']
                 );
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

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

References ILIAS\Badge\ilBadgeTableGUI\getRecords().

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

Here is the call graph for this function:

◆ renderTable()

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

Definition at line 331 of file class.ilBadgeTableGUI.php.

References $id, $out, ILIAS\Data\Order\ASC, factory(), ILIAS\Badge\ilBadgeTableGUI\getActions(), ILIAS\Badge\ilBadgeTableGUI\getColumns(), 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('obj_bdga'), $this->getColumns())
             ->withId(self::class . '_' . $this->parent_id)
             ->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->to()->string());
             $ids = $query->retrieve($row_id_token->getName(), $this->refinery->custom()->transformation(fn($v) => $v));
 
             if ($action === 'delete') {
                 $items = [];
                 foreach ($ids as $id) {
                     $items[] = $this->factory->modal()->interruptiveItem()->keyValue(
                         $id,
                         $row_id_token->getName(),
                         $id
                     );
                 }
 
                 $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));
     }

Here is the call graph for this function:

Field Documentation

◆ $badge_image_service

readonly ilBadgeImage ILIAS\Badge\ilBadgeTableGUI::$badge_image_service

private

Definition at line 54 of file class.ilBadgeTableGUI.php.

◆ $cached_records

array ILIAS\Badge\ilBadgeTableGUI::$cached_records = null

private

Returns: null|list<array{ id: int, badge: ilBadge, active: bool, type: string, manual: bool, image: string, title: string, title_sortable: string }>

Definition at line 67 of file class.ilBadgeTableGUI.php.

Referenced by ILIAS\Badge\ilBadgeTableGUI\getRecords().

◆ $factory

readonly Factory ILIAS\Badge\ilBadgeTableGUI::$factory

private

Definition at line 44 of file class.ilBadgeTableGUI.php.

◆ $http

readonly Services ILIAS\Badge\ilBadgeTableGUI::$http

private

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

◆ $irss

readonly ILIAS ResourceStorage Services ILIAS\Badge\ilBadgeTableGUI::$irss

private

Definition at line 53 of file class.ilBadgeTableGUI.php.

◆ $lng

readonly ilLanguage ILIAS\Badge\ilBadgeTableGUI::$lng

private

Definition at line 51 of file class.ilBadgeTableGUI.php.

◆ $parent_id

readonly int ILIAS\Badge\ilBadgeTableGUI::$parent_id

private

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

◆ $parent_type

readonly string ILIAS\Badge\ilBadgeTableGUI::$parent_type

private

Definition at line 50 of file class.ilBadgeTableGUI.php.

◆ $refinery

readonly ILIAS Refinery Factory ILIAS\Badge\ilBadgeTableGUI::$refinery

private

Definition at line 46 of file class.ilBadgeTableGUI.php.

◆ $renderer

readonly Renderer ILIAS\Badge\ilBadgeTableGUI::$renderer

private

Definition at line 45 of file class.ilBadgeTableGUI.php.

◆ $request

readonly ServerRequestInterface RequestInterface ILIAS\Badge\ilBadgeTableGUI::$request

private

Definition at line 47 of file class.ilBadgeTableGUI.php.

◆ $tpl

readonly ilGlobalTemplateInterface ILIAS\Badge\ilBadgeTableGUI::$tpl

private

Definition at line 52 of file class.ilBadgeTableGUI.php.

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

components/ILIAS/Badge/classes/class.ilBadgeTableGUI.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ enrichRecord()

◆ getActions()

◆ getColumns()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

◆ renderTable()

Field Documentation

◆ $badge_image_service

◆ $cached_records

◆ $factory

◆ $http

◆ $irss

◆ $lng

◆ $parent_id

◆ $parent_type

◆ $refinery

◆ $renderer

◆ $request

◆ $tpl