ILIAS\AdministrativeNotification\DataRetrieval Class Reference

Inheritance diagram for ILIAS\AdministrativeNotification\DataRetrieval:

Collaboration diagram for ILIAS\AdministrativeNotification\DataRetrieval:

Public Member Functions
	__construct (protected bool $has_write_access,)
	getRows (I\DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	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...
Public Member Functions inherited from 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. 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...

Protected Member Functions
	getRecords (Order $order)
	formatDate (DateTimeImmutable $timestamp)
	getLanguagesTextForNotification (array $record)

Private Attributes
ilLanguage	$lng

Detailed Description

Definition at line 34 of file DataRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\AdministrativeNotification\DataRetrieval::__construct

(

protected bool

$has_write_access

)

Definition at line 38 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

formatDate()

ILIAS\AdministrativeNotification\DataRetrieval::formatDate ( DateTimeImmutable  $timestamp )

protected

Definition at line 98 of file DataRetrieval.php.

                                                               : string
    {
        return ilDatePresentation::formatDate(new ilDateTime($timestamp->getTimestamp(), IL_CAL_UNIX));
    }

References $timestamp, ilDatePresentation\formatDate(), and IL_CAL_UNIX.

Here is the call graph for this function:

getLanguagesTextForNotification()

ILIAS\AdministrativeNotification\DataRetrieval::getLanguagesTextForNotification ( array  $record )

protected

Definition at line 103 of file DataRetrieval.php.

                                                                     : string
    {
        $has_language_limitation = $record['has_language_limitation'];
        $limited_to_languages = $record['limited_to_languages'];
        // text is all by default
        $languages_text = $this->lng->txt("all");
        if ($has_language_limitation) {
            // text is none in case the notification has a language limitation but no languages are specified
            $languages_text = $this->lng->txt("none");
            if (!empty($limited_to_languages)) {
                $this->lng->loadLanguageModule("meta");
                // text is comma separated list of languages if the notification has a language limitation
                // and the languages have been specified
                $languages_text = implode(
                    ', ',
                    array_map(
                        fn(string $lng_code): string => $this->lng->txt("meta_l_" . $lng_code),
                        $limited_to_languages
                    )
                );
            }
        }
        return $languages_text;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getRecords()

ILIAS\AdministrativeNotification\DataRetrieval::getRecords ( Order  $order )

protected

Definition at line 65 of file DataRetrieval.php.

                                               : array
    {
        $records = ilADNNotification::getArray();
 
        // populate with additional data
        array_walk($records, function (array &$record): void {
            $record['languages'] = $this->getLanguagesTextForNotification($record);
            $record['type'] = $this->lng->txt("msg_type_" . $record['type']);
            $record['event_start'] = $this->formatDate($record['event_start']);
            $record['event_end'] = $this->formatDate($record['event_end']);
            $record['display_start'] = $this->formatDate($record['display_start']);
            $record['display_end'] = $this->formatDate($record['display_end']);
 
            $record['type_during_event'] = $record['permanent'] ? '' : $this->lng->txt("msg_type_" . $record['type_during_event']);
        });
 
        // sort
        [$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, ActiveRecord\getArray(), ILIAS\Data\Order\join(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getRows()

ILIAS\AdministrativeNotification\DataRetrieval::getRows	(	I\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 45 of file DataRetrieval.php.

     : Generator {
        $records = $this->getRecords($order);
        foreach ($records as $record) {
            $row_id = (string) $record['id'];
 
            yield $row_builder->buildDataRow($row_id, $record)
                              ->withDisabledAction(Table::ACTION_DUPLICATE, !$this->has_write_access)
                              ->withDisabledAction(Table::ACTION_EDIT, !$this->has_write_access)
                              ->withDisabledAction(Table::ACTION_DELETE, !$this->has_write_access)
                              ->withDisabledAction(Table::ACTION_RESET, !$this->has_write_access);
        }
    }

References ILIAS\AdministrativeNotification\Table\ACTION_DELETE, ILIAS\AdministrativeNotification\Table\ACTION_DUPLICATE, ILIAS\AdministrativeNotification\Table\ACTION_EDIT, and ILIAS\AdministrativeNotification\Table\ACTION_RESET.

getTotalRowCount()

ILIAS\AdministrativeNotification\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.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 91 of file DataRetrieval.php.

     : ?int {
        return count(ilADNNotification::getArray());
    }

Field Documentation

$lng

ilLanguage ILIAS\AdministrativeNotification\DataRetrieval::$lng

private

Definition at line 36 of file DataRetrieval.php.

---

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

• components/ILIAS/AdministrativeNotification/classes/DataRetrieval.php