modules/CDev/FileAttachments/src/Model/Product/Attachment.php line 103

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 CDev\FileAttachments\Model\Product;
  10. use ApiPlatform\Core\Annotation as ApiPlatform;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use CDev\FileAttachments\API\Endpoint\ProductAttachment\DTO\ProductAttachmentInput as Input;
  13. use CDev\FileAttachments\API\Endpoint\ProductAttachment\DTO\ProductAttachmentUpdateInput as Update;
  14. use CDev\FileAttachments\API\Endpoint\ProductAttachment\DTO\ProductAttachmentOutput as Output;
  16. /**
  17.  * Product attachment
  18.  *
  19.  * @ORM\Entity
  20.  * @ORM\Table (
  21.  *     name="product_attachments",
  22.  *     indexes={
  23.  *         @ORM\Index (name="o", columns={"orderby"})
  24.  *     }
  25.  * )
  26.  * @ApiPlatform\ApiResource(
  27.  *     shortName="Product Attachment",
  28.  *     itemOperations={
  29.  *          "get"={
  30.  *              "method"="GET",
  31.  *              "path"="/products/{product_id}/attachments/{id}.{_format}",
  32.  *              "identifiers"={"product_id", "id"},
  33.  *              "requirements"={"product_id"="\d+", "id"="\d+"},
  34.  *              "input"=Input::class,
  35.  *              "output"=Output::class,
  36.  *              "openapi_context"={
  37.  *                  "parameters"={
  38.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  39.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  40.  *                  }
  41.  *              }
  42.  *          },
  43.  *          "put"={
  44.  *              "method"="PUT",
  45.  *              "path"="/products/{product_id}/attachments/{id}.{_format}",
  46.  *              "identifiers"={"product_id", "id"},
  47.  *              "requirements"={"product_id"="\d+", "id"="\d+"},
  48.  *              "input"=Update::class,
  49.  *              "output"=Output::class,
  50.  *              "openapi_context"={
  51.  *                  "parameters"={
  52.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  53.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  54.  *                  }
  55.  *              }
  56.  *          },
  57.  *          "delete"={
  58.  *              "method"="DELETE",
  59.  *              "path"="/products/{product_id}/attachments/{id}.{_format}",
  60.  *              "identifiers"={"product_id", "id"},
  61.  *              "requirements"={"product_id"="\d+", "id"="\d+"},
  62.  *              "input"=Input::class,
  63.  *              "output"=Output::class,
  64.  *              "openapi_context"={
  65.  *                  "parameters"={
  66.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}},
  67.  *                      {"name"="id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  68.  *                  }
  69.  *              }
  70.  *          }
  71.  *     },
  72.  *     collectionOperations={
  73.  *          "get"={
  74.  *              "method"="GET",
  75.  *              "path"="/products/{product_id}/attachments.{_format}",
  76.  *              "identifiers"={"product_id"},
  77.  *              "requirements"={"product_id"="\d+"},
  78.  *              "input"=Input::class,
  79.  *              "output"=Output::class,
  80.  *              "openapi_context"={
  81.  *                  "parameters"={
  82.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  83.  *                  },
  84.  *              }
  85.  *          },
  86.  *          "post"={
  87.  *              "method"="POST",
  88.  *              "path"="/products/{product_id}/attachments.{_format}",
  89.  *              "controller"="xcart.api.cdev.file_attachments.product_attachment.controller",
  90.  *              "identifiers"={"product_id"},
  91.  *              "requirements"={"product_id"="\d+"},
  92.  *              "input"=Input::class,
  93.  *              "output"=Output::class,
  94.  *              "openapi_context"={
  95.  *                  "parameters"={
  96.  *                      {"name"="product_id", "in"="path", "required"=true, "schema"={"type"="integer"}}
  97.  *                  }
  98.  *              }
  99.  *          }
  100.  *     }
  101.  * )
  102.  */
  103. class Attachment extends \XLite\Model\Base\I18n
  104. {
  105.     public const ACCESS_ANY = 'A';
  106.     public const ACCESS_REGISTERED = 'R';
  108.     // {{{ Collumns
  110.     /**
  111.      * @var int
  112.      *
  113.      * @ORM\Id
  114.      * @ORM\GeneratedValue (strategy="AUTO")
  115.      * @ORM\Column (type="integer", options={"unsigned": true})
  116.      */
  117.     protected $id;
  119.     /**
  120.      * @var int
  121.      *
  122.      * @ORM\Column (type="integer")
  123.      */
  124.     protected $orderby = 0;
  126.     // }}}
  128.     // {{{ Associations
  130.     /**
  131.      * Relation to a product entity
  132.      *
  133.      * @var \XLite\Model\Product
  134.      *
  135.      * @ORM\ManyToOne (targetEntity="XLite\Model\Product", inversedBy="attachments")
  136.      * @ORM\JoinColumn (name="product_id", referencedColumnName="product_id", onDelete="CASCADE")
  137.      */
  138.     protected $product;
  140.     /**
  141.      * @var \CDev\FileAttachments\Model\Product\Attachment\Storage
  142.      *
  143.      * @ORM\OneToOne (targetEntity="CDev\FileAttachments\Model\Product\Attachment\Storage", mappedBy="attachment", cascade={"all"}, fetch="EAGER")
  144.      */
  145.     protected $storage;
  147.     /**
  148.      * Access - membership id or [self::ACCESS_ANY, self::ACCESS_REGISTERED]
  149.      *
  150.      * @var string
  151.      *
  152.      * @ORM\Column (type="string")
  153.      */
  154.     protected $access = self::ACCESS_ANY;
  156.     /**
  157.      * @var string
  158.      *
  159.      * @ORM\Column (type="string", length=512, nullable=true)
  160.      */
  161.     protected $remoteUrl;
  163.     /**
  164.      * @var \Doctrine\Common\Collections\Collection
  165.      *
  166.      * @ORM\OneToMany (targetEntity="CDev\FileAttachments\Model\Product\AttachmentTranslation", mappedBy="owner", cascade={"all"})
  167.      */
  168.     protected $translations;
  170.     // }}}
  172.     // {{{ Getters / setters
  174.     /**
  175.      * Get storage
  176.      *
  177.      * @return \CDev\FileAttachments\Model\Product\Attachment\Storage
  178.      */
  179.     public function getStorage($method = null)
  180.     {
  181.         if (!$this->storage) {
  182.             $this->setStorage(new \CDev\FileAttachments\Model\Product\Attachment\Storage());
  183.             if (isset($method)) {
  184.                 $this->storage->setStorageType($this->storage::STORAGE_URL);
  185.             }
  186.             $this->storage->setAttachment($this);
  187.         }
  189.         return $this->storage;
  190.     }
  192.     /**
  193.      * Get public title
  194.      *
  195.      * @return string
  196.      */
  197.     public function getPublicTitle()
  198.     {
  199.         return $this->getTitle() ?: $this->getStorage()->getFileName();
  200.     }
  202.     /**
  203.      * Get public url
  204.      *
  205.      * @return string
  206.      */
  207.     public function getURL()
  208.     {
  209.         return $this->getStorage()->getURL();
  210.     }
  212.     // }}}
  214.     /**
  215.      * Clone for product
  216.      *
  217.      * @param \XLite\Model\Product $product Product
  218.      *
  219.      * @return \XLite\Model\AEntity
  220.      */
  221.     public function cloneEntityForProduct(\XLite\Model\Product $product)
  222.     {
  223.         $newAttachment = parent::cloneEntity();
  225.         $newAttachment->setProduct($product);
  226.         $product->addAttachments($newAttachment);
  228.         $this->getStorage()->cloneEntityForAttachment($newAttachment);
  230.         return $newAttachment;
  231.     }
  233.     /**
  234.      * Get id
  235.      *
  236.      * @return integer
  237.      */
  238.     public function getId()
  239.     {
  240.         return $this->id;
  241.     }
  243.     /**
  244.      * Set orderby
  245.      *
  246.      * @param integer $orderby
  247.      * @return Attachment
  248.      */
  249.     public function setOrderby($orderby)
  250.     {
  251.         $this->orderby = $orderby;
  252.         return $this;
  253.     }
  255.     /**
  256.      * Get orderby
  257.      *
  258.      * @return integer
  259.      */
  260.     public function getOrderby()
  261.     {
  262.         return $this->orderby;
  263.     }
  265.     /**
  266.      * Set product
  267.      *
  268.      * @param \XLite\Model\Product $product
  269.      * @return Attachment
  270.      */
  271.     public function setProduct(\XLite\Model\Product $product = null)
  272.     {
  273.         $this->product = $product;
  274.         return $this;
  275.     }
  277.     /**
  278.      * Get product
  279.      *
  280.      * @return \XLite\Model\Product
  281.      */
  282.     public function getProduct()
  283.     {
  284.         return $this->product;
  285.     }
  287.     /**
  288.      * Set storage
  289.      *
  290.      * @param \CDev\FileAttachments\Model\Product\Attachment\Storage $storage
  291.      * @return Attachment
  292.      */
  293.     public function setStorage(\CDev\FileAttachments\Model\Product\Attachment\Storage $storage = null)
  294.     {
  295.         $this->storage = $storage;
  296.         return $this;
  297.     }
  299.     /**
  300.      * Return Access
  301.      *
  302.      * @return string
  303.      */
  304.     public function getAccess()
  305.     {
  306.         return !empty($this->access) ? $this->access : static::ACCESS_ANY;
  307.     }
  309.     /**
  310.      * Set Access
  311.      *
  312.      * @param string $access
  313.      *
  314.      * @return $this
  315.      */
  316.     public function setAccess($access)
  317.     {
  318.         if ($access instanceof \XLite\Model\Membership) {
  319.             $access = $access->getMembershipId();
  320.         }
  322.         $this->access = $access;
  323.         return $this;
  324.     }
  326.     /**
  327.      * Get attachment icon type
  328.      *
  329.      * @return string
  330.      */
  331.     public function getIconType()
  332.     {
  333.         $ext = strtolower($this->getStorage()->getExtension());
  335.         if (in_array($ext, \XLite\Core\Converter::getArchiveExtensions())) {
  336.             $icon = 'zip';
  337.         } elseif (in_array($ext, \XLite\Core\Converter::getImageExtensions())) {
  338.             $icon = 'image';
  339.         } elseif (in_array($ext, \XLite\Core\Converter::getPhotoshopExtensions())) {
  340.             $icon = 'ps';
  341.         } elseif (in_array($ext, \XLite\Core\Converter::getPresentationExtensions())) {
  342.             $icon = 'powerpoint';
  343.         } elseif (in_array($ext, \XLite\Core\Converter::getAudioExtensions())) {
  344.             $icon = 'music';
  345.         } elseif (in_array($ext, \XLite\Core\Converter::getVideoExtensions())) {
  346.             $icon = 'video';
  347.         } elseif (in_array($ext, ['pdf', 'csv', 'ai', 'exe'])) {
  348.             $icon = $ext;
  349.         } elseif (in_array($ext, \XLite\Core\Converter::getDocumentExtensions())) {
  350.             $icon = 'doc';
  351.         } elseif (in_array($ext, \XLite\Core\Converter::getMSWordExtensions())) {
  352.             $icon = 'word';
  353.         } else {
  354.             $icon = $this->getStorage()->isURL() ? 'url' : 'default';
  355.         }
  357.         return $icon;
  358.     }
  360.     // {{{ Translation Getters / setters
  362.     /**
  363.      * @return string
  364.      */
  365.     public function getTitle()
  366.     {
  367.         return $this->getTranslationField(__FUNCTION__);
  368.     }
  370.     /**
  371.      * @param string $title
  372.      *
  373.      * @return \XLite\Model\Base\Translation
  374.      */
  375.     public function setTitle($title)
  376.     {
  377.         return $this->setTranslationField(__FUNCTION__, $title);
  378.     }
  380.     /**
  381.      * @return string
  382.      */
  383.     public function getDescription()
  384.     {
  385.         return $this->getTranslationField(__FUNCTION__);
  386.     }
  388.     /**
  389.      * @param string $description
  390.      *
  391.      * @return \XLite\Model\Base\Translation
  392.      */
  393.     public function setDescription($description)
  394.     {
  395.         return $this->setTranslationField(__FUNCTION__, $description);
  396.     }
  398.     /**
  399.      * @param string $remoteUrl
  400.      *
  401.      * @return $this
  402.      */
  403.     public function setRemoteUrl($remoteUrl)
  404.     {
  405.         $this->remoteUrl = $remoteUrl;
  406.         return $this;
  407.     }
  409.     /**
  410.      * @return string
  411.      */
  412.     public function getRemoteUrl()
  413.     {
  414.         return $this->remoteUrl;
  415.     }
  417.     // }}}
  418. }