UploadPolicyResolver Class Reference

Collaboration diagram for UploadPolicyResolver:

Public Member Functions
	__construct (protected ilRbacReview $rbac_review, protected ilObjUser $current_user, protected array $upload_policies,)
	getUserUploadSizeLimitInBytes ()
	Returns the upload-size limit of the current user if customized by any upload policy. More...

Protected Member Functions
	isPolicyActiveAndValid (UploadPolicy $policy)

Protected Attributes
const	MB_TO_BYTES = 1_000 * 1_000
	Multiply for MB to Bytes, divide for Bytes to MB. More...

Detailed Description

Author

Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 24 of file UploadPolicyResolver.php.

Constructor & Destructor Documentation

__construct()

UploadPolicyResolver::__construct	(	protected ilRbacReview	$rbac_review,
		protected ilObjUser	$current_user,
		protected array	$upload_policies
	)

Parameters

UploadPolicy[]

$upload_policies

Definition at line 34 of file UploadPolicyResolver.php.

      {
    }

Member Function Documentation

getUserUploadSizeLimitInBytes()

UploadPolicyResolver::getUserUploadSizeLimitInBytes

(

)

Returns the upload-size limit of the current user if customized by any upload policy.

If multiple policies apply, the largest limit will be returned.

Definition at line 45 of file UploadPolicyResolver.php.

References UploadPolicy\AUDIENCE_TYPE_ALL_USERS, UploadPolicy\AUDIENCE_TYPE_GLOBAL_ROLE, and isPolicyActiveAndValid().

                                                   : ?int
    {
        $largest_limit_in_bytes = null;
        foreach ($this->upload_policies as $policy) {
            if (!$this->isPolicyActiveAndValid($policy)) {
                continue;
            }

            $policy_limit_in_bytes = ($policy->getUploadLimitInMB() * self::MB_TO_BYTES);

            if (UploadPolicy::AUDIENCE_TYPE_ALL_USERS === $policy->getAudienceType() &&
                (null === $largest_limit_in_bytes || $policy_limit_in_bytes > $largest_limit_in_bytes)
            ) {
                $largest_limit_in_bytes = $policy_limit_in_bytes;
                continue;
            }

            if (UploadPolicy::AUDIENCE_TYPE_GLOBAL_ROLE === $policy->getAudienceType() &&
                $this->rbac_review->isAssignedToAtLeastOneGivenRole(
                    $this->current_user->getId(),
                    array_map(
                        'intval',
                        array_merge(
                            $policy->getAudience()['global_roles'] ?? [],
                            $policy->getAudience()['local_roles'] ?? []
                        )
                    )
                ) &&
                (null === $largest_limit_in_bytes || $policy_limit_in_bytes > $largest_limit_in_bytes)
            ) {
                $largest_limit_in_bytes = $policy_limit_in_bytes;
            }
        }

        return $largest_limit_in_bytes;
    }

Here is the call graph for this function:

isPolicyActiveAndValid()

UploadPolicyResolver::isPolicyActiveAndValid ( UploadPolicy  $policy )

protected

Definition at line 82 of file UploadPolicyResolver.php.

References UploadPolicy\getValidFrom(), UploadPolicy\getValidUntil(), and UploadPolicy\isActive().

Referenced by getUserUploadSizeLimitInBytes().

                                                                   : bool
    {
        $valid_from = $policy->getValidFrom();
        $valid_until = $policy->getValidUntil();

        if (null === $valid_from && null === $valid_until) {
            return $policy->isActive();
        }

        $today = new \DateTimeImmutable('today midnight');

        if (null !== $valid_from && null !== $valid_until) {
            return $policy->isActive() && $valid_from >= $today && $today < $valid_until;
        }

        if (null !== $valid_until && null === $valid_from) {
            return $policy->isActive() && $today <= $valid_until;
        }

        if (null !== $valid_from && null === $valid_until) {
            return $policy->isActive() && $today >= $valid_from;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

MB_TO_BYTES

const UploadPolicyResolver::MB_TO_BYTES = 1_000 * 1_000

protected

Multiply for MB to Bytes, divide for Bytes to MB.

Definition at line 29 of file UploadPolicyResolver.php.

---

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

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