ILIAS\Rating\RatingCategoryOrderingTable Class Reference

Inheritance diagram for ILIAS\Rating\RatingCategoryOrderingTable:

Collaboration diagram for ILIAS\Rating\RatingCategoryOrderingTable:

Public Member Functions
	__construct (private readonly int $parent_obj_id, private readonly Factory $ui_factory, private readonly ilLanguage $lng, private readonly ilCtrlInterface $ctrl, private readonly DataFactory $data_factory, private readonly ServerRequestInterface $httpRequest,)
	getComponent ()
	getActions (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token)
	getRows (OrderingRowBuilder $row_builder, array $visible_column_ids,)
	This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	initRecords ()
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	getRows (OrderingRowBuilder $row_builder, array $visible_column_ids)
	This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

Private Member Functions
	getColumns ()

Private Attributes
array	$records = null

Detailed Description

Definition at line 37 of file RatingCategoryOrderingTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Rating\RatingCategoryOrderingTable::__construct	(	private readonly int	$parent_obj_id,
		private readonly Factory	$ui_factory,
		private readonly ilLanguage	$lng,
		private readonly ilCtrlInterface	$ctrl,
		private readonly DataFactory	$data_factory,
		private readonly ServerRequestInterface	$httpRequest
	)

Definition at line 41 of file RatingCategoryOrderingTable.php.

      {
    }

Member Function Documentation

getActions()

ILIAS\Rating\RatingCategoryOrderingTable::getActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token
	)

Definition at line 85 of file RatingCategoryOrderingTable.php.

     : array {
        return [
            'edit' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $url_builder->withParameter($action_parameter_token, 'edit'),
                $row_id_token
            ),
            'delete' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('delete'),
                $url_builder->withParameter($action_parameter_token, 'confirmDelete'),
                $row_id_token
            )
        ];
    }

Referenced by ILIAS\Rating\RatingCategoryOrderingTable\getComponent().

Here is the caller graph for this function:

getColumns()

ILIAS\Rating\RatingCategoryOrderingTable::getColumns ( )

private

Returns

array{ title: \ILIAS\UI\Component\Table\Column\Text, description: \ILIAS\UI\Component\Table\Column\Text }

Definition at line 127 of file RatingCategoryOrderingTable.php.

                                 : array
    {
        return [
            'title' => $this->ui_factory->table()->column()->text($this->lng->txt('title')),
            'description' => $this->ui_factory->table()->column()->text($this->lng->txt('description'))
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getComponent()

ILIAS\Rating\RatingCategoryOrderingTable::getComponent

(

)

Definition at line 51 of file RatingCategoryOrderingTable.php.

                                  : Ordering
    {
        $query_params_namespace = ['rating', 'category', 'ordering'];
        $uri = $this->data_factory->uri(
            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(ilRatingCategoryGUI::class, 'handleTableActions')
        );
        $url_builder = new URLBuilder($uri);
        [$url_builder, $action_parameter_token, $row_id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            'table_action',
            'rating_ids'
        );
 
        return $this->ui_factory
            ->table()
            ->ordering(
                $this,
                $uri->withParameter('cmd', 'updateOrder'),
                $this->lng->txt('rating_categories'),
                $this->getColumns(),
            )
            ->withId(
                'rating_category_ordering_table'
            )
            ->withRequest($this->httpRequest)
            ->withActions(
                $this->getActions(
                    $url_builder,
                    $action_parameter_token,
                    $row_id_token
                )
            );
    }

References ILIAS\Repository\ctrl(), and ILIAS\Rating\RatingCategoryOrderingTable\getActions().

Here is the call graph for this function:

getRows()

ILIAS\Rating\RatingCategoryOrderingTable::getRows	(	OrderingRowBuilder	$row_builder,
		array	$visible_column_ids
	)

This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildOrderingRow($row_id, $record).

Implements ILIAS\UI\Component\Table\OrderingRetrieval.

Definition at line 104 of file RatingCategoryOrderingTable.php.

     : Generator {
        $this->initRecords();
        foreach ($this->records as $record) {
            yield $row_builder->buildOrderingRow((string) $record['id'], $record);
        }
    }

References ILIAS\UI\Component\Table\OrderingRowBuilder\buildOrderingRow().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Rating\RatingCategoryOrderingTable::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 135 of file RatingCategoryOrderingTable.php.

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

initRecords()

ILIAS\Rating\RatingCategoryOrderingTable::initRecords

(

)

Definition at line 114 of file RatingCategoryOrderingTable.php.

                                 : void
    {
        if (!$this->records) {
            $this->records = ilRatingCategory::getAllForObject($this->parent_obj_id);
        }
    }

References ilRatingCategory\getAllForObject().

Here is the call graph for this function:

Field Documentation

$records

array ILIAS\Rating\RatingCategoryOrderingTable::$records = null

private

Definition at line 39 of file RatingCategoryOrderingTable.php.

---

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

• components/ILIAS/Rating/classes/RatingCategoryOrderingTable.php