classes/XLite/Model/Image/Category/Banner.php line 96

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\Category;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use XLite\API\Endpoint\CategoryBanner\DTO\CategoryBannerInput;
  13. use XLite\API\Endpoint\CategoryBanner\DTO\CategoryBannerOutput;
  14. use XLite\Controller\API\CategoryBanner\DeleteCategoryBanner;
  16. /**
  17.  * Category
  18.  *
  19.  * @ORM\Entity
  20.  * @ORM\Table  (name="category_banners")
  21.  * @ApiPlatform\ApiResource(
  22.  *     shortName="Category Banner",
  23.  *     output=CategoryBannerOutput::class,
  24.  *     itemOperations={
  25.  *         "get"={
  26.  *             "method"="GET",
  27.  *             "path"="/categories/{category_id}/banner.{_format}",
  28.  *             "identifiers"={"category_id"},
  29.  *             "requirements"={"category_id"="\d+"},
  30.  *             "openapi_context"={
  31.  *                  "summary"="Retrieve a banner from a category",
  32.  *                  "parameters"={
  33.  *                      {"name"="category_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  34.  *                  }
  35.  *             },
  36.  *          },
  37.  *         "delete"={
  38.  *             "method"="DELETE",
  39.  *             "path"="/categories/{category_id}/banner.{_format}",
  40.  *             "identifiers"={"category_id"},
  41.  *             "requirements"={"category_id"="\d+"},
  42.  *             "controller"=DeleteCategoryBanner::class,
  43.  *             "read"=false,
  44.  *             "openapi_context"={
  45.  *                  "summary"="Delete a banner from a category",
  46.  *                  "parameters"={
  47.  *                      {"name"="category_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  48.  *                  }
  49.  *             },
  50.  *         },
  51.  *     },
  52.  *     collectionOperations={
  53.  *         "post"={
  54.  *             "method"="POST",
  55.  *             "input"=CategoryBannerInput::class,
  56.  *             "path"="/categories/{category_id}/banner.{_format}",
  57.  *             "identifiers"={"category_id"},
  58.  *             "requirements"={"category_id"="\d+"},
  59.  *             "openapi_context"={
  60.  *                 "summary"="Add a banner to a category",
  61.  *                 "parameters"={
  62.  *                     {"name"="category_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  63.  *                 },
  64.  *                 "requestBody"={
  65.  *                     "content"={
  66.  *                         "application/json"={
  67.  *                             "schema"={
  68.  *                                 "type"="object",
  69.  *                                 "properties"={
  70.  *                                     "alt"={
  71.  *                                         "type"="string",
  72.  *                                         "description"="Alt text"
  73.  *                                     },
  74.  *                                     "externalUrl"={
  75.  *                                         "type"="string",
  76.  *                                         "description"="URL to the image file which will be downloaded from there"
  77.  *                                     },
  78.  *                                     "attachment"={
  79.  *                                         "type"="string",
  80.  *                                         "description"="base64-encoded image"
  81.  *                                     },
  82.  *                                     "filename"={
  83.  *                                         "type"="string",
  84.  *                                         "description"="Image name with correct extension. Required for 'attachement' field."
  85.  *                                     },
  86.  *                                 },
  87.  *                             },
  88.  *                         },
  89.  *                     },
  90.  *                 },
  91.  *             },
  92.  *         }
  93.  *     }
  94.  * )
  95.  */
  96. class Banner extends \XLite\Model\Base\Image
  97. {
  98.     /**
  99.      * Relation to a category entity
  100.      *
  101.      * @var \XLite\Model\Category
  102.      *
  103.      * @ORM\OneToOne   (targetEntity="XLite\Model\Category", inversedBy="banner")
  104.      * @ORM\JoinColumn (name="category_id", referencedColumnName="category_id", onDelete="CASCADE")
  105.      */
  106.     protected $category;
  108.     /**
  109.      * Alternative image text
  110.      *
  111.      * @var string
  112.      *
  113.      * @ORM\Column (type="string", length=255)
  114.      */
  115.     protected $alt = '';
  117.     /**
  118.      * Set alt
  119.      *
  120.      * @param string $alt
  121.      * @return Image
  122.      */
  123.     public function setAlt($alt)
  124.     {
  125.         $this->alt = $alt;
  126.         return $this;
  127.     }
  129.     /**
  130.      * Get alt
  131.      *
  132.      * @return string
  133.      */
  134.     public function getAlt()
  135.     {
  136.         return $this->alt;
  137.     }
  139.     /**
  140.      * Set category
  141.      *
  142.      * @param \XLite\Model\Category $category
  143.      * @return Image
  144.      */
  145.     public function setCategory(\XLite\Model\Category $category = null)
  146.     {
  147.         $this->category = $category;
  148.         return $this;
  149.     }
  151.     /**
  152.      * Get category
  153.      *
  154.      * @return \XLite\Model\Category
  155.      */
  156.     public function getCategory()
  157.     {
  158.         return $this->category;
  159.     }
  160. }