Inheritance diagram for ILIAS\Badge\ilBadgeUserTableGUI:

Collaboration diagram for ILIAS\Badge\ilBadgeUserTableGUI:

Public Member Functions
	__construct (private readonly ?int $parent_ref_id=null, private readonly ?ilBadge $award_badge=null, private readonly ?int $parent_obj_id=null, private readonly ?int $restrict_badge_id=null)

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $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)

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

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

Private Attributes
readonly Factory	$factory

readonly Renderer	$renderer

readonly ServerRequestInterface RequestInterface	$request

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly ilTree	$tree

readonly ilObjUser	$user

DateFormat	$date_format

bool	$is_container_context = false

array	$cached_records = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Badge\ilBadgeUserTableGUI::__construct	(	private readonly ?int	$parent_ref_id = `null`,
		private readonly ?ilBadge	$award_badge = `null`,
		private readonly ?int	$parent_obj_id = `null`,
		private readonly ?int	$restrict_badge_id = `null`
	)

Definition at line 76 of file class.ilBadgeUserTableGUI.php.

      {
        global $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->tree = $DIC->repositoryTree();
        $this->user = $DIC->user();
 
        if ($this->parent_ref_id) {
            $parent_type = ilObject::_lookupType($this->parent_ref_id, true);
            if (\in_array($parent_type, ['grp', 'crs'], true)) {
                $this->is_container_context = $this->parent_obj_id === null && $this->award_badge === null;
            }
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getActions()

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

private

Returns: array<string, Action>

Definition at line 324 of file class.ilBadgeUserTableGUI.php.

     : array {
        return ($this->award_badge instanceof ilBadge) ? [
            'badge_award_badge' =>
                $this->factory->table()->action()->multi(
                    $this->lng->txt('badge_award_badge'),
                    $url_builder->withParameter($action_parameter_token, 'assignBadge'),
                    $row_id_token
                ),
            'badge_revoke_badge' =>
                $this->factory->table()->action()->multi(
                    $this->lng->txt('badge_remove_badge'),
                    $url_builder->withParameter($action_parameter_token, 'revokeBadge'),
                    $row_id_token
                )
        ] : [];
    }

◆ getColumns()

ILIAS\Badge\ilBadgeUserTableGUI::getColumns ( )

Returns: array<string, Column>

Definition at line 303 of file class.ilBadgeUserTableGUI.php.

                                : array
    {
        $columns = [
            'name' => $this->factory->table()->column()->text($this->lng->txt('name')),
            'login' => $this->factory->table()->column()->text($this->lng->txt('login')),
            'type' => $this->factory->table()->column()->text($this->lng->txt('type')),
            'title' => $this->factory->table()->column()->text($this->lng->txt('title')),
            // Cannot be a date column, because when awarding/revoking badges for uses, the list items may contain NULL values for `issued`
            'issued' => $this->factory->table()->column()->text($this->lng->txt('badge_issued_on'))
        ];
 
        if ($this->is_container_context) {
            $columns['parent'] = $this->factory->table()->column()->text($this->lng->txt('object'));
        }
 
        return $columns;
    }

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

Here is the call graph for this function:

◆ getRows()

ILIAS\Badge\ilBadgeUserTableGUI::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 236 of file class.ilBadgeUserTableGUI.php.

     : 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, ['name', 'login', 'type', 'title', 'parent'], true)) {
                    if ($order_field === 'parent') {
                        $order_field .= '_sortable';
                    }
 
                    return \ilStr::strCmp(
                        $left[$order_field] ?? '',
                        $right[$order_field] ?? ''
                    );
                }
 
                if ($order_field === 'issued') {
                    $order_field .= '_sortable';
                    return $left[$order_field] <=> $right[$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());
        }
 
        foreach ($records as $record) {
            yield $row_builder->buildDataRow($record['id'], $record)->withDisabledAction(
                'badge_award_badge',
                $record['issued'] === null
            )->withDisabledAction(
                'badge_revoke_badge',
                $record['issued'] !== null
            );
        }
    }

References ILIAS\Data\Order\join().

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Badge\ilBadgeUserTableGUI::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 292 of file class.ilBadgeUserTableGUI.php.

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

◆ renderTable()

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

Definition at line 345 of file class.ilBadgeUserTableGUI.php.

                                            : void
    {
        $df = new \ILIAS\Data\Factory();
        $this->date_format = $this->user->getDateTimeFormat();
 
        $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',
        );
 
        if ($this->award_badge instanceof ilBadge) {
            $title = $this->lng->txt('badge_award_badge') . ': ' . $this->award_badge->getTitle();
        } else {
            $parent = '';
            if ($this->parent_obj_id) {
                $title = ilObject::_lookupTitle($this->parent_obj_id);
                if (!$title) {
                    $title = ilObjectDataDeletionLog::get($this->parent_obj_id);
                    if ($title) {
                        $title = $title['title'];
                    }
                }
 
                if ($this->restrict_badge_id) {
                    $badge = new ilBadge($this->restrict_badge_id);
                    $title .= ' - ' . $badge->getTitle();
                }
 
                $parent = $title . ': ';
            }
            $title = $parent . $this->lng->txt('users');
        }
 
        $table = $this->factory
            ->table()
            ->data($this, $title, $this->getColumns())
            ->withId(self::class . '_' . $this->parent_ref_id)
            ->withOrder(new Order('name', Order::ASC))
            ->withActions($this->getActions($url_builder, $action_parameter_token, $row_id_token))
            ->withRequest($this->request);
 
        $out = [$table];
 
        $this->tpl->setContent($this->renderer->render($out));
    }