HP-1631: added into Customer entity state

src/action/ActionState.php

@@ -17,56 +17,92 @@
  */
 class ActionState
 {
-    const STATE_NEW      = 'new';
-    const STATE_FINISHED = 'finished';
-    const STATE_FAILED   = 'failed';
+    private const STATE_NEW       = 'new';
 
-    /** @var string */
-    protected $state;
+    private const STATE_FINISHED  = 'finished';
 
-    private function __construct(string $state = self::STATE_NEW)
+    private const STATE_PREMATURE = 'premature';
+
+    private const STATE_FUTURE    = 'future';
+
+    private const STATE_CANCELED  = 'canceled';
+
+    private const STATE_EXPIRED   = 'expired';
+
+    private function __construct(protected string $state = self::STATE_NEW)
     {
-        $this->state = $state;
     }
 
-    public function getName()
+    public function getName(): string
     {
         return $this->state;
     }
 
-    public function isNew()
+    public function isNew(): bool
     {
         return $this->state === self::STATE_NEW;
     }
 
-    public function isFinished()
+    public function isFinished(): bool
     {
-        return $this->state === self::STATE_FINISHED;
+        return !$this->isNew();
     }
 
-    public static function new()
+    public static function new(): self
     {
         return new self(self::STATE_NEW);
     }
 
-    public static function finished()
+    /**
+     * @deprecated use ActionState::expired()
+     * @return self
+     */
+    public static function finished(): self
     {
         return new self(self::STATE_FINISHED);
     }
 
-    public static function failed()
+    public static function premature(): self
+    {
+        return new self(self::STATE_PREMATURE);
+    }
+
+    public static function future(): self
+    {
+        return new self(self::STATE_FUTURE);
+    }
+
+    public static function canceled(): self
+    {
+        return new self(self::STATE_CANCELED);
+    }
+
+    public static function expired(): self
     {
-        return new self(self::STATE_FAILED);
+        return new self(self::STATE_EXPIRED);
     }
 
-    public static function fromString(string $name)
+    public static function fromString(string $name): self
     {
-        foreach ([self::STATE_NEW, self::STATE_FINISHED, self::STATE_FAILED] as $state) {
+        $allowedStates = [
+            self::STATE_NEW,
+            self::STATE_FINISHED,
+            self::STATE_PREMATURE,
+            self::STATE_FUTURE,
+            self::STATE_CANCELED,
+            self::STATE_EXPIRED,
+        ];
+        foreach ($allowedStates as $state) {
             if ($state === $name) {
                 return new self($state);
             }
         }
 
         throw new \Exception("wrong action state '$name'");
     }
+
+    public function equals(ActionState $other): bool
+    {
+        return $this->state === $other->getName();
+    }
 }

src/customer/Customer.php

@@ -37,11 +37,17 @@ class Customer implements CustomerInterface
      */
     protected $sellers = [];
 
-    public function __construct($id, $login, CustomerInterface $seller = null)
+    /**
+     * @var string|null
+     */
+    protected ?string $state = null;
+
+    public function __construct($id, $login, CustomerInterface $seller = null, ?string $state = null)
     {
         $this->id = $id;
         $this->login = $login;
         $this->seller = $seller;
+        $this->state = $state;
     }
 
     public function getId()
@@ -73,6 +79,19 @@ public function getSeller()
         return $this->seller;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getState(): ?string
+    {
+        return $this->state;
+    }
+
+    public function isDeleted(): bool
+    {
+        return CustomerState::isDeleted($this);
+    }
+
     public static function fromArray(array $info)
     {
         if (!empty($info['seller_id']) && !empty($info['seller'])) {
@@ -81,7 +100,7 @@ public static function fromArray(array $info)
             $seller = null;
         }
 
-        return new static($info['id'], $info['login'], $seller);
+        return new static($info['id'], $info['login'], $seller, $info['state'] ?? null);
     }
 
     public function jsonSerialize(): array

src/customer/CustomerInterface.php

@@ -35,4 +35,12 @@ public function getLogin();
      * @return static|null
      */
     public function getSeller();
+
+    /**
+     * Get Customer state.
+     * @return null|string
+     */
+    public function getState(): ?string;
+
+    public function isDeleted(): bool;
 }

src/customer/CustomerState.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace hiqdev\php\billing\customer;
+
+enum CustomerState: string
+{
+    case BLOCKED = 'blocked';
+    case DELETED = 'deleted';
+    case NEW = 'new';
+    case OK = 'ok';
+
+    public static function isDeleted(CustomerInterface $customer): bool
+    {
+        return self::tryFrom((string)$customer->getState()) === self::DELETED;
+    }
+}

src/sale/Sale.php

@@ -105,7 +105,7 @@ public function getCloseTime(): ?DateTimeImmutable
         return $this->closeTime;
     }
 
-    public function close(DateTimeImmutable $closeTime): void
+    public function close(DateTimeImmutable $closeTime): SaleInterface
     {
         if ($this->closeTime !== null) {
             throw new InvariantException('Sale is already closed');
@@ -116,6 +116,8 @@ public function close(DateTimeImmutable $closeTime): void
         }
 
         $this->closeTime = $closeTime;
+
+        return $this;
     }
 
     public function setId($id)

src/sale/SaleInterface.php

@@ -71,7 +71,7 @@ public function getData(): ?array;
      * @throws InvariantException
      * @throws ConstraintException
      */
-    public function close(DateTimeImmutable $time): void;
+    public function close(DateTimeImmutable $time): SaleInterface;
 
     public function cancelClosing(): void;
 }