User::initialize() - Code Metrics - Ecodev/my-ichtus - Measure and Improve Code Quality continuously with Scrutinizer

User::initialize() A
last analyzed 2025-06-19 12:49 UTC

↳ Parent: User
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace Application\Model;

use Application\Api\Enum\SexType;
use Application\Api\Enum\UserRoleType;
use Application\Api\Input\Operator\AccountBalance\AccountBalanceEqualOperatorType;
use Application\Api\Input\Operator\AccountBalance\AccountBalanceGreaterOperatorType;
use Application\Api\Input\Operator\AccountBalance\AccountBalanceGreaterOrEqualOperatorType;
use Application\Api\Input\Operator\AccountBalance\AccountBalanceLessOperatorType;
use Application\Api\Input\Operator\AccountBalance\AccountBalanceLessOrEqualOperatorType;
use Application\Api\Input\Operator\BookingCount\BookingCountEqualOperatorType;
use Application\Api\Input\Operator\BookingCount\BookingCountGreaterOperatorType;
use Application\Api\Input\Operator\BookingCount\BookingCountGreaterOrEqualOperatorType;
use Application\Api\Input\Operator\BookingCount\BookingCountLessOperatorType;
use Application\Api\Input\Operator\BookingCount\BookingCountLessOrEqualOperatorType;
use Application\Api\Input\Operator\BookingDate\BookingDateEqualOperatorType;
use Application\Api\Input\Operator\BookingDate\BookingDateGreaterOperatorType;
use Application\Api\Input\Operator\BookingDate\BookingDateGreaterOrEqualOperatorType;
use Application\Api\Input\Operator\BookingDate\BookingDateLessOperatorType;
use Application\Api\Input\Operator\BookingDate\BookingDateLessOrEqualOperatorType;
use Application\Api\Input\Operator\HasBookingCompletedOperatorType;
use Application\Api\Input\Operator\HasBookingStatusOperatorType;
use Application\Api\Input\Operator\HasBookingWithBookableOperatorType;
use Application\Api\Input\Operator\HasBookingWithTaggedBookableOperatorType;
use Application\Api\Input\Sorting\Age;
use Application\Api\Input\Sorting\Balance;
use Application\Enum\BillingType;
use Application\Enum\BookingStatus;
use Application\Enum\Door;
use Application\Enum\Relationship;
use Application\Enum\SwissSailingType;
use Application\Enum\SwissWindsurfType;
use Application\Enum\UserStatus;
use Application\Repository\LogRepository;
use Application\Repository\UserRepository;
use Application\Service\Role;
use Application\Traits\HasAddress;
use Application\Traits\HasDoorAccess;
use Application\Traits\HasIban;
use Application\Traits\HasRemarks;
use Cake\Chronos\Chronos;
use Cake\Chronos\ChronosDate;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\ReadableCollection;
use Doctrine\ORM\Mapping as ORM;
use Ecodev\Felix\Api\Exception;
use Ecodev\Felix\Api\Scalar\LoginType;
use Ecodev\Felix\Model\CurrentUser;
use Ecodev\Felix\Model\Traits\HasInternalRemarks;
use Ecodev\Felix\Model\Traits\HasPassword;
use GraphQL\Doctrine\Attribute as API;

/**
 * User.
 */
