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\AccessControl\Log\Table, ILIAS\Badge\ilBadgeImageTemplateTableGUI, ilBadgePersonalTableGUI, ILIAS\Badge\ilBadgeTableGUI, ILIAS\Badge\ilBadgeTypesTableGUI, ILIAS\Badge\ilBadgeUserTableGUI, ILIAS\Badge\ilObjectBadgeTableGUI, ilBiblLibraryTableGUI, ILIAS\Calendar\ConsultationHours\BookingTableGUI, ILIAS\Conditions\Configuration\ConditionTriggerTableGUI, ILIAS\Contact\TableRows, ILIAS\Course\Grouping\Table\AssignmentRetrieval, ILIAS\Course\Grouping\Table\GroupingRetrieval, ILIAS\Dashboard\DataRetrieval\Language, ilDidacticTemplateSettingsTableDataRetrieval, ILIAS\ILIASObject\Properties\Translations\TranslationsTable, ilLTIConsumerGradeSynchronizationTableGUI, ilLTIConsumerProviderTableGUI, ilObjectConsumerTableGUI, ILIAS\Mail\Folder\MailFolderTableUI, ILIAS\MetaData\Settings\Vocabularies\DataRetrieval, ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable, ILIAS\components\ResourceStorage\Container\View\RequestToDataTable, ILIAS\Test\Questions\Presentation\QuestionsBrowserTable, ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable, ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable, ILIAS\Test\Results\Toplist\DataRetrieval, ILIAS\Test\Scoring\Manual\ScoringByQuestionTableBinder, ILIAS\Test\Scoring\Marks\MarkSchemaTable, ILIAS\User\Profile\Fields\ConfigurationGUI, ILIAS\User\Settings\ConfigurationGUI, ILIAS\Registration\RegistrationCodesTable, LDAPRoleAssignmentTable, LDAPRoleMappingTable, and ilMailTemplateTable.
◆ 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 ILIAS\AccessControl\Log\Table, ILIAS\AdministrativeNotification\DataRetrieval, ILIAS\components\Authentication\Pages\AuthPageLanguagesOverviewTable, ILIAS\Badge\ilBadgeImageTemplateTableGUI, ilBadgePersonalTableGUI, ILIAS\Badge\ilBadgeTableGUI, ILIAS\Badge\ilBadgeTypesTableGUI, ILIAS\Badge\ilBadgeUserTableGUI, ILIAS\Badge\ilObjectBadgeTableGUI, ilBiblLibraryTableGUI, ILIAS\Bibliographic\FieldFilter\DataRetrieval, ILIAS\Calendar\ConsultationHours\BookingTableGUI, ILIAS\Certificate\Overview\CertificateOverviewTable, ILIAS\Chatroom\Bans\BannedUsersTable, ILIAS\Conditions\Configuration\ConditionTriggerTableGUI, ILIAS\Contact\MailingLists\MailingListsMembersTable, ILIAS\Contact\MailingLists\MailingListsTable, ILIAS\Contact\MemberSearch\MailMemberSearchTable, ILIAS\Contact\TableRows, ilCourseParticipantsGroupsTableDataRetrieval, ILIAS\Course\Grouping\Table\AssignmentRetrieval, ILIAS\Course\Grouping\Table\GroupingRetrieval, ILIAS\Cron\Job\Manager\UI\JobTable, ILIAS\Dashboard\DataRetrieval\Language, ilDidacticTemplateSettingsTableDataRetrieval, ILIAS\Export\ExportHandler\Table\DataRetrieval\Handler, ILIAS\Forum\Drafts\ForumDraftsTable, ILIAS\Forum\Moderation\ForumModeratorsTable, ILIAS\Forum\Notification\ForumNotificationTable, ILIAS\Forum\Statistics\ForumStatisticsTable, ILIAS\ILIASObject\Properties\Translations\TranslationsTable, ilLanguageFolderTable, ilLanguageStatisticsTable, LDAPRoleAssignmentTable, LDAPRoleMappingTable, ILIAS\LDAP\Server\UI\ServerTable, ilLTIConsumerGradeSynchronizationTableGUI, ilLTIConsumerProviderTableGUI, ilLTIConsumerProviderUsageTableGUI, ilObjectConsumerTableGUI, ilLTIProviderReleasedObjectsTableGUI, ILIAS\Mail\Attachments\MailAttachmentTableGUI, ilMailTemplateTable, ILIAS\Mail\Folder\MailFolderTableUI, ILIAS\MetaData\Settings\Vocabularies\DataRetrieval, ILIAS\Registration\RegistrationCodesTable, ILIAS\Repository\Table\TableRetrieval, ILIAS\components\ResourceStorage\Collections\View\RequestToDataTable, ILIAS\components\ResourceStorage\Container\View\RequestToDataTable, ilSamlIdpTableGUI, ilStudyProgrammeTypeDBRepository, ILIAS\Test\Participants\ParticipantTable, ILIAS\Test\Questions\Presentation\QuestionsBrowserTable, ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable, ILIAS\Test\Questions\RandomQuestionSetNonAvailablePoolsTable, ILIAS\Test\Results\Toplist\DataRetrieval, ILIAS\Test\Scoring\Manual\ScoringByQuestionTableBinder, ILIAS\Test\Scoring\Marks\MarkSchemaTable, ILIAS\UI\examples\Table\Data\DataTableDemoRepo, ILIAS\User\Profile\Fields\ConfigurationGUI, and ILIAS\User\Settings\ConfigurationGUI.
The documentation for this interface was generated from the following file:
- components/ILIAS/UI/src/Component/Table/DataRetrieval.php
