UploadPoliciesTableUI Class Reference

Collaboration diagram for UploadPoliciesTableUI:

Public Member Functions
	__construct (protected UploadPolicyDBRepository $upload_policy_db_repository, protected ilCtrlInterface $ctrl, protected HttpServices $http, protected ilLanguage $language, protected ilGlobalTemplateInterface $main_tpl, protected ilRbacReview $rbac_review, protected RefineryFactory $refinery, protected UIFactory $ui_factory, protected Renderer $ui_renderer, protected bool $write_access)
	getComponents ()

Data Fields
const	ACTIVE_FILTER_PARAM = "active_filter"

Protected Member Functions
	buildPolicyActions (array $policies)
	getAudienceText (int $audience_type, array $audience_data)
	getViewControl ()
	getDeletionConfirmationModal (UploadPolicy $record)
	getPresentablePolicies ()

Protected Attributes
const	ACTIVE_FILTER_ALL = "all"
const	ACTIVE_FILTER_ACTIVE = "active"
const	ACTIVE_FILTER_INACTIVE = "inactive"
array	$components = []

Detailed Description

Author

Lukas Zehnder lukas.nosp@m.@sr..nosp@m.solut.nosp@m.ions

Definition at line 34 of file UploadPoliciesTableUI.php.

Constructor & Destructor Documentation

__construct()

UploadPoliciesTableUI::__construct	(	protected UploadPolicyDBRepository	$upload_policy_db_repository,
		protected ilCtrlInterface	$ctrl,
		protected HttpServices	$http,
		protected ilLanguage	$language,
		protected ilGlobalTemplateInterface	$main_tpl,
		protected ilRbacReview	$rbac_review,
		protected RefineryFactory	$refinery,
		protected UIFactory	$ui_factory,
		protected Renderer	$ui_renderer,
		protected bool	$write_access
	)

Definition at line 46 of file UploadPoliciesTableUI.php.

References buildPolicyActions(), getAudienceText(), getPresentablePolicies(), getViewControl(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), null, ILIAS\UI\Component\Table\PresentationRow\withAction(), and ILIAS\UI\Component\Table\PresentationRow\withHeadline().

      {
        $policies = $this->getPresentablePolicies();
        $actions = $this->buildPolicyActions($policies);
        $table = $this->ui_factory->table()->presentation(
            $this->language->txt('upload_policies'),
            [$this->getViewControl()],
            function (
                PresentationRow $row,
                UploadPolicy $record,
                UIFactory $ui_factory
            ) use ($actions): PresentationRow {
                // Create texts for better data presentation in table
                $upload_limit_text = $record->getUploadLimitInMB() . " MB";
                $active_text = ($record->isActive()) ? $this->language->txt('yes') : $this->language->txt('no');
                $audience_text = $this->getAudienceText($record->getAudienceType(), $record->getAudience());
                $scope_text = $record->getScopeDefinition();
                $valid_until_text = $record->getValidUntil()?->format('d.m.Y') ?? $this->language->txt(
                    "policy_no_validity_limitation_set"
                );

                // Create row with fields and actions
                $row = $row
                    ->withHeadline($record->getTitle())
                    ->withImportantFields(
                        [
                            $this->language->txt('policy_upload_limit') => $upload_limit_text,
                            $this->language->txt('policy_audience') => $audience_text,
                            $this->language->txt('active') => $active_text
                        ]
                    )
                    ->withContent(
                        $ui_factory->listing()->descriptive(
                            [
                                $this->language->txt('policy_upload_limit') => $upload_limit_text,
                                $this->language->txt('policy_audience') => $audience_text,
                                $this->language->txt('active') => $active_text,
                                $this->language->txt('policy_scope') => $scope_text,
                                $this->language->txt('policy_valid_until') => $valid_until_text,
                            ]
                        )
                    );

                if (null !== ($dropdown = $actions[$record->getPolicyId()] ?? null)) {
                    return $row->withAction($dropdown);
                }

                return $row;
            }
        )->withData($policies);

        $this->components[] = $table;
    }

Here is the call graph for this function:

Member Function Documentation

buildPolicyActions()

UploadPoliciesTableUI::buildPolicyActions ( array  $policies )

protected

Parameters

UploadPolicy[]

$policies

Returns

Dropdown[]

Definition at line 122 of file UploadPoliciesTableUI.php.