#[API\Sorting(Age::class)]
#[API\Sorting(Balance::class)]
#[API\Filter(field: 'custom', operator: HasBookingWithTaggedBookableOperatorType::class, type: 'id')]
#[API\Filter(field: 'custom', operator: HasBookingWithBookableOperatorType::class, type: 'id')]
#[API\Filter(field: 'custom', operator: HasBookingStatusOperatorType::class, type: 'id')]
#[API\Filter(field: 'custom', operator: HasBookingCompletedOperatorType::class, type: 'boolean')]
#[API\Filter(field: 'bookingCount', operator: BookingCountEqualOperatorType::class, type: 'int')]
#[API\Filter(field: 'bookingCount', operator: BookingCountGreaterOperatorType::class, type: 'int')]
#[API\Filter(field: 'bookingCount', operator: BookingCountGreaterOrEqualOperatorType::class, type: 'int')]
#[API\Filter(field: 'bookingCount', operator: BookingCountLessOperatorType::class, type: 'int')]
#[API\Filter(field: 'bookingCount', operator: BookingCountLessOrEqualOperatorType::class, type: 'int')]
#[API\Filter(field: 'accountBalance', operator: AccountBalanceEqualOperatorType::class, type: 'Money')]
#[API\Filter(field: 'accountBalance', operator: AccountBalanceGreaterOperatorType::class, type: 'Money')]
#[API\Filter(field: 'accountBalance', operator: AccountBalanceGreaterOrEqualOperatorType::class, type: 'Money')]
#[API\Filter(field: 'accountBalance', operator: AccountBalanceLessOperatorType::class, type: 'Money')]
#[API\Filter(field: 'accountBalance', operator: AccountBalanceLessOrEqualOperatorType::class, type: 'Money')]
#[API\Filter(field: 'bookingDate', operator: BookingDateEqualOperatorType::class, type: 'Date')]
#[API\Filter(field: 'bookingDate', operator: BookingDateGreaterOperatorType::class, type: 'Date')]
#[API\Filter(field: 'bookingDate', operator: BookingDateGreaterOrEqualOperatorType::class, type: 'Date')]
#[API\Filter(field: 'bookingDate', operator: BookingDateLessOperatorType::class, type: 'Date')]
#[API\Filter(field: 'bookingDate', operator: BookingDateLessOrEqualOperatorType::class, type: 'Date')]
#[ORM\Entity(UserRepository::class)]
#[ORM\HasLifecycleCallbacks]
#[ORM\AssociationOverrides([new ORM\AssociationOverride(name: 'owner', inversedBy: 'users')])]
class User extends AbstractModel implements \Ecodev\Felix\Model\User
{
    final public const ROLE_ANONYMOUS = 'anonymous';
    final public const ROLE_BOOKING_ONLY = 'booking_only';
    final public const ROLE_INDIVIDUAL = 'individual';
    final public const ROLE_ACCOUNTING_VERIFICATOR = 'accounting_verificator';
    final public const ROLE_MEMBER = 'member';
    final public const ROLE_TRAINER = 'trainer';
    final public const ROLE_FORMATION_RESPONSIBLE = 'formation_responsible';
    final public const ROLE_RESPONSIBLE = 'responsible';
    final public const ROLE_ADMINISTRATOR = 'administrator';

    use HasAddress;
    use HasDoorAccess;
    use HasIban;
    use HasInternalRemarks;
    use HasPassword;
    use HasRemarks;

    private static ?User $currentUser = null;

    /**
     * Set currently logged in user
     * WARNING: this method should only be called from \Application\Authentication\AuthenticationListener.
     */
    public static function setCurrent(?self $user): void
    {
        self::$currentUser = $user;

        // Initialize ACL filter with current user if a logged in one exists
        /** @var UserRepository $userRepository */
        $userRepository = _em()->getRepository(self::class);
        $aclFilter = $userRepository->getAclFilter();
        $aclFilter->setUser($user);

        CurrentUser::set($user);
    }

    /**
     * Returns currently logged user or null.
     */
    public static function getCurrent(): ?self
    {
        return self::$currentUser;
    }

    #[ORM\Column(type: 'string', length: 50, nullable: true, unique: true)]
    private ?string $login = null;

    #[ORM\Column(type: 'string', length: 191)]
    private string $firstName = '';

    #[ORM\Column(type: 'string', length: 191)]
    private string $lastName = '';

    #[ORM\Column(type: 'string', length: 191, nullable: true, unique: true)]
    private ?string $email = null;

    #[ORM\Column(type: 'UserRole', options: ['default' => self::ROLE_INDIVIDUAL])]
    private string $role = self::ROLE_INDIVIDUAL;

    #[ORM\Column(type: 'enum', options: ['default' => UserStatus::New])]
    private UserStatus $status = UserStatus::New;

