classes/XLite/Model/AttributeValue/AttributeValueSelect.php line 109

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\AttributeValue;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XLite\API\Endpoint\AttributeValue\Select\DTO\AttributeValueSelectInput as Input;
  13. use XLite\API\Endpoint\AttributeValue\Select\DTO\AttributeValueSelectOutput as Output;
  14. use XLite\Controller\API\AttributeValue\Select\Post as PostController;
  15. use XLite\Core\Translation\Label;
  17. /**
  18.  * Attribute value (select)
  19.  *
  20.  * @ORM\Entity
  21.  * @ORM\Table  (name="attribute_values_select",
  22.  *      indexes={
  23.  *          @ORM\Index (name="product_id", columns={"product_id"}),
  24.  *          @ORM\Index (name="attribute_id", columns={"attribute_id"}),
  25.  *          @ORM\Index (name="attribute_option_id", columns={"attribute_option_id"})
  26.  *      }
  27.  * )
  28.  * @ApiPlatform\ApiResource(
  29.  *     attributes={"pagination_enabled": false},
  30.  *     shortName="Plain Field Attribute Value",
  31.  *     itemOperations={
  32.  *          "get"={
  33.  *              "method"="GET",
  34.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/values/{id}.{_format}",
  35.  *              "identifiers"={"id"},
  36.  *              "input"=Input::class,
  37.  *              "output"=Output::class,
  38.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  39.  *              "openapi_context"={
  40.  *                  "summary"="Retrieve a value from a product plain field attribute",
  41.  *                  "parameters"={
  42.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  43.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  44.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  45.  *                  }
  46.  *              }
  47.  *          },
  48.  *          "put"={
  49.  *              "method"="PUT",
  50.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/values/{id}.{_format}",
  51.  *              "identifiers"={"id"},
  52.  *              "input"=Input::class,
  53.  *              "output"=Output::class,
  54.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  55.  *              "openapi_context"={
  56.  *                  "summary"="Update a value of a product plain field attribute",
  57.  *                  "parameters"={
  58.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  59.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  60.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  61.  *                  }
  62.  *              }
  63.  *          },
  64.  *          "delete"={
  65.  *              "method"="DELETE",
  66.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/values/{id}.{_format}",
  67.  *              "identifiers"={"id"},
  68.  *              "input"=Input::class,
  69.  *              "output"=Output::class,
  70.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  71.  *              "openapi_context"={
  72.  *                  "summary"="Delete a value from a product plain field attribute",
  73.  *                  "parameters"={
  74.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  75.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  76.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  77.  *                  }
  78.  *              }
  79.  *          }
  80.  *     },
  81.  *     collectionOperations={
  82.  *          "get"={
  83.  *              "method"="GET",
  84.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/values.{_format}",
  85.  *              "identifiers"={"id"},
  86.  *              "input"=Input::class,
  87.  *              "output"=Output::class,
  88.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+"},
  89.  *              "openapi_context"={
  90.  *                  "summary"="Retrieve a list of values from a product plain field attribute",
  91.  *                  "parameters"={
  92.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  93.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  94.  *                  }
  95.  *              }
  96.  *          },
  97.  *          "post"={
  98.  *              "method"="POST",
  99.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/values.{_format}",
  100.  *              "identifiers"={"id"},
  101.  *              "input"=Input::class,
  102.  *              "output"=Output::class,
  103.  *              "controller"=PostController::class,
  104.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+"},
  105.  *              "openapi_context"={
  106.  *                  "summary"="Add a value to a product plain field attribute",
  107.  *                  "parameters"={
  108.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  109.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  110.  *                  }
  111.  *              }
  112.  *          }
  113.  *     }
  114.  * )
  115.  */
  116. class AttributeValueSelect extends \XLite\Model\AttributeValue\Multiple
  117. {
  118.     /**
  119.      * @var \XLite\Model\Product
  120.      *
  121.      * @ORM\ManyToOne (targetEntity="XLite\Model\Product", inversedBy="attributeValueS")
  122.      * @ORM\JoinColumn (name="product_id", referencedColumnName="product_id", onDelete="CASCADE")
  123.      */
  124.     protected $product;
  126.     /**
  127.      * Attribute option
  128.      *
  129.      * @var \XLite\Model\AttributeOption
  130.      *
  131.      * @ORM\ManyToOne  (targetEntity="XLite\Model\AttributeOption")
  132.      * @ORM\JoinColumn (name="attribute_option_id", referencedColumnName="id", onDelete="CASCADE")
  133.      */
  134.     protected $attribute_option;
  136.     /**
  137.      * Position
  138.      *
  139.      * @var integer
  140.      *
  141.      * @ORM\Column (type="integer")
  142.      */
  143.     protected $position = 0;
  145.     /**
  146.      * @var \Doctrine\Common\Collections\Collection
  147.      *
  148.      * @ORM\OneToMany (targetEntity="XLite\Model\AttributeValue\AttributeValueSelectTranslation", mappedBy="owner", cascade={"all"})
  149.      */
  150.     protected $translations;
  152.     /**
  153.      * Return attribute value as string
  154.      *
  155.      * @return string|Label
  156.      */
  157.     public function asString()
  158.     {
  159.         /** @see \XLite\Model\AttributeOptionTranslation */
  160.         return $this->getAttributeOption()->getName();
  161.     }
  163.     /**
  164.      * Clone
  165.      *
  166.      * @return static
  167.      */
  168.     public function cloneEntity()
  169.     {
  170.         /** @var static $newEntity */
  171.         $newEntity = parent::cloneEntity();
  173.         if ($this->getAttributeOption()) {
  174.             if ($this->getAttribute()->getProduct()) {
  175.                 $attributeOption = $this->getAttributeOption()->cloneEntity();
  176.                 \XLite\Core\Database::getEM()->persist($attributeOption);
  177.             } else {
  178.                 $attributeOption = $this->getAttributeOption();
  179.             }
  180.             $newEntity->setAttributeOption($attributeOption);
  181.         }
  183.         return $newEntity;
  184.     }
  186.     /**
  187.      * @return \XLite\Model\Product
  188.      */
  189.     public function getProduct()
  190.     {
  191.         return $this->product;
  192.     }
  194.     /**
  195.      * @param \XLite\Model\Product $product
  196.      */
  197.     public function setProduct(\XLite\Model\Product $product = null)
  198.     {
  199.         $this->product = $product;
  200.     }
  202.     /**
  203.      * @return \XLite\Model\AttributeOption
  204.      */
  205.     public function getAttributeOption()
  206.     {
  207.         return $this->attribute_option;
  208.     }
  210.     /**
  211.      * @param \XLite\Model\AttributeOption $attributeOption
  212.      *
  213.      * @return static
  214.      */
  215.     public function setAttributeOption(\XLite\Model\AttributeOption $attributeOption = null)
  216.     {
  217.         $this->attribute_option = $attributeOption;
  219.         return $this;
  220.     }
  222.     /**
  223.      * @return integer
  224.      */
  225.     public function getPosition()
  226.     {
  227.         return $this->position;
  228.     }
  230.     /**
  231.      * @param integer $position
  232.      *
  233.      * @return static
  234.      */
  235.     public function setPosition($position)
  236.     {
  237.         $this->position = $position;
  239.         return $this;
  240.     }
  241. }