Inheritance diagram for ILIAS\Contact\MailingLists\MailingListsTable:

Collaboration diagram for ILIAS\Contact\MailingLists\MailingListsTable:

Public Member Functions
	__construct (private readonly ilMailingLists $mailing_lists, private readonly \ilCtrlInterface $ctrl, private readonly ilLanguage $lng, private readonly \ILIAS\UI\Factory $ui_factory, \ILIAS\HTTP\GlobalHttpState $http)

	setMailingAllowed (bool $mailing_allowed)

	getComponent ()

	getRows (UI\Component\Table\DataRowBuilder $row_builder, array $visible_column_ids, Data\Range $range, Data\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...

Private Member Functions
	isMailingAllowed ()

	getColumns ()

	getActions ()

	initRecords ()

	sortedRecords (Data\Order $order)

	getRecords (Data\Range $range, Data\Order $order)

	limitRecords (array $records, Data\Range $range)

Private Attributes
readonly ServerRequestInterface	$request

readonly Data Factory	$data_factory

bool	$mailing_allowed = false

array	$records = null

Detailed Description

Definition at line 32 of file MailingListsTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Contact\MailingLists\MailingListsTable::__construct	(	private readonly ilMailingLists	$mailing_lists,
		private readonly \ilCtrlInterface	$ctrl,
		private readonly ilLanguage	$lng,
		private readonly \ILIAS\UI\Factory	$ui_factory,
		\ILIAS\HTTP\GlobalHttpState	$http
	)

Definition at line 40 of file MailingListsTable.php.

       {
         $this->request = $http->request();
         $this->data_factory = new Data\Factory();
     }

Member Function Documentation

◆ getActions()

ILIAS\Contact\MailingLists\MailingListsTable::getActions ( )

private

Returns: array<string, >

Definition at line 106 of file MailingListsTable.php.

References ILIAS\Repository\ctrl(), ILIAS\Contact\MailingLists\MailingListsTable\isMailingAllowed(), and ILIAS\Repository\lng().

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getComponent().

                                  : array
     {
         $query_params_namespace = ['contact', 'mailinglist', 'list'];
 
         $uri = $this->data_factory->uri(
             ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                 ilMailingListsGUI::class,
                 'handleMailingListActions'
             )
         );
 
         $url_builder = new UI\URLBuilder($uri);
         [
             $url_builder,
             $action_parameter_token_copy,
             $row_id_token
         ] = $url_builder->acquireParameters(
             $query_params_namespace,
             'action',
             'ml_ids'
         );
 
         $actions = [
             'confirmDelete' => $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('delete'),
                 $url_builder->withParameter($action_parameter_token_copy, 'confirmDelete'),
                 $row_id_token
             ),
             'showForm' => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('edit'),
                 $url_builder->withParameter($action_parameter_token_copy, 'showForm'),
                 $row_id_token
             ),
             'showMembersList' => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('members'),
                 $url_builder->withParameter($action_parameter_token_copy, 'showMembersList'),
                 $row_id_token
             )
         ];
 
         if ($this->isMailingAllowed()) {
             $actions['mailToList'] = $this->ui_factory->table()->action()->standard(
                 $this->lng->txt('send_mail_to'),
                 $url_builder->withParameter($action_parameter_token_copy, 'mailToList'),
                 $row_id_token
             );
         }
 
         return $actions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Contact\MailingLists\MailingListsTable::getColumns ( )

private

Returns: array<string, >