    #[ORM\Column(type: 'datetime', nullable: true)]
    private ?Chronos $welcomeSessionDate = null;

    #[ORM\Column(type: 'datetime', nullable: true)]
    private ?Chronos $resignDate = null;

    /**
     * @var int sex
     */
    #[ORM\Column(type: 'smallint', options: ['default' => 0])]
    private int $sex = 0;

    #[ORM\Column(type: 'string', length: 25, options: ['default' => ''])]
    private string $phone = '';

    #[ORM\Column(type: 'string', length: 25, options: ['default' => ''])]
    private string $mobilePhone = '';

    #[ORM\Column(type: 'string', length: 25, options: ['default' => ''])]
    private string $swissSailing = '';

    #[ORM\Column(type: 'enum', nullable: true)]
    private ?SwissSailingType $swissSailingType = null;

    #[ORM\Column(type: 'enum', nullable: true)]
    private ?SwissWindsurfType $swissWindsurfType = null;

    #[ORM\Column(type: 'date', nullable: true)]
    private ?ChronosDate $birthday = null;

    #[ORM\Column(type: 'boolean', options: ['default' => false])]
    private bool $termsAgreement = false;

    #[ORM\Column(type: 'boolean', options: ['default' => false])]
    private bool $hasInsurance = false;

    #[ORM\Column(type: 'boolean', options: ['default' => false])]
    private bool $receivesNewsletter = false;

    #[ORM\Column(type: 'enum', options: ['default' => Relationship::Householder])]
    private Relationship $familyRelationship = Relationship::Householder;

    #[ORM\Column(type: 'enum', options: ['default' => BillingType::Electronic])]
    private BillingType $billingType = BillingType::Electronic;

    #[ORM\Column(type: 'datetime', nullable: true)]
    private ?Chronos $firstLogin = null;

    #[ORM\Column(type: 'datetime', nullable: true)]
    private ?Chronos $lastLogin = null;

    /**
     * @var Collection<int, Booking>
     */
    #[ORM\OneToMany(targetEntity: Booking::class, mappedBy: 'owner')]
    private Collection $bookings;

    /**
     * @var Collection<int, License>
     */
    #[ORM\ManyToMany(targetEntity: License::class, mappedBy: 'users')]
    private Collection $licenses;

    /**
     * @var Collection<int, UserTag>
     */
    #[ORM\ManyToMany(targetEntity: UserTag::class, mappedBy: 'users')]
    private Collection $userTags;

    /**
     * @var Collection<int, Message>
     */
    #[ORM\OneToMany(targetEntity: Message::class, mappedBy: 'recipient')]
    private Collection $messages;

    /**
     * There is actually 0 to 1 account, never more. And this is
     * enforced by DB unique constraints.
     *
     * @var Collection<int, Account>
     */
    #[ORM\OneToMany(targetEntity: Account::class, mappedBy: 'owner')]
    private Collection $accounts;

    /**
     * @var Collection<int, User>
     */
    #[ORM\OneToMany(targetEntity: self::class, mappedBy: 'owner')]
    private Collection $users;

    /**
     * @param string $role role for new user
     */
    public function __construct(string $role = self::ROLE_INDIVIDUAL)
    {
        $this->role = $role;
        $this->bookings = new ArrayCollection();
        $this->accounts = new ArrayCollection();
        $this->licenses = new ArrayCollection();
        $this->userTags = new ArrayCollection();
        $this->messages = new ArrayCollection();
        $this->users = new ArrayCollection();
    }

    /**
     * Set login (eg: johndoe).
     */
    #[API\Input(type: LoginType::class)]
    public function setLogin(string $login): void
    {
        $this->login = $login;
    }

    /**
     * Get login (eg: johndoe).
     */
    #[API\Field(type: '?Login')]
    public function getLogin(): ?string
    {
        return $this->login;
    }

    /**
     * Set first name.
     */
    public function setFirstName(string $firstName): void
    {
        $this->firstName = $firstName;
    }

