classes/XLite/Model/Order/Status/Shipping.php line 38

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2001-present X-Cart Holdings LLC. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XLite\Model\Order\Status;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XLite\API\Endpoint\OrderShippingStatus\DTO\OrderShippingStatusInput as Input;
  13. use XLite\API\Endpoint\OrderShippingStatus\DTO\OrderShippingStatusOutput as Output;
  15. /**
  16.  * Shipping status
  17.  *
  18.  * @ORM\Entity
  19.  * @ORM\Table  (name="order_shipping_statuses",
  20.  *      indexes={
  21.  *          @ORM\Index (name="code", columns={"code"})
  22.  *      }
  23.  * )
  24.  * @ApiPlatform\ApiResource(
  25.  *     shortName="OrderShippingStatus",
  26.  *     input=Input::class,
  27.  *     output=Output::class,
  28.  *     itemOperations={
  29.  *          "get"={
  30.  *              "method"="GET",
  31.  *              "path"="/orders/{id}/shipping_status.{_format}",
  32.  *              "identifiers"={"id"},
  33.  *              "requirements"={"id"="\d+"}
  34.  *          },
  35.  *          "put"={
  36.  *              "method"="PUT",
  37.  *              "path"="/orders/{id}/shipping_status.{_format}",
  38.  *              "identifiers"={"id"},
  39.  *              "requirements"={"id"="\d+"}
  40.  *          }
  41.  *     },
  42.  *     collectionOperations={}
  43.  * )
  44.  */
  45. class Shipping extends \XLite\Model\Order\Status\AStatus
  46. {
  47.     /**
  48.      * Statuses
  49.      */
  50.     public const STATUS_NEW                 = 'N';
  51.     public const STATUS_PROCESSING          = 'P';
  52.     public const STATUS_SHIPPED             = 'S';
  53.     public const STATUS_DELIVERED           = 'D';
  54.     public const STATUS_WILL_NOT_DELIVER    = 'WND';
  55.     public const STATUS_RETURNED            = 'R';
  56.     public const STATUS_WAITING_FOR_APPROVE = 'WFA';
  57.     public const STATUS_NEW_BACKORDERED     = 'NBA';
  59.     /**
  60.      * @var \Doctrine\Common\Collections\Collection
  61.      *
  62.      * @ORM\OneToMany (targetEntity="XLite\Model\Order\Status\ShippingTranslation", mappedBy="owner", cascade={"all"})
  63.      */
  64.     protected $translations;
  66.     /**
  67.      * Disallowed to set manually statuses
  68.      *
  69.      * @return array
  70.      */
  71.     public static function getDisallowedToSetManuallyStatuses()
  72.     {
  73.         return [
  74.             static::STATUS_WAITING_FOR_APPROVE,
  75.             static::STATUS_NEW_BACKORDERED,
  76.         ];
  77.     }
  79.     /**
  80.      * Status is allowed to set manually
  81.      *
  82.      * @return boolean
  83.      */
  84.     public function isAllowedToSetManually()
  85.     {
  86.         return !in_array(
  87.             $this->getCode(),
  88.             static::getDisallowedToSetManuallyStatuses()
  89.         );
  90.     }
  92.     /**
  93.      * Get id
  94.      *
  95.      * @return integer
  96.      */
  97.     public function getId()
  98.     {
  99.         return $this->id;
  100.     }
  102.     /**
  103.      * Set code
  104.      *
  105.      * @param string $code
  106.      *
  107.      * @return Shipping
  108.      */
  109.     public function setCode($code)
  110.     {
  111.         $this->code = $code;
  112.         return $this;
  113.     }
  115.     /**
  116.      * Get code
  117.      *
  118.      * @return string|null
  119.      */
  120.     public function getCode()
  121.     {
  122.         return $this->code;
  123.     }
  125.     /**
  126.      * Set position
  127.      *
  128.      * @param integer $position
  129.      *
  130.      * @return Shipping
  131.      */
  132.     public function setPosition($position)
  133.     {
  134.         $this->position = $position;
  135.         return $this;
  136.     }
  138.     /**
  139.      * Get position
  140.      *
  141.      * @return integer
  142.      */
  143.     public function getPosition()
  144.     {
  145.         return $this->position;
  146.     }
  148.     /**
  149.      * List of change status handlers;
  150.      * top index - old status, second index - new one
  151.      * (<old_status> ----> <new_status>: $statusHandlers[$old][$new])
  152.      *
  153.      * @return array
  154.      */
  155.     public static function getStatusHandlers()
  156.     {
  157.         return [
  158.             static::STATUS_NEW => [
  159.                 static::STATUS_SHIPPED => ['ship'],
  160.                 static::STATUS_WAITING_FOR_APPROVE => ['waitingForApprove']
  161.             ],
  163.             static::STATUS_PROCESSING => [
  164.                 static::STATUS_SHIPPED => ['ship'],
  165.                 static::STATUS_WAITING_FOR_APPROVE => ['waitingForApprove']
  166.             ],
  168.             static::STATUS_DELIVERED => [
  169.                 static::STATUS_SHIPPED => ['ship'],
  170.             ],
  172.             static::STATUS_WILL_NOT_DELIVER => [
  173.                 static::STATUS_SHIPPED => ['ship'],
  174.             ],
  176.             static::STATUS_RETURNED => [
  177.                 static::STATUS_SHIPPED => ['ship'],
  178.             ],
  180.             static::STATUS_WAITING_FOR_APPROVE => [
  181.                 static::STATUS_SHIPPED => ['ship'],
  182.             ],
  184.             static::STATUS_NEW_BACKORDERED => [
  185.                 static::STATUS_NEW              => ['releaseBackorder'],
  186.                 static::STATUS_PROCESSING       => ['releaseBackorder'],
  187.                 static::STATUS_SHIPPED          => ['ship', 'releaseBackorder'],
  188.                 static::STATUS_DELIVERED        => ['releaseBackorder'],
  189.                 static::STATUS_WILL_NOT_DELIVER => ['releaseBackorder'],
  190.                 static::STATUS_RETURNED         => ['releaseBackorder'],
  191.             ],
  192.         ];
  193.     }
  194. }