HP-1631: added into Customer entity state

src/action/AbstractAction.php

@@ -169,9 +169,9 @@ public function setFinished(): void
         $this->state = ActionState::finished();
     }
 
-    public function isFinished(): ?bool
+    public function isNotActive(): ?bool
     {
-        return $this->state === null ? null : $this->state->isFinished();
+        return $this->state === null ? null : $this->state->isNotActive();
     }
 
     /**

src/action/ActionFactory.php

@@ -17,12 +17,18 @@
  */
 class ActionFactory implements ActionFactoryInterface
 {
-    /**
-     * Creates action object.
-     * @return Action
-     */
-    public function create(ActionCreationDto $dto)
+    public function create(ActionCreationDto $dto): AbstractAction
     {
-        return new Action($dto->id, $dto->type, $dto->target, $dto->quantity, $dto->customer, $dto->time, $dto->sale, $dto->state, $dto->parent);
+        return new Action(
+            $dto->id,
+            $dto->type,
+            $dto->target,
+            $dto->quantity,
+            $dto->customer,
+            $dto->time,
+            $dto->sale,
+            $dto->state,
+            $dto->parent,
+        );
     }
 }

src/action/ActionFactoryInterface.php

@@ -17,9 +17,5 @@
  */
 interface ActionFactoryInterface
 {
-    /**
-     * Creates action object.
-     * @return Action
-     */
-    public function create(ActionCreationDto $dto);
+    public function create(ActionCreationDto $dto): AbstractAction;
 }

src/action/ActionInterface.php

@@ -70,7 +70,7 @@ public function getSale(): ?SaleInterface;
     /**
      * Returns null if the action state is not set.
      */
-    public function isFinished(): ?bool;
+    public function isNotActive(): ?bool;
 
     public function getParent(): ?ActionInterface;
 

src/action/ActionState.php

@@ -17,56 +17,80 @@
  */
 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 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 isNotActive(): 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()
+    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_FAILED);
+        return new self(self::STATE_FUTURE);
     }
 
