LDAPRoleMappingTable Class Reference

Inheritance diagram for LDAPRoleMappingTable:

Collaboration diagram for LDAPRoleMappingTable:

Public Member Functions
	__construct (private readonly ServerRequestInterface $http_request, private readonly ilLanguage $lng, private readonly UIFactory $ui_factory, private readonly int $server_id, private readonly ilObjectDataCache $object_data_cache, private readonly ilRbacReview $rbac_review, private readonly \ILIAS\Data\URI $action_url, private readonly bool $has_write_access)
	getRows (ILIAS\UI\Component\Table\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...
	initRecords ()
	getComponent ()
	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...
	getActions (URLBuilder $url_builder, URLBuilderToken $action_parameter_token, URLBuilderToken $row_id_token)
	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
	getRecords (Range $range, Order $order)
	limitRecords (array $records, Range $range)
	orderRecords (array $records, Order $order)
	getColumns ()

Private Attributes
array	$records = null

Detailed Description

Definition at line 32 of file LDAPRoleMappingTable.php.

Constructor & Destructor Documentation

__construct()

LDAPRoleMappingTable::__construct	(	private readonly ServerRequestInterface	$http_request,
		private readonly ilLanguage	$lng,
		private readonly UIFactory	$ui_factory,
		private readonly int	$server_id,
		private readonly ilObjectDataCache	$object_data_cache,
		private readonly ilRbacReview	$rbac_review,
		private readonly \ILIAS\Data\URI	$action_url,
		private readonly bool	$has_write_access
	)

Definition at line 45 of file LDAPRoleMappingTable.php.

      {
    }

Member Function Documentation

getActions()

LDAPRoleMappingTable::getActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$action_parameter_token,
		URLBuilderToken	$row_id_token
	)

Returns

array<string, Action>

Definition at line 159 of file LDAPRoleMappingTable.php.

                                                                                                                               : array
    {
        $actions = [];
 
        if ($this->has_write_access) {
            $actions['delete'] = $this->ui_factory->table()->action()->multi(
                $this->lng->txt('delete'),
                $url_builder->withParameter($action_parameter_token, 'confirmDeleteRoleMapping'),
                $row_id_token
            );
 
            $actions['copy'] = $this->ui_factory->table()->action()->single(
                $this->lng->txt('copy'),
                $url_builder->withParameter($action_parameter_token, 'addRoleMapping'),
                $row_id_token
            );
        }
 
        $actions['edit'] = $this->ui_factory->table()->action()->single(
            $this->has_write_access ? $this->lng->txt('edit') : $this->lng->txt('view'),
            $url_builder->withParameter($action_parameter_token, 'editRoleMapping'),
            $row_id_token
        );
 
        return $actions;
    }

References ILIAS\Repository\lng(), and ILIAS\UI\URLBuilder\withParameter().

Here is the call graph for this function:

getColumns()

LDAPRoleMappingTable::getColumns ( )

private

Returns

array<string, Column>

