timrourke/incognito

<?php
 
declare(strict_types=1);
 
namespace Incognito\Entity;
 
use Assert\Assertion;
use DateTimeImmutable;
use Incognito\Entity\UserAttribute\UserAttribute;
use Incognito\Entity\UserAttribute\UserAttributeCollection;
 
class User
{
    /**
     * The user's UUID
     *
     * @var string
     */
    private string $id;
 
    /**
     * The user's username
     *
     * @var \Incognito\Entity\Username
     */
    private Username $username;
 
    /**
     * The date the user was created at
     *
     * @var \DateTimeImmutable
     */
    private DateTimeImmutable $createdAt;
 
    /**
     * The date the user was last updated at
     *
     * @var \DateTimeImmutable
     */
    private DateTimeImmutable $updatedAt;
 
    /**
     * Whether the AWS Cognito User is enabled
     *
     * @var bool
     */
    private bool $enabled;
 
    /**
     * The current status for the user
     *
     * @var \Incognito\Entity\UserStatus|null
     */
    private ?UserStatus $status;
 
    /**
     * The user attributes for this user
     *
     * @var \Incognito\Entity\UserAttribute\UserAttributeCollection
     */
    private UserAttributeCollection $userAttributes;
 
    /**
     * Constructor.
     *
     * @param \Incognito\Entity\Username                              $username
     * @param \Incognito\Entity\UserAttribute\UserAttributeCollection $userAttributes
     */
    public function __construct(
        Username $username,
        UserAttributeCollection $userAttributes = null
    ) {
        if (is_null($userAttributes)) {
            $userAttributes = new UserAttributeCollection();
        }
 
        $this->username       = $username;
        $this->userAttributes = $userAttributes;
    }
 
    /**
     * Set a user attribute for this user
     *
     * @param \Incognito\Entity\UserAttribute\UserAttribute $userAttribute
     */
    public function setAttribute(UserAttribute $userAttribute): void
    {
        $this->userAttributes->add($userAttribute);
    }
 
    /**
     * Get a user attribute by name
     *
     * @param  string $name
     * @return UserAttribute
     */
    public function getAttribute(string $name): UserAttribute
    {
        return $this->userAttributes->get($name);
    }
 
    /**
     * Get the array of user attributes for this user
     *
     * @return UserAttribute[]
     */
    public function getAttributes(): array
    {
        return $this->userAttributes->toArray();
    }
 
    /**
     * Get the user's ID
     *
     * @return string
     */
    public function id(): string
    {
        return $this->id ?? '';
    }
 
    /**
     * Set the user's ID
     *
     * @param  string $id
     * @return \Incognito\Entity\User
     */
    public function setId(string $id): User
    {
        $this->id = $id;
 
        return $this;
    }
 
    /**
     * Get the user's username
     *
     * @return string
     */
    public function username(): string
    {
        return (string) $this->username;
    }
 
    /**
     * Set the user's username
     *
     * @param  Username $username
     * @return \Incognito\Entity\User
     */
    public function setUsername(Username $username): User
    {
        $this->username = $username;
 
        return $this;
    }
 
    /**
     * Get the date the user was created at
     *
     * @return \DateTimeImmutable|null
     */
    public function createdAt(): ?DateTimeImmutable
    {
        return $this->createdAt ?? null;
    }
 
    /**
     * Set the date the user was created at
     *
     * @param  \DateTimeImmutable $createdAt
     * @return \Incognito\Entity\User
     * @throws \Assert\AssertionFailedException
     */
    public function setCreatedAt(DateTimeImmutable $createdAt): User
    {
        Assertion::false(
            isset($this->createdAt),
            'Invalid createdAt: user already has a "createdAt" date.'
        );
 
        $this->createdAt = $createdAt;
 
        return $this;
    }
 
    /**
     * Get the date the user was last updated at
     *
     * @return \DateTimeImmutable|null
     */
    public function updatedAt(): ?DateTimeImmutable
    {
        return $this->updatedAt ?? null;
    }
 
    /**
     * Set the date the user was last updated at
     *
     * @param  \DateTimeImmutable $updatedAt
     * @return \Incognito\Entity\User
     */
    public function setUpdatedAt(DateTimeImmutable $updatedAt): User
    {
        $this->updatedAt = $updatedAt;
 
        return $this;
    }
 
    /**
     * Get whether this user is enabled
     *
     * @return bool|null
     */
    public function enabled(): ?bool
    {
        return $this->enabled ?? null;
    }
 
    /**
     * Set whether this user is enabled
     *
     * @param  bool $enabled
     * @return \Incognito\Entity\User
     */
    public function setEnabled(bool $enabled): User
    {
        $this->enabled = $enabled;
 
        return $this;
    }
 
    /**
     * Get the user's status
     *
     * @return \Incognito\Entity\UserStatus
     */
    public function status(): UserStatus
    {
        return isset($this->status)
            ? $this->status
            : new UserStatus();
    }
 
    /**
     * Set the user's status
     *
     * @param  \Incognito\Entity\UserStatus $status
     * @return \Incognito\Entity\User
     */
    public function setStatus(UserStatus $status): User
    {
        $this->status = $status;
 
        return $this;
    }
}