ILIAS\Bibliographic\Field\DataRetrieval Class Reference

Class DataRetrieval. More...

Inheritance diagram for ILIAS\Bibliographic\Field\DataRetrieval:

Collaboration diagram for ILIAS\Bibliographic\Field\DataRetrieval:

Public Member Functions
	__construct (protected \ilBiblAdminFactoryFacadeInterface $facade, private bool $has_write_access)
	getRows (OrderingRowBuilder $row_builder, array $visible_column_ids)
	This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	getRows (OrderingRowBuilder $row_builder, array $visible_column_ids)
	This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

Protected Member Functions
	getRecords (Order $order)

Private Attributes
ilLanguage	$lng

Detailed Description

Class DataRetrieval.

Definition at line 29 of file DataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Bibliographic\Field\DataRetrieval::__construct	(	protected \ilBiblAdminFactoryFacadeInterface	$facade,
		private bool	$has_write_access
	)

Definition at line 33 of file DataRetrieval.php.

      {
        global $DIC;
        $this->lng = $DIC['lng'];
    }

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

Here is the call graph for this function:

Member Function Documentation

getRecords()

ILIAS\Bibliographic\Field\DataRetrieval::getRecords ( Order  $order )

protected

Definition at line 58 of file DataRetrieval.php.

                                               : array
    {
        $records = $this->facade->fieldFactory()->filterAllFieldsForTypeAsArray($this->facade->type());
        [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value): array => [$key, $value]);
        usort($records, fn($a, $b): int => $a[$order_field] <=> $b[$order_field]);
        if ($order_direction === 'DESC') {
            return array_reverse($records);
        }
        return $records;
    }

References Vendor\Package\$a, Vendor\Package\$b, and ILIAS\Data\Order\join().

Here is the call graph for this function:

getRows()

ILIAS\Bibliographic\Field\DataRetrieval::getRows	(	OrderingRowBuilder	$row_builder,
		array	$visible_column_ids
	)

This is called by the (ordering-)table to retrieve rows; map data-records to rows using the $row_builder e.g.

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

Implements ILIAS\UI\Component\Table\OrderingRetrieval.

Definition at line 41 of file DataRetrieval.php.

     : \Generator {
        $records = $this->getRecords(new Order('position', 'ASC'));
        foreach ($records as $record) {
            $row_id = (string) $record['id'];
            $field = $this->facade->fieldFactory()->findById($record['id']);
            $record['data_type'] = $this->facade->translationFactory()->translate($field);
            $record['is_standard_field'] = $field->isStandardField() ? $this->lng->txt('standard') : $this->lng->txt(
                'custom'
            );
            yield $row_builder->buildOrderingRow($row_id, $record)
                              ->withDisabledAction('translate', !$this->has_write_access);
        }
    }

References ILIAS\UI\Component\Table\OrderingRowBuilder\buildOrderingRow(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Bibliographic\Field\DataRetrieval::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 69 of file DataRetrieval.php.

     : ?int {
        return count($this->facade->fieldFactory()->getAvailableFieldsForObjId($this->facade->iliasObjId()));
    }

Field Documentation

$lng

ilLanguage ILIAS\Bibliographic\Field\DataRetrieval::$lng

private

Definition at line 31 of file DataRetrieval.php.

---

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

• components/ILIAS/Bibliographic/classes/Field/DataRetrieval.php