Collaboration diagram for ilBiblEntryTableGUI:

Public Member Functions
	__construct (protected ilObjBibliographicGUI $a_parent_obj, protected ilBiblFactoryFacade $facade, protected UIServices $ui)

	getRenderedTableAndExistingFilters ()

	getSortationsMapping ()

Data Fields
const	P_PAGE = 'page'

const	P_SORTATION = 'sortation'

const	SORTATION_BY_TITLE_ASC = 1

const	SORTATION_BY_TITLE_DESC = 2

const	SORTATION_BY_AUTHOR_ASC = 3

const	SORTATION_BY_AUTHOR_DESC = 4

const	SORTATION_BY_YEAR_ASC = 5

const	SORTATION_BY_YEAR_DESC = 6

Protected Member Functions
	buildFilter ()

	buildTable ()

	getSortedRecords (array $records)

	getRecordsOfCurrentPage (array $records)

Protected Attributes
array	$filter_objects = []

Private Member Functions
	renderLibraryButtons (int $entry_id)

	determinePage ()

	determineSortation ()

Private Attributes
readonly HttpServices	$http

readonly ilLanguage	$lng

readonly UIFactory	$ui_factory

readonly Renderer	$ui_renderer

readonly ilCtrlInterface	$ctrl

readonly Factory	$refinery

int	$current_page = 0

int	$entries_per_page = 10

readonly ilUIService	$ui_service

StandardFilter	$filter

PresentationTable	$table

Detailed Description

Definition at line 28 of file class.ilBiblEntryTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblEntryTableGUI::__construct	(	protected ilObjBibliographicGUI	$a_parent_obj,
		protected ilBiblFactoryFacade	$facade,
		protected UIServices	$ui
	)

Definition at line 54 of file class.ilBiblEntryTableGUI.php.

