classes/XLite/Model/AttributeOption.php line 327

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\AttributeOption\Hidden\DTO\AttributeOptionHiddenInput as InputHiddenOption;
  13. use XLite\API\Endpoint\AttributeOption\Hidden\DTO\AttributeOptionHiddenOutput as OutputHiddenOption;
  14. use XLite\API\Endpoint\AttributeOption\Select\DTO\AttributeOptionSelectInput as InputSelectOption;
  15. use XLite\API\Endpoint\AttributeOption\Select\DTO\AttributeOptionSelectOutput as OutputSelectOption;
  17. /**
  18.  * @ORM\Entity
  19.  * @ORM\Table (name="attribute_options")
  20.  * @ApiPlatform\ApiResource(
  21.  *     shortName="Attribute Option",
  22.  *     itemOperations={
  23.  *          "get_option_select"={
  24.  *              "method"="GET",
  25.  *              "path"="/attributes_select/{attribute_id}/options/{id}.{_format}",
  26.  *              "identifiers"={"id"},
  27.  *              "input"=InputSelectOption::class,
  28.  *              "output"=OutputSelectOption::class,
  29.  *              "requirements"={"attribute_id"="\d+", "id"="\d+"},
  30.  *              "openapi_context"={
  31.  *                  "summary"="Retrieve an option from a global plain field attribute",
  32.  *                  "parameters"={
  33.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  34.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  35.  *                  }
  36.  *              }
  37.  *          },
  38.  *          "put_option_select"={
  39.  *              "method"="PUT",
  40.  *              "path"="/attributes_select/{attribute_id}/options/{id}.{_format}",
  41.  *              "identifiers"={"id"},
  42.  *              "input"=InputSelectOption::class,
  43.  *              "output"=OutputSelectOption::class,
  44.  *              "requirements"={"attribute_id"="\d+", "id"="\d+"},
  45.  *              "openapi_context"={
  46.  *                  "summary"="Update an option of a global plain field attribute",
  47.  *                  "parameters"={
  48.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  49.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  50.  *                  }
  51.  *              }
  52.  *          },
  53.  *          "delete_option_select"={
  54.  *              "method"="DELETE",
  55.  *              "path"="/attributes_select/{attribute_id}/options/{id}.{_format}",
  56.  *              "identifiers"={"id"},
  57.  *              "input"=InputSelectOption::class,
  58.  *              "output"=OutputSelectOption::class,
  59.  *              "requirements"={"attribute_id"="\d+", "id"="\d+"},
  60.  *              "openapi_context"={
  61.  *                  "summary"="Delete an option from a global plain field attribute",
  62.  *                  "parameters"={
  63.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  64.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  65.  *                  }
  66.  *              }
  67.  *          },
  68.  *          "get_option_hidden"={
  69.  *              "method"="GET",
  70.  *              "path"="/attributes_hidden/{attribute_id}/options/{id}.{_format}",
  71.  *              "identifiers"={"id"},
  72.  *              "input"=InputHiddenOption::class,
  73.  *              "output"=OutputHiddenOption::class,
  74.  *              "requirements"={"attribute_id"="\d+", "id"="\d+"},
  75.  *              "openapi_context"={
  76.  *                  "summary"="Retrieve an option from a global hidden attribute",
  77.  *                  "parameters"={
  78.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  79.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  80.  *                  }
  81.  *              }
  82.  *          },
  83.  *          "put_option_hidden"={
  84.  *              "method"="PUT",
  85.  *              "path"="/attributes_hidden/{attribute_id}/options/{id}.{_format}",
  86.  *              "identifiers"={"id"},
  87.  *              "input"=InputHiddenOption::class,
  88.  *              "output"=OutputHiddenOption::class,
  89.  *              "requirements"={"attribute_id"="\d+", "id"="\d+"},
  90.  *              "openapi_context"={
  91.  *                  "summary"="Update an option of a global hidden attribute",
  92.  *                  "parameters"={
  93.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  94.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  95.  *                  }
  96.  *              }
  97.  *          },
  98.  *          "delete_option_hidden"={
  99.  *              "method"="DELETE",
  100.  *              "path"="/attributes_hidden/{attribute_id}/options/{id}.{_format}",
  101.  *              "identifiers"={"id"},
  102.  *              "input"=InputHiddenOption::class,
  103.  *              "output"=OutputHiddenOption::class,
  104.  *              "requirements"={"attribute_id"="\d+", "id"="\d+"},
  105.  *              "openapi_context"={
  106.  *                  "summary"="Delete an option from a global hidden attribute",
  107.  *                  "parameters"={
  108.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  109.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  110.  *                  }
  111.  *              }
  112.  *          },
  113.  *          "product_class_based_get_option_select"={
  114.  *              "method"="GET",
  115.  *              "path"="/product_classes/{class_id}/attributes_select/{attribute_id}/options/{id}.{_format}",
  116.  *              "identifiers"={"id"},
  117.  *              "input"=InputSelectOption::class,
  118.  *              "output"=OutputSelectOption::class,
  119.  *              "requirements"={"class_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  120.  *              "openapi_context"={
  121.  *                  "summary"="Retrieve an option from a product class plain field attribute",
  122.  *                  "parameters"={
  123.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  124.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  125.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  126.  *                  }
  127.  *              }
  128.  *          },
  129.  *          "product_class_based_put_option_select"={
  130.  *              "method"="PUT",
  131.  *              "path"="/product_classes/{class_id}/attributes_select/{attribute_id}/options/{id}.{_format}",
  132.  *              "identifiers"={"id"},
  133.  *              "input"=InputSelectOption::class,
  134.  *              "output"=OutputSelectOption::class,
  135.  *              "requirements"={"class_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  136.  *              "openapi_context"={
  137.  *                  "summary"="Update an option of a product class plain field attribute",
  138.  *                  "parameters"={
  139.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  140.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  141.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  142.  *                  }
  143.  *              }
  144.  *          },
  145.  *          "product_class_based_delete_option_select"={
  146.  *              "method"="DELETE",
  147.  *              "path"="/product_classes/{class_id}/attributes_select/{attribute_id}/options/{id}.{_format}",
  148.  *              "identifiers"={"id"},
  149.  *              "input"=InputSelectOption::class,
  150.  *              "output"=OutputSelectOption::class,
  151.  *              "requirements"={"class_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  152.  *              "openapi_context"={
  153.  *                  "summary"="Delete an option from a product class plain field attribute",
  154.  *                  "parameters"={
  155.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  156.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  157.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  158.  *                  }
  159.  *              }
  160.  *          },
  161.  *          "product_based_get_option_select"={
  162.  *              "method"="GET",
  163.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/options/{id}.{_format}",
  164.  *              "identifiers"={"id"},
  165.  *              "input"=InputSelectOption::class,
  166.  *              "output"=OutputSelectOption::class,
  167.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  168.  *              "openapi_context"={
  169.  *                  "summary"="Retrieve an option from a product-specific plain field attribute",
  170.  *                  "parameters"={
  171.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  172.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  173.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  174.  *                  }
  175.  *              }
  176.  *          },
  177.  *          "product_based_put_option_select"={
  178.  *              "method"="PUT",
  179.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/options/{id}.{_format}",
  180.  *              "identifiers"={"id"},
  181.  *              "input"=InputSelectOption::class,
  182.  *              "output"=OutputSelectOption::class,
  183.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  184.  *              "openapi_context"={
  185.  *                  "summary"="Update an option of a product-specific plain field attribute",
  186.  *                  "parameters"={
  187.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  188.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  189.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  190.  *                  }
  191.  *              }
  192.  *          },
  193.  *          "product_based_delete_option_select"={
  194.  *              "method"="DELETE",
  195.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/options/{id}.{_format}",
  196.  *              "identifiers"={"id"},
  197.  *              "input"=InputSelectOption::class,
  198.  *              "output"=OutputSelectOption::class,
  199.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+", "id"="\d+"},
  200.  *              "openapi_context"={
  201.  *                  "summary"="Delete an option from a product-specific plain field attribute",
  202.  *                  "parameters"={
  203.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  204.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  205.  *                     {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  206.  *                  }
  207.  *              }
  208.  *          }
  209.  *     },
  210.  *     collectionOperations={
  211.  *          "get_option_selects"={
  212.  *              "method"="GET",
  213.  *              "path"="/attributes_select/{attribute_id}/options.{_format}",
  214.  *              "identifiers"={"id"},
  215.  *              "input"=InputSelectOption::class,
  216.  *              "output"=OutputSelectOption::class,
  217.  *              "requirements"={"attribute_id"="\d+"},
  218.  *              "openapi_context"={
  219.  *                  "summary"="Retrieve a list of options from a global plain field attribute",
  220.  *                  "parameters"={
  221.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  222.  *                  }
  223.  *              }
  224.  *          },
  225.  *          "post_option_select"={
  226.  *              "method"="POST",
  227.  *              "controller"="xcart.api.attribute_option.select.controller",
  228.  *              "path"="/attributes_select/{attribute_id}/options.{_format}",
  229.  *              "identifiers"={"id"},
  230.  *              "input"=InputSelectOption::class,
  231.  *              "output"=OutputSelectOption::class,
  232.  *              "requirements"={"attribute_id"="\d+"},
  233.  *              "openapi_context"={
  234.  *                  "summary"="Add an option to a global plain field attribute",
  235.  *                  "parameters"={
  236.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  237.  *                  }
  238.  *              }
  239.  *          },
  240.  *          "get_option_hiddens"={
  241.  *              "method"="GET",
  242.  *              "path"="/attributes_hidden/{attribute_id}/options.{_format}",
  243.  *              "identifiers"={"id"},
  244.  *              "input"=InputHiddenOption::class,
  245.  *              "output"=OutputHiddenOption::class,
  246.  *              "requirements"={"attribute_id"="\d+"},
  247.  *              "openapi_context"={
  248.  *                  "summary"="Retrieve a list of options from a global hidden attribute",
  249.  *                  "parameters"={
  250.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  251.  *                  }
  252.  *              }
  253.  *          },
  254.  *          "post_option_hidden"={
  255.  *              "method"="POST",
  256.  *              "controller"="xcart.api.attribute_option.hidden.controller",
  257.  *              "path"="/attributes_hidden/{attribute_id}/options.{_format}",
  258.  *              "identifiers"={"id"},
  259.  *              "input"=InputHiddenOption::class,
  260.  *              "output"=OutputHiddenOption::class,
  261.  *              "requirements"={"attribute_id"="\d+"},
  262.  *              "openapi_context"={
  263.  *                  "summary"="Add an option to a global hidden attribute",
  264.  *                  "parameters"={
  265.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  266.  *                  }
  267.  *              }
  268.  *          },
  269.  *          "product_class_based_get_option_selects"={
  270.  *              "method"="GET",
  271.  *              "path"="/product_classes/{class_id}/attributes_select/{attribute_id}/options.{_format}",
  272.  *              "identifiers"={"id"},
  273.  *              "input"=InputSelectOption::class,
  274.  *              "output"=OutputSelectOption::class,
  275.  *              "requirements"={"class_id"="\d+", "attribute_id"="\d+"},
  276.  *              "openapi_context"={
  277.  *                  "summary"="Retrieve a list of options from a product class plain field attribute",
  278.  *                  "parameters"={
  279.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  280.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  281.  *                  }
  282.  *              }
  283.  *          },
  284.  *          "product_class_based_post_option_select"={
  285.  *              "method"="POST",
  286.  *              "controller"="xcart.api.attribute_option.select.product_class_controller",
  287.  *              "path"="/product_classes/{class_id}/attributes_select/{attribute_id}/options.{_format}",
  288.  *              "identifiers"={"id"},
  289.  *              "input"=InputSelectOption::class,
  290.  *              "output"=OutputSelectOption::class,
  291.  *              "requirements"={"class_id"="\d+", "attribute_id"="\d+"},
  292.  *              "openapi_context"={
  293.  *                  "summary"="Add an option to a product class plain field attribute",
  294.  *                  "parameters"={
  295.  *                     {"name"="class_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  296.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  297.  *                  }
  298.  *              }
  299.  *          },
  300.  *          "product_based_get_option_selects"={
  301.  *              "method"="GET",
  302.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/options.{_format}",
  303.  *              "identifiers"={"id"},
  304.  *              "input"=InputSelectOption::class,
  305.  *              "output"=OutputSelectOption::class,
  306.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+"},
  307.  *              "openapi_context"={
  308.  *                  "summary"="Retrieve a list of options from a product-specific plain field attribute",
  309.  *                  "parameters"={
  310.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  311.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  312.  *                  }
  313.  *              }
  314.  *          },
  315.  *          "product_based_post_option_select"={
  316.  *              "method"="POST",
  317.  *              "controller"="xcart.api.attribute_option.select.product_controller",
  318.  *              "path"="/products/{product_id}/attributes_select/{attribute_id}/options.{_format}",
  319.  *              "identifiers"={"id"},
  320.  *              "input"=InputSelectOption::class,
  321.  *              "output"=OutputSelectOption::class,
  322.  *              "requirements"={"product_id"="\d+", "attribute_id"="\d+"},
  323.  *              "openapi_context"={
  324.  *                  "summary"="Add an option to a product-specific plain field attribute",
  325.  *                  "parameters"={
  326.  *                     {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  327.  *                     {"name"="attribute_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  328.  *                  }
  329.  *              }
  330.  *          }
  331.  *     }
  332.  * )
  333.  */
  334. class AttributeOption extends \XLite\Model\Base\I18n
  335. {
  336.     /**
  337.      * @var int
  338.      *
  339.      * @ORM\Id
  340.      * @ORM\GeneratedValue (strategy="AUTO")
  341.      * @ORM\Column (type="integer", options={"unsigned": true})
  342.      */
  343.     protected $id;
  345.     /**
  346.      * @var \XLite\Model\Attribute
  347.      *
  348.      * @ORM\ManyToOne (targetEntity="XLite\Model\Attribute", inversedBy="attribute_options")
  349.      * @ORM\JoinColumn (name="attribute_id", referencedColumnName="id", onDelete="CASCADE")
  350.      */
  351.     protected $attribute;
  353.     /**
  354.      * Add to new products or class’s assigns automatically
  355.      *
  356.      * @var bool
  357.      *
  358.      * @ORM\Column (type="boolean")
  359.      */
  360.     protected $addToNew = false;
  362.     /**
  363.      * @var int
  364.      *
  365.      * @ORM\Column (type="integer")
  366.      */
  367.     protected $position = 0;
  369.     /**
  370.      * @var \Doctrine\Common\Collections\Collection
  371.      *
  372.      * @ORM\OneToMany (targetEntity="XLite\Model\AttributeOptionTranslation", mappedBy="owner", cascade={"all"})
  373.      */
  374.     protected $translations;
  376.     /**
  377.      * Get id
  378.      *
  379.      * @return integer
  380.      */
  381.     public function getId()
  382.     {
  383.         return $this->id;
  384.     }
  386.     /**
  387.      * Set addToNew
  388.      *
  389.      * @param boolean $addToNew
  390.      */
  391.     public function setAddToNew($addToNew)
  392.     {
  393.         $this->addToNew = $addToNew;
  394.     }
  396.     /**
  397.      * Get addToNew
  398.      *
  399.      * @return boolean
  400.      */
  401.     public function getAddToNew()
  402.     {
  403.         return $this->addToNew;
  404.     }
  406.     /**
  407.      * Set attribute
  408.      *
  409.      * @param \XLite\Model\Attribute $attribute
  410.      */
  411.     public function setAttribute(\XLite\Model\Attribute $attribute = null)
  412.     {
  413.         $this->attribute = $attribute;
  414.     }
  416.     /**
  417.      * Get attribute
  418.      *
  419.      * @return \XLite\Model\Attribute
  420.      */
  421.     public function getAttribute()
  422.     {
  423.         return $this->attribute;
  424.     }
  426.     /**
  427.      * @return int
  428.      */
  429.     public function getPosition()
  430.     {
  431.         return $this->position;
  432.     }
  434.     /**
  435.      * @param int $position
  436.      */
  437.     public function setPosition($position)
  438.     {
  439.         $this->position = $position;
  440.     }
  441. }