Collaboration diagram for ILIAS\Registration\DualOptIn\Entity\PendingRegistration:

Public Member Functions
	__construct (private PendingRegistrationId $id, private ObjectId $usr_id, private PendingRegistrationHash $hash, private \DateTimeImmutable $created_at, private PendingRegistrationStatus $status=PendingRegistrationStatus::PENDING)

	id ()

	userId ()

	hash ()

	createdAt ()

	status ()

	isConfirmed ()

	isExpired ()

	isPending ()

	withConfirmed ()

	withExpired ()

	hasExpiredAt (\DateTimeImmutable $now, int $validity_in_seconds)

	withEvaluatedState (\DateTimeImmutable $now, ?int $validity_in_seconds)

Detailed Description

Definition at line 27 of file PendingRegistration.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::__construct	(	private PendingRegistrationId	$id,
		private ObjectId	$usr_id,
		private PendingRegistrationHash	$hash,
		private \DateTimeImmutable	$created_at,
		private PendingRegistrationStatus	$status = `PendingRegistrationStatus::PENDING`
	)

Definition at line 29 of file PendingRegistration.php.

35 {

36 }

Member Function Documentation

◆ createdAt()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::createdAt ( )

Definition at line 53 of file PendingRegistration.php.

                               : \DateTimeImmutable
    {
        return $this->created_at;
    }

Referenced by ILIAS\Registration\DualOptIn\Repository\PendingRegistrationDatabaseRepository\store().

Here is the caller graph for this function:

◆ hasExpiredAt()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::hasExpiredAt	(	\DateTimeImmutable	$now,
		int	$validity_in_seconds
	)

Definition at line 116 of file PendingRegistration.php.

                                                                                   : bool
    {
        $expiration_date = $this->created_at->modify("+{$validity_in_seconds} seconds");
 
        return $now >= $expiration_date;
    }

Referenced by ILIAS\Registration\DualOptIn\Entity\PendingRegistration\withEvaluatedState().

Here is the caller graph for this function:

◆ hash()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::hash ( )

Definition at line 48 of file PendingRegistration.php.

                          : PendingRegistrationHash
    {
        return $this->hash;
    }

Referenced by ILIAS\Registration\DualOptIn\Repository\PendingRegistrationDatabaseRepository\store().

Here is the caller graph for this function:

◆ id()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::id ( )

Definition at line 38 of file PendingRegistration.php.

                        : PendingRegistrationId
    {
        return $this->id;
    }

References $id.

Referenced by ILIAS\Registration\DualOptIn\Repository\PendingRegistrationDatabaseRepository\delete(), and ILIAS\Registration\DualOptIn\Repository\PendingRegistrationDatabaseRepository\store().

Here is the caller graph for this function:

◆ isConfirmed()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::isConfirmed ( )

Definition at line 63 of file PendingRegistration.php.

                                 : bool
    {
        return $this->status === PendingRegistrationStatus::CONFIRMED;
    }

References ILIAS\Registration\DualOptIn\Entity\PendingRegistration\status().

Here is the call graph for this function:

◆ isExpired()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::isExpired ( )

Definition at line 68 of file PendingRegistration.php.

                               : bool
    {
        return $this->status === PendingRegistrationStatus::EXPIRED;
    }

References ILIAS\Registration\DualOptIn\Entity\EXPIRED, and ILIAS\Registration\DualOptIn\Entity\PendingRegistration\status().

Referenced by ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\deleteExpiredUserObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPending()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::isPending ( )

Definition at line 73 of file PendingRegistration.php.

                               : bool
    {
        return $this->status === PendingRegistrationStatus::PENDING;
    }

References ILIAS\Registration\DualOptIn\Entity\PendingRegistration\status().

Here is the call graph for this function:

◆ status()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::status ( )

Definition at line 58 of file PendingRegistration.php.

                            : PendingRegistrationStatus
    {
        return $this->status;
    }

Referenced by ILIAS\Registration\DualOptIn\Entity\PendingRegistration\isConfirmed(), ILIAS\Registration\DualOptIn\Entity\PendingRegistration\isExpired(), ILIAS\Registration\DualOptIn\Entity\PendingRegistration\isPending(), ILIAS\Registration\DualOptIn\Entity\PendingRegistration\withConfirmed(), ILIAS\Registration\DualOptIn\Entity\PendingRegistration\withEvaluatedState(), and ILIAS\Registration\DualOptIn\Entity\PendingRegistration\withExpired().

Here is the caller graph for this function:

◆ userId()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::userId ( )

Definition at line 43 of file PendingRegistration.php.

                            : ObjectId
    {
        return $this->usr_id;
    }

Referenced by ILIAS\Registration\DualOptIn\Repository\PendingRegistrationDatabaseRepository\store(), and ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\triggerExpiredUserCleanup().

Here is the caller graph for this function:

◆ withConfirmed()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::withConfirmed ( )

Definition at line 78 of file PendingRegistration.php.

                                   : self
    {
        if ($this->status === PendingRegistrationStatus::EXPIRED) {
            throw new \DomainException('Cannot confirm an expired registration.');
        }
 
        if ($this->status === PendingRegistrationStatus::CONFIRMED) {
            return $this;
        }
 
        return new self(
            $this->id,
            $this->usr_id,
            $this->hash,
            $this->created_at,
            PendingRegistrationStatus::CONFIRMED
        );
    }

References $id, ILIAS\Registration\DualOptIn\Entity\EXPIRED, and ILIAS\Registration\DualOptIn\Entity\PendingRegistration\status().

Here is the call graph for this function:

◆ withEvaluatedState()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::withEvaluatedState	(	\DateTimeImmutable	$now,
		?int	$validity_in_seconds
	)

Exceptions

InvalidArgumentException if the passed validity in seconds is invalid

Definition at line 126 of file PendingRegistration.php.

                                                                                          : self
    {
        if (\is_int($validity_in_seconds) && $validity_in_seconds < 1) {
            throw new \InvalidArgumentException('Invalid validity_in_seconds value.');
        }
 
        if ($this->status === PendingRegistrationStatus::CONFIRMED) {
            return $this;
        }
 
        if (\is_int($validity_in_seconds) && $this->hasExpiredAt($now, $validity_in_seconds)) {
            return $this->withExpired();
        }
 
        return $this;
    }

References ILIAS\Registration\DualOptIn\Entity\PendingRegistration\hasExpiredAt(), ILIAS\Registration\DualOptIn\Entity\PendingRegistration\status(), and ILIAS\Registration\DualOptIn\Entity\PendingRegistration\withExpired().

Referenced by ILIAS\Registration\DualOptIn\Service\DualOptInServiceImpl\deleteExpiredUserObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withExpired()

ILIAS\Registration\DualOptIn\Entity\PendingRegistration::withExpired ( )

Definition at line 97 of file PendingRegistration.php.

                                 : self
    {
        if ($this->status === PendingRegistrationStatus::CONFIRMED) {
            throw new \DomainException('Cannot expire an already confirmed registration.');
        }
 
        if ($this->status === PendingRegistrationStatus::EXPIRED) {
            return $this;
        }
 
        return new self(
            $this->id,
            $this->usr_id,
            $this->hash,
            $this->created_at,
            PendingRegistrationStatus::EXPIRED
        );
    }