References $DIC, buildFilter(), buildTable(), ILIAS\Repository\ctrl(), ILIAS\Repository\filter(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

       {
         global $DIC;
         $this->ctrl = $DIC->ctrl();
         $this->http = $DIC->http();
         $this->lng = $DIC->language();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->ui_service = $DIC->uiService();
         $this->refinery = $DIC->refinery();
         $this->ctrl->saveParameterByClass(ilObjBibliographicGUI::class, self::P_PAGE);
         $this->ctrl->saveParameterByClass(ilObjBibliographicGUI::class, self::P_SORTATION);
 
         $this->filter = $this->buildFilter();
         $this->table = $this->buildTable();
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildFilter()

ilBiblEntryTableGUI::buildFilter ( )

protected

Definition at line 83 of file class.ilBiblEntryTableGUI.php.

References ilObjBibliographicGUI\CMD_SHOW_CONTENT, ILIAS\Repository\ctrl(), ilBiblField\getId(), and ilBiblField\getIdentifier().

Referenced by __construct().

                                     : ?StandardFilter
     {
         $filter_objects = $this->facade->filterFactory()->getAllForObjectId($this->facade->iliasObjId());
         if (empty($filter_objects)) {
             return null;
         }
 
         $available_field_ids_for_object = array_map(
             static fn(ilBiblField $field): ?int => $field->getId(),
             $this->facade->fieldFactory()->getAvailableFieldsForObjId($this->facade->iliasObjId())
         );
 
         $filter_inputs = [];
         $filter_active_states = [];
         foreach ($filter_objects as $filter_object) {
             if (in_array($filter_object->getFieldId(), $available_field_ids_for_object, true)) {
                 $filter_presentation = new ilBiblFieldFilterPresentationGUI($filter_object, $this->facade);
                 $field = $this->facade->fieldFactory()->findById($filter_object->getFieldId());
                 $post_var = $field->getIdentifier();
                 $filter_input = $filter_presentation->getFilterInput();
                 $filter_inputs[$post_var] = $filter_input;
                 $filter_active_states[] = true;
                 $this->filter_objects[$post_var] = $filter_object;
             }
         }
 
         return $this->ui_service->filter()->standard(
             'bibl_entry_filter',
             $this->ctrl->getLinkTargetByClass(
                 ilObjBibliographicGUI::class,
                 ilObjBibliographicGUI::CMD_SHOW_CONTENT,
                 "",
                 true
             ),
             $filter_inputs,
             $filter_active_states,
             true,
             true
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTable()

ilBiblEntryTableGUI::buildTable ( )

protected

Definition at line 146 of file class.ilBiblEntryTableGUI.php.

References ilObjBibliographicGUI\CMD_SHOW_CONTENT, ILIAS\Repository\ctrl(), determinePage(), ILIAS\Repository\filter(), ilBiblFieldFilterInterface\FILTER_TYPE_MULTI_SELECT_INPUT, ilBiblFieldFilterInterface\FILTER_TYPE_SELECT_INPUT, ilBiblFieldFilterInterface\FILTER_TYPE_TEXT_INPUT, getRecordsOfCurrentPage(), getSortationsMapping(), getSortedRecords(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), renderLibraryButtons(), and ILIAS\UI\Implementation\Component\Table\PresentationRow\withHeadline().

Referenced by __construct().

                                    : PresentationTable
     {
         $records = $this->getData();
         $sorted_records = $this->getSortedRecords($records);
         $this->current_page = $this->determinePage();
         $records_current_page = $this->getRecordsOfCurrentPage($sorted_records);
         $view_controls = [];
         $sortations = [];
         foreach (array_keys($this->getSortationsMapping()) as $sort_id) {
             $sortations[$sort_id] = $this->lng->txt('sorting_' . $sort_id);
         }
         if ($sortations !== []) {
             $view_controls[] = $this->ui_factory->viewControl()->sortation($sortations, array_key_first($sortations))
                                                 ->withTargetURL(
                                                     $this->ctrl->getLinkTargetByClass(
                                                         ilObjBibliographicGUI::class,
                                                         ilObjBibliographicGUI::CMD_SHOW_CONTENT
                                                     ),
                                                     self::P_SORTATION
                                                 );
         }
 
         $view_controls[] = $this->ui_factory->viewControl()->pagination()
                                             ->withTargetURL($this->http->request()->getRequestTarget(), self::P_PAGE)
                                             ->withTotalEntries(count($records))
                                             ->withPageSize($this->entries_per_page)
                                             ->withCurrentPage($this->current_page);
 
         return $this->ui_factory->table()->presentation(
             "",
             $view_controls,
             function (
                 PresentationRow $row,
                 array $record,
                 UIFactory $ui_factory
             ): PresentationRow {
                 // Create row with fields and actions
                 $record['author'] = empty($record['author']) ? null : $record['author'];
                 $record['title'] = empty($record['title']) ? null : $record['title'];
                 $record['year'] = empty($record['year']) ? null : $record['year'];
 
                 $author = $record['autor'] = $record['author'] ?? $record['AU'] ?? '';
                 $title = ($record['title'] ??= $record['TI'] ?? '');
                 $year = ($record['year'] ??= $record['PY'] ?? '');
                 $entry_id = $record['entry_id'];
 
                 unset($record['author'], $record['title'], $record['AU'], $record['TI'], $record['entry_id']);
 
                 $translated_record = $this->getRecordWithTranslatedKeys($record);
 
                 $this->ctrl->setParameterByClass(ilObjBibliographicGUI::class, 'entry_id', $entry_id);
 
                 return $row
                     ->withHeadline($title)
                     ->withAction(
                         $this->ui_factory->button()->shy(
                             $this->lng->txt('detail_view'),
                             $this->ctrl->getLinkTargetByClass(
                                 ilObjBibliographicGUI::class,
                                 'showDetails'
                             )
                         )
                     )
                     ->withSubheadline($author)
                     ->withImportantFields([$year])
                     ->withFurtherFields($this->renderLibraryButtons($entry_id))
                     ->withContent($ui_factory->listing()->descriptive($translated_record));
             }
         )->withData($records_current_page);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determinePage()

ilBiblEntryTableGUI::determinePage ( )

private

Definition at line 312 of file class.ilBiblEntryTableGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by buildTable().

                                     : int
     {
         return $this->http->wrapper()->query()->has(self::P_PAGE)
             ? $this->http->wrapper()->query()->retrieve(self::P_PAGE, $this->refinery->kindlyTo()->int())
             : 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineSortation()

ilBiblEntryTableGUI::determineSortation ( )

private

Definition at line 319 of file class.ilBiblEntryTableGUI.php.

References getSortationsMapping(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by getSortedRecords().

                                          : int
     {
         return $this->http->wrapper()->query()->has(self::P_SORTATION)
             ? $this->http->wrapper()->query()->retrieve(self::P_SORTATION, $this->refinery->kindlyTo()->int())
             : array_keys($this->getSortationsMapping())[0] ?? self::SORTATION_BY_TITLE_ASC;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordsOfCurrentPage()

ilBiblEntryTableGUI::getRecordsOfCurrentPage ( array $records )

protected

Definition at line 288 of file class.ilBiblEntryTableGUI.php.

References $entries_per_page, and ActiveRecord\where().

Referenced by buildTable().

                                                               : array
     {
         $offset = array_search($this->current_page * $this->entries_per_page, array_keys($records), true);
         $length = $this->entries_per_page;
         return array_slice($records, $offset, $length);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRenderedTableAndExistingFilters()

ilBiblEntryTableGUI::getRenderedTableAndExistingFilters ( )

Definition at line 74 of file class.ilBiblEntryTableGUI.php.

References $components, $filter, $table, and ILIAS\Repository\filter().

                                                         : string
     {
         if ($this->filter !== null) {
             $components[] = $this->filter;
         }
         $components[] = $this->table;
         return $this->ui_renderer->render($components);
     }

Here is the call graph for this function:

◆ getSortationsMapping()

ilBiblEntryTableGUI::getSortationsMapping ( )

Definition at line 326 of file class.ilBiblEntryTableGUI.php.

Referenced by buildTable(), determineSortation(), and getSortedRecords().

                                           : array
     {
         return [
             self::SORTATION_BY_TITLE_ASC => 'title ASC',
             self::SORTATION_BY_TITLE_DESC => 'title DESC',
             self::SORTATION_BY_AUTHOR_ASC => 'author ASC',
             self::SORTATION_BY_AUTHOR_DESC => 'author DESC',
             self::SORTATION_BY_YEAR_ASC => 'year ASC',
             self::SORTATION_BY_YEAR_DESC => 'year DESC'
         ];
     }

Here is the caller graph for this function:

◆ getSortedRecords()

ilBiblEntryTableGUI::getSortedRecords ( array $records )

protected

Definition at line 276 of file class.ilBiblEntryTableGUI.php.

References determineSortation(), and getSortationsMapping().

Referenced by buildTable().

                                                        : array
     {
         $sortation = $this->determineSortation();
         $sortation_mapping = $this->getSortationsMapping();
         $sortation_string = $sortation_mapping[$sortation];
         $sortation_parts = explode(' ', (string) $sortation_string);
         $sortation_field = array_column($records, $sortation_parts[0]);
         $sortation_direction = ($sortation_parts[1] === 'ASC') ? SORT_ASC : SORT_DESC;
         array_multisort($sortation_field, $sortation_direction, $records);
         return $records;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderLibraryButtons()

ilBiblEntryTableGUI::renderLibraryButtons ( int $entry_id )

private

Definition at line 124 of file class.ilBiblEntryTableGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by buildTable().

                                                         : array
     {
         $entry = $this->facade->entryFactory()->findByIdAndTypeString(
             $entry_id,
             $this->facade->type()->getStringRepresentation()
         );
 
         $settings = $this->facade->libraryFactory()->getAll();
         if ($settings === []) {
             return [];
         }
 
         $buttons = [];
 
         foreach ($settings as $set) {
             $presentation = new ilBiblLibraryPresentationGUI($set, $this->facade, $this->ctrl, $this->lng, $this->ui);
             $buttons[$set->getName()] = $presentation->getButton($this->facade, $entry);
         }
 
         return $buttons;
     }