classes/XLite/Model/Product/GlobalTab.php line 15

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\Product;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * The "tab" model class
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table  (name="global_product_tabs",
  17.  *      uniqueConstraints={
  18.  *          @ORM\UniqueConstraint (name="service_name", columns={"service_name"})
  19.  *      }
  20.  * )
  21.  */
  22. class GlobalTab extends \XLite\Model\AEntity implements \XLite\Model\Product\IProductTab, \XLite\Model\Base\IModuleRelatedEntity
  23. {
  24.     public const TYPE_WIDGET = 'widget';
  25.     public const TYPE_LIST = 'list';
  26.     public const TYPE_TEMPLATE = 'template';
  29.     /**
  30.      * Tab unique ID
  31.      *
  32.      * @var integer
  33.      *
  34.      * @ORM\Id
  35.      * @ORM\GeneratedValue (strategy="AUTO")
  36.      * @ORM\Column         (type="integer", options={ "unsigned": true })
  37.      */
  38.     protected $id;
  40.     /**
  41.      * Tab position
  42.      *
  43.      * @var integer
  44.      *
  45.      * @ORM\Column (type="integer")
  46.      */
  47.     protected $position = 0;
  49.     /**
  50.      * Tab name
  51.      *
  52.      * @var string
  53.      *
  54.      * @ORM\Column (type="string", nullable=true)
  55.      */
  56.     protected $service_name;
  58.     /**
  59.      * Tab provider(module namespace or core)
  60.      *
  61.      * @var \XLite\Model\Product\GlobalTabProvider[]
  62.      *
  63.      * @ORM\OneToMany (targetEntity="XLite\Model\Product\GlobalTabProvider", mappedBy="tab", cascade={"all"})
  64.      */
  65.     protected $providers;
  67.     /**
  68.      * @ORM\Column(type="string", nullable=true)
  69.      */
  70.     protected ?string $module = null;
  72.     /**
  73.      * Constructor
  74.      *
  75.      * @param array $data Entity properties OPTIONAL
  76.      */
  77.     public function __construct(array $data = [])
  78.     {
  79.         $this->providers = new \Doctrine\Common\Collections\ArrayCollection();
  81.         parent::__construct($data);
  82.     }
  84.     /**
  85.      * Get id
  86.      *
  87.      * @return integer
  88.      */
  89.     public function getId()
  90.     {
  91.         return $this->id;
  92.     }
  94.     /**
  95.      * Return Position
  96.      *
  97.      * @return int
  98.      */
  99.     public function getPosition()
  100.     {
  101.         return $this->position;
  102.     }
  104.     /**
  105.      * Set Position
  106.      *
  107.      * @param int $position
  108.      *
  109.      * @return $this
  110.      */
  111.     public function setPosition($position)
  112.     {
  113.         $this->position = $position;
  114.         return $this;
  115.     }
  117.     /**
  118.      * Return Name
  119.      *
  120.      * @return string|null
  121.      */
  122.     public function getServiceName()
  123.     {
  124.         return $this->service_name;
  125.     }
  127.     /**
  128.      * Set Name
  129.      *
  130.      * @param string $service_name
  131.      *
  132.      * @return $this
  133.      */
  134.     public function setServiceName($service_name)
  135.     {
  136.         $this->service_name = $service_name;
  137.         return $this;
  138.     }
  140.     /**
  141.      * Return Providers
  142.      *
  143.      * @return GlobalTabProvider[]
  144.      */
  145.     public function getProviders()
  146.     {
  147.         return $this->providers;
  148.     }
  150.     /**
  151.      * Set Providers
  152.      *
  153.      * @param GlobalTabProvider $provider
  154.      *
  155.      * @return $this
  156.      */
  157.     public function addProvider($provider)
  158.     {
  159.         $this->providers[] = $provider;
  160.         return $this;
  161.     }
  163.     /**
  164.      * Get provider by code
  165.      *
  166.      * @param $code
  167.      *
  168.      * @return array
  169.      */
  170.     public function getProviderByCode($code)
  171.     {
  172.         $provider = array_filter($this->getProviders()->toArray(), static function ($v, $k) use ($code) {
  173.             /** @var \XLite\Model\Product\GlobalTabProvider $v */
  174.             return $v->getCode() === $code;
  175.         }, ARRAY_FILTER_USE_BOTH);
  177.         return !empty($provider) ? array_shift($provider) : null;
  178.     }
  180.     /**
  181.      * Check if at least one provider available
  182.      *
  183.      * @return boolean
  184.      */
  185.     public function checkProviders()
  186.     {
  187.         foreach ($this->getProviders() as $provider) {
  188.             if ($provider->checkProvider()) {
  189.                 return true;
  190.             }
  191.         }
  193.         return false;
  194.     }
  196.     /**
  197.      * Check if tab available
  198.      *
  199.      * @return bool
  200.      */
  201.     public function isAvailable()
  202.     {
  203.         return $this->checkProviders();
  204.     }
  206.     /**
  207.      * Returns tab name
  208.      *
  209.      * @return string
  210.      */
  211.     public function getName()
  212.     {
  213.         return static::t($this->getServiceName());
  214.     }
  216.     public function getModule(): ?string
  217.     {
  218.         return $this->module;
  219.     }
  221.     public function setModule(string $module): void
  222.     {
  223.         $this->module = $module;
  224.     }
  225. }