Inheritance diagram for ILIAS\MetaData\Settings\Vocabularies\DataRetrieval:

Collaboration diagram for ILIAS\MetaData\Settings\Vocabularies\DataRetrieval:

Public Member Functions
	__construct (VocabManager $vocab_manager, Presentation $presentation, UIFactory $ui_factory)

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

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

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

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

Protected Member Functions
	getVocabs (?Range $range=null)

Protected Attributes
const int	MAX_PREVIEW_VALUES = 5

VocabManager	$vocab_manager

Presentation	$presentation

UIFactory	$ui_factory

array	$vocabs

Detailed Description

Definition at line 31 of file DataRetrieval.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::__construct	(	VocabManager	$vocab_manager,
		Presentation	$presentation,
		UIFactory	$ui_factory
	)

Definition at line 44 of file DataRetrieval.php.

      {
        $this->vocab_manager = $vocab_manager;
        $this->presentation = $presentation;
        $this->ui_factory = $ui_factory;
    }

References ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\$presentation, ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\$ui_factory, and ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\$vocab_manager.

Member Function Documentation

◆ getRows()

ILIAS\MetaData\Settings\Vocabularies\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.

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

Parameters

string[] $visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 54 of file DataRetrieval.php.

     : \Generator {
        $checked_icon = $this->ui_factory->symbol()->icon()->custom(
            'assets/images/standard/icon_checked.svg',
            $this->presentation->txt('yes'),
            'small'
        );
        $unchecked_icon = $this->ui_factory->symbol()->icon()->custom(
            'assets/images/standard/icon_unchecked.svg',
            $this->presentation->txt('yes'),
            'small'
        );
 
        $infos = $this->vocab_manager->infos();
        foreach ($this->getVocabs($range) as $vocab) {
            $record = [];
 
            $record['element'] = $this->presentation->makeSlotPresentable($vocab->slot());
            $record['type'] = $this->presentation->makeTypePresentable($vocab->type());
            $record['source'] = $vocab->source();
            $record['preview'] = implode(
                ', ',
                $this->presentation->makeValuesPresentable($vocab, self::MAX_PREVIEW_VALUES)
            );
            $record['active'] = $vocab->isActive() ? $checked_icon : $unchecked_icon;
            if ($infos->isCustomInputApplicable($vocab)) {
                $record['custom_input'] = $vocab->allowsCustomInputs() ? $checked_icon : $unchecked_icon;
            }
 
            yield $row_builder->buildDataRow(
                $vocab->id(),
                $record
            )->withDisabledAction(
                'delete',
                !$infos->canBeDeleted($vocab)
            )->withDisabledAction(
                'activate',
                $vocab->isActive()
            )->withDisabledAction(
                'deactivate',
                !$vocab->isActive() ||
                !$infos->isDeactivatable($vocab)
            )->withDisabledAction(
                'allow_custom_input',
                !$infos->isCustomInputApplicable($vocab) ||
                $vocab->allowsCustomInputs()
            )->withDisabledAction(
                'disallow_custom_input',
                !$infos->isCustomInputApplicable($vocab) ||
                !$infos->canDisallowCustomInput($vocab) ||
                !$vocab->allowsCustomInputs()
            );
        };
    }

References $vocab, and ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::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 115 of file DataRetrieval.php.

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

◆ getVocabs()

ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::getVocabs ( ?Range $range = null )

protected

Definition at line 120 of file DataRetrieval.php.

                                                      : array
    {
        if (isset($this->vocabs)) {
            $vocabs = $this->vocabs;
        } else {
            $vocabs = iterator_to_array($this->vocab_manager->getAllVocabularies(), false);
        }
 
        if ($range) {
            $vocabs = array_slice($vocabs, $range->getStart(), $range->getLength());
        }
 
        return $this->vocabs = $vocabs;
    }

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Data\Range\getLength(), and ILIAS\Data\Range\getStart().

Here is the call graph for this function:

Field Documentation

◆ $presentation

Presentation ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::$presentation

protected

Definition at line 36 of file DataRetrieval.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\__construct().

◆ $ui_factory

UIFactory ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::$ui_factory

protected

Definition at line 37 of file DataRetrieval.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\__construct().

◆ $vocab_manager

VocabManager ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::$vocab_manager

protected

Definition at line 35 of file DataRetrieval.php.

Referenced by ILIAS\MetaData\Settings\Vocabularies\DataRetrieval\__construct().

◆ $vocabs

array ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::$vocabs

protected

Definition at line 42 of file DataRetrieval.php.

◆ MAX_PREVIEW_VALUES

const int ILIAS\MetaData\Settings\Vocabularies\DataRetrieval::MAX_PREVIEW_VALUES = 5

protected

Definition at line 33 of file DataRetrieval.php.

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

components/ILIAS/MetaData/classes/Settings/Vocabularies/DataRetrieval.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getRows()

◆ getTotalRowCount()

◆ getVocabs()

Field Documentation

◆ $presentation

◆ $ui_factory

◆ $vocab_manager

◆ $vocabs

◆ MAX_PREVIEW_VALUES