Inheritance diagram for ILIAS\Badge\ilBadgeImageTemplateTableGUI:

Collaboration diagram for ILIAS\Badge\ilBadgeImageTemplateTableGUI:

Public Member Functions
	__construct (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
	getRecords ()

	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 ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

array	$cached_records = null

Detailed Description

Definition at line 41 of file class.ilBadgeImageTemplateTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Badge\ilBadgeImageTemplateTableGUI::__construct ( protected bool $has_write = false )

Definition at line 53 of file class.ilBadgeImageTemplateTableGUI.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();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getActions()

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

private

Returns: array<string, >

Definition at line 181 of file class.ilBadgeImageTemplateTableGUI.php.

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

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

      : array {
         return $this->has_write ? [
             'badge_image_template_edit' => $this->factory->table()->action()->single(
                 $this->lng->txt('edit'),
                 $url_builder->withParameter($action_parameter_token, 'badge_image_template_editImageTemplate'),
                 $row_id_token
             ),
             'badge_image_template_delete' =>
                 $this->factory->table()->action()->standard(
                     $this->lng->txt('delete'),
                     $url_builder->withParameter($action_parameter_token, 'badge_image_template_delete'),
                     $row_id_token
                 )
         ] : [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Badge\ilBadgeImageTemplateTableGUI::getColumns ( )

Returns: array<string, Column>

Definition at line 170 of file class.ilBadgeImageTemplateTableGUI.php.

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

Referenced by ILIAS\Badge\ilBadgeImageTemplateTableGUI\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'))
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecords()

ILIAS\Badge\ilBadgeImageTemplateTableGUI::getRecords ( )

private

Returns: list<array{id: int, image: string, title: string, title_sortable: string}>

Definition at line 68 of file class.ilBadgeImageTemplateTableGUI.php.

References ILIAS\Badge\ilBadgeImageTemplateTableGUI\$cached_records, factory(), ilBadgeImageTemplate\getInstances(), ILIAS\Badge\ilBadgeImage\IMAGE_SIZE_XL, null, and renderer().

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

                                  : array
     {
         if ($this->cached_records !== null) {
             return $this->cached_records;
         }
 
         $modal_container = new ModalBuilder();
         $rows = [];
 
         foreach (ilBadgeImageTemplate::getInstances() as $template) {
             $image = '';
             $title = $template->getTitle();
 
             $image_src = $template->getImageFromResourceId();
             if ($image_src !== '') {
                 $image_component = $this->factory->image()->responsive(
                     $image_src,
                     $template->getTitle()
                 );
                 $image_html = $this->renderer->render($image_component);
 
                 $image_src_large = $template->getImageFromResourceId(
                     ilBadgeImage::IMAGE_SIZE_XL
                 );
                 $large_image_component = $this->factory->image()->responsive(
                     $image_src_large,
                     $template->getTitle()
                 );
 
                 $modal = $modal_container->constructModal($large_image_component, $template->getTitle());
 
                 $image = implode('', [
                     $modal_container->renderShyButton($image_html, $modal),
                     $modal_container->renderModal($modal)
                 ]);
                 $title = $modal_container->renderShyButton($template->getTitle(), $modal);
             }
 
             $rows[] = [
                 'id' => $template->getId(),
                 'image' => $image,
                 'title' => $title,
                 'title_sortable' => $template->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\ilBadgeImageTemplateTableGUI::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 119 of file class.ilBadgeImageTemplateTableGUI.php.

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

      : 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 ($order_field === 'title') {
                     return \ilStr::strCmp(
                         $left[$order_field . '_sortable'],
                         $right[$order_field . '_sortable']
                     );
                 }
 
                 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());
         }
 
         foreach ($records as $record) {
             yield $row_builder->buildDataRow((string) $record['id'], $record);
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

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

References ILIAS\Badge\ilBadgeImageTemplateTableGUI\getRecords().

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

Here is the call graph for this function:

◆ renderTable()

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

Definition at line 201 of file class.ilBadgeImageTemplateTableGUI.php.

References $id, $out, ILIAS\Data\Order\ASC, factory(), ILIAS\Badge\ilBadgeImageTemplateTableGUI\getActions(), ILIAS\Badge\ilBadgeImageTemplateTableGUI\getColumns(), ilBadgeImageTemplate\getInstances(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), null, 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_image_templates'), $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('tid')) {
             $query_values = $query->retrieve(
                 'tid',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
             );
 
             $items = [];
             if ($query_values === ['ALL_OBJECTS']) {
                 foreach (ilBadgeImageTemplate::getInstances() as $template) {
                     if ($template->getId() !== null) {
                         $items[] = $this->factory->modal()->interruptiveItem()->keyValue(
                             (string) $template->getId(),
                             (string) $template->getId(),
                             $template->getTitle()
                         );
                     }
                 }
             } elseif (\is_array($query_values)) {
                 foreach ($query_values as $id) {
                     $badge = new ilBadgeImageTemplate((int) $id);
                     $items[] = $this->factory->modal()->interruptiveItem()->keyValue(
                         (string) $id,
                         (string) $badge->getId(),
                         $badge->getTitle()
                     );
                 }
             } else {
                 $badge = new ilBadgeImageTemplate($query_values);
                 $items[] = $this->factory->modal()->interruptiveItem()->keyValue(
                     (string) $badge->getId(),
                     (string) $badge->getId(),
                     $badge->getTitle()
                 );
             }
             if ($query->has($action_parameter_token->getName())) {
                 $action = $query->retrieve($action_parameter_token->getName(), $this->refinery->kindlyTo()->string());
                 if ($action === 'badge_image_template_delete') {
                     $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));
     }