UploadPolicyDBRepository Class Reference

Collaboration diagram for UploadPolicyDBRepository:

Public Member Functions
	__construct (protected readonly ilDBInterface $db)
	store (UploadPolicy $policy)
	get (int $policy_id)
	getAll ()
	delete (UploadPolicy $policy)

Protected Member Functions
	transformToDtoOrAbort (stdClass $dataset)
	getDateString (DateTimeImmutable $date)
	getDateObject (string $date_string)
	Returns a datetime object with '00:00:00' as H:i:s to avoid comparison errors because PHP will use the current time automatically otherwise. More...
	getDateTimeString (DateTimeImmutable $date_time)
	getDateTimeObject (string $date_time_string)
	missingRequiredField (string $field_name)

Protected Attributes
const	MYSQL_DATETIME_FORMAT = 'Y-m-d H:i:s'
const	MYSQL_DATE_FORMAT = 'Y-m-d'

Detailed Description

Author

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

Definition at line 23 of file UploadPolicyDBRepository.php.

Constructor & Destructor Documentation

__construct()

UploadPolicyDBRepository::__construct

(

protected readonly ilDBInterface

$db

)

Definition at line 28 of file UploadPolicyDBRepository.php.

    {
    }

Member Function Documentation

delete()

UploadPolicyDBRepository::delete

(

UploadPolicy

$policy

)

Definition at line 93 of file UploadPolicyDBRepository.php.

                                                : void
    {
        if (null === ($policy_id = $policy->getPolicyId())) {
            return;
        }

        $query = "DELETE FROM il_upload_policy WHERE policy_id = %s";
        $this->db->manipulateF($query, ['integer'], [$policy_id]);
    }

get()

UploadPolicyDBRepository::get

(

int

$policy_id

)

Definition at line 66 of file UploadPolicyDBRepository.php.

References transformToDtoOrAbort().

                                       : ?UploadPolicy
    {
        $query = "SELECT * FROM il_upload_policy WHERE policy_id = %s";
        $result = $this->db->queryF($query, ['integer'], [$policy_id]);
        if (null !== ($dataset = $this->db->fetchObject($result))) {
            return $this->transformToDtoOrAbort($dataset);
        }

        return null;
    }

Here is the call graph for this function:

getAll()

UploadPolicyDBRepository::getAll

(

)

Returns

UploadPolicy[]

Definition at line 80 of file UploadPolicyDBRepository.php.

References transformToDtoOrAbort().

                            : array
    {
        $query = "SELECT * FROM il_upload_policy";
        $result = $this->db->query($query);

        $upload_policies = [];
        while (null !== ($dataset = $this->db->fetchObject($result))) {
            $upload_policies[] = $this->transformToDtoOrAbort($dataset);
        }

        return $upload_policies;
    }

Here is the call graph for this function:

getDateObject()

UploadPolicyDBRepository::getDateObject ( string  $date_string )

protected

Returns a datetime object with '00:00:00' as H:i:s to avoid comparison errors because PHP will use the current time automatically otherwise.

Definition at line 142 of file UploadPolicyDBRepository.php.

Referenced by transformToDtoOrAbort().

                                                         : DateTimeImmutable
    {
        return
            (DateTimeImmutable::createFromFormat(self::MYSQL_DATETIME_FORMAT, $date_string . ' 00:00:00')) ?:
                throw new LogicException("Could not create DateTimeImmutable from '$date_string'.");
    }

Here is the caller graph for this function:

getDateString()

UploadPolicyDBRepository::getDateString ( DateTimeImmutable  $date )

protected

Definition at line 133 of file UploadPolicyDBRepository.php.

Referenced by store().

                                                             : string
    {
        return $date->format(self::MYSQL_DATE_FORMAT);
    }

Here is the caller graph for this function:

getDateTimeObject()

UploadPolicyDBRepository::getDateTimeObject ( string  $date_time_string )

protected

Definition at line 154 of file UploadPolicyDBRepository.php.

Referenced by transformToDtoOrAbort().

                                                                  : DateTimeImmutable
    {
        return
            (DateTimeImmutable::createFromFormat(self::MYSQL_DATETIME_FORMAT, $date_time_string)) ?:
                throw new LogicException("Could not create DateTimeImmutable from '$date_time_string'.");
    }

Here is the caller graph for this function:

getDateTimeString()

UploadPolicyDBRepository::getDateTimeString ( DateTimeImmutable  $date_time )

protected

Definition at line 149 of file UploadPolicyDBRepository.php.

Referenced by store().

                                                                      : string
    {
        return $date_time->format(self::MYSQL_DATETIME_FORMAT);
    }

Here is the caller graph for this function:

missingRequiredField()

