classes/XLite/Model/TaxClass.php line 57

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2011-present Qualiteam software Ltd. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XLite\Model;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XLite\API\Endpoint\TaxClass\DTO\TaxClassInput;
  13. use XLite\API\Endpoint\TaxClass\DTO\TaxClassOutput;
  14. use XLite\API\Filter\AlphabeticalOrderFilter;
  16. /**
  17.  * Tax class
  18.  *
  19.  * @ORM\Entity
  20.  * @ORM\Table  (name="tax_classes")
  21.  * @ApiPlatform\ApiResource(
  22.  *     shortName="Tax Class",
  23.  *     input=TaxClassInput::class,
  24.  *     output=TaxClassOutput::class,
  25.  *     itemOperations={
  26.  *         "get"={
  27.  *             "method"="GET",
  28.  *             "path"="/tax_classes/{id}",
  29.  *             "identifiers"={"id"},
  30.  *         },
  31.  *         "put"={
  32.  *             "method"="PUT",
  33.  *             "path"="/tax_classes/{id}",
  34.  *             "identifiers"={"id"},
  35.  *         },
  36.  *         "delete"={
  37.  *             "method"="DELETE",
  38.  *             "path"="/tax_classes/{id}",
  39.  *             "identifiers"={"id"},
  40.  *         }
  41.  *     },
  42.  *     collectionOperations={
  43.  *         "get"={
  44.  *             "method"="GET",
  45.  *             "path"="/tax_classes",
  46.  *             "identifiers"={"id"},
  47.  *         },
  48.  *         "post"={
  49.  *             "method"="POST",
  50.  *             "path"="/tax_classes",
  51.  *             "identifiers"={"id"},
  52.  *         }
  53.  *     }
  54.  * )
  55.  * @ApiPlatform\ApiFilter(AlphabeticalOrderFilter::class, properties={"name"="ASC"})
  56.  */
  57. class TaxClass extends \XLite\Model\Base\I18n
  58. {
  59.     /**
  60.      * ID
  61.      *
  62.      * @var integer
  63.      *
  64.      * @ORM\Id
  65.      * @ORM\GeneratedValue (strategy="AUTO")
  66.      * @ORM\Column         (type="integer", options={ "unsigned": true })
  67.      */
  68.     protected $id;
  70.     /**
  71.      * Position
  72.      *
  73.      * @var   integer
  74.      * @see   ____var_see____
  75.      * @since 1.0.0
  76.      *
  77.      * @ORM\Column (type="integer")
  78.      */
  79.     protected $position = 0;
  81.     /**
  82.      * @var \Doctrine\Common\Collections\Collection
  83.      *
  84.      * @ORM\OneToMany (targetEntity="XLite\Model\TaxClassTranslation", mappedBy="owner", cascade={"all"})
  85.      */
  86.     protected $translations;
  88.     /**
  89.      * Return number of products associated with the category
  90.      *
  91.      * @return integer
  92.      */
  93.     public function getProductsCount()
  94.     {
  95.         return $this->getProducts(null, true);
  96.     }
  98.     /**
  99.      * Return products list
  100.      *
  101.      * @param \XLite\Core\CommonCell $cnd       Search condition OPTIONAL
  102.      * @param boolean                $countOnly Return items list or only its size OPTIONAL
  103.      *
  104.      * @return array|integer
  105.      */
  106.     public function getProducts(\XLite\Core\CommonCell $cnd = null, $countOnly = false)
  107.     {
  108.         if (!isset($cnd)) {
  109.             $cnd = new \XLite\Core\CommonCell();
  110.         }
  112.         // Main condition for this search
  113.         $cnd->{\XLite\Model\Repo\Product::P_TAX_CLASS} = $this;
  115.         return \XLite\Core\Database::getRepo('XLite\Model\Product')->search($cnd, $countOnly);
  116.     }
  118.     /**
  119.      * Get id
  120.      *
  121.      * @return integer
  122.      */
  123.     public function getId()
  124.     {
  125.         return $this->id;
  126.     }
  128.     /**
  129.      * Set position
  130.      *
  131.      * @param integer $position
  132.      * @return TaxClass
  133.      */
  134.     public function setPosition($position)
  135.     {
  136.         $this->position = $position;
  137.         return $this;
  138.     }
  140.     /**
  141.      * Get position
  142.      *
  143.      * @return integer
  144.      */
  145.     public function getPosition()
  146.     {
  147.         return $this->position;
  148.     }
  149. }