    /**
     * Get first name.
     */
    public function getFirstName(): string
    {
        return $this->firstName;
    }

    /**
     * Set last name.
     */
    public function setLastName(string $lastName): void
    {
        $this->lastName = $lastName;
    }

    /**
     * Get last name.
     */
    public function getLastName(): string
    {
        return $this->lastName;
    }

    /**
     * Get full name.
     */
    public function getName(): string
    {
        return implode(' ', [$this->getFirstName(), $this->getLastName()]);
    }

    /**
     * Set email.
     */
    #[API\Input(type: '?Email')]
    public function setEmail(?string $email): void
    {
        $this->email = $email;
    }

    /**
     * Get email.
     */
    #[API\Field(type: '?Email')]
    public function getEmail(): ?string
    {
        return $this->email;
    }

    /**
     * Get the user role.
     */
    #[API\Field(type: UserRoleType::class)]
    public function getRole(): string
    {
        return $this->role;
    }

    /**
     * Sets the user role.
     */
    #[API\Input(type: UserRoleType::class)]
    public function setRole(string $role): void
    {
        if (!Role::canUpdate(self::getCurrent(), $this->role, $role)) {
            $currentRole = self::getCurrent() ? self::getCurrent()->getRole() : self::ROLE_ANONYMOUS;

            throw new Exception($currentRole . ' is not allowed to change role from ' . $this->role . ' to ' . $role);
        }

        $this->role = $role;
    }

    public function setOwner(?self $owner = null): void
    {
        if ($owner === $this) {
            throw new Exception('This user cannot be owned by himself');
        }

        if ($owner && $owner->getOwner()) {
            throw new Exception('This user cannot be owned by a user who is himself owned by somebody else');
        }

        if ($owner && $this->users->count()) {
            throw new Exception('This user owns other users, so he cannot himself be owned by somebody else');
        }

        if ($this->getOwner()) {
            $this->getOwner()->getEmail(); // Trigger lazy loading
            $this->getOwner()->users->removeElement($this);
        }

        parent::setOwner($owner);

        if ($this->getOwner()) {
            $this->getOwner()->getEmail(); // Trigger lazy loading
            $this->getOwner()->users->add($this);
            $this->setStatus($this->getOwner()->getStatus());
        }
    }

    public function getStatus(): UserStatus
    {
        return $this->status;
    }

    /**
     * Whether the user is allowed to log in or stay logged in.
     */
    public function canLogin(): bool
    {
        return in_array($this->getStatus(), [UserStatus::Active, UserStatus::Inactive, UserStatus::New], true);
    }

    public function setStatus(UserStatus $newStatus): void
    {
        if ($newStatus === UserStatus::Archived && $this->status !== UserStatus::Archived) {
            $this->setResignDate(Chronos::NOW());
        } elseif ($this->status === UserStatus::Archived && $newStatus !== UserStatus::Archived) {
            $this->setResignDate(null);
        }

        $this->status = $newStatus;
        $this->revokeToken();

        foreach ($this->users as $user) {
            if ($user !== $this) {
                $user->setStatus($newStatus);
            }
        }
    }

    /**
     * Whether this user is a family owner or not.
     *
     * This is used for our internal logic and should
     * NEVER be related to `familyRelationship`. That field
     * is purely informative for humans.
     */
    public function isFamilyOwner(): bool
    {
        return !$this->getOwner();
    }

    public function initialize(): void
    {
        $this->role = self::ROLE_MEMBER; // Bypass security
        $this->setStatus(UserStatus::New);
    }

    public function getPhone(): string
    {
        return $this->phone;
    }

    public function setPhone(string $phone): void
    {
        $this->phone = $phone;
    }

    public function getMobilePhone(): string
    {
        return $this->mobilePhone;
    }

    public function setMobilePhone(string $mobilePhone): void
    {
        $this->mobilePhone = $mobilePhone;
    }

    public function getBirthday(): ?ChronosDate
    {
        return $this->birthday;
    }

