ILIAS\UI\Component\Table\DataRetrieval Interface Reference

Inheritance diagram for ILIAS\UI\Component\Table\DataRetrieval:

Collaboration diagram for ILIAS\UI\Component\Table\DataRetrieval:

Public Member Functions
	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...

Detailed Description

Definition at line 27 of file DataRetrieval.php.

Member Function Documentation

getRows()

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.

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

Parameters

string[]

$visible_column_ids

Implemented in ILIAS\Mail\Folder\MailFolderTableUI, ILIAS\components\ResourceStorage\Container\View\RequestToDataTable, ilBiblLibraryTableGUI, ILIAS\Test\Questions\Presentation\QuestionsBrowserTable, ILIAS\AccessControl\Log\Table, ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable, ILIAS\Test\Scoring\Marks\MarkSchemaTable, ILIAS\Test\Results\Toplist\DataRetrieval, ilBadgePersonalTableGUI, ILIAS\Calendar\ConsultationHours\BookingTableGUI, ILIAS\Conditions\Configuration\ConditionTriggerTableGUI, ilDidacticTemplateSettingsTableDataRetrieval, ILIAS\MetaData\Settings\Vocabularies\DataRetrieval, ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable, ILIAS\Test\Scoring\Manual\ScoringByQuestionTableBinder, ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable, and ILIAS\Dashboard\DataRetrieval\Language.

Referenced by ILIAS\Certificate\Overview\CertificateOverviewTable\__construct(), ILIAS\Test\Participants\ParticipantTable\getTotalRowCount(), and ILIAS\Export\ExportHandler\Table\DataRetrieval\Handler\withExportObject().

Here is the caller graph for this function:

getTotalRowCount()

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

Implemented in ilStudyProgrammeTypeDBRepository, ILIAS\Mail\Folder\MailFolderTableUI, ILIAS\components\ResourceStorage\Container\View\RequestToDataTable, ILIAS\Badge\ilBadgeUserTableGUI, ILIAS\Badge\ilBadgeTableGUI, ilLanguageFolderTable, ILIAS\Forum\Statistics\ForumStatisticsTable, ILIAS\Contact\MailingLists\MailingListsTable, ilSamlIdpTableGUI, ILIAS\Mail\Attachments\MailAttachmentTableGUI, ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable, ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable, ILIAS\Chatroom\Bans\BannedUsersTable, ILIAS\Test\Questions\Presentation\QuestionsBrowserTable, ILIAS\AccessControl\Log\Table, ilBiblLibraryTableGUI, ILIAS\Forum\Moderation\ForumModeratorsTable, ILIAS\Certificate\Overview\CertificateOverviewTable, ILIAS\Contact\MemberSearch\MailMemberSearchTable, ILIAS\Badge\ilBadgeImageTemplateTableGUI, ILIAS\Contact\MailingLists\MailingListsMembersTable, ILIAS\Export\ExportHandler\Table\DataRetrieval\Handler, ILIAS\Badge\ilBadgeTypesTableGUI, ilLanguageStatisticsTable, ILIAS\Forum\Drafts\ForumDraftsTable, ILIAS\Badge\ilObjectBadgeTableGUI, ILIAS\COPage\Editor\Server\UI\ServerTable, ILIAS\BackgroundTasks\Task\Job\Manager\UI\JobTable, ilBadgePersonalTableGUI, ILIAS\Test\Scoring\Marks\MarkSchemaTable, ILIAS\Test\Results\Toplist\DataRetrieval, ILIAS\MetaData\Settings\Vocabularies\DataRetrieval, ILIAS\Calendar\ConsultationHours\BookingTableGUI, ILIAS\Conditions\Configuration\ConditionTriggerTableGUI, ILIAS\Test\Participants\ParticipantTable, ilDidacticTemplateSettingsTableDataRetrieval, ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable, ILIAS\Test\Scoring\Manual\ScoringByQuestionTableBinder, ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable, and ILIAS\Dashboard\DataRetrieval\Language.

---

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

• components/ILIAS/UI/src/Component/Table/DataRetrieval.php