Inheritance diagram for ILIAS\Forum\Statistics\ForumStatisticsTable:

Collaboration diagram for ILIAS\Forum\Statistics\ForumStatisticsTable:

Public Member Functions
	__construct (private readonly ilObjForum $forum, private readonly ilForumProperties $obj_properties, private readonly bool $has_general_lp_access, private readonly bool $has_rbac_or_position_access, private readonly ilObjUser $actor, private readonly UIFactory $ui_factory, private readonly HttpRequest $request, private readonly ilLanguage $lng,)

	getComponent ()

	getRows (\ILIAS\UI\Component\Table\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...

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

	initRecords ()

	sortedRecords (array $records, Order $order)

	getRecords (Range $range, Order $order)

	limitRecords (array $records, Range $range)

	getProgressStatus (int $user_id)

Private Attributes
bool	$has_active_lp = false

array	$completed = []

array	$failed = []

array	$in_progress = []

array	$records = null

readonly ilLPStatusIcons	$icons

Detailed Description

Definition at line 39 of file ForumStatisticsTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Forum\Statistics\ForumStatisticsTable::__construct	(	private readonly ilObjForum	$forum,
		private readonly ilForumProperties	$obj_properties,
		private readonly bool	$has_general_lp_access,
		private readonly bool	$has_rbac_or_position_access,
		private readonly ilObjUser	$actor,
		private readonly UIFactory	$ui_factory,
		private readonly HttpRequest	$request,
		private readonly ilLanguage	$lng
	)

Definition at line 54 of file ForumStatisticsTable.php.

References ilLPStatusWrapper\_lookupCompletedForObject(), ilLPStatusWrapper\_lookupFailedForObject(), ilLPStatusWrapper\_lookupInProgressForObject(), ilLPStatusIcons\getInstance(), ilObjectLP\getInstance(), ilLPStatusIcons\ICON_VARIANT_LONG, and ILIAS\Repository\lng().

       {
         $this->icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
 
         $lp = ilObjectLP::getInstance($forum->getId());
         if ($lp->isActive()) {
             $this->has_active_lp = true;
         }
 
         if ($this->has_active_lp && $this->has_general_lp_access) {
             $this->lng->loadLanguageModule('trac');
             $this->completed = ilLPStatusWrapper::_lookupCompletedForObject($forum->getId());
             $this->in_progress = ilLPStatusWrapper::_lookupInProgressForObject($forum->getId());
             $this->failed = ilLPStatusWrapper::_lookupFailedForObject($forum->getId());
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ getColumns()

ILIAS\Forum\Statistics\ForumStatisticsTable::getColumns ( )

private

Returns: array<string, >

Definition at line 95 of file ForumStatisticsTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\getComponent().

                                  : array
     {
         $columns = [
             'ranking' => $this->ui_factory->table()->column()->number(
                 $this->lng->txt('frm_statistics_ranking')
             )->withIsSortable(true),
             'login' => $this->ui_factory->table()->column()->text(
                 $this->lng->txt('login')
             )->withIsSortable(true),
             'lastname' => $this->ui_factory->table()->column()->text(
                 $this->lng->txt('lastname')
             )->withIsSortable(true),
             'firstname' => $this->ui_factory->table()->column()->text(
                 $this->lng->txt('firstname')
             )->withIsSortable(true),
         ];
         if ($this->has_active_lp && $this->has_general_lp_access) {
             $columns['progress'] = $this->ui_factory->table()->column()->status(
                 $this->lng->txt('learning_progress')
             )->withIsSortable(false);
         }
 
         return $columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\Forum\Statistics\ForumStatisticsTable::getComponent ( )

Definition at line 79 of file ForumStatisticsTable.php.

References ILIAS\Forum\Statistics\ForumStatisticsTable\getColumns(), and ILIAS\Repository\lng().

                                   : DataTable
     {
         return $this->ui_factory
             ->table()
             ->data(
                 $this,
                 $this->lng->txt('frm_moderators'),
                 $this->getColumns()
             )
             ->withId(self::class . '_' . $this->forum->getId())
             ->withRequest($this->request);
     }

Here is the call graph for this function:

◆ getProgressStatus()

ILIAS\Forum\Statistics\ForumStatisticsTable::getProgressStatus ( int $user_id )

private

Definition at line 205 of file ForumStatisticsTable.php.

References $user_id, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\initRecords().

                                                     : string
     {
         $icon = '';
         if ($this->has_active_lp &&
             $this->has_general_lp_access &&
             ($this->has_rbac_or_position_access || $this->actor->getId() === $user_id)) {
             $icon = match (true) {
                 \in_array($user_id, $this->completed, false) => $this->icons->renderIconForStatus(
                     ilLPStatus::LP_STATUS_COMPLETED_NUM
                 ),
                 \in_array($user_id, $this->in_progress, false) => $this->icons->renderIconForStatus(
                     ilLPStatus::LP_STATUS_IN_PROGRESS_NUM
                 ),
                 \in_array($user_id, $this->failed, false) => $this->icons->renderIconForStatus(
                     ilLPStatus::LP_STATUS_FAILED_NUM
                 ),
                 default => $this->icons->renderIconForStatus(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM),
             };
         }
 
         return $icon;
     }

Here is the caller graph for this function:

◆ getRecords()

ILIAS\Forum\Statistics\ForumStatisticsTable::getRecords	(	Range	$range,
		Order	$order
	)

private

Returns: list<array<string, mixed>>

Definition at line 166 of file ForumStatisticsTable.php.

References ILIAS\Forum\Statistics\ForumStatisticsTable\initRecords(), ILIAS\Forum\Statistics\ForumStatisticsTable\limitRecords(), and ILIAS\Forum\Statistics\ForumStatisticsTable\sortedRecords().

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\getRows().

                                                            : array
     {
         $this->initRecords();
         $records = $this->sortedRecords($this->records, $order);
 
         return $this->limitRecords($records, $range);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\Forum\Statistics\ForumStatisticsTable::getRows	(	\ILIAS\UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 183 of file ForumStatisticsTable.php.

References ILIAS\Forum\Statistics\ForumStatisticsTable\getRecords().

      : \Generator {
         $records = $this->getRecords($range, $order);
         foreach ($records as $record) {
             $row_id = (string) $record['usr_id'];
             yield $row_builder->buildDataRow($row_id, $record);
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Forum\Statistics\ForumStatisticsTable::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 198 of file ForumStatisticsTable.php.

References ILIAS\Forum\Statistics\ForumStatisticsTable\initRecords().

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

Here is the call graph for this function:

◆ initRecords()

ILIAS\Forum\Statistics\ForumStatisticsTable::initRecords ( )

private

Definition at line 120 of file ForumStatisticsTable.php.

References $data, ILIAS\Forum\Statistics\ForumStatisticsTable\getProgressStatus(), and null.

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\getRecords(), and ILIAS\Forum\Statistics\ForumStatisticsTable\getTotalRowCount().

                                   : void
     {
         if ($this->records === null) {
             $this->records = [];
             $data = $this->forum->Forum->getUserStatistics($this->obj_properties->isPostActivationEnabled());
             $counter = 0;
             foreach ($data as $row) {
                 $this->records[$counter]['usr_id'] = $row['usr_id'];
                 $this->records[$counter]['ranking'] = $row['num_postings'];
                 $this->records[$counter]['login'] = $row['login'];
                 $this->records[$counter]['lastname'] = $row['lastname'];
                 $this->records[$counter]['firstname'] = $row['firstname'];
                 if ($this->has_active_lp && $this->has_general_lp_access) {
                     $this->records[$counter]['progress'] = $this->getProgressStatus($row['usr_id']);
                 }
                 ++$counter;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ limitRecords()

ILIAS\Forum\Statistics\ForumStatisticsTable::limitRecords	(	array	$records,
		Range	$range
	)

private

Parameters

list<array<string,mixed>> $records

Returns: list<array<string, mixed>>

Definition at line 178 of file ForumStatisticsTable.php.

References ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\getRecords().

                                                                : array
     {
         return \array_slice($records, $range->getStart(), $range->getLength());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortedRecords()

ILIAS\Forum\Statistics\ForumStatisticsTable::sortedRecords	(	array	$records,
		Order	$order
	)

private

Parameters

list<array<string,mixed>> $records

Returns: list<array<string, mixed>>

Definition at line 144 of file ForumStatisticsTable.php.

References ILIAS\Forum\Statistics\ForumStatisticsTable\$records, ILIAS\Data\Order\join(), and ilStr\strCmp().

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\getRecords().

                                                                 : array
     {
         [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
 
         usort($records, static function ($left, $right) use ($order_field): int {
             if ($order_field === 'ranking') {
                 return $left[$order_field] <=> $right[$order_field];
             }
 
             return ilStr::strCmp($left[$order_field], $right[$order_field]);
         });
 
         if ($order_direction === 'DESC') {
             $records = array_reverse($records);
         }
 
         return $records;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $completed

array ILIAS\Forum\Statistics\ForumStatisticsTable::$completed = []

private

Definition at line 43 of file ForumStatisticsTable.php.

◆ $failed

array ILIAS\Forum\Statistics\ForumStatisticsTable::$failed = []

private

Definition at line 45 of file ForumStatisticsTable.php.

◆ $has_active_lp

bool ILIAS\Forum\Statistics\ForumStatisticsTable::$has_active_lp = false

private

Definition at line 41 of file ForumStatisticsTable.php.

◆ $icons

readonly ilLPStatusIcons ILIAS\Forum\Statistics\ForumStatisticsTable::$icons

private

Definition at line 52 of file ForumStatisticsTable.php.

◆ $in_progress

array ILIAS\Forum\Statistics\ForumStatisticsTable::$in_progress = []

private

Definition at line 47 of file ForumStatisticsTable.php.

◆ $records

array ILIAS\Forum\Statistics\ForumStatisticsTable::$records = null

private

Definition at line 51 of file ForumStatisticsTable.php.

Referenced by ILIAS\Forum\Statistics\ForumStatisticsTable\sortedRecords().

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

components/ILIAS/Forum/classes/Statistics/ForumStatisticsTable.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getColumns()

◆ getComponent()

◆ getProgressStatus()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

◆ initRecords()

◆ limitRecords()

◆ sortedRecords()

Field Documentation

◆ $completed

◆ $failed

◆ $has_active_lp

◆ $icons

◆ $in_progress

◆ $records