Collaboration diagram for UploadPolicyFormUI:

Public Member Functions
	__construct (protected UploadPolicyDBRepository $upload_policy_db_repository, protected ilCtrlInterface $ctrl, protected HttpServices $http, protected ilLanguage $language, protected ilRbacReview $rbac_review, protected RefineryFactory $refinery, protected UIFactory $ui_factory)

	getForm ()

Data Fields
const	INPUT_SECTION_GENERAL = "general_section"

const	INPUT_SECTION_AUDIENCE = "audience_section"

const	INPUT_SECTION_VALIDITY = "validity_section"

const	HIDDEN_INPUT_POLICY_ID = "policy_id"

const	INPUT_FIELD_TITLE = "title"

const	INPUT_FIELD_UPLOAD_LIMIT = "upload_limit"

const	INPUT_FIELD_AUDIENCE = "audience"

const	INPUT_FIELD_AUDIENCE_TYPE = "audience_type"

const	INPUT_FIELD_AUDIENCE_DATA = "audience_data"

const	INPUT_OPTION_ALL_USERS = "all_users"

const	INPUT_OPTION_GLOBAL_ROLES = "global_roles"

const	INPUT_FIELD_GLOBAL_ROLES = "global_roles"

const	INPUT_FIELD_VALID_UNTIL = "valid_until"

const	INPUT_FIELD_ACTIVE = "active"

Protected Member Functions
	getGlobalRoles ()

	getAudienceTransformation ()

Protected Attributes
const	LABEL_INPUT_SECTION_GENERAL = "general"

const	LABEL_INPUT_SECTION_AUDIENCE = "policy_audience"

const	LABEL_INPUT_SECTION_VALIDITY = "policy_validity"

const	LABEL_INPUT_FIELD_TITLE = "title"

const	LABEL_INPUT_FIELD_UPLOAD_LIMIT = "policy_upload_limit"

const	LABEL_INPUT_FIELD_AUDIENCE = "policy_audience"

const	LABEL_INPUT_OPTION_ALL_USERS = "all_users"

const	LABEL_INPUT_OPTION_GLOBAL_ROLES = "all_global_roles"

const	LABEL_INPUT_FIELD_GLOBAL_ROLES = "all_global_roles"

const	LABEL_INPUT_FIELD_VALID_UNTIL = "policy_valid_until"

const	LABEL_INPUT_FIELD_ACTIVE = "active"

const	BYLINE_INPUT_FIELD_TITLE = "policy_title_desc"

const	BYLINE_INPUT_FIELD_UPLOAD_LIMIT = "policy_upload_limit_desc"

const	BYLINE_INPUT_OPTION_ALL_USERS = "policy_audience_all_users_option_desc"

const	BYLINE_INPUT_OPTION_GLOBAL_ROLES = "policy_audience_global_roles_option_desc"

const	BYLINE_INPUT_FIELD_VALID_UNTIL = "policy_valid_until_desc"

StandardForm	$form

Detailed Description

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

Definition at line 29 of file UploadPolicyFormUI.php.

Constructor & Destructor Documentation

◆ __construct()

UploadPolicyFormUI::__construct	(	protected UploadPolicyDBRepository	$upload_policy_db_repository,
		protected ilCtrlInterface	$ctrl,
		protected HttpServices	$http,
		protected ilLanguage	$language,
		protected ilRbacReview	$rbac_review,
		protected RefineryFactory	$refinery,
		protected UIFactory	$ui_factory
	)

Definition at line 70 of file UploadPolicyFormUI.php.

