UploadPolicy Class Reference

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 23 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 30 of file UploadPolicy.php.

      {
    }

Member Function Documentation

getAudience()

UploadPolicy::getAudience

(

)

Definition at line 61 of file UploadPolicy.php.

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

                                 : array
    {
        return $this->audience;
    }

Here is the caller graph for this function:

getAudienceType()

UploadPolicy::getAudienceType

(

)

Definition at line 66 of file UploadPolicy.php.

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

                                     : int
    {
        return $this->audience_type;
    }

Here is the caller graph for this function:

getCreateDate()

UploadPolicy::getCreateDate

(

)

Definition at line 96 of file UploadPolicy.php.

Referenced by UploadPolicyDBRepository\store().

                                   : DateTimeImmutable
    {
        return $this->create_date;
    }

Here is the caller graph for this function:

getLastUpdate()

UploadPolicy::getLastUpdate

(

)

Definition at line 101 of file UploadPolicy.php.

Referenced by UploadPolicyDBRepository\store().

                                   : DateTimeImmutable
    {
        return $this->last_update;
    }

Here is the caller graph for this function:

getOwnerId()

UploadPolicy::getOwnerId

(

)

Definition at line 91 of file UploadPolicy.php.

Referenced by UploadPolicyDBRepository\store().

                                : int
    {
        return $this->owner;
    }

Here is the caller graph for this function:

getPolicyId()

UploadPolicy::getPolicyId

(

)

Definition at line 46 of file UploadPolicy.php.

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

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

Here is the caller graph for this function:

getScopeDefinition()

UploadPolicy::getScopeDefinition

(

)

Definition at line 71 of file UploadPolicy.php.

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

                                        : string
    {
        return $this->scope_definition;
    }

Here is the caller graph for this function:

getTitle()

UploadPolicy::getTitle

(

)

Definition at line 51 of file UploadPolicy.php.

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

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getUploadLimitInMB()

UploadPolicy::getUploadLimitInMB

(

)

Definition at line 56 of file UploadPolicy.php.

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

                                        : int
    {
        return $this->upload_limit_in_mb;
    }

Here is the caller graph for this function:

getValidFrom()

UploadPolicy::getValidFrom

(

)

Definition at line 81 of file UploadPolicy.php.

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

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

Here is the caller graph for this function:

getValidUntil()

UploadPolicy::getValidUntil

(

)

Definition at line 86 of file UploadPolicy.php.

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

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

Here is the caller graph for this function:

isActive()

UploadPolicy::isActive

(

)

Definition at line 76 of file UploadPolicy.php.

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

                              : bool
    {
        return $this->active;
    }

Here is the caller graph for this function:

Field Documentation

AUDIENCE_TYPE_ALL_USERS

const UploadPolicy::AUDIENCE_TYPE_ALL_USERS = 0

Definition at line 26 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 27 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 25 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 28 of file UploadPolicy.php.

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

---

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

• Services/FileServices/classes/UploadService/UploadLimits/UploadPolicy.php