ILIAS\AccessControl\Log\Table Class Reference

Inheritance diagram for ILIAS\AccessControl\Log\Table:

Collaboration diagram for ILIAS\AccessControl\Log\Table:

Public Member Functions
	__construct (private readonly \ilRbacLog $rbac_log, private readonly UIFactory $ui_factory, private readonly DataFactory $data_factory, private readonly \ilLanguage $lng, private readonly \ilCtrl $ctrl, private readonly \ilUIService $ui_service, private readonly \ilObjectDefinition $object_definition, private readonly RequestInterface $request, \ilRbacReview $rbac_review, private readonly \ilObjUser $current_user, private readonly \ilObjectGUI $gui_object)
	getTableAndFilter ()
	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...

Private Member Functions
	getTable ()
	getFilter ()
	getRefId ()
	buildUserDateTimeFormat ()
	applyFilterValuesTrafos (array $filter_values)
	buildChangeColumn (int $action, array $data)
	parseChangesFaPa (array $raw)
	parseChangesTemplate (array $raw)
	getOPCaption (string $type, array|int|string $op)
	getNonCreateTranslation (string $type, string $op_id)
	getCreateTranslation (string $type, string $op_id)
	getTranslationFromPlugin (string $type, string $op_id)
	isTranslated (?string $perm, string $op_id)

Private Attributes
const	FILTER_ID = 'perm_table_filter'
const	FILTER_FIELD_ACTION = 'action'
const	FILTER_FIELD_PERIOD = 'period'
const	COLUMN_DATE = 'created'
const	COLUMN_NAME = 'name'
const	COLUMN_LOGIN = 'login'
const	COLUMN_ACTION = 'action'
const	COLUMN_CHANGES = 'changes'
array	$filter_data
array	$action_map = []
array	$operations = []

Detailed Description

Definition at line 34 of file Table.php.

Constructor & Destructor Documentation

__construct()

ILIAS\AccessControl\Log\Table::__construct	(	private readonly \ilRbacLog	$rbac_log,
		private readonly UIFactory	$ui_factory,
		private readonly DataFactory	$data_factory,
		private readonly \ilLanguage	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilUIService	$ui_service,
		private readonly \ilObjectDefinition	$object_definition,
		private readonly RequestInterface	$request,
		\ilRbacReview	$rbac_review,
		private readonly \ilObjUser	$current_user,
		private readonly \ilObjectGUI	$gui_object
	)

Definition at line 54 of file Table.php.

References ilRbacLog\CHANGE_OWNER, ilRbacLog\COPY_OBJECT, ilRbacLog\CREATE_OBJECT, ilRbacLog\EDIT_PERMISSIONS, ilRbacLog\EDIT_TEMPLATE, ilRbacLog\EDIT_TEMPLATE_EXISTING, ilRbacReview\getOperations(), ilRbacLog\LINK_OBJECT, ILIAS\Repository\lng(), and ilRbacLog\MOVE_OBJECT.

      {
        $this->action_map = [
            \ilRbacLog::EDIT_PERMISSIONS => $this->lng->txt('rbac_log_edit_permissions'),
            \ilRbacLog::MOVE_OBJECT => $this->lng->txt('rbac_log_move_object'),
            \ilRbacLog::LINK_OBJECT => $this->lng->txt('rbac_log_link_object'),
            \ilRbacLog::COPY_OBJECT => $this->lng->txt('rbac_log_copy_object'),
            \ilRbacLog::CREATE_OBJECT => $this->lng->txt('rbac_log_create_object'),
            \ilRbacLog::EDIT_TEMPLATE => $this->lng->txt('rbac_log_edit_template'),
            \ilRbacLog::EDIT_TEMPLATE_EXISTING => $this->lng->txt('rbac_log_edit_template_existing'),
            \ilRbacLog::CHANGE_OWNER => $this->lng->txt('rbac_log_change_owner')
        ];

        foreach ($rbac_review->getOperations() as $op) {
            $this->operations[$op['ops_id']] = $op['operation'];
        }
    }

