Collaboration diagram for UploadPolicy:

Public Member Functions
	__construct (protected ?int $policy_id, protected string $title, protected int $upload_limit_in_mb, protected array $audience, protected int $audience_type, protected string $scope_definition, protected bool $active, protected ?DateTimeImmutable $valid_from, protected ?DateTimeImmutable $valid_until, protected int $owner, protected DateTimeImmutable $create_date, protected DateTimeImmutable $last_update)

	getPolicyId ()

	getTitle ()

	getUploadLimitInMB ()

	getAudience ()

	getAudienceType ()

	getScopeDefinition ()

	isActive ()

	getValidFrom ()

	getValidUntil ()

	getOwnerId ()

	getCreateDate ()

	getLastUpdate ()

Data Fields
const	POLICY_ID = 'policy_id'

const	AUDIENCE_TYPE_ALL_USERS = 0

const	AUDIENCE_TYPE_GLOBAL_ROLE = 1

const	SCOPE_DEFINITION_GLOBAL = "Global"

Detailed Description

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

Definition at line 24 of file UploadPolicy.php.

Constructor & Destructor Documentation

◆ __construct()

UploadPolicy::__construct	(	protected ?int	$policy_id,
		protected string	$title,
		protected int	$upload_limit_in_mb,
		protected array	$audience,
		protected int	$audience_type,
		protected string	$scope_definition,
		protected bool	$active,
		protected ?DateTimeImmutable	$valid_from,
		protected ?DateTimeImmutable	$valid_until,
		protected int	$owner,
		protected DateTimeImmutable	$create_date,
		protected DateTimeImmutable	$last_update
	)

Definition at line 31 of file UploadPolicy.php.

44 {

45 }

Member Function Documentation

◆ getAudience()

UploadPolicy::getAudience ( )

Definition at line 62 of file UploadPolicy.php.

                                 : array
    {
        return $this->audience;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getAudienceType()

UploadPolicy::getAudienceType ( )

Definition at line 67 of file UploadPolicy.php.

                                     : int
    {
        return $this->audience_type;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getCreateDate()

UploadPolicy::getCreateDate ( )

Definition at line 97 of file UploadPolicy.php.

                                   : DateTimeImmutable
    {
        return $this->create_date;
    }

Referenced by UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getLastUpdate()

UploadPolicy::getLastUpdate ( )

Definition at line 102 of file UploadPolicy.php.

                                   : DateTimeImmutable
    {
        return $this->last_update;
    }

Referenced by UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getOwnerId()

UploadPolicy::getOwnerId ( )

Definition at line 92 of file UploadPolicy.php.

                                : int
    {
        return $this->owner;
    }

Referenced by UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getPolicyId()

UploadPolicy::getPolicyId ( )

Definition at line 47 of file UploadPolicy.php.

                                 : ?int
    {
        return $this->policy_id;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getScopeDefinition()

UploadPolicy::getScopeDefinition ( )

Definition at line 72 of file UploadPolicy.php.

                                        : string
    {
        return $this->scope_definition;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getTitle()

UploadPolicy::getTitle ( )

Definition at line 52 of file UploadPolicy.php.

                              : string
    {
        return $this->title;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getUploadLimitInMB()

UploadPolicy::getUploadLimitInMB ( )

Definition at line 57 of file UploadPolicy.php.

                                        : int
    {
        return $this->upload_limit_in_mb;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getValidFrom()

UploadPolicy::getValidFrom ( )

Definition at line 82 of file UploadPolicy.php.

                                  : ?DateTimeImmutable
    {
        return $this->valid_from;
    }

Referenced by UploadPolicyResolver\isPolicyActiveAndValid(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ getValidUntil()

UploadPolicy::getValidUntil ( )

Definition at line 87 of file UploadPolicy.php.

                                   : ?DateTimeImmutable
    {
        return $this->valid_until;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), UploadPolicyResolver\isPolicyActiveAndValid(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

◆ isActive()

UploadPolicy::isActive ( )

Definition at line 77 of file UploadPolicy.php.

                              : bool
    {
        return $this->active;
    }

Referenced by UploadPoliciesTableUI\__construct(), UploadPoliciesTableUI\getDeletionConfirmationModal(), UploadPolicyResolver\isPolicyActiveAndValid(), and UploadPolicyDBRepository\store().

Here is the caller graph for this function:

Field Documentation

◆ AUDIENCE_TYPE_ALL_USERS

const UploadPolicy::AUDIENCE_TYPE_ALL_USERS = 0

Definition at line 27 of file UploadPolicy.php.

Referenced by UploadPoliciesTableUI\getAudienceText(), UploadPolicyFormUI\getAudienceTransformation(), UploadPolicyResolver\getUserUploadSizeLimitInBytes(), and UploadPolicyResolverTest\testLimitedPolicy().

◆ AUDIENCE_TYPE_GLOBAL_ROLE

const UploadPolicy::AUDIENCE_TYPE_GLOBAL_ROLE = 1

Definition at line 28 of file UploadPolicy.php.

Referenced by UploadPolicyFormUI\__construct(), UploadPoliciesTableUI\getAudienceText(), UploadPolicyFormUI\getAudienceTransformation(), and UploadPolicyResolver\getUserUploadSizeLimitInBytes().

◆ POLICY_ID

const UploadPolicy::POLICY_ID = 'policy_id'

Definition at line 26 of file UploadPolicy.php.

Referenced by UploadPolicyFormUI\__construct(), UploadPoliciesTableUI\buildPolicyActions(), and ilUploadLimitsOverviewGUI\deleteUploadPolicy().

◆ SCOPE_DEFINITION_GLOBAL

const UploadPolicy::SCOPE_DEFINITION_GLOBAL = "Global"

Definition at line 29 of file UploadPolicy.php.

Referenced by ilUploadLimitsOverviewGUI\saveUploadPolicy(), and UploadPolicyResolverTest\testLimitedPolicy().

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

components/ILIAS/FileServices/classes/UploadService/UploadLimits/UploadPolicy.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAudience()

◆ getAudienceType()

◆ getCreateDate()

◆ getLastUpdate()

◆ getOwnerId()

◆ getPolicyId()

◆ getScopeDefinition()

◆ getTitle()

◆ getUploadLimitInMB()

◆ getValidFrom()

◆ getValidUntil()

◆ isActive()

Field Documentation

◆ AUDIENCE_TYPE_ALL_USERS

◆ AUDIENCE_TYPE_GLOBAL_ROLE

◆ POLICY_ID

◆ SCOPE_DEFINITION_GLOBAL