classes/XLite/Model/Image/Product/Image.php line 110

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\Image\Product;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XLite\API\Endpoint\ProductImage\DTO\ProductImageInput;
  13. use XLite\API\Endpoint\ProductImage\DTO\ProductImageOutput;
  14. use XLite\API\Endpoint\ProductImage\DTO\ProductImageUpdateInput;
  15. use XLite\Controller\API\ProductImage\DeleteProductImage;
  17. /**
  18.  * Product image
  19.  *
  20.  * @ORM\Entity
  21.  * @ORM\Table  (name="product_images")
  22.  * @ApiPlatform\ApiResource(
  23.  *     shortName="Product Image",
  24.  *     output=ProductImageOutput::class,
  25.  *     itemOperations={
  26.  *         "get"={
  27.  *             "method"="GET",
  28.  *             "path"="/products/{product_id}/images/{image_id}.{_format}",
  29.  *             "identifiers"={"product_id", "image_id"},
  30.  *             "requirements"={"product_id"="\d+", "image_id"="\d+"},
  31.  *             "openapi_context"={
  32.  *                  "summary"="Retrieve an image from a product",
  33.  *                  "parameters"={
  34.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  35.  *                      {"name"="image_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  36.  *                  },
  37.  *             },
  38.  *          },
  39.  *         "put"={
  40.  *             "method"="PUT",
  41.  *             "input"=ProductImageUpdateInput::class,
  42.  *             "path"="/products/{product_id}/images/{image_id}.{_format}",
  43.  *             "identifiers"={"product_id", "image_id"},
  44.  *             "requirements"={"product_id"="\d+", "image_id"="\d+"},
  45.  *             "read"=false,
  46.  *             "openapi_context"={
  47.  *                  "summary"="Update the properties of a product image",
  48.  *                  "parameters"={
  49.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  50.  *                      {"name"="image_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  51.  *                  },
  52.  *             },
  53.  *         },
  54.  *         "delete"={
  55.  *             "method"="DELETE",
  56.  *             "path"="/products/{product_id}/images/{image_id}.{_format}",
  57.  *             "identifiers"={"product_id", "image_id"},
  58.  *             "requirements"={"product_id"="\d+", "image_id"="\d+"},
  59.  *             "controller"=DeleteProductImage::class,
  60.  *             "read"=false,
  61.  *             "openapi_context"={
  62.  *                  "summary"="Delete an image from a product",
  63.  *                  "parameters"={
  64.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  65.  *                      {"name"="image_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  66.  *                  },
  67.  *             },
  68.  *         },
  69.  *     },
  70.  *     collectionOperations={
  71.  *         "post"={
  72.  *             "method"="POST",
  73.  *             "input"=ProductImageInput::class,
  74.  *             "path"="/products/{product_id}/images.{_format}",
  75.  *             "identifiers"={"product_id", "image_id"},
  76.  *             "requirements"={"product_id"="\d+"},
  77.  *             "openapi_context"={
  78.  *                  "summary"="Add an image to a product",
  79.  *                  "parameters"={
  80.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  81.  *                  },
  82.  *                  "requestBody"={
  83.  *                      "content"={
  84.  *                          "application/json"={
  85.  *                              "schema"={
  86.  *                                  "type"="object",
  87.  *                                  "properties"={
  88.  *                                      "position"={
  89.  *                                          "type"="integer"
  90.  *                                      },
  91.  *                                      "alt"={
  92.  *                                          "type"="string",
  93.  *                                          "description"="Alt text"
  94.  *                                      },
  95.  *                                      "externalUrl"={
  96.  *                                          "type"="string",
  97.  *                                          "description"="URL to the image file which will be downloaded from there"
  98.  *                                      },
  99.  *                                      "attachment"={
  100.  *                                          "type"="string",
  101.  *                                          "description"="base64-encoded image"
  102.  *                                      },
  103.  *                                      "filename"={
  104.  *                                          "type"="string",
  105.  *                                          "description"="Image name with correct extension. Required for 'attachement' field."
  106.  *                                      },
  107.  *                                  },
  108.  *                              },
  109.  *                          },
  110.  *                      },
  111.  *                  },
  112.  *              },
  113.  *          }
  114.  *     }
  115.  * )
  116.  */
  117. class Image extends \XLite\Model\Base\Image
  118. {
  119.     /**
  120.      * Image position
  121.      *
  122.      * @var integer
  123.      *
  124.      * @ORM\Column (type="integer")
  125.      */
  126.     protected $orderby = 0;
  128.     /**
  129.      * Relation to a product entity
  130.      *
  131.      * @var \XLite\Model\Product
  132.      *
  133.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Product", inversedBy="images")
  134.      * @ORM\JoinColumn (name="product_id", referencedColumnName="product_id", onDelete="CASCADE")
  135.      */
  136.     protected $product;
  138.     /**
  139.      * Alternative image text
  140.      *
  141.      * @var string
  142.      *
  143.      * @ORM\Column (type="string", length=255)
  144.      */
  145.     protected $alt = '';
  147.     /**
  148.      * Set orderby
  149.      *
  150.      * @param integer $orderby
  151.      * @return Image
  152.      */
  153.     public function setOrderby($orderby)
  154.     {
  155.         $this->orderby = $orderby;
  156.         return $this;
  157.     }
  159.     /**
  160.      * Get orderby
  161.      *
  162.      * @return integer
  163.      */
  164.     public function getOrderby()
  165.     {
  166.         return $this->orderby;
  167.     }
  169.     /**
  170.      * Set alt
  171.      *
  172.      * @param string $alt
  173.      * @return Image
  174.      */
  175.     public function setAlt($alt)
  176.     {
  177.         $this->alt = $alt;
  178.         return $this;
  179.     }
  181.     /**
  182.      * Get alt
  183.      *
  184.      * @return string
  185.      */
  186.     public function getAlt()
  187.     {
  188.         return $this->alt;
  189.     }
  191.     /**
  192.      * Set product
  193.      *
  194.      * @param \XLite\Model\Product $product
  195.      * @return Image
  196.      */
  197.     public function setProduct(\XLite\Model\Product $product = null)
  198.     {
  199.         $this->product = $product;
  200.         return $this;
  201.     }
  203.     /**
  204.      * Get product
  205.      *
  206.      * @return \XLite\Model\Product
  207.      */
  208.     public function getProduct()
  209.     {
  210.         return $this->product;
  211.     }
  212. }