    public function setBirthday(?ChronosDate $birthday): void
    {
        $this->birthday = $birthday;
    }

    /**
     * return null|int.
     */
    public function getAge(): ?int
    {
        if ($this->birthday) {
            return (new ChronosDate())->diffInYears($this->birthday);
        }

        return null;
    }

    /**
     * Get bookings.
     */
    public function getBookings(): Collection
    {
        return $this->bookings;
    }

    /**
     * Get active bookings (confirmed and non-terminated).
     */
    #[API\Exclude]
    public function getRunningBookings(): ReadableCollection
    {
        return $this->bookings->filter(fn (Booking $booking) => $booking->getStatus() === BookingStatus::Booked && $booking->getEndDate() === null);
    }

    /**
     * Notify the user that it has a new booking.
     * This should only be called by Booking::setResponsible().
     */
    public function bookingAdded(Booking $booking): void
    {
        $this->bookings->add($booking);
    }

    /**
     * Notify the user that it has a booking was removed.
     * This should only be called by Booking::setResponsible().
     */
    public function bookingRemoved(Booking $booking): void
    {
        $this->bookings->removeElement($booking);
    }

    public function getLicenses(): Collection
    {
        return $this->licenses;
    }

    public function getUserTags(): Collection
    {
        return $this->userTags;
    }

    /**
     * Notify the user that it has a new license.
     * This should only be called by License::addUser().
     */
    public function licenseAdded(License $license): void
    {
        $this->licenses->add($license);
    }

    /**
     * Notify the user that it a license was removed.
     * This should only be called by License::removeUser().
     */
    public function licenseRemoved(License $license): void
    {
        $this->licenses->removeElement($license);
    }

    /**
     * Notify the user that it has a new userTag.
     * This should only be called by UserTag::addUser().
     */
    public function userTagAdded(UserTag $userTag): void
    {
        $this->userTags->add($userTag);
    }

    /**
     * Notify the user that a userTag was removed.
     * This should only be called by UserTag::removeUser().
     */
    public function userTagRemoved(UserTag $userTag): void
    {
        $this->userTags->removeElement($userTag);
    }

    public function isTermsAgreement(): bool
    {
        return $this->termsAgreement;
    }

    public function setTermsAgreement(bool $termsAgreement): void
    {
        $this->termsAgreement = $termsAgreement;
    }

    public function hasInsurance(): bool
    {
        return $this->hasInsurance;
    }

    public function setHasInsurance(bool $hasInsurance): void
    {
        $this->hasInsurance = $hasInsurance;
    }

    public function getWelcomeSessionDate(): ?Chronos
    {
        return $this->welcomeSessionDate;
    }

    public function setWelcomeSessionDate(?Chronos $welcomeSessionDate): void
    {
        $this->welcomeSessionDate = $welcomeSessionDate;
    }

    public function getResignDate(): ?Chronos
    {
        return $this->resignDate;
    }

    public function setResignDate(?Chronos $resignDate): void
    {
        $this->resignDate = $resignDate;
    }

    public function getReceivesNewsletter(): bool
    {
        return $this->receivesNewsletter;
    }

    public function setReceivesNewsletter(bool $receivesNewsletter): void
    {
        $this->receivesNewsletter = $receivesNewsletter;
    }

    /**
     * Get the sex.
     */
    #[API\Field(type: SexType::class)]
    public function getSex(): int
    {
        return $this->sex;
    }

    /**
     * Set the sex.
     */
    #[API\Input(type: SexType::class)]
    public function setSex(int $sex): void
    {
        $this->sex = $sex;
    }

    /**
     * Get the Swiss Sailing licence number.
     */
    public function getSwissSailing(): string
    {
        return $this->swissSailing;
    }

    public function setSwissSailing(string $swissSailing): void
    {
        $this->swissSailing = $swissSailing;
    }

    /**
     * Get the Swiss Sailing licence type.
     */
    public function getSwissSailingType(): ?SwissSailingType
    {
        return $this->swissSailingType;
    }