References $data, ilUploadLimitsOverviewGUI\CMD_EDIT_UPLOAD_POLICY, ILIAS\Repository\ctrl(), getDeletionConfirmationModal(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and UploadPolicy\POLICY_ID.

Referenced by __construct().

                                                          : array
    {
        if (!$this->write_access) {
            return [];
        }
        $dropdowns = [];
        foreach ($policies as $policy) {
            // Store policy_id for later use when the table's actions (edit / delete) are used)
            $this->ctrl->setParameterByClass(
                ilUploadLimitsOverviewGUI::class,
                UploadPolicy::POLICY_ID,
                $policy->getPolicyId()
            );

            $deletion_modal = $this->getDeletionConfirmationModal($policy);
            $dropdowns[$policy->getPolicyId()] = $this->ui_factory->dropdown()->standard(
                [
                    $this->ui_factory->button()->shy(
                        $this->language->txt('edit'),
                        $this->ctrl->getLinkTargetByClass(
                            ilUploadLimitsOverviewGUI::class,
                            ilUploadLimitsOverviewGUI::CMD_EDIT_UPLOAD_POLICY
                        )
                    ),
                    $this->ui_factory->button()->shy(
                        $this->language->txt('delete'),
                        $deletion_modal->getShowSignal()
                    )
                ]
            );

            $this->components[] = $deletion_modal;
        }

        return $dropdowns;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAudienceText()

UploadPoliciesTableUI::getAudienceText ( int  $audience_type, array  $audience_data  )

protected

Definition at line 185 of file UploadPoliciesTableUI.php.

References UploadPolicy\AUDIENCE_TYPE_ALL_USERS, UploadPolicy\AUDIENCE_TYPE_GLOBAL_ROLE, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by __construct(), and getDeletionConfirmationModal().

                                                                                : string
    {
        switch ($audience_type) {
            case UploadPolicy::AUDIENCE_TYPE_GLOBAL_ROLE:
                $audience_text = $this->language->txt('all_global_roles');
                // add selected roles to audience_text
                if (!empty($audience_data['global_roles'])) {
                    $roles = $this->rbac_review->getRolesForIDs($audience_data['global_roles'], false);
                    $counter = 0;
                    foreach ($roles as $role) {
                        $counter++;
                        $audience_text .= " \"" . $role['title'] . "\"";
                        if ($counter !== count($roles)) {
                            $audience_text .= ",";
                        }
                    }
                }
                break;
            case UploadPolicy::AUDIENCE_TYPE_ALL_USERS:
            default:
                $audience_text = $this->language->txt('all_users');
                break;
        }

        return $audience_text;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComponents()

UploadPoliciesTableUI::getComponents

(

)

Returns

Component[]

Definition at line 113 of file UploadPoliciesTableUI.php.

References $components.

                                   : array
    {
        return $this->components;
    }

getDeletionConfirmationModal()

UploadPoliciesTableUI::getDeletionConfirmationModal ( UploadPolicy  $record )

protected

Definition at line 239 of file UploadPoliciesTableUI.php.

References ilUploadLimitsOverviewGUI\CMD_DELETE_UPLOAD_POLICY, ILIAS\Repository\ctrl(), UploadPolicy\getAudience(), getAudienceText(), UploadPolicy\getAudienceType(), UploadPolicy\getPolicyId(), UploadPolicy\getScopeDefinition(), UploadPolicy\getTitle(), UploadPolicy\getUploadLimitInMB(), UploadPolicy\getValidUntil(), UploadPolicy\isActive(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by buildPolicyActions().

                                                                         : Interruptive
    {
        $upload_limit_text = $record->getUploadLimitInMB() . " MB";
        $active_text = ($record->isActive()) ? $this->language->txt('yes') : $this->language->txt('no');
        $audience_text = $this->getAudienceText($record->getAudienceType(), $record->getAudience());
        $valid_until_text = $record->getValidUntil()?->format('d.m.Y') ?? $this->language->txt(
            "policy_no_validity_limitation_set"
        );

        $deletion_items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
            (string) $record->getPolicyId(),
            $this->language->txt('title'),
            $record->getTitle()
        );

        $deletion_items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
            (string) $record->getPolicyId(),
            $this->language->txt('policy_upload_limit'),
            $upload_limit_text
        );

        $deletion_items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
            (string) $record->getPolicyId(),
            $this->language->txt('policy_audience'),
            $audience_text
        );

        $deletion_items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
            (string) $record->getPolicyId(),
            $this->language->txt('active'),
            $active_text
        );

        $deletion_items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
            (string) $record->getPolicyId(),
            $this->language->txt('policy_scope'),
            $record->getScopeDefinition()
        );

        $deletion_items[] = $this->ui_factory->modal()->interruptiveItem()->keyValue(
            (string) $record->getPolicyId(),
            $this->language->txt('policy_valid_until'),
            $valid_until_text
        );

        return $this->ui_factory->modal()->interruptive(
            $this->language->txt("delete"),
            $this->language->txt('policy_confirm_deletion'),
            $this->ctrl->getLinkTargetByClass(
                ilUploadLimitsOverviewGUI::class,
                ilUploadLimitsOverviewGUI::CMD_DELETE_UPLOAD_POLICY
            )
        )->withAffectedItems(
            $deletion_items
        )->withActionButtonLabel($this->language->txt('delete'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPresentablePolicies()

UploadPoliciesTableUI::getPresentablePolicies ( )

protected

Returns

UploadPolicy[]

Definition at line 299 of file UploadPoliciesTableUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by __construct().

                                               : array
    {
        $policy_data = $this->upload_policy_db_repository->getAll();

        if ($this->http->wrapper()->query()->has(self::ACTIVE_FILTER_PARAM)) {
            return $this->filterData(
                $this->http->wrapper()->query()->retrieve(
                    self::ACTIVE_FILTER_PARAM,
                    $this->refinery->kindlyTo()->string()
                ),
                $policy_data
            );
        }

        return $policy_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getViewControl()

UploadPoliciesTableUI::getViewControl ( )

protected

Definition at line 212 of file UploadPoliciesTableUI.php.

References ilUploadLimitsOverviewGUI\CMD_INDEX, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\refinery().

Referenced by __construct().

                                       : Mode
    {
        $target = $this->ctrl->getLinkTargetByClass(
            ilUploadLimitsOverviewGUI::class,
            ilUploadLimitsOverviewGUI::CMD_INDEX
        );

        $active_control_element = self::ACTIVE_FILTER_ALL;
        if ($this->http->wrapper()->query()->has(self::ACTIVE_FILTER_PARAM)) {
            $active_control_element = $this->http->wrapper()->query()->retrieve(
                self::ACTIVE_FILTER_PARAM,
                $this->refinery->kindlyTo()->string()
            );
        }

        $actions_prefix = $target . "&" . self::ACTIVE_FILTER_PARAM . "=";
        $actions = [
            $this->language->txt(self::ACTIVE_FILTER_ALL) => $actions_prefix . self::ACTIVE_FILTER_ALL,
            $this->language->txt(self::ACTIVE_FILTER_ACTIVE) => $actions_prefix . self::ACTIVE_FILTER_ACTIVE,
            $this->language->txt(self::ACTIVE_FILTER_INACTIVE) => $actions_prefix . self::ACTIVE_FILTER_INACTIVE
        ];

        return $this->ui_factory->viewControl()->mode($actions, 'policy_filter')->withActive(
            $this->language->txt($active_control_element)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$components

array UploadPoliciesTableUI::$components = []

protected

Definition at line 44 of file UploadPoliciesTableUI.php.

Referenced by getComponents().

ACTIVE_FILTER_ACTIVE

const UploadPoliciesTableUI::ACTIVE_FILTER_ACTIVE = "active"

protected

Definition at line 38 of file UploadPoliciesTableUI.php.

ACTIVE_FILTER_ALL

const UploadPoliciesTableUI::ACTIVE_FILTER_ALL = "all"

protected

Definition at line 37 of file UploadPoliciesTableUI.php.

ACTIVE_FILTER_INACTIVE

const UploadPoliciesTableUI::ACTIVE_FILTER_INACTIVE = "inactive"

protected

Definition at line 39 of file UploadPoliciesTableUI.php.

ACTIVE_FILTER_PARAM

const UploadPoliciesTableUI::ACTIVE_FILTER_PARAM = "active_filter"

Definition at line 36 of file UploadPoliciesTableUI.php.

---

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

• components/ILIAS/FileServices/classes/UploadService/UploadLimits/UploadPoliciesTableUI.php