Definition at line 82 of file MailingListsTable.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getComponent().

                                  : array
     {
         return [
             'title' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('title'))
                 ->withIsSortable(true),
             'description' => $this->ui_factory
                 ->table()
                 ->column()
                 ->text($this->lng->txt('description'))
                 ->withIsSortable(true),
             'members' => $this->ui_factory
                 ->table()
                 ->column()
                 ->number($this->lng->txt('members'))
                 ->withIsSortable(true),
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getComponent()

ILIAS\Contact\MailingLists\MailingListsTable::getComponent ( )

Definition at line 61 of file MailingListsTable.php.

References ILIAS\Data\Order\ASC, ILIAS\Contact\MailingLists\MailingListsTable\getActions(), ILIAS\Contact\MailingLists\MailingListsTable\getColumns(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Table\withOrder().

                                   : UI\Component\Table\Data
     {
         $columns = $this->getColumns();
         $actions = $this->getActions();
 
         return $this->ui_factory
             ->table()
             ->data(
                 $this,
                 $this->lng->txt('mail_mailing_lists'),
                 $columns,
             )
             ->withOrder(new \ILIAS\Data\Order('title', \ILIAS\Data\Order::ASC))
             ->withId(self::class)
             ->withActions($actions)
             ->withRequest($this->request);
     }

Here is the call graph for this function:

◆ getRecords()

ILIAS\Contact\MailingLists\MailingListsTable::getRecords	(	Data\Range	$range,
		Data\Order	$order
	)

private

Returns: list<array<string, mixed>>

Definition at line 223 of file MailingListsTable.php.

References ILIAS\Contact\MailingLists\MailingListsTable\initRecords(), ILIAS\Contact\MailingLists\MailingListsTable\limitRecords(), and ILIAS\Contact\MailingLists\MailingListsTable\sortedRecords().

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getRows().

                                                                      : array
     {
         $this->initRecords();
         $records = $this->sortedRecords($order);
 
         return $this->limitRecords($records, $range);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\Contact\MailingLists\MailingListsTable::getRows	(	UI\Component\Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Data\Range	$range,
		Data\Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 179 of file MailingListsTable.php.

References ILIAS\Contact\MailingLists\MailingListsTable\getRecords().

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

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Contact\MailingLists\MailingListsTable::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 195 of file MailingListsTable.php.

References ILIAS\Contact\MailingLists\MailingListsTable\initRecords().

      : ?int {
         $this->initRecords();
 
         return \count($this->records);
     }

Here is the call graph for this function:

◆ initRecords()

ILIAS\Contact\MailingLists\MailingListsTable::initRecords ( )

private

Definition at line 157 of file MailingListsTable.php.

References ilMailingList\MODE_TEMPORARY, and null.

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getRecords(), and ILIAS\Contact\MailingLists\MailingListsTable\getTotalRowCount().

                                   : void
     {
         if ($this->records === null) {
             $this->records = [];
             $counter = 0;
             $entries = $this->mailing_lists->getAll();
 
             foreach ($entries as $entry) {
                 if ($entry->getMode() === ilMailingList::MODE_TEMPORARY) {
                     continue;
                 }
 
                 $this->records[$counter]['ml_id'] = $entry->getId();
                 $this->records[$counter]['title'] = $entry->getTitle() . ' [#il_ml_' . $entry->getId() . ']';
                 $this->records[$counter]['description'] = $entry->getDescription() ?? '';
                 $this->records[$counter]['members'] = \count($entry->getAssignedEntries());
 
                 ++$counter;
             }
         }
     }

Here is the caller graph for this function:

◆ isMailingAllowed()

ILIAS\Contact\MailingLists\MailingListsTable::isMailingAllowed ( )

private

Definition at line 51 of file MailingListsTable.php.

References ILIAS\Contact\MailingLists\MailingListsTable\$mailing_allowed.

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getActions().

                                        : bool
     {
         return $this->mailing_allowed;
     }

Here is the caller graph for this function:

◆ limitRecords()

ILIAS\Contact\MailingLists\MailingListsTable::limitRecords	(	array	$records,
		Data\Range	$range
	)

private

Parameters

list<array<string,mixed>> $records

Returns: list<array<string, mixed>>

Definition at line 235 of file MailingListsTable.php.

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getRecords().

                                                                     : array
     {
         return \array_slice($records, $range->getStart(), $range->getLength());
     }

Here is the caller graph for this function:

◆ setMailingAllowed()

ILIAS\Contact\MailingLists\MailingListsTable::setMailingAllowed ( bool $mailing_allowed )

Definition at line 56 of file MailingListsTable.php.

References ILIAS\Contact\MailingLists\MailingListsTable\$mailing_allowed.

                                                             : void
     {
         $this->mailing_allowed = $mailing_allowed;
     }

◆ sortedRecords()

ILIAS\Contact\MailingLists\MailingListsTable::sortedRecords ( Data\Order $order )

private

Returns: list<array<string, mixed>>

Definition at line 207 of file MailingListsTable.php.

References ILIAS\Contact\MailingLists\MailingListsTable\$records, and ilArrayUtil\stableSortArray().

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\getRecords().

                                                      : array
     {
         $records = $this->records;
         [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
 
         return ilArrayUtil::stableSortArray(
             $records,
             $order_field,
             strtolower($order_direction),
             $order_field === 'members'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $data_factory

readonly Data Factory ILIAS\Contact\MailingLists\MailingListsTable::$data_factory

private

Definition at line 35 of file MailingListsTable.php.

◆ $mailing_allowed

bool ILIAS\Contact\MailingLists\MailingListsTable::$mailing_allowed = false

private

Definition at line 36 of file MailingListsTable.php.

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\isMailingAllowed(), and ILIAS\Contact\MailingLists\MailingListsTable\setMailingAllowed().

◆ $records

array ILIAS\Contact\MailingLists\MailingListsTable::$records = null

private

Definition at line 38 of file MailingListsTable.php.

Referenced by ILIAS\Contact\MailingLists\MailingListsTable\sortedRecords().

◆ $request

readonly ServerRequestInterface ILIAS\Contact\MailingLists\MailingListsTable::$request

private

Definition at line 34 of file MailingListsTable.php.

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

components/ILIAS/Contact/classes/MailingLists/MailingListsTable.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActions()

◆ getColumns()

◆ getComponent()

◆ getRecords()

◆ getRows()

◆ getTotalRowCount()

◆ initRecords()

◆ isMailingAllowed()

◆ limitRecords()

◆ setMailingAllowed()

◆ sortedRecords()

Field Documentation

◆ $data_factory

◆ $mailing_allowed

◆ $records

◆ $request