ILIAS\Test\Settings\Templates\PersonalSettingsTable Class Reference

Inheritance diagram for ILIAS\Test\Settings\Templates\PersonalSettingsTable:

Collaboration diagram for ILIAS\Test\Settings\Templates\PersonalSettingsTable:

Public Member Functions
	__construct (private readonly Language $lng, private readonly UIFactory $ui_factory, private readonly DataFactory $data_factory, private readonly \ilObjUser $user, private readonly RequestDataCollector $test_request, private readonly PersonalSettingsTableActions $table_actions, private readonly URLBuilder $url_builder, private readonly PersonalSettingsRepository $repository,)
	perform ()
	getComponent ()
	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...
	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
	acquireParameters ()
	getColumns ()

Private Attributes
const string	ID = 'pst'

Detailed Description

Definition at line 37 of file PersonalSettingsTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::__construct	(	private readonly Language	$lng,
		private readonly UIFactory	$ui_factory,
		private readonly DataFactory	$data_factory,
		private readonly \ilObjUser	$user,
		private readonly RequestDataCollector	$test_request,
		private readonly PersonalSettingsTableActions	$table_actions,
		private readonly URLBuilder	$url_builder,
		private readonly PersonalSettingsRepository	$repository
	)

Definition at line 41 of file PersonalSettingsTable.php.

      {
    }

Member Function Documentation

acquireParameters()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::acquireParameters ( )

private

Definition at line 58 of file PersonalSettingsTable.php.

                                        : array
    {
        return $this->url_builder->acquireParameters(
            [self::ID],
            PersonalSettingsTableActions::ROW_ID_PARAMETER,
            PersonalSettingsTableActions::ACTION_PARAMETER,
            PersonalSettingsTableActions::ACTION_TYPE_PARAMETER
        );
    }

References ILIAS\Test\Settings\Templates\PersonalSettingsTableActions\ACTION_PARAMETER, ILIAS\Test\Settings\Templates\PersonalSettingsTableActions\ACTION_TYPE_PARAMETER, and ILIAS\Test\Settings\Templates\PersonalSettingsTableActions\ROW_ID_PARAMETER.

Referenced by ILIAS\Test\Settings\Templates\PersonalSettingsTable\perform().

Here is the caller graph for this function:

getColumns()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::getColumns ( )

private

Returns

array<string, Column>

Definition at line 71 of file PersonalSettingsTable.php.

                                 : array
    {
        $column_factory = $this->ui_factory->table()->column();
 
        return [
            'name' => $column_factory->text($this->lng->txt('personal_settings_name')),
            'description' => $column_factory->text($this->lng->txt('personal_settings_description'))->withIsSortable(false),
            'tstamp' => $column_factory->date($this->lng->txt('personal_settings_timestamp'), $this->user->getDateTimeFormat()),
            'author' => $column_factory->text($this->lng->txt('personal_settings_author'))
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getComponent()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::getComponent

(

)

Definition at line 83 of file PersonalSettingsTable.php.

                                  : DataTable
    {
        return $this->ui_factory->table()
            ->data($this, $this->lng->txt('personal_settings_templates_available'), $this->getColumns())
            ->withRequest($this->test_request->getRequest())
            ->withActions($this->table_actions->getActions(...$this->acquireParameters()))
            ->withOrder(new Order('tstamp', Order::DESC))
            ->withId(self::ID);
    }

References ILIAS\Data\Order\DESC, and ILIAS\Repository\lng().

Here is the call graph for this function:

getRows()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::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 93 of file PersonalSettingsTable.php.

     : Generator {
        foreach ($this->repository->getForUser($range, $order) as $template) {
            $row = [
                'name' => $template->getName(),
                'tstamp' => $template->getCreatedAt(),
                'description' => $template->getDescription(),
                'author' => $template->getAuthor(),
            ];
 
            yield $row_builder->buildDataRow((string) $template->getId(), $row);
        }
    }

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::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 114 of file PersonalSettingsTable.php.

     : ?int {
        return $this->repository->countForUser();
    }

perform()

ILIAS\Test\Settings\Templates\PersonalSettingsTable::perform

(

)

Definition at line 53 of file PersonalSettingsTable.php.

                             : ?Modal
    {
        return $this->table_actions->perform(...$this->acquireParameters());
    }

References ILIAS\Test\Settings\Templates\PersonalSettingsTable\acquireParameters().

Here is the call graph for this function:

Field Documentation

ID

const string ILIAS\Test\Settings\Templates\PersonalSettingsTable::ID = 'pst'

private

Definition at line 39 of file PersonalSettingsTable.php.

---

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

• components/ILIAS/Test/src/Settings/Templates/PersonalSettingsTable.php