This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilBiblLibraryTableGUI:

Collaboration diagram for ilBiblLibraryTableGUI:

Public Member Functions
	__construct (private readonly ilBiblAdminLibraryFacadeInterface $facade)

	getRenderedTable ()

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

Private Member Functions
	buildTable ()

	getColumns ()

	getRecords (Range $range=null, Order $order=null)

Private Attributes
ilAccessHandler	$access

ilCtrlInterface	$ctrl

DataFactory	$data_factory

HttpRequest	$http_request

ilLanguage	$lng

UIFactory	$ui_factory

UIRenderer	$ui_renderer

DataTable	$table

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 32 of file class.ilBiblLibraryTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblLibraryTableGUI::__construct ( private readonly ilBiblAdminLibraryFacadeInterface $facade )

Definition at line 44 of file class.ilBiblLibraryTableGUI.php.

References $DIC, ILIAS\Repository\access(), buildTable(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

     {
         global $DIC;
 
         $this->access = $DIC->access();
         $this->ctrl = $DIC->ctrl();
         $this->data_factory = new DataFactory();
         $this->http_request = $DIC->http()->request();
         $this->lng = $DIC->language();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
 
         $this->table = $this->buildTable();
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildTable()

ilBiblLibraryTableGUI::buildTable ( )

private

Definition at line 66 of file class.ilBiblLibraryTableGUI.php.

References getColumns(), ILIAS\Repository\lng(), ILIAS\UI\Implementation\Component\Table\withOrder(), and ILIAS\UI\Implementation\Component\Table\withRange().

Referenced by __construct().

                                  : DataTable
     {
         return $this->ui_factory->table()->data(
             $this->lng->txt('bibl_settings_libraries'),
             $this->getColumns(),
             $this
         )->withActions(
             $this->getActions()
         )->withRange(
             new Range(0, 10)
         )->withOrder(
             new Order('bibl_library_name', Order::ASC)
         )->withRequest($this->http_request);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ilBiblLibraryTableGUI::getColumns ( )

private

Definition at line 82 of file class.ilBiblLibraryTableGUI.php.

References $namespace, ILIAS\Repository\access(), ilBiblLibraryGUI\CMD_DELETE, ilBiblLibraryGUI\CMD_EDIT, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by buildTable().

                                  : array
     {
         return [
             'bibl_library_name' => $this->ui_factory->table()->column()->text($this->lng->txt('bibl_library_name')),
             'bibl_library_url' => $this->ui_factory->table()->column()->text($this->lng->txt('bibl_library_url')),
             'bibl_library_img' => $this->ui_factory->table()->column()->text($this->lng->txt('bibl_library_img'))
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecords()

ilBiblLibraryTableGUI::getRecords	(	Range	$range = `null`,
		Order	$order = `null`
	)

private

Definition at line 176 of file class.ilBiblLibraryTableGUI.php.

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

Referenced by getRows(), and getTotalRowCount().

                                                                          : array
     {
         $records = [];
         $libraries = $this->facade->libraryFactory()->getAll();
         foreach ($libraries as $library) {
             $records[] = [
                 "bibl_library_id" => $library->getId(),
                 "bibl_library_name" => $library->getName(),
                 "bibl_library_url" => $library->getUrl(),
                 "bibl_library_img" => $library->getImg(),
             ];
         }
 
         if ($order) {
             [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
             usort($records, static fn($a, $b) => $a[$order_field] <=> $b[$order_field]);
             if ($order_direction === 'DESC') {
                 $records = array_reverse($records);
             }
         }
         if ($range) {
             $records = array_slice($records, $range->getStart(), $range->getLength());
         }
 
         return $records;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRenderedTable()

ilBiblLibraryTableGUI::getRenderedTable ( )

Definition at line 60 of file class.ilBiblLibraryTableGUI.php.

                                       : string
     {
         return $this->ui_renderer->render([$this->table]);
     }

◆ getRows()

ilBiblLibraryTableGUI::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 154 of file class.ilBiblLibraryTableGUI.php.

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

      : Generator {
         $records = $this->getRecords($range, $order);
         foreach ($records as $record) {
             $row_id = (string) $record['bibl_library_id'];
             yield $row_builder->buildDataRow($row_id, $record);
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ilBiblLibraryTableGUI::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 170 of file class.ilBiblLibraryTableGUI.php.

References getRecords().

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