Here is the call graph for this function:

Member Function Documentation

applyFilterValuesTrafos()

ILIAS\AccessControl\Log\Table::applyFilterValuesTrafos ( array  $filter_values )

private

Definition at line 194 of file Table.php.

Referenced by ILIAS\AccessControl\Log\Table\getFilter().

                                                                  : array
    {
        $transformed_values = [
            'action' => $filter_values['action']
        ];
        if (isset($filter_values['period'][0])) {
            $transformed_values['from'] = (new \DateTimeImmutable(
                $filter_values['period'][0],
                new \DateTimeZone($this->current_user->getTimeZone())
            ))->getTimestamp();
        }
        if (isset($filter_values['period'][1])) {
            $transformed_values['to'] = (new \DateTimeImmutable(
                $filter_values['period'][1] . '23:59:59',
                new \DateTimeZone($this->current_user->getTimeZone())
            ))->getTimestamp();
        }
        return $transformed_values;
    }

Here is the caller graph for this function:

buildChangeColumn()

ILIAS\AccessControl\Log\Table::buildChangeColumn ( int  $action, array  $data  )

private

Definition at line 214 of file Table.php.

References ilObjUser\_lookupFullname(), ilRbacLog\CHANGE_OWNER, ilRbacLog\EDIT_TEMPLATE, ILIAS\AccessControl\Log\Table\parseChangesFaPa(), and ILIAS\AccessControl\Log\Table\parseChangesTemplate().

