modules/QSL/SpecialOffersBase/src/Model/OfferType.php line 20

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\SpecialOffersBase\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * Special Offer Type model.
  14.  *
  15.  * It stores information on what special offer logic should be used and offer settings.
  16.  *
  17.  * @ORM\Entity (repositoryClass="\QSL\SpecialOffersBase\Model\Repo\OfferType")
  18.  * @ORM\Table  (name="special_offer_types",
  19.  *      indexes={
  20.  *          @ORM\Index (name="type_id", columns={"type_id"}),
  21.  *          @ORM\Index (name="processorClass", columns={"processorClass"}),
  22.  *          @ORM\Index (name="position", columns={"position"}),
  23.  *          @ORM\Index (name="enabled", columns={"enabled"})
  24.  *      }
  25.  * )
  26.  */
  27. class OfferType extends \XLite\Model\Base\I18n
  28. {
  29.     /**
  30.      * Unique identifier of the offer type.
  31.      *
  32.      * @var integer
  33.      *
  34.      * @ORM\Id
  35.      * @ORM\GeneratedValue (strategy="AUTO")
  36.      * @ORM\Column         (type="integer")
  37.      */
  38.     protected $type_id;
  40.     /**
  41.      * Whether the offer type is enabled, or not.
  42.      *
  43.      * @var boolean
  44.      *
  45.      * @ORM\Column (type="boolean")
  46.      */
  47.     protected $enabled = true;
  49.     /**
  50.      * Name of the class that implements the offer logic.
  51.      *
  52.      * @var string
  53.      *
  54.      * @ORM\Column (type="string", length=255)
  55.      */
  56.     protected $processorClass;
  58.     /**
  59.      * Name of the class that implements the View Model logic.
  60.      *
  61.      * @var string
  62.      *
  63.      * @ORM\Column (type="string", length=255)
  64.      */
  65.     protected $viewModelClass;
  67.     /**
  68.      * Position of the exit offer among other ones in the list.
  69.      *
  70.      * @var integer
  71.      *
  72.      * @ORM\Column (type="integer")
  73.      */
  74.     protected $position = 0;
  76.     /**
  77.      * Special offers of this type.
  78.      *
  79.      * @var \Doctrine\Common\Collections\Collection
  80.      *
  81.      * @ORM\OneToMany (targetEntity="QSL\SpecialOffersBase\Model\SpecialOffer", mappedBy="offerType", cascade={"remove"})
  82.      */
  83.     protected $specialOffers; // when the offer type is deleted, the operation cascades to all related offers (via Doctrine)
  85.     /**
  86.      * Cached processor class instance.
  87.      *
  88.      * @var \QSL\SpecialOffersBase\Logic\Order\SpecialOffer\ASpecialOffer
  89.      */
  90.     protected $processor;
  92.     /**
  93.      * @var \Doctrine\Common\Collections\Collection
  94.      *
  95.      * @ORM\OneToMany (targetEntity="QSL\SpecialOffersBase\Model\OfferTypeTranslation", mappedBy="owner", cascade={"all"})
  96.      */
  97.     protected $translations;
  99.     /**
  100.      * Checks if the special offer has correct processor and view model classes.
  101.      *
  102.      * @return boolean
  103.      */
  104.     public function hasAllRequiredClasses()
  105.     {
  106.         return class_exists($this->getProcessorClass())
  107.             && class_exists($this->getViewModelClass());
  108.     }
  110.     /**
  111.      * Returns the processor class for this special offer type.
  112.      *
  113.      * @return \QSL\SpecialOffersBase\Logic\Order\SpecialOffer\ASpecialOffer
  114.      */
  115.     public function getProcessor()
  116.     {
  117.         if (!isset($this->processor)) {
  118.             $this->processor = $this->factoryProcessor();
  119.         }
  121.         return $this->processor;
  122.     }
  124.     /**
  125.      * Creates a new instance of the processor class for this special offer type.
  126.      *
  127.      * @return \QSL\SpecialOffersBase\Logic\Order\SpecialOffer\ASpecialOffer
  128.      */
  129.     protected function factoryProcessor()
  130.     {
  131.         $class = $this->getProcessorClass();
  133.         return class_exists($class) ? new $class() : null;
  134.     }
  136.     /**
  137.      * Returns the model identifier.
  138.      *
  139.      * @return integer
  140.      */
  141.     public function getTypeId()
  142.     {
  143.         return $this->type_id;
  144.     }
  146.     /**
  147.      * Confgiures whether the special offer type is enabled, or disabled.
  148.      *
  149.      * @param boolean $enabled New state
  150.      *
  151.      * @return OfferType
  152.      */
  153.     public function setEnabled($enabled)
  154.     {
  155.         $this->enabled = $enabled;
  157.         return $this;
  158.     }
  160.     /**
  161.      * Checks if the special offer type is enabled, or not.
  162.      *
  163.      * @return boolean
  164.      */
  165.     public function getEnabled()
  166.     {
  167.         return $this->enabled;
  168.     }
  170.     /**
  171.      * Updates the name of the processor class for the special offer.
  172.      *
  173.      * @param string $processorClass Class name
  174.      *
  175.      * @return OfferType
  176.      */
  177.     public function setProcessorClass($processorClass)
  178.     {
  179.         $this->processorClass = $processorClass;
  181.         return $this;
  182.     }
  184.     /**
  185.      * Returns the name of the processor class for the special offer type.
  186.      *
  187.      * @return string
  188.      */
  189.     public function getProcessorClass()
  190.     {
  191.         return $this->processorClass;
  192.     }
  194.     /**
  195.      * Updates the name of the view class for the special offer type.
  196.      *
  197.      * @param string $viewModelClass Class name
  198.      *
  199.      * @return OfferType
  200.      */
  201.     public function setViewModelClass($viewModelClass)
  202.     {
  203.         $this->viewModelClass = $viewModelClass;
  205.         return $this;
  206.     }
  208.     /**
  209.      * Returns the name of the view class for the special offer type.
  210.      *
  211.      * @return string
  212.      */
  213.     public function getViewModelClass()
  214.     {
  215.         return $this->viewModelClass;
  216.     }
  218.     /**
  219.      * Updates the position of the special offer type among others.
  220.      *
  221.      * @param integer $position New position
  222.      *
  223.      * @return OfferType
  224.      */
  225.     public function setPosition($position)
  226.     {
  227.         $this->position = $position;
  229.         return $this;
  230.     }
  232.     /**
  233.      * Returns the position of the special offer type among others.
  234.      *
  235.      * @return integer
  236.      */
  237.     public function getPosition()
  238.     {
  239.         return $this->position;
  240.     }
  242.     /**
  243.      * Associates a special offer with the special offer type.
  244.      *
  245.      * @param \QSL\SpecialOffersBase\Model\SpecialOffer $specialOffers Special offer model
  246.      *
  247.      * @return OfferType
  248.      */
  249.     public function addSpecialOffers(\QSL\SpecialOffersBase\Model\SpecialOffer $specialOffers)
  250.     {
  251.         $this->specialOffers[] = $specialOffers;
  253.         return $this;
  254.     }
  256.     /**
  257.      * Returns special offers of the type.
  258.      *
  259.      * @return \Doctrine\Common\Collections\Collection
  260.      */
  261.     public function getSpecialOffers()
  262.     {
  263.         return $this->specialOffers;
  264.     }
  265. }