References UploadPolicy\AUDIENCE_TYPE_GLOBAL_ROLE, ilUploadLimitsOverviewGUI\CMD_SAVE_UPLOAD_POLICY, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getAudienceTransformation(), getGlobalRoles(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), UploadPolicy\POLICY_ID, ILIAS\Repository\refinery(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

       {
         $policy_id = null;
         $upload_policy = null;
 
         // Retrieve upload_policy if request contains policy_id
         if ($this->http->wrapper()->query()->has(UploadPolicy::POLICY_ID)) {
             $policy_id = $this->http->wrapper()->query()->retrieve(
                 UploadPolicy::POLICY_ID,
                 $this->refinery->kindlyTo()->int()
             );
             $upload_policy = $this->upload_policy_db_repository->get($policy_id);
         }
 
         // Create hidden input (policy_id)
         $policy_id_hidden_input = $this->ui_factory->input()->field()->hidden()->withValue((string) $policy_id);
 
         // Create general section and its inputs (title and upload_limit)
         $policy_title_input = $this->ui_factory->input()->field()->text(
             $this->language->txt(self::LABEL_INPUT_FIELD_TITLE),
             $this->language->txt(self::BYLINE_INPUT_FIELD_TITLE)
         )->withValue(
             $upload_policy?->getTitle() ?? ""
         )->withRequired(true);
         $upload_limit_input = $this->ui_factory->input()->field()->numeric(
             $this->language->txt(self::LABEL_INPUT_FIELD_UPLOAD_LIMIT),
             $this->language->txt(self::BYLINE_INPUT_FIELD_UPLOAD_LIMIT)
         )->withValue(
             $upload_policy?->getUploadLimitInMB()
         )->withRequired(true);
         $general_section = $this->ui_factory->input()->field()->section(
             [
                 self::INPUT_FIELD_TITLE => $policy_title_input,
                 self::INPUT_FIELD_UPLOAD_LIMIT => $upload_limit_input
             ],
             $this->language->txt(self::LABEL_INPUT_SECTION_GENERAL)
         );
 
         // Create audience section and its input (audience)
         $all_users_option = $this->ui_factory->input()->field()->group(
             [],
             $this->language->txt(self::LABEL_INPUT_OPTION_ALL_USERS),
             $this->language->txt(self::BYLINE_INPUT_OPTION_ALL_USERS)
         );
         $global_role_input = $this->ui_factory->input()->field()->multiSelect(
             $this->language->txt(self::LABEL_INPUT_FIELD_GLOBAL_ROLES) . ":",
             $this->getGlobalRoles()
         )->withValue(
             $upload_policy?->getAudience()['global_roles'] ?? []
         );
         $global_roles_option = $this->ui_factory->input()->field()->group(
             [
                 self::INPUT_FIELD_GLOBAL_ROLES => $global_role_input
             ],
             $this->language->txt(self::LABEL_INPUT_OPTION_GLOBAL_ROLES),
             $this->language->txt(self::BYLINE_INPUT_OPTION_GLOBAL_ROLES)
         );
         $audience_input = $this->ui_factory->input()->field()->switchableGroup(
             [
                 self::INPUT_OPTION_ALL_USERS => $all_users_option,
                 self::INPUT_OPTION_GLOBAL_ROLES => $global_roles_option
             ],
             $this->language->txt(self::LABEL_INPUT_FIELD_AUDIENCE)
         )->withValue(
             ($upload_policy?->getAudienceType() === UploadPolicy::AUDIENCE_TYPE_GLOBAL_ROLE) ? self::INPUT_OPTION_GLOBAL_ROLES : self::INPUT_OPTION_ALL_USERS
         )->withRequired(true);
         $audience_section = $this->ui_factory->input()->field()->section(
             [
                 self::INPUT_FIELD_AUDIENCE => $audience_input
             ],
             $this->language->txt(self::LABEL_INPUT_SECTION_AUDIENCE)
         )->withAdditionalTransformation(
             $this->getAudienceTransformation()
         );
 
         // Create validity section and its inputs (valid_until and active)
         $valid_until_input = $this->ui_factory->input()->field()->dateTime(
             $this->language->txt(self::LABEL_INPUT_FIELD_VALID_UNTIL),
             $this->language->txt(self::BYLINE_INPUT_FIELD_VALID_UNTIL)
         )->withValue(
             $upload_policy?->getValidUntil()
         );
         $active_input = $this->ui_factory->input()->field()->checkbox(
             $this->language->txt(self::LABEL_INPUT_FIELD_ACTIVE)
         )->withValue(
             $upload_policy?->isActive()
         );
         $validity_section = $this->ui_factory->input()->field()->section(
             [
                 self::INPUT_FIELD_VALID_UNTIL => $valid_until_input,
                 self::INPUT_FIELD_ACTIVE => $active_input
             ],
             $this->language->txt(self::LABEL_INPUT_SECTION_VALIDITY)
         );
 
         // Create form
         $this->form = $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getLinkTargetByClass(ilUploadLimitsOverviewGUI::class, ilUploadLimitsOverviewGUI::CMD_SAVE_UPLOAD_POLICY),
             [
                 self::INPUT_SECTION_GENERAL => $general_section,
                 self::INPUT_SECTION_AUDIENCE => $audience_section,
                 self::INPUT_SECTION_VALIDITY => $validity_section,
                 self::HIDDEN_INPUT_POLICY_ID => $policy_id_hidden_input,
             ]
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAudienceTransformation()

UploadPolicyFormUI::getAudienceTransformation ( )

protected

Definition at line 206 of file UploadPolicyFormUI.php.

References UploadPolicy\AUDIENCE_TYPE_ALL_USERS, UploadPolicy\AUDIENCE_TYPE_GLOBAL_ROLE, and ILIAS\Repository\refinery().

Referenced by __construct().

                                                   : Transformation
     {
         return $this->refinery->custom()->transformation(function ($audience_section): array {
             switch ($audience_section[self::INPUT_FIELD_AUDIENCE][0]) {
                 case self::INPUT_OPTION_GLOBAL_ROLES:
                     $audience_type = UploadPolicy::AUDIENCE_TYPE_GLOBAL_ROLE;
                     break;
                 case self::INPUT_OPTION_ALL_USERS:
                 default:
                     $audience_type = UploadPolicy::AUDIENCE_TYPE_ALL_USERS;
                     break;
             }
 
             return [
                 self::INPUT_FIELD_AUDIENCE_TYPE => $audience_type,
                 self::INPUT_FIELD_AUDIENCE_DATA => $audience_section[self::INPUT_FIELD_AUDIENCE][1]
             ];
         });
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForm()

UploadPolicyFormUI::getForm ( )

Definition at line 185 of file UploadPolicyFormUI.php.

References $form.

                              : StandardForm
     {
         return $this->form;
     }

◆ getGlobalRoles()

UploadPolicyFormUI::getGlobalRoles ( )

protected

Definition at line 191 of file UploadPolicyFormUI.php.

Referenced by __construct().

                                        : array
     {
         $global_roles = $this->rbac_review->getRolesForIDs(
             $this->rbac_review->getGlobalRoles(),
             false
         );
 
         $roles = [];
         foreach ($global_roles as $global_role) {
             $roles[$global_role['rol_id']] = $global_role['title'];
         }
 
         return $roles;
     }

Here is the caller graph for this function:

Field Documentation

◆ $form

StandardForm UploadPolicyFormUI::$form

protected

Definition at line 67 of file UploadPolicyFormUI.php.

Referenced by getForm().

◆ BYLINE_INPUT_FIELD_TITLE

const UploadPolicyFormUI::BYLINE_INPUT_FIELD_TITLE = "policy_title_desc"

protected

Definition at line 60 of file UploadPolicyFormUI.php.

◆ BYLINE_INPUT_FIELD_UPLOAD_LIMIT

const UploadPolicyFormUI::BYLINE_INPUT_FIELD_UPLOAD_LIMIT = "policy_upload_limit_desc"

protected

Definition at line 61 of file UploadPolicyFormUI.php.

◆ BYLINE_INPUT_FIELD_VALID_UNTIL

const UploadPolicyFormUI::BYLINE_INPUT_FIELD_VALID_UNTIL = "policy_valid_until_desc"

protected

Definition at line 64 of file UploadPolicyFormUI.php.

◆ BYLINE_INPUT_OPTION_ALL_USERS

const UploadPolicyFormUI::BYLINE_INPUT_OPTION_ALL_USERS = "policy_audience_all_users_option_desc"

protected

Definition at line 62 of file UploadPolicyFormUI.php.

◆ BYLINE_INPUT_OPTION_GLOBAL_ROLES

const UploadPolicyFormUI::BYLINE_INPUT_OPTION_GLOBAL_ROLES = "policy_audience_global_roles_option_desc"

protected

Definition at line 63 of file UploadPolicyFormUI.php.

◆ HIDDEN_INPUT_POLICY_ID

const UploadPolicyFormUI::HIDDEN_INPUT_POLICY_ID = "policy_id"

Definition at line 35 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_FIELD_ACTIVE

const UploadPolicyFormUI::INPUT_FIELD_ACTIVE = "active"

Definition at line 45 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_FIELD_AUDIENCE

const UploadPolicyFormUI::INPUT_FIELD_AUDIENCE = "audience"

Definition at line 38 of file UploadPolicyFormUI.php.

◆ INPUT_FIELD_AUDIENCE_DATA

const UploadPolicyFormUI::INPUT_FIELD_AUDIENCE_DATA = "audience_data"

Definition at line 40 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_FIELD_AUDIENCE_TYPE

const UploadPolicyFormUI::INPUT_FIELD_AUDIENCE_TYPE = "audience_type"

Definition at line 39 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_FIELD_GLOBAL_ROLES

const UploadPolicyFormUI::INPUT_FIELD_GLOBAL_ROLES = "global_roles"

Definition at line 43 of file UploadPolicyFormUI.php.

◆ INPUT_FIELD_TITLE

const UploadPolicyFormUI::INPUT_FIELD_TITLE = "title"

Definition at line 36 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_FIELD_UPLOAD_LIMIT

const UploadPolicyFormUI::INPUT_FIELD_UPLOAD_LIMIT = "upload_limit"

Definition at line 37 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_FIELD_VALID_UNTIL

const UploadPolicyFormUI::INPUT_FIELD_VALID_UNTIL = "valid_until"

Definition at line 44 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_OPTION_ALL_USERS

const UploadPolicyFormUI::INPUT_OPTION_ALL_USERS = "all_users"

Definition at line 41 of file UploadPolicyFormUI.php.

◆ INPUT_OPTION_GLOBAL_ROLES

const UploadPolicyFormUI::INPUT_OPTION_GLOBAL_ROLES = "global_roles"

Definition at line 42 of file UploadPolicyFormUI.php.

◆ INPUT_SECTION_AUDIENCE

const UploadPolicyFormUI::INPUT_SECTION_AUDIENCE = "audience_section"

Definition at line 32 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_SECTION_GENERAL

const UploadPolicyFormUI::INPUT_SECTION_GENERAL = "general_section"

Definition at line 31 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ INPUT_SECTION_VALIDITY

const UploadPolicyFormUI::INPUT_SECTION_VALIDITY = "validity_section"

Definition at line 33 of file UploadPolicyFormUI.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy().

◆ LABEL_INPUT_FIELD_ACTIVE

const UploadPolicyFormUI::LABEL_INPUT_FIELD_ACTIVE = "active"

protected

Definition at line 58 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_FIELD_AUDIENCE

const UploadPolicyFormUI::LABEL_INPUT_FIELD_AUDIENCE = "policy_audience"

protected

Definition at line 53 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_FIELD_GLOBAL_ROLES

const UploadPolicyFormUI::LABEL_INPUT_FIELD_GLOBAL_ROLES = "all_global_roles"

protected

Definition at line 56 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_FIELD_TITLE

const UploadPolicyFormUI::LABEL_INPUT_FIELD_TITLE = "title"

protected

Definition at line 51 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_FIELD_UPLOAD_LIMIT

const UploadPolicyFormUI::LABEL_INPUT_FIELD_UPLOAD_LIMIT = "policy_upload_limit"

protected

Definition at line 52 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_FIELD_VALID_UNTIL

const UploadPolicyFormUI::LABEL_INPUT_FIELD_VALID_UNTIL = "policy_valid_until"

protected

Definition at line 57 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_OPTION_ALL_USERS

const UploadPolicyFormUI::LABEL_INPUT_OPTION_ALL_USERS = "all_users"

protected

Definition at line 54 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_OPTION_GLOBAL_ROLES

const UploadPolicyFormUI::LABEL_INPUT_OPTION_GLOBAL_ROLES = "all_global_roles"

protected

Definition at line 55 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_SECTION_AUDIENCE

const UploadPolicyFormUI::LABEL_INPUT_SECTION_AUDIENCE = "policy_audience"

protected

Definition at line 48 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_SECTION_GENERAL

const UploadPolicyFormUI::LABEL_INPUT_SECTION_GENERAL = "general"

protected

Definition at line 47 of file UploadPolicyFormUI.php.

◆ LABEL_INPUT_SECTION_VALIDITY

const UploadPolicyFormUI::LABEL_INPUT_SECTION_VALIDITY = "policy_validity"

protected

Definition at line 49 of file UploadPolicyFormUI.php.

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

Services/FileServices/classes/UploadService/UploadLimits/UploadPolicyFormUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAudienceTransformation()

◆ getForm()

◆ getGlobalRoles()

Field Documentation

◆ $form

◆ BYLINE_INPUT_FIELD_TITLE

◆ BYLINE_INPUT_FIELD_UPLOAD_LIMIT

◆ BYLINE_INPUT_FIELD_VALID_UNTIL

◆ BYLINE_INPUT_OPTION_ALL_USERS

◆ BYLINE_INPUT_OPTION_GLOBAL_ROLES

◆ HIDDEN_INPUT_POLICY_ID

◆ INPUT_FIELD_ACTIVE

◆ INPUT_FIELD_AUDIENCE

◆ INPUT_FIELD_AUDIENCE_DATA

◆ INPUT_FIELD_AUDIENCE_TYPE

◆ INPUT_FIELD_GLOBAL_ROLES

◆ INPUT_FIELD_TITLE

◆ INPUT_FIELD_UPLOAD_LIMIT

◆ INPUT_FIELD_VALID_UNTIL

◆ INPUT_OPTION_ALL_USERS

◆ INPUT_OPTION_GLOBAL_ROLES

◆ INPUT_SECTION_AUDIENCE

◆ INPUT_SECTION_GENERAL

◆ INPUT_SECTION_VALIDITY

◆ LABEL_INPUT_FIELD_ACTIVE

◆ LABEL_INPUT_FIELD_AUDIENCE

◆ LABEL_INPUT_FIELD_GLOBAL_ROLES

◆ LABEL_INPUT_FIELD_TITLE

◆ LABEL_INPUT_FIELD_UPLOAD_LIMIT

◆ LABEL_INPUT_FIELD_VALID_UNTIL

◆ LABEL_INPUT_OPTION_ALL_USERS

◆ LABEL_INPUT_OPTION_GLOBAL_ROLES

◆ LABEL_INPUT_SECTION_AUDIENCE

◆ LABEL_INPUT_SECTION_GENERAL

◆ LABEL_INPUT_SECTION_VALIDITY