Referenced by ILIAS\AccessControl\Log\Table\getRows().

                                                                : string
    {
        if ($action === \ilRbacLog::CHANGE_OWNER) {
            $user_name = \ilObjUser::_lookupFullname($data[0] ?? 0);
            return "{$this->lng->txt('rbac_log_changed_owner')}: {$user_name}";
        }

        if ($action === \ilRbacLog::EDIT_TEMPLATE) {
            return $this->parseChangesTemplate($data);
        }

        return $this->parseChangesFaPa($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildUserDateTimeFormat()

ILIAS\AccessControl\Log\Table::buildUserDateTimeFormat ( )

private

Definition at line 185 of file Table.php.

References ilCalendarSettings\TIME_FORMAT_24.

Referenced by ILIAS\AccessControl\Log\Table\getTable().

                                              : DateFormat
    {
        $user_format = $this->current_user->getDateFormat();
        if ($this->current_user->getTimeFormat() == \ilCalendarSettings::TIME_FORMAT_24) {
            return $this->data_factory->dateFormat()->withTime24($user_format);
        }
        return $this->data_factory->dateFormat()->withTime12($user_format);
    }

Here is the caller graph for this function:

getCreateTranslation()

ILIAS\AccessControl\Log\Table::getCreateTranslation ( string  $type, string  $op_id  )

private

Definition at line 330 of file Table.php.

References ILIAS\AccessControl\Log\Table\getTranslationFromPlugin(), ILIAS\AccessControl\Log\Table\isTranslated(), and ILIAS\Repository\lng().

Referenced by ILIAS\AccessControl\Log\Table\getOPCaption().

                                                                      : string
    {
        $obj_type = substr($op_id, 7, strlen($op_id));
        $perm = $this->getTranslationFromPlugin($obj_type, $op_id);

        if ($this->isTranslated($perm, $op_id)) {
            return $perm;
        }

        return $this->lng->txt('rbac_' . $op_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilter()

ILIAS\AccessControl\Log\Table::getFilter ( )

private

Definition at line 112 of file Table.php.

References ILIAS\AccessControl\Log\Table\$action_map, ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\AccessControl\Log\Table\applyFilterValuesTrafos(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ILIAS\AccessControl\Log\Table\getTableAndFilter().

                                : Filter
    {
        $ff = $this->ui_factory->input()->field();

        $inputs = [
            self::FILTER_FIELD_ACTION => $ff->multiSelect(
                $this->lng->txt('action'),
                $this->action_map
            ),
            self::FILTER_FIELD_PERIOD => $ff->duration($this->lng->txt('date'))
        ];

        $active = array_fill(0, count($inputs), true);

        $filter = $this->ui_service->filter()->standard(
            self::FILTER_ID,
            $this->ctrl->getFormActionByClass([get_class($this->gui_object), \ilPermissionGUI::class], 'log'),
            $inputs,
            $active,
            true,
            true
        );
        $this->filter_data = $this->applyFilterValuesTrafos($this->ui_service->filter()->getData($filter));
        return $filter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNonCreateTranslation()

ILIAS\AccessControl\Log\Table::getNonCreateTranslation ( string  $type, string  $op_id  )

private

Definition at line 316 of file Table.php.

References ILIAS\AccessControl\Log\Table\getTranslationFromPlugin(), ILIAS\AccessControl\Log\Table\isTranslated(), and ILIAS\Repository\lng().

Referenced by ILIAS\AccessControl\Log\Table\getOPCaption().

                                                                         : string
    {
        $perm = $this->getTranslationFromPlugin($type, $op_id);
        if ($this->isTranslated($perm, $op_id)) {
            return $perm;
        }

        if ($this->lng->exists($type . '_' . $op_id . '_short')) {
            return $this->lng->txt($type . '_' . $op_id . '_short');
        }

        return $this->lng->txt($op_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOPCaption()

ILIAS\AccessControl\Log\Table::getOPCaption ( string  $type, array|int|string  $op  )

private

Definition at line 292 of file Table.php.

References $c, ILIAS\AccessControl\Log\Table\getCreateTranslation(), and ILIAS\AccessControl\Log\Table\getNonCreateTranslation().

Referenced by ILIAS\AccessControl\Log\Table\parseChangesFaPa(), and ILIAS\AccessControl\Log\Table\parseChangesTemplate().

                                                                     : string
    {
        if (is_array($op)) {
            return array_reduce(
                $op,
                fn(string $c, array|int|string $v) => $c === ''
                    ? $this->getOPCaption($type, $v)
                    : $c . ',' . $this->getOPCaption($type, $v),
                ''
            );
        }

        if (!isset($this->operations[$op])) {
            return '';
        }

        $op_id = $this->operations[$op];
        if (substr($op_id, 0, 7) !== 'create_') {
            return $this->getNonCreateTranslation($type, $op_id);
        }

        return $this->getCreateTranslation($type, $op_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ILIAS\AccessControl\Log\Table::getRefId ( )

private

Definition at line 176 of file Table.php.

References ROLE_FOLDER_ID, and ROOT_FOLDER_ID.

Referenced by ILIAS\AccessControl\Log\Table\getRows(), and ILIAS\AccessControl\Log\Table\getTotalRowCount().

                               : int
    {
        // special case: role folder should display root folder entries
        if ($this->gui_object->getRefId() === ROLE_FOLDER_ID) {
            return ROOT_FOLDER_ID;
        }
        return $this->gui_object->getRefId();
    }

Here is the caller graph for this function:

getRows()

ILIAS\AccessControl\Log\Table::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.

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

Parameters

string[]

$visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 138 of file Table.php.

References ilObjUser\_lookupName(), ILIAS\AccessControl\Log\Table\buildChangeColumn(), ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), and ILIAS\AccessControl\Log\Table\getRefId().

     : \Generator {
        $log_data = $this->rbac_log->getLogItems(
            $this->getRefId(),
            $range,
            $order,
            $this->filter_data
        );

        foreach ($log_data as $entry) {
            $user_data = \ilObjUser::_lookupName($entry['user_id']);
            yield $row_builder->buildDataRow(
                (string) $entry['log_id'],
                [
                    self::COLUMN_DATE => (new \DateTimeImmutable('@' . $entry['created']))
                        ->setTimezone(new \DateTimeZone($this->current_user->getTimeZone())),
                    self::COLUMN_NAME => "{$user_data['lastname']}, {$user_data['firstname']}",
                    self::COLUMN_LOGIN => $user_data['login'],
                    self::COLUMN_ACTION => $this->action_map[$entry['action']] ?? '',
                    self::COLUMN_CHANGES => $this->buildChangeColumn($entry['action'], $entry['data'] ?? [])
                ]
            );
        }
    }

Here is the call graph for this function:

getTable()

ILIAS\AccessControl\Log\Table::getTable ( )

private

Definition at line 91 of file Table.php.

References ILIAS\AccessControl\Log\Table\buildUserDateTimeFormat(), and ILIAS\Repository\lng().

Referenced by ILIAS\AccessControl\Log\Table\getTableAndFilter().

                               : DataTable
    {
        $cf = $this->ui_factory->table()->column();

        return $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('rbac_log'),
            [
                self::COLUMN_DATE => $cf->date(
                    $this->lng->txt('date'),
                    $this->buildUserDateTimeFormat()
                ),
                self::COLUMN_NAME => $cf->text($this->lng->txt('name')),
                self::COLUMN_LOGIN => $cf->text($this->lng->txt('login')),
                self::COLUMN_ACTION => $cf->text($this->lng->txt('action')),
                self::COLUMN_CHANGES => $cf->text($this->lng->txt('rbac_changes'))
                    ->withIsSortable(false)
            ],
        )->withRequest($this->request);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTableAndFilter()

ILIAS\AccessControl\Log\Table::getTableAndFilter

(

)

Definition at line 83 of file Table.php.

References ILIAS\AccessControl\Log\Table\getFilter(), and ILIAS\AccessControl\Log\Table\getTable().

                                       : array
    {
        return [
            $this->getFilter(),
            $this->getTable()
        ];
    }

Here is the call graph for this function:

getTotalRowCount()

ILIAS\AccessControl\Log\Table::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 169 of file Table.php.

References ILIAS\AccessControl\Log\Table\getRefId().

     : ?int {
        return $this->rbac_log->getLogItemsCount($this->getRefId(), $filter_data);
    }

Here is the call graph for this function:

getTranslationFromPlugin()

ILIAS\AccessControl\Log\Table::getTranslationFromPlugin ( string  $type, string  $op_id  )

private

Definition at line 342 of file Table.php.

References null.

Referenced by ILIAS\AccessControl\Log\Table\getCreateTranslation(), and ILIAS\AccessControl\Log\Table\getNonCreateTranslation().

                                                                          : ?string
    {
        if ($this->object_definition->isPlugin($type)) {
            return \ilObjectPlugin::lookupTxtById($type, $op_id);
        }
        return null;
    }

Here is the caller graph for this function:

isTranslated()

ILIAS\AccessControl\Log\Table::isTranslated ( ?string  $perm, string  $op_id  )

private

Definition at line 350 of file Table.php.

References null.

Referenced by ILIAS\AccessControl\Log\Table\getCreateTranslation(), and ILIAS\AccessControl\Log\Table\getNonCreateTranslation().

                                                               : bool
    {
        return $perm !== null && strpos($perm, $op_id) === false;
    }

Here is the caller graph for this function:

parseChangesFaPa()

ILIAS\AccessControl\Log\Table::parseChangesFaPa ( array  $raw )

private

Definition at line 228 of file Table.php.

References ilObjRole\_getTranslation(), ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ILIAS\AccessControl\Log\Table\getOPCaption(), and ILIAS\Repository\lng().

Referenced by ILIAS\AccessControl\Log\Table\buildChangeColumn().

                                                 : string
    {
        $result = [];

        if (isset($raw['src']) && is_int($raw['src'])) {
            $obj_id = \ilObject::_lookupObjectId($raw['src']);
            if ($obj_id) {
                $result[] = "{$this->lng->txt('rbac_log_source_object')}: "
                    . '<a href="' . \ilLink::_getLink($raw['src']) . '">'
                    . \ilObject::_lookupTitle($obj_id) . '</a>';
            }

            // added only
            foreach ($raw['ops'] as $role_id => $ops) {
                foreach ($ops as $op) {
                    $result[] = sprintf(
                        $this->lng->txt('rbac_log_operation_add'),
                        \ilObjRole::_getTranslation(\ilObject::_lookupTitle((int) $role_id))
                    ) . ': ' . $this->getOPCaption($this->gui_object->getObject()->getType(), $op);
                }
            }
        } elseif (isset($raw['ops'])) {
            foreach ($raw['ops'] as $role_id => $actions) {
                foreach ($actions as $action => $ops) {
                    foreach ((array) $ops as $op) {
                        $result[] = sprintf(
                            $this->lng->txt('rbac_log_operation_' . $action),
                            \ilObjRole::_getTranslation(\ilObject::_lookupTitle((int) $role_id))
                        ) . ': ' . $this->getOPCaption($this->gui_object->getObject()->getType(), $op);
                    }
                }
            }
        }

        if (isset($raw['inht'])) {
            foreach ($raw['inht'] as $action => $role_ids) {
                foreach ((array) $role_ids as $role_id) {
                    $result[] = sprintf(
                        $this->lng->txt('rbac_log_inheritance_' . $action),
                        \ilObjRole::_getTranslation(\ilObject::_lookupTitle((int) $role_id))
                    );
                }
            }
        }

        return implode('<br>', $result);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseChangesTemplate()

ILIAS\AccessControl\Log\Table::parseChangesTemplate ( array  $raw )

private

Definition at line 276 of file Table.php.

References ILIAS\AccessControl\Log\Table\getOPCaption(), and ILIAS\Repository\lng().

Referenced by ILIAS\AccessControl\Log\Table\buildChangeColumn().

                                                     : string
    {
        $result = [];
        foreach ($raw as $type => $actions) {
            foreach ($actions as $action => $ops) {
                foreach ($ops as $op) {
                    $result[] = sprintf(
                        $this->lng->txt('rbac_log_operation_' . $action),
                        $this->lng->txt('obj_' . $type)
                    ) . ': ' . $this->getOPCaption($type, $op);
                }
            }
        }
        return implode('<br>', $result);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_map

array ILIAS\AccessControl\Log\Table::$action_map = []

private

Definition at line 51 of file Table.php.

Referenced by ILIAS\AccessControl\Log\Table\getFilter().

$filter_data

array ILIAS\AccessControl\Log\Table::$filter_data

private

Definition at line 49 of file Table.php.

$operations

array ILIAS\AccessControl\Log\Table::$operations = []

private

Definition at line 52 of file Table.php.

COLUMN_ACTION

const ILIAS\AccessControl\Log\Table::COLUMN_ACTION = 'action'

private

Definition at line 43 of file Table.php.

COLUMN_CHANGES

const ILIAS\AccessControl\Log\Table::COLUMN_CHANGES = 'changes'

private

Definition at line 44 of file Table.php.

COLUMN_DATE

const ILIAS\AccessControl\Log\Table::COLUMN_DATE = 'created'

private

Definition at line 40 of file Table.php.

COLUMN_LOGIN

const ILIAS\AccessControl\Log\Table::COLUMN_LOGIN = 'login'

private

Definition at line 42 of file Table.php.

COLUMN_NAME

const ILIAS\AccessControl\Log\Table::COLUMN_NAME = 'name'

private

Definition at line 41 of file Table.php.

FILTER_FIELD_ACTION

const ILIAS\AccessControl\Log\Table::FILTER_FIELD_ACTION = 'action'

private

Definition at line 37 of file Table.php.

FILTER_FIELD_PERIOD

const ILIAS\AccessControl\Log\Table::FILTER_FIELD_PERIOD = 'period'

private

Definition at line 38 of file Table.php.

FILTER_ID

const ILIAS\AccessControl\Log\Table::FILTER_ID = 'perm_table_filter'

private

Definition at line 36 of file Table.php.

---

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

• components/ILIAS/AccessControl/src/Log/Table.php