    /**
     * Set the Swiss Sailing licence type.
     */
    public function setSwissSailingType(?SwissSailingType $swissSailingType): void
    {
        $this->swissSailingType = $swissSailingType;
    }

    /**
     * Get the Swiss Windsurf licence type.
     */
    public function getSwissWindsurfType(): ?SwissWindsurfType
    {
        return $this->swissWindsurfType;
    }

    /**
     * Set the Swiss Windsurf licence type.
     */
    #[API\Input(type: '?SwissWindsurfType')]
    public function setSwissWindsurfType(?SwissWindsurfType $swissWindsurfType): void
    {
        $this->swissWindsurfType = $swissWindsurfType;
    }

    /**
     * Get the first login date.
     */
    public function getFirstLogin(): ?Chronos
    {
        return $this->firstLogin;
    }

    /**
     * Get the last login date.
     */
    public function getLastLogin(): ?Chronos
    {
        return $this->lastLogin;
    }

    public function recordLogin(): void
    {
        _log()->info(LogRepository::LOGIN);

        $now = new Chronos();
        if (!$this->firstLogin) {
            $this->firstLogin = $now;
        }

        $this->lastLogin = $now;
    }

    public function getFamilyRelationship(): Relationship
    {
        return $this->familyRelationship;
    }

    public function setFamilyRelationship(Relationship $familyRelationship): void
    {
        $this->familyRelationship = $familyRelationship;
    }

    public function getBillingType(): BillingType
    {
        return $this->billingType;
    }

    public function setBillingType(BillingType $billingType): void
    {
        $this->billingType = $billingType;
    }

    /**
     * Get the user transaction account.
     */
    public function getAccount(): ?Account
    {
        if ($this->getOwner() && $this->getOwner() !== $this) {
            return $this->getOwner()->getAccount();
        }

        return $this->accounts->first() ?: null;
    }

    /**
     * Notify the user that it has a new account
     * This should only be called by Account::setOwner().
     */
    public function accountAdded(Account $account): void
    {
        $this->accounts->clear();
        $this->accounts->add($account);
    }

    /**
     * Notify the user that a account was removed
     * This should only be called by Account::setOwner().
     */
    public function accountRemoved(): void
    {
        $this->accounts->clear();
    }

    /**
     * Get messages sent to the user.
     */
    #[API\Exclude]
    public function getMessages(): Collection
    {
        return $this->messages;
    }

    /**
     * Notify the user that it has a new message
     * This should only be called by Message::setRecipient().
     */
    public function messageAdded(Message $message): void
    {
        $this->messages->add($message);
    }

    /**
     * Notify the user that a message was removed
     * This should only be called by Message::setRecipient().
     */
    public function messageRemoved(Message $message): void
    {
        $this->messages->removeElement($message);
    }

    /**
     * Check if the user can *really* open a door
     * This also takes into account the user status and role.
     *
     * @param null|Door $door a particular door, or null for any
     */
    public function getCanOpenDoor(?Door $door = null): bool
    {
        $allowedStatus = [UserStatus::Active];
        $allowedRoles = [
            self::ROLE_ACCOUNTING_VERIFICATOR,
            self::ROLE_INDIVIDUAL,
            self::ROLE_MEMBER,
            self::ROLE_TRAINER,
            self::ROLE_FORMATION_RESPONSIBLE,
            self::ROLE_RESPONSIBLE,
            self::ROLE_ADMINISTRATOR,
        ];

        if ($door && !$this->{$door->value}) {
            return false;
        }

        if (!in_array($this->status, $allowedStatus, true) || !in_array($this->role, $allowedRoles, true)) {
            return false;
        }

        return true;
    }

    /**
     * Override parent to prevents users created from administration to be family of the administrator.
     *
     * The owner must be explicitly set for all users.
     */
    protected function getOwnerForCreation(): ?self
    {
        return null;
    }
}

Ecodev / my-ichtus

User::initialize() A last analyzed 2025-06-19 12:49 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

User::initialize() A
last analyzed 2025-06-19 12:49 UTC
