classes/XLite/Model/Order/Status/Payment.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\OrderPaymentStatus\DTO\OrderPaymentStatusInput as Input;
  13. use XLite\API\Endpoint\OrderPaymentStatus\DTO\OrderPaymentStatusOutput as Output;
  15. /**
  16.  * Payment status
  17.  *
  18.  * @ORM\Entity
  19.  * @ORM\Table  (name="order_payment_statuses",
  20.  *      indexes={
  21.  *          @ORM\Index (name="code", columns={"code"})
  22.  *      }
  23.  * )
  24.  * @ApiPlatform\ApiResource(
  25.  *     shortName="OrderPaymentStatus",
  26.  *     input=Input::class,
  27.  *     output=Output::class,
  28.  *     itemOperations={
  29.  *          "get"={
  30.  *              "method"="GET",
  31.  *              "path"="/orders/{id}/payment_status.{_format}",
  32.  *              "identifiers"={"id"},
  33.  *              "requirements"={"id"="\d+"}
  34.  *          },
  35.  *          "put"={
  36.  *              "method"="PUT",
  37.  *              "path"="/orders/{id}/payment_status.{_format}",
  38.  *              "identifiers"={"id"},
  39.  *              "requirements"={"id"="\d+"}
  40.  *          }
  41.  *     },
  42.  *     collectionOperations={}
  43.  * )
  44.  */
  45. class Payment extends \XLite\Model\Order\Status\AStatus
  46. {
  47.     /**
  48.      * Statuses
  49.      */
  50.     public const STATUS_AUTHORIZED     = 'A';
  51.     public const STATUS_PART_PAID      = 'PP';
  52.     public const STATUS_PAID           = 'P';
  53.     public const STATUS_DECLINED       = 'D';
  54.     public const STATUS_CANCELED       = 'C';
  55.     public const STATUS_QUEUED         = 'Q';
  56.     public const STATUS_REFUNDED       = 'R';
  58.     /**
  59.      * @var \Doctrine\Common\Collections\Collection
  60.      *
  61.      * @ORM\OneToMany (targetEntity="XLite\Model\Order\Status\PaymentTranslation", mappedBy="owner", cascade={"all"})
  62.      */
  63.     protected $translations;
  65.     /**
  66.      * Disallowed to set manually statuses
  67.      *
  68.      * @return array
  69.      */
  70.     public static function getDisallowedToSetManuallyStatuses()
  71.     {
  72.         return [
  73.             static::STATUS_AUTHORIZED,
  74.             static::STATUS_DECLINED
  75.         ];
  76.     }
  78.     /**
  79.      * Not compatible with Shipping statuses
  80.      *
  81.      * @return array
  82.      */
  83.     public static function getNotCompatibleWithShippingStatuses()
  84.     {
  85.         return [
  86.             static::STATUS_DECLINED,
  87.             static::STATUS_CANCELED,
  88.         ];
  89.     }
  91.     /**
  92.      * Get open order statuses
  93.      *
  94.      * @return array
  95.      */
  96.     public static function getOpenStatuses()
  97.     {
  98.         return [
  99.             static::STATUS_AUTHORIZED,
  100.             static::STATUS_PART_PAID,
  101.             static::STATUS_PAID,
  102.             static::STATUS_QUEUED,
  103.         ];
  104.     }
  106.     /**
  107.      * Get paid statuses
  108.      *
  109.      * @return array
  110.      */
  111.     public static function getPaidStatuses()
  112.     {
  113.         return [
  114.             static::STATUS_AUTHORIZED,
  115.             static::STATUS_PART_PAID,
  116.             static::STATUS_PAID,
  117.         ];
  118.     }
  120.     /**
  121.      * Payment status is compatible with shipping status
  122.      *
  123.      * @return boolean
  124.      */
  125.     public function isCompatibleWithShippingStatus()
  126.     {
  127.         return !in_array(
  128.             $this->getCode(),
  129.             static::getNotCompatibleWithShippingStatuses()
  130.         );
  131.     }
  133.     /**
  134.      * Status is allowed to set manually
  135.      *
  136.      * @return boolean
  137.      */
  138.     public function isAllowedToSetManually()
  139.     {
  140.         return !in_array(
  141.             $this->getCode(),
  142.             static::getDisallowedToSetManuallyStatuses()
  143.         );
  144.     }
  146.     /**
  147.      * Get id
  148.      *
  149.      * @return integer
  150.      */
  151.     public function getId()
  152.     {
  153.         return $this->id;
  154.     }
  156.     /**
  157.      * Set code
  158.      *
  159.      * @param string $code
  160.      * @return Payment
  161.      */
  162.     public function setCode($code)
  163.     {
  164.         $this->code = $code;
  165.         return $this;
  166.     }
  168.     /**
  169.      * Get code
  170.      *
  171.      * @return string|null
  172.      */
  173.     public function getCode()
  174.     {
  175.         return $this->code;
  176.     }
  178.     /**
  179.      * Set position
  180.      *
  181.      * @param integer $position
  182.      * @return Payment
  183.      */
  184.     public function setPosition($position)
  185.     {
  186.         $this->position = $position;
  187.         return $this;
  188.     }
  190.     /**
  191.      * Get position
  192.      *
  193.      * @return integer
  194.      */
  195.     public function getPosition()
  196.     {
  197.         return $this->position;
  198.     }
  200.     /**
  201.      * List of change status handlers;
  202.      * top index - old status, second index - new one
  203.      * (<old_status> ----> <new_status>: $statusHandlers[$old][$new])
  204.      *
  205.      * @return array
  206.      */
  207.     public static function getStatusHandlers()
  208.     {
  209.         return [
  210.             static::STATUS_QUEUED => [
  211.                 static::STATUS_AUTHORIZED => ['authorize'],
  212.                 static::STATUS_PAID       => ['process'],
  213.                 static::STATUS_DECLINED   => ['decline', 'uncheckout', 'fail'],
  214.                 static::STATUS_CANCELED   => ['decline', 'uncheckout', 'cancel'],
  215.             ],
  217.             static::STATUS_AUTHORIZED => [
  218.                 static::STATUS_PAID       => ['process'],
  219.                 static::STATUS_DECLINED   => ['decline', 'uncheckout', 'fail'],
  220.                 static::STATUS_CANCELED   => ['decline', 'uncheckout', 'cancel'],
  221.             ],
  223.             static::STATUS_PART_PAID => [
  224.                 static::STATUS_PAID       => ['process'],
  225.                 static::STATUS_DECLINED   => ['decline', 'uncheckout', 'fail'],
  226.                 static::STATUS_CANCELED   => ['decline', 'uncheckout', 'fail'],
  227.             ],
  229.             static::STATUS_PAID => [
  230.                 static::STATUS_DECLINED   => ['decline', 'uncheckout', 'fail'],
  231.                 static::STATUS_CANCELED   => ['decline', 'uncheckout', 'cancel'],
  232.             ],
  234.             static::STATUS_DECLINED => [
  235.                 static::STATUS_AUTHORIZED => ['checkout', 'queue', 'authorize'],
  236.                 static::STATUS_PART_PAID  => ['checkout', 'queue'],
  237.                 static::STATUS_PAID       => ['checkout', 'queue', 'process'],
  238.                 static::STATUS_QUEUED     => ['checkout', 'queue'],
  239.                 static::STATUS_CANCELED   => ['cancel'],
  240.             ],
  242.             static::STATUS_CANCELED => [
  243.                 static::STATUS_AUTHORIZED => ['checkout', 'queue', 'authorize'],
  244.                 static::STATUS_PART_PAID  => ['checkout', 'queue'],
  245.                 static::STATUS_PAID       => ['checkout', 'queue', 'process'],
  246.                 static::STATUS_QUEUED     => ['checkout', 'queue'],
  247.                 static::STATUS_DECLINED   => ['fail'],
  248.             ],
  250.             static::STATUS_REFUNDED => [
  251.                 static::STATUS_PAID       => ['process'],
  252.                 static::STATUS_DECLINED   => ['fail'],
  253.                 static::STATUS_CANCELED   => ['cancel'],
  254.             ],
  255.         ];
  256.     }
  257. }