modules/QSL/Banner/src/Model/Banner.php line 17

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 QSL\Banner\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * Banner
  14.  *
  15.  * @ORM\Entity (repositoryClass="\QSL\Banner\Model\Repo\Banner")
  16.  * @ORM\Table (name="banners",
  17.  *    indexes={
  18.  *      @ORM\Index (name="ep", columns={"enabled","position"}),
  19.  *      @ORM\Index (name="effect", columns={"effect"})
  20.  *  }
  21.  * )
  22.  *
  23.  */
  24. class Banner extends \XLite\Model\AEntity
  25. {
  26.     /**
  27.     * banner + category link unique id
  28.     *
  29.     * @var   integer
  30.     *
  31.     * @ORM\Id
  32.     * @ORM\GeneratedValue (strategy="AUTO")
  33.     * @ORM\Column         (type="integer", options={"unsigned": true})
  34.     */
  35.     protected $id;
  37.     /**
  38.     * Title
  39.     *
  40.     * @var   string
  41.     *
  42.     * @ORM\Column (type="string", length=255)
  43.     */
  44.     protected $title;
  46.     /**
  47.     * Title
  48.     *
  49.     * @var   string
  50.     *
  51.     * @ORM\Column (type="string", length=255)
  52.     */
  53.     protected $location;
  56.     /**
  57.     * Categories
  58.     *
  59.     * @var   \Doctrine\Common\Collections\ArrayCollection
  60.     *
  61.     * @ORM\ManyToMany (targetEntity="XLite\Model\Category", inversedBy="banners")
  62.     * @ORM\JoinTable (name="banner_category",
  63.     *      joinColumns={@ORM\JoinColumn(name="banner_id", referencedColumnName="id")},
  64.     *      inverseJoinColumns={@ORM\JoinColumn(name="category_id", referencedColumnName="category_id")}
  65.     * )
  66.     */
  67.     protected $categories;
  70.     /**
  71.     * Banner slides
  72.     *
  73.     * @var   \Doctrine\Common\Collections\Collection
  74.     *
  75.     * @ORM\OneToMany (targetEntity="QSL\Banner\Model\BannerSlide", mappedBy="banner", cascade={"all"})
  76.     * @ORM\OrderBy   ({"position" = "ASC"})
  77.     */
  78.     protected $bannerSlide;
  80.     /**
  81.     * Banner contents
  82.     *
  83.     * @var   \Doctrine\Common\Collections\Collection
  84.     *
  85.     * @ORM\OneToMany (targetEntity="QSL\Banner\Model\Content", mappedBy="banner", cascade={"all"})
  86.     * @ORM\OrderBy   ({"position" = "ASC"})
  87.     */
  88.     protected $contents;
  91.     /**
  92.      * Memberships
  93.      *
  94.      * @var   \Doctrine\Common\Collections\ArrayCollection
  95.      *
  96.      * @ORM\ManyToMany (targetEntity="XLite\Model\Membership", inversedBy="banners")
  97.      * @ORM\JoinTable (name="membership_banner",
  98.      *      joinColumns={@ORM\JoinColumn (name="banner_id", referencedColumnName="id", onDelete="CASCADE")},
  99.      *      inverseJoinColumns={@ORM\JoinColumn (name="membership_id", referencedColumnName="membership_id", onDelete="CASCADE")}
  100.      * )
  101.      */
  102.     protected $memberships;
  104.     /**
  105.     * Banner width
  106.     *
  107.     * @var   integer
  108.     *
  109.     * @ORM\Column (type="integer")
  110.     */
  111.     protected $width = 0;
  113.     /**
  114.     * Banner height
  115.     *
  116.     * @var   integer
  117.     *
  118.     * @ORM\Column (type="integer")
  119.     */
  120.     protected $height = 0;
  122.     /**
  123.     * Sort position
  124.     *
  125.     * @var   integer
  126.     *
  127.     * @ORM\Column (type="integer")
  128.     */
  129.     protected $position = 0;
  131.     /**
  132.     * Enabled
  133.     *
  134.     * @var   boolean
  135.     *
  136.     * @ORM\Column (type="boolean")
  137.     */
  138.     protected $enabled = true;
  140.     /**
  141.      * Enabled
  142.      *
  143.      * @var   boolean
  144.      *
  145.      * @ORM\Column (type="boolean")
  146.      */
  147.     protected $parallax = false;
  149.     /**
  150.     * Roation effect
  151.     *
  152.     * @var  integer
  153.     *
  154.     * @ORM\Column (type="string", length=255)
  155.     */
  156.     protected $effect;
  158.     /**
  159.     * Banner slide delay
  160.     *
  161.     * @var   integer
  162.     *
  163.     * @ORM\Column (type="integer")
  164.     */
  165.     protected $timeout = 4;
  168.     /**
  169.     * Banner animation speed
  170.     *
  171.     * @var   integer
  172.     *
  173.     * @ORM\Column (type="integer")
  174.     */
  175.     protected $delay = 3;
  177.     /**
  178.     * Show on home page
  179.     *
  180.     * @var   boolean
  181.     *
  182.     * @ORM\Column (type="boolean")
  183.     */
  184.     protected $home_page = true;
  186.     /**
  187.      * Show on product pages
  188.      *
  189.      * @var   boolean
  190.      *
  191.      * @ORM\Column (type="boolean", options={"default":true})
  192.      */
  193.     protected $products_pages = true;
  195.     /**
  196.     * Show navigation
  197.     *
  198.     * @var   boolean
  199.     *
  200.     * @ORM\Column (type="boolean")
  201.     */
  202.     protected $navigation = false;
  204.     /**
  205.     * Show arrows
  206.     *
  207.     * @var   boolean
  208.     *
  209.     * @ORM\Column (type="boolean")
  210.     */
  211.     protected $arrows = false;
  214.     /**
  215.      * Banner constructor.
  216.      * @param array $data
  217.      */
  218.     public function __construct(array $data = [])
  219.     {
  220.         $this->categories  = new \Doctrine\Common\Collections\ArrayCollection();
  221.         $this->memberships = new \Doctrine\Common\Collections\ArrayCollection();
  222.         $this->bannerSlide = new \Doctrine\Common\Collections\ArrayCollection();
  223.         $this->contents    = new \Doctrine\Common\Collections\ArrayCollection();
  225.         parent::__construct($data);
  226.     }
  228.     /**
  229.     * Get escaped title
  230.     *
  231.     * @return string
  232.     */
  233.     public function getTitleEscaped()
  234.     {
  235.         return htmlspecialchars($this->getTitle(), ENT_QUOTES);
  236.     }
  239.     /**
  240.      * @return \Doctrine\Common\Collections\ArrayCollection|\Doctrine\Common\Collections\Collection
  241.      */
  242.     public function getBannerSlide()
  243.     {
  244.         return $this->bannerSlide;
  245.     }
  248.     /**
  249.      * @return \Doctrine\Common\Collections\ArrayCollection|\Doctrine\Common\Collections\Collection
  250.      */
  251.     public function getContents()
  252.     {
  253.         return $this->contents;
  254.     }
  256.     /**
  257.      * Add categories
  258.      *
  259.      * @param \XLite\Model\Category $categories
  260.      * @return Banner
  261.      */
  262.     public function addCategories(\XLite\Model\Category $categories)
  263.     {
  264.         //$this->categories[] = $categories;
  265.         $this->getCategories()->add($categories);
  266.         return $this;
  267.     }
  269.     /**
  270.      * Get categories
  271.      *
  272.      * @return \Doctrine\Common\Collections\Collection
  273.      */
  274.     public function getCategories()
  275.     {
  276.         return $this->categories;
  277.     }
  279.     /**
  280.      * Clear categories
  281.      */
  282.     public function clearCategories()
  283.     {
  284.         foreach ($this->getCategories()->getKeys() as $key) {
  285.             $this->getCategories()->remove($key);
  286.         }
  287.     }
  289.     /**
  290.      * Add memberships
  291.      *
  292.      * @param \XLite\Model\Membership $memberships
  293.      * @return Banner
  294.      */
  295.     public function addMemberships(\XLite\Model\Membership $memberships)
  296.     {
  297.         $this->memberships[] = $memberships;
  298.         return $this;
  299.     }
  301.     /**
  302.      * Get memberships
  303.      *
  304.      * @return \Doctrine\Common\Collections\Collection
  305.      */
  306.     public function getMemberships()
  307.     {
  308.         return $this->memberships;
  309.     }
  311.     /**
  312.      * Clear memberships
  313.      */
  314.     public function clearMemberships()
  315.     {
  316.         foreach ($this->getMemberships()->getKeys() as $key) {
  317.             $this->getMemberships()->remove($key);
  318.         }
  319.     }
  321.     /**
  322.      * Get id
  323.      *
  324.      * @return integer
  325.      */
  326.     public function getId()
  327.     {
  328.         return $this->id;
  329.     }
  331.     /**
  332.      * Set enabled
  333.      *
  334.      * @param boolean $enabled
  335.      * @return Banner
  336.      */
  337.     public function setEnabled($enabled)
  338.     {
  339.         $this->enabled = $enabled;
  340.         return $this;
  341.     }
  343.     /**
  344.      * Get enabled
  345.      *
  346.      * @return boolean
  347.      */
  348.     public function getEnabled()
  349.     {
  350.         return $this->enabled;
  351.     }
  353.     /**
  354.      * Set navigation
  355.      *
  356.      * @param boolean $navigation
  357.      * @return Banner
  358.      */
  359.     public function setNavigation($navigation)
  360.     {
  361.         $this->navigation = $navigation;
  362.         return $this;
  363.     }
  365.     /**
  366.      * Get navigation
  367.      *
  368.      * @return boolean
  369.      */
  370.     public function getNavigation()
  371.     {
  372.         return $this->navigation;
  373.     }
  375.     /**
  376.      * Set arrows
  377.      *
  378.      * @param boolean $arrows
  379.      * @return Banner
  380.      */
  381.     public function setArrows($arrows)
  382.     {
  383.         $this->arrows = $arrows;
  384.         return $this;
  385.     }
  387.     /**
  388.      * Get navigation
  389.      *
  390.      * @return boolean
  391.      */
  392.     public function getArrows()
  393.     {
  394.         return $this->arrows;
  395.     }
  398.     /**
  399.      * Set enabled
  400.      *
  401.      * @param boolean $parallax
  402.      * @return Banner
  403.      */
  404.     public function setParallax($parallax)
  405.     {
  406.         $this->parallax = $parallax;
  407.         return $this;
  408.     }
  410.     /**
  411.      * Get enabled
  412.      *
  413.      * @return boolean
  414.      */
  415.     public function getParallax()
  416.     {
  417.         return $this->parallax;
  418.     }
  421.     /**
  422.      * @param $position
  423.      * @return $this
  424.      */
  425.     public function setPosition($position)
  426.     {
  427.         $this->position = $position;
  428.         return $this;
  429.     }
  431.     /**
  432.      * Get position
  433.      *
  434.      * @return boolean
  435.      */
  436.     public function getPosition()
  437.     {
  438.         return $this->position;
  439.     }
  441.     /**
  442.      * @param $timeout
  443.      * @return $this
  444.      */
  445.     public function setTimeout($timeout)
  446.     {
  447.         $this->timeout = $timeout;
  448.         return $this;
  449.     }
  451.     /**
  452.      * Get timeout
  453.      *
  454.      * @return boolean
  455.      */
  456.     public function getTimeout()
  457.     {
  458.         return $this->timeout;
  459.     }
  462.     /**
  463.      * @param $delay
  464.      * @return $this
  465.      */
  466.     public function setDelay($delay)
  467.     {
  468.         $this->delay = $delay;
  469.         return $this;
  470.     }
  472.     /**
  473.      * Get delay
  474.      *
  475.      * @return boolean
  476.      */
  477.     public function getDelay()
  478.     {
  479.         return $this->delay;
  480.     }
  483.     /**
  484.      * @param $height
  485.      * @return $this
  486.      */
  487.     public function setHeight($height)
  488.     {
  489.         $this->height = $height;
  490.         return $this;
  491.     }
  493.     /**
  494.      * Get enabled
  495.      *
  496.      * @return boolean
  497.      */
  498.     public function getHeight()
  499.     {
  500.         return $this->height;
  501.     }
  504.     /**
  505.      * @param $width
  506.      * @return $this
  507.      */
  508.     public function setWidth($width)
  509.     {
  510.         $this->width = $width;
  511.         return $this;
  512.     }
  514.     /**
  515.      * Get enabled
  516.      *
  517.      * @return boolean
  518.      */
  519.     public function getWidth()
  520.     {
  521.         return $this->width;
  522.     }
  525.     /**
  526.      * @param $location
  527.      * @return $this
  528.      */
  529.     public function setLocation($location)
  530.     {
  531.         $this->location = $location;
  532.         return $this;
  533.     }
  535.     /**
  536.      * Get enabled
  537.      *
  538.      * @return boolean
  539.      */
  540.     public function getLocation()
  541.     {
  542.         return $this->location;
  543.     }
  545.     /**
  546.      * @param $products_pages
  547.      * @return $this
  548.      */
  549.     public function setProductsPages($products_pages)
  550.     {
  551.         $this->products_pages = $products_pages;
  552.         return $this;
  553.     }
  555.     /**
  556.      * @return bool
  557.      */
  558.     public function getProductsPages()
  559.     {
  560.         return $this->products_pages;
  561.     }
  563.     /**
  564.      * Set enabled
  565.      *
  566.      * @return integer
  567.      */
  568.     public function setEffect($effect)
  569.     {
  570.         $this->effect = $effect;
  571.         return $this;
  572.     }
  574.     /**
  575.      * Get enabled
  576.      *
  577.      * @return boolean
  578.      */
  579.     public function getEffect()
  580.     {
  581.         return $this->effect;
  582.     }
  586.     /**
  587.      * Add images
  588.      *
  589.      * @param \QSL\Banner\Model\BannerSlide $bannerSlide
  590.      * @return BannerSlide
  591.      */
  592.     public function addImages(\QSL\Banner\Model\BannerSlide $bannerSlide)
  593.     {
  594.         $this->bannerSlide[] = $bannerSlide;
  595.         return $this;
  596.     }
  599.     /**
  600.      * Add images
  601.      *
  602.      * @param \QSL\Banner\Model\Content $contents
  603.      * @return Content
  604.      */
  605.     public function addContents(\QSL\Banner\Model\Content $contents)
  606.     {
  607.         $this->contents[] = $contents;
  608.         return $this;
  609.     }
  610. }