UploadPolicyDBRepository::missingRequiredField ( string  $field_name )

protected

Exceptions

LogicException

Definition at line 164 of file UploadPolicyDBRepository.php.

Referenced by transformToDtoOrAbort().

                                                               : void
    {
        throw new LogicException("Could not retrieve data for required field '$field_name'.");
    }

Here is the caller graph for this function:

store()

UploadPolicyDBRepository::store

(

UploadPolicy

$policy

)

Definition at line 32 of file UploadPolicyDBRepository.php.

References UploadPolicy\getAudience(), UploadPolicy\getAudienceType(), UploadPolicy\getCreateDate(), getDateString(), getDateTimeString(), UploadPolicy\getLastUpdate(), UploadPolicy\getOwnerId(), UploadPolicy\getPolicyId(), UploadPolicy\getScopeDefinition(), UploadPolicy\getTitle(), UploadPolicy\getUploadLimitInMB(), UploadPolicy\getValidFrom(), UploadPolicy\getValidUntil(), and UploadPolicy\isActive().

                                               : void
    {
        $data_for_storage = [
            "title" => ['text', $policy->getTitle()],
            "upload_limit_in_mb" => ['integer', $policy->getUploadLimitInMB()],
            "audience" => ['text', json_encode($policy->getAudience(), JSON_THROW_ON_ERROR)],
            "audience_type" => ['integer', $policy->getAudienceType()],
            "scope_definition" => ['text', $policy->getScopeDefinition()],
            "active" => ['integer', $policy->isActive()],
            "valid_from" => ['date', (null !== ($from = $policy->getValidFrom())) ? $this->getDateString($from) : null],
            "valid_until" => [
                'date',
                (null !== ($until = $policy->getValidUntil())) ? $this->getDateString($until) : null
            ],
            "owner" => ['integer', $policy->getOwnerId()],
            "last_update" => ['timestamp', $this->getDateTimeString($policy->getLastUpdate())]
        ];

        if (null !== ($policy_id = $policy->getPolicyId()) && null !== $this->get($policy_id)) {
            // UPDATE
            $this->db->update(
                "il_upload_policy",
                $data_for_storage,
                ["policy_id" => ['integer', $policy_id]]
            );
        } else {
            // CREATE
            $data_for_storage["policy_id"] = ['integer', $this->db->nextId("il_upload_policy")];
            $data_for_storage["create_date"] = ['timestamp', $this->getDateTimeString($policy->getCreateDate())];

            $this->db->insert("il_upload_policy", $data_for_storage);
        }
    }

Here is the call graph for this function:

transformToDtoOrAbort()

UploadPolicyDBRepository::transformToDtoOrAbort ( stdClass  $dataset )

protected

Exceptions

LogicException

if required data is missing

Definition at line 106 of file UploadPolicyDBRepository.php.

References getDateObject(), getDateTimeObject(), and missingRequiredField().

Referenced by get(), and getAll().

                                                               : UploadPolicy
    {
        $audience_json = $dataset?->audience ?? $this->missingRequiredField('audience');

        $valid_from = (null !== ($from = $dataset?->valid_from)) ? $this->getDateObject((string) $from) : null;
        $valid_until = (null !== ($until = $dataset?->valid_until)) ? $this->getDateObject((string) $until) : null;

        return new UploadPolicy(
            $dataset?->policy_id ?? $this->missingRequiredField('policy_id'),
            $dataset?->title ?? $this->missingRequiredField('title'),
            $dataset->upload_limit_in_mb ?? $this->missingRequiredField('upload_limit_in_mb'),
            json_decode((string) $audience_json, true, 512, JSON_THROW_ON_ERROR),
            $dataset?->audience_type ?? $this->missingRequiredField('audience_type'),
            $dataset?->scope_definition ?? $this->missingRequiredField('scope_definition'),
            (bool) ($dataset?->active ?? $this->missingRequiredField('active')),
            $valid_from,
            $valid_until,
            $dataset?->owner ?? $this->missingRequiredField('owner'),
            $this->getDateTimeObject(
                (string) ($dataset?->create_date ?? $this->missingRequiredField('create_date'))
            ),
            $this->getDateTimeObject(
                (string) ($dataset?->last_update ?? $this->missingRequiredField('last_update'))
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

MYSQL_DATE_FORMAT

const UploadPolicyDBRepository::MYSQL_DATE_FORMAT = 'Y-m-d'

protected

Definition at line 26 of file UploadPolicyDBRepository.php.

MYSQL_DATETIME_FORMAT

const UploadPolicyDBRepository::MYSQL_DATETIME_FORMAT = 'Y-m-d H:i:s'

protected

Definition at line 25 of file UploadPolicyDBRepository.php.

---

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

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