Inheritance diagram for ILIAS\File\Versions\Table\DataRetrieval:

Collaboration diagram for ILIAS\File\Versions\Table\DataRetrieval:

Public Member Functions
	__construct (private readonly \ilObjFile $file, private readonly int $current_version, private readonly bool $current_version_is_draft, private readonly int $amount_of_versions, private readonly \ilCtrlInterface $ctrl, private readonly \ilFileVersionsGUI $parent_gui, private readonly \ilLanguage $lng, private readonly UIFactory $ui_factory)

	getRows (I\DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)

	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...

Public Member Functions inherited from ILIAS\UI\Component\Table\DataRetrieval
	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...

Data Fields
const string	ACTION_DELETE = 'delete'

const string	ACTION_ROLLBACK = 'rollback'

const string	ACTION_PUBLISH = 'publish'

const string	ACTION_UNPUBLISH = 'unpublish'

Private Member Functions
	getRecords (Order $order)

	mapRecord (array $record)

Detailed Description

Definition at line 29 of file DataRetrieval.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\File\Versions\Table\DataRetrieval::__construct	(	private readonly \ilObjFile	$file,
		private readonly int	$current_version,
		private readonly bool	$current_version_is_draft,
		private readonly int	$amount_of_versions,
		private readonly \ilCtrlInterface	$ctrl,
		private readonly \ilFileVersionsGUI	$parent_gui,
		private readonly \ilLanguage	$lng,
		private readonly UIFactory	$ui_factory
	)

Definition at line 36 of file DataRetrieval.php.

45 {

46 }

Member Function Documentation

◆ getRecords()

ILIAS\File\Versions\Table\DataRetrieval::getRecords ( Order $order )

private

Returns: array<int, array<string, mixed>>

Definition at line 94 of file DataRetrieval.php.

                                             : array
    {
        $records = [];
        foreach ($this->file->getVersions() as $version) {
            $records[] = $version->getArrayCopy();
        }
 
        [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value): array => [$key, $value]);
        if ($order_field === 'version') {
            usort($records, static fn(array $a, array $b): int => (int) $a['version'] <=> (int) $b['version']);
        } else {
            usort($records, static fn(array $a, array $b): int => ($a[$order_field] ?? null) <=> ($b[$order_field] ?? null));
        }
        if ($order_direction === 'DESC') {
            $records = array_reverse($records);
        }
        return $records;
    }

References Vendor\Package\$a, Vendor\Package\$b, $version, and ILIAS\Data\Order\join().

Here is the call graph for this function:

◆ getRows()

ILIAS\File\Versions\Table\DataRetrieval::getRows	(	I\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Definition at line 48 of file DataRetrieval.php.

     : \Generator {
        $records = $this->getRecords($order);
        foreach ($records as $record) {
            $row_id = (string) $record['hist_entry_id'];
            $version_number = (int) $record['version'];
            $is_current = $version_number === $this->current_version;
 
            yield $row_builder->buildDataRow($row_id, $this->mapRecord($record))
                ->withDisabledAction(
                    self::ACTION_DELETE,
                    $this->current_version_is_draft
                )
                ->withDisabledAction(
                    self::ACTION_ROLLBACK,
                    $this->current_version_is_draft || $is_current
                )
                ->withDisabledAction(
                    self::ACTION_PUBLISH,
                    !($this->current_version_is_draft && $is_current)
                )
                ->withDisabledAction(
                    self::ACTION_UNPUBLISH,
                    $this->current_version_is_draft || !$is_current || $this->amount_of_versions <= 1
                );
        }
    }

References ILIAS\Repository\int(), and ILIAS\File\Versions\Table\DataRetrieval\mapRecord().

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\File\Versions\Table\DataRetrieval::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 83 of file DataRetrieval.php.

     : ?int {
        return count($this->file->getVersions());
    }

◆ mapRecord()

ILIAS\File\Versions\Table\DataRetrieval::mapRecord ( array $record )

private

Parameters

array<string,mixed> $record

Returns: array<string, mixed>

Definition at line 117 of file DataRetrieval.php.

                                             : array
    {
        $hist_id = (int) $record['hist_entry_id'];
 
        $name = \ilObjUser::_lookupName((int) $record['user_id']);
        $username = trim(($name['title'] ?? '') . ' ' . ($name['firstname'] ?? '') . ' ' . ($name['lastname'] ?? ''));
 
        $action_label = $this->lng->txt('file_version_' . $record['action']);
        if ($record['action'] === 'rollback') {
            $rollback_name = \ilObjUser::_lookupName((int) $record['rollback_user_id']);
            $rollback_username = trim(
                ($rollback_name['title'] ?? '') . ' ' .
                ($rollback_name['firstname'] ?? '') . ' ' .
                ($rollback_name['lastname'] ?? '')
            );
            $action_label = sprintf($action_label, $record['rollback_version'], $rollback_username);
        }
 
        $this->ctrl->setParameter($this->parent_gui, \ilFileVersionsGUI::HIST_ID, $hist_id);
        $download_url = $this->ctrl->getLinkTarget($this->parent_gui, \ilFileVersionsGUI::CMD_DOWNLOAD_VERSION);
        $this->ctrl->setParameter($this->parent_gui, \ilFileVersionsGUI::HIST_ID, '');
 
        $filename_link = $this->ui_factory->link()->standard((string) $record['filename'], $download_url);
 
        $size = new DataSize((int) ($record['size'] ?? 0), DataSize::KB);
 
        return [
            'version' => (int) $record['version'],
            'filename' => $filename_link,
            'date' => new \DateTimeImmutable((string) $record['date']),
            'uploaded_by' => $username,
            'versionname' => (string) ($record['title'] ?? ''),
            'filesize' => (string) $size,
            'status' => $action_label,
        ];
    }