-    public static function fromString(string $name)
+    public static function canceled(): self
     {
-        foreach ([self::STATE_NEW, self::STATE_FINISHED, self::STATE_FAILED] as $state) {
+        return new self(self::STATE_CANCELED);
+    }
+
+    public static function fromString(string $name): self
+    {
+        $allowedStates = [
+            self::STATE_NEW,
+            self::STATE_FINISHED,
+            self::STATE_PREMATURE,
+            self::STATE_FUTURE,
+            self::STATE_CANCELED,
+        ];
+        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/bill/BillFactory.php

@@ -17,11 +17,7 @@
  */
 class BillFactory implements BillFactoryInterface
 {
-    /**
-     * Creates bill object.
-     * @return Bill
-     */
-    public function create(BillCreationDto $dto)
+    public function create(BillCreationDto $dto): BillInterface
     {
         return new Bill(
             $dto->id,

src/bill/BillFactoryInterface.php

@@ -17,9 +17,5 @@
  */
 interface BillFactoryInterface
 {
-    /**
-     * Creates bill object.
-     * @return Bill
-     */
-    public function create(BillCreationDto $dto);
+    public function create(BillCreationDto $dto): BillInterface;
 }

src/charge/ChargeFactory.php

@@ -17,11 +17,7 @@
  */
 class ChargeFactory implements ChargeFactoryInterface
 {
-    /**
-     * Creates charge object.
-     * @return Charge
-     */
-    public function create(ChargeCreationDto $dto)
+    public function create(ChargeCreationDto $dto): ChargeInterface
     {
         return new Charge(
             $dto->id,

src/charge/ChargeFactoryInterface.php

@@ -17,9 +17,5 @@
  */
 interface ChargeFactoryInterface
 {
-    /**
-     * Creates charge object.
-     * @return Charge
-     */
-    public function create(ChargeCreationDto $dto);
+    public function create(ChargeCreationDto $dto): ChargeInterface;
 }

src/customer/Customer.php

@@ -37,11 +37,14 @@ class Customer implements CustomerInterface
      */
     protected $sellers = [];
 
-    public function __construct($id, $login, CustomerInterface $seller = null)
+    protected ?CustomerState $state = null;
+
+    public function __construct($id, $login, CustomerInterface $seller = null, ?CustomerState $state = null)
     {
         $this->id = $id;
         $this->login = $login;
         $this->seller = $seller;
+        $this->state = $state;
     }
 
     public function getId()
@@ -73,6 +76,26 @@ public function getSeller()
         return $this->seller;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getState(): ?CustomerState
+    {
+        return $this->state;
+    }
+
+    public function setState(CustomerState $state): self
+    {
+        $this->state = $state;
+
+        return $this;
+    }
+
+    public function isDeleted(): bool
+    {
+        return CustomerState::isDeleted($this);
+    }
+
     public static function fromArray(array $info)
     {
         if (!empty($info['seller_id']) && !empty($info['seller'])) {
@@ -81,7 +104,12 @@ public static function fromArray(array $info)
             $seller = null;
         }
 
-        return new static($info['id'], $info['login'], $seller);
+        return new static(
+            $info['id'],
+            $info['login'],
+            $seller,
+            isset($info['state']) ? CustomerState::from($info['state']) : null,
+        );
     }
 
     public function jsonSerialize(): array

src/customer/CustomerFactory.php

@@ -17,11 +17,7 @@
  */
 class CustomerFactory implements CustomerFactoryInterface
 {
-    /**
-     * Creates customer object.
-     * @return Customer
-     */
-    public function create(CustomerCreationDto $dto)
+    public function create(CustomerCreationDto $dto): CustomerInterface
     {
         return new Customer($dto->id, $dto->login, $dto->seller);
     }

src/customer/CustomerFactoryInterface.php

@@ -17,9 +17,5 @@
  */
 interface CustomerFactoryInterface
 {
-    /**
-     * Creates customer object.
-     * @return Customer
-     */
-    public function create(CustomerCreationDto $dto);
+    public function create(CustomerCreationDto $dto): CustomerInterface;
 }

src/customer/CustomerInterface.php

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

src/customer/CustomerState.php

@@ -0,0 +1,21 @@
+<?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 $customer->getState() === self::DELETED;
+    }
+
+    public static function deleted(): CustomerState
+    {
+        return self::DELETED;
+    }
+}

src/order/Calculator.php

@@ -106,7 +106,7 @@ public function calculatePrice(PriceInterface $price, ActionInterface $action):
             $charges = [$charge];
         }
 
-        if ($action->isFinished()) {
+        if ($action->isNotActive()) {
             foreach ($charges as $charge) {
                 $charge->setFinished();
             }

src/plan/PlanFactory.php

@@ -17,16 +17,12 @@
  */
 class PlanFactory implements PlanFactoryInterface
 {
-    /**
-     * Creates plan object.
-     * @return Plan
-     */
-    public function create(PlanCreationDto $dto)
+    public function create(PlanCreationDto $dto): PlanInterface
     {
         return $this->createAnyPlan($dto);
     }
 
-    protected function createAnyPlan(PlanCreationDto $dto, string $class = null)
+    protected function createAnyPlan(PlanCreationDto $dto, string $class = null): PlanInterface
     {
         $class = $class ?? Plan::class;
 

src/plan/PlanFactoryInterface.php

@@ -17,9 +17,5 @@
  */
 interface PlanFactoryInterface
 {
-    /**
-     * Creates plan object.
-     * @return Plan
-     */
-    public function create(PlanCreationDto $dto);
+    public function create(PlanCreationDto $dto): PlanInterface;
 }

src/price/PriceFactory.php

@@ -42,9 +42,6 @@ public function __construct(array $types = [], $defaultClass = null)
     }
 
 
-    /**
-     * Creates price object.
-     */
     public function create(PriceCreationDto $dto): PriceInterface
     {
         $class = $this->findClassForTypes([

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)