ilBiblLibraryTableGUI Class Reference

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, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $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, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $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

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

Constructor & Destructor Documentation

__construct()

ilBiblLibraryTableGUI::__construct

(

private readonly ilBiblAdminLibraryFacadeInterface

$facade

)

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

    {
        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();
    }

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

Here is the call graph for this function:

Member Function Documentation

buildTable()

ilBiblLibraryTableGUI::buildTable ( )

private

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

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

References ILIAS\Repository\lng().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ilBiblLibraryTableGUI::getColumns ( )

private

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

                                 : 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'))
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getRecords()

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

private

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

                                                                           : 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 !== null) {
            [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value): array => [$key, $value]);
            usort($records, static fn($a, $b): int => $a[$order_field] <=> $b[$order_field]);
            if ($order_direction === 'DESC') {
                $records = array_reverse($records);
            }
        }
        if ($range !== null) {
            return array_slice($records, $range->getStart(), $range->getLength());
        }
 
        return $records;
    }

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

Here is the call graph for this function:

getRenderedTable()

ilBiblLibraryTableGUI::getRenderedTable

(

)

Definition at line 59 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,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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 153 of file class.ilBiblLibraryTableGUI.php.

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

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow().

Here is the call graph for this function:

getTotalRowCount()

ilBiblLibraryTableGUI::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$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.

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

Field Documentation

$access

ilAccessHandler ilBiblLibraryTableGUI::$access

private

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

$ctrl

ilCtrlInterface ilBiblLibraryTableGUI::$ctrl

private

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

$data_factory

DataFactory ilBiblLibraryTableGUI::$data_factory

private

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

$http_request

HttpRequest ilBiblLibraryTableGUI::$http_request

private

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

$lng

ilLanguage ilBiblLibraryTableGUI::$lng

private

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

$table

DataTable ilBiblLibraryTableGUI::$table

private

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

$ui_factory

UIFactory ilBiblLibraryTableGUI::$ui_factory

private

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

$ui_renderer

UIRenderer ilBiblLibraryTableGUI::$ui_renderer

private

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

---

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

• components/ILIAS/Bibliographic/classes/Admin/Library/class.ilBiblLibraryTableGUI.php