Definition at line 252 of file LDAPRoleMappingTable.php.

                                 : array
    {
        return [
            'title' => $this->ui_factory->table()->column()->text($this->lng->txt('title')),
            'role' => $this->ui_factory->table()->column()->text($this->lng->txt('obj_role')),
            'dn' => $this->ui_factory->table()->column()->text($this->lng->txt('ldap_group_dn')),
            'url' => $this->ui_factory->table()->column()->text($this->lng->txt('ldap_server')),
            'member_attribute' => $this->ui_factory->table()->column()->text($this->lng->txt('ldap_group_member')),
            'info' => $this->ui_factory->table()->column()->text($this->lng->txt('ldap_info_text')),
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getComponent()

LDAPRoleMappingTable::getComponent

(

)

Definition at line 93 of file LDAPRoleMappingTable.php.

                                  : DataTable
    {
        $query_params_namespace = ['ldap', 'role', 'mapping'];
        $url_builder = new URLBuilder($this->action_url);
        [$url_builder, $action_parameter_token, $row_id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            'table_action',
            'mapping_ids'
        );
 
        return $this->ui_factory->table()
            ->data(
                $this,
                $this->lng->txt('mail_templates'),
                $this->getColumns()
            )
            ->withTitle($this->lng->txt('ldap_role_group_assignments'))
            ->withActions($this->getActions($url_builder, $action_parameter_token, $row_id_token))
            ->withId(
                'ldap_role_mapping_table'
            )
            ->withOrder(new Order('title', Order::DESC))
            ->withRange(new Range(0, 100))
            ->withRequest($this->http_request);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getRecords()

LDAPRoleMappingTable::getRecords ( Range  $range, Order  $order  )

private

Returns

list<array{ 'id': int, 'title': string, 'role': string, 'dn': string, 'url': string, 'member_attribute': string, 'info': string }>

Definition at line 140 of file LDAPRoleMappingTable.php.

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

References ILIAS\UI\Implementation\Component\Table\$range.

getRows()

LDAPRoleMappingTable::getRows	(	ILIAS\UI\Component\Table\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 57 of file LDAPRoleMappingTable.php.

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

getTotalRowCount()

LDAPRoleMappingTable::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 119 of file LDAPRoleMappingTable.php.

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

initRecords()

LDAPRoleMappingTable::initRecords

(

)

Definition at line 72 of file LDAPRoleMappingTable.php.

                                 : void
    {
        if ($this->records === null) {
            $this->records = [];
            $mapping_instance = ilLDAPRoleGroupMappingSettings::_getInstanceByServerId($this->server_id);
            $mappings = $mapping_instance->getMappings();
            foreach ($mappings as $item) {
                $title = $this->object_data_cache->lookupTitle($this->rbac_review->getObjectOfRole((int) $item['role']));
                $this->records[] = [
                    'id' => $item['mapping_id'],
                    'title' => ilStr::shortenTextExtended($title, 30, true),
                    'role' => $item['role_name'],
                    'dn' => $item['dn'],
                    'url' => $item['url'],
                    'member_attribute' => $item['member_attribute'],
                    'info' => ilLegacyFormElementsUtil::prepareFormOutput($item['info'])
                ];
            }
        }
    }

References ilLDAPRoleGroupMappingSettings\_getInstanceByServerId(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilStr\shortenTextExtended().

Here is the call graph for this function:

limitRecords()

LDAPRoleMappingTable::limitRecords ( array  $records, Range  $range  )

private

Parameters

list<array{

'id': int, 'title': string, 'role': string, 'dn': string, 'url': string, 'member_attribute': string, 'info': string }> $records

Returns

list<array{ 'id': int, 'title': string, 'role': string, 'dn': string, 'url': string, 'member_attribute': string, 'info': string }>>

Definition at line 206 of file LDAPRoleMappingTable.php.

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

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

Here is the call graph for this function:

orderRecords()

LDAPRoleMappingTable::orderRecords ( array  $records, Order  $order  )

private

Parameters

list<array{

'id': int, 'title': string, 'role': string, 'dn': string, 'url': string, 'member_attribute': string, 'info': string }> $records

Returns

list<array{ 'id': int, 'title': string, 'role': string, 'dn': string, 'url': string, 'member_attribute': string, 'info': string }>

Definition at line 231 of file LDAPRoleMappingTable.php.

                                                               : array
    {
        [$order_field, $order_direction] = $order->join(
            [],
            fn($ret, $key, $value) => [$key, $value]
        );
        usort($records, static fn(array $left, array $right): int => ilStr::strCmp(
            $left[$order_field] ?? '',
            $right[$order_field] ?? ''
        ));
 
        if ($order_direction === Order::DESC) {
            $records = array_reverse($records);
        }
 
        return $records;
    }

References ILIAS\Data\Order\join(), and ilStr\strCmp().

Here is the call graph for this function:

Field Documentation

$records

array LDAPRoleMappingTable::$records = null

private

Definition at line 43 of file LDAPRoleMappingTable.php.

---

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

• components/ILIAS/LDAP/classes/LDAPRoleMappingTable.php