src/CmsBundle/Entity/Widget.php line 27

Open in your IDE?
  1. <?php
  3. namespace App\CmsBundle\Entity;
  5. use App\CmsBundle\Enum\WidgetPosition;
  6. use App\CmsBundle\Helper\WidgetHelper;
  7. use Doctrine\Common\Collections\ArrayCollection;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Growthbook\Growthbook;
  10. use Doctrine\Common\Collections\Collection;
  12. /**
  13.  * Widget
  14.  *
  15.  * @ORM\Table(
  16.  *     name="widget",
  17.  *     indexes={
  18.  *         @ORM\Index(name="widget_position_index", columns={"position"}),
  19.  *         @ORM\Index(name="widget_published_index", columns={"published"}),
  20.  *         @ORM\Index(name="widget_template_index", columns={"template_id"}),
  21.  *         @ORM\Index(name="widget_route_index", columns={"route_id"})
  22.  *     }
  23.  * )
  24.  * @ORM\Entity(repositoryClass="App\CmsBundle\Repository\WidgetRepository")
  25.  * @ORM\HasLifecycleCallbacks()
  26.  */
  27. class Widget
  28. {
  29.     use IdTrait, TitleTrait, AlternativeTitleTrait, ParametersTrait, PublishedTrait, TimeStampedTrait;
  31.     /**
  32.      * @ORM\Column(name="summary_title", type="text", length=255, nullable=true)
  33.      */
  34.     private $summaryTitle;
  36.     /**
  37.      * @var integer
  38.      *
  39.      * @ORM\Column(name="position", type="integer", nullable=false)
  40.      */
  41.     private $position;
  43.     /**
  44.      * @ORM\Column(type="string", length=255, nullable=true)
  45.      */
  46.     private $handler;
  48.     /**
  49.      * @ORM\Column(type="boolean", nullable=true)
  50.      */
  51.     private $displayTitle;
  53.     /**
  54.      * @ORM\Column(type="boolean", nullable=true)
  55.      */
  56.     private $generateSlugs;
  58.     /**
  59.      * @ORM\ManyToOne(targetEntity="App\CmsBundle\Entity\Template", inversedBy="widgets", cascade={"persist"})
  60.      * @ORM\JoinColumn(nullable=true)
  61.      */
  62.     private $template;
  64.     /**
  65.      * @ORM\ManyToOne(targetEntity="App\CmsBundle\Entity\Route", inversedBy="widgets", cascade={"persist"})
  66.      * @ORM\JoinColumn(nullable=true)
  67.      */
  68.     private $route;
  70.     /**
  71.      * @ORM\ManyToOne(targetEntity="App\CmsBundle\Entity\Preset", inversedBy="widgets")
  72.      * @ORM\JoinColumn(name="preset_id", referencedColumnName="id")
  73.      */
  74.     private ?Preset $preset = null;
  76.     /**
  77.      * @ORM\Column(type="integer", options={"default":"12"})
  78.      */
  79.     private int $width;
  81.     /**
  82.      * @ORM\Column(type="integer", nullable=true,  options={"default":"1"})
  83.      */
  84.     private ?int $section;
  86.     /**
  87.      * @ORM\ManyToMany(targetEntity=WidgetCategory::class)
  88.      * @ORM\JoinTable(name="widget_widget_category",
  89.      *      joinColumns={@ORM\JoinColumn(name="widget_id", referencedColumnName="id")},
  90.      *      inverseJoinColumns={@ORM\JoinColumn(name="widget_category_id", referencedColumnName="id")}
  91.      * )
  92.      */
  93.     private Collection $categories;
  95.     /**
  96.      * @ORM\OneToOne(
  97.      *     targetEntity="App\CmsBundle\Entity\WidgetSummator",
  98.      *     mappedBy="widget",
  99.      *     cascade={"persist", "remove"})
  100.      */
  101.     private ?WidgetSummator $widgetSummator = null;
  103.     private ?string $htmlContent;
  105.     private $content;
  107.     private $staticContent;
  109.     private ?string $style = null;
  111.     private ?string $script = null;
  113.     private ?array $autoReplacedVariables = null;
  114.     /**
  115.      * @ORM\Column(name="align_with_upper_widget", type="boolean", nullable=true)
  116.      */
  117.     private ?bool $alignWithUpperWidget = null;
  118.     public function __construct()
  119.     {
  120.         $this->categories = new ArrayCollection();
  121.         $this->setPosition(WidgetPosition::BLOCK_1);
  122.         $this->parameters = json_encode([]);
  123.         $this->setWidth(12);
  124.     }
  126.     public function __toString(): string
  127.     {
  128.         return $this->getTitle() ?? '';
  129.     }
  131.     /**
  132.      * @return int
  133.      */
  134.     public function getId(): ?int
  135.     {
  136.         return $this->id;
  137.     }
  139.     /**
  140.      * @param int $id
  141.      */
  142.     public function setId(int $id): void
  143.     {
  144.         $this->id = $id;
  145.     }
  147.     /**
  148.      * @return int|null
  149.      */
  150.     public function getPosition(): ?int
  151.     {
  152.         return $this->position;
  153.     }
  155.     /**
  156.      * @return string
  157.      */
  158.     public function getPositionStr(): string
  159.     {
  160.         return WidgetPosition::getKey($this->position);
  161.     }
  163.     /**
  164.      * @param int|null $position
  165.      * @return $this
  166.      */
  167.     public function setPosition(?int $position): self
  168.     {
  169.         $this->position = $position;
  170.         return $this;
  171.     }
  173.     /**
  174.      * @return string|null
  175.      */
  176.     public function getHandler(): ?string
  177.     {
  178.         return $this->handler;
  179.     }
  181.     /**
  182.      * @param string|null $handler
  183.      * @return $this
  184.      */
  185.     public function setHandler(?string $handler): self
  186.     {
  187.         $this->handler = $handler;
  188.         return $this;
  189.     }
  191.     /**
  192.      * @return bool
  193.      */
  194.     public function getGenerateSlugs(): bool
  195.     {
  196.         return (is_null($this->generateSlugs))
  197.             ? false
  198.             : (bool)$this->generateSlugs;
  199.     }
  201.     /**
  202.      * @param bool $generateSlugs
  203.      * @return $this
  204.      */
  205.     public function setGenerateSlugs(bool $generateSlugs): self
  206.     {
  207.         $this->generateSlugs = $generateSlugs;
  208.         return $this;
  209.     }
  211.     /**
  212.      * @return bool
  213.      */
  214.     public function getDisplayTitle(): bool
  215.     {
  216.         return is_null($this->displayTitle) || (bool)$this->displayTitle;
  217.     }
  219.     /**
  220.      * @param bool $displayTitle
  221.      * @return $this
  222.      */
  223.     public function setDisplayTitle(bool $displayTitle): self
  224.     {
  225.         $this->displayTitle = $displayTitle;
  226.         return $this;
  227.     }
  229.     /**
  230.      * @return Route|null
  231.      */
  232.     public function getRoute(): ?Route
  233.     {
  234.         return $this->route;
  235.     }
  237.     /**
  238.      * @param Route|null $route
  239.      * @return $this
  240.      */
  241.     public function setRoute(?Route $route): self
  242.     {
  243.         $this->route = $route;
  244.         if ($route) $route->addWidget($this);
  246.         return $this;
  247.     }
  249.     /**
  250.      * @return Template|null
  251.      */
  252.     public function getTemplate(): ?Template
  253.     {
  254.         return $this->template;
  255.     }
  257.     /**
  258.      * @param Template|null $template
  259.      * @return $this
  260.      */
  261.     public function setTemplate(?Template $template): self
  262.     {
  263.         $this->template = $template;
  264.         if ($template) {
  265.             $template->addWidget($this);
  266.             $this->setRoute($template->getRoute());
  267.         }
  269.         return $this;
  270.     }
  272.     /**
  273.      * @return string|null
  274.      */
  275.     public function getHtmlContent(): ?string
  276.     {
  277.         return $this->htmlContent;
  278.     }
  280.     /**
  281.      * @param string|null $htmlContent
  282.      * @return $this
  283.      */
  284.     public function setHtmlContent(?string $htmlContent = null): self
  285.     {
  286.         $this->htmlContent = $htmlContent;
  287.         return $this;
  288.     }
  290.     /**
  291.      * @return mixed
  292.      */
  293.     public function getContent()
  294.     {
  295.         return $this->content;
  296.     }
  298.     /**
  299.      * @param $content
  300.      * @return $this
  301.      */
  302.     public function setContent($content): self
  303.     {
  304.         $this->content = $content;
  305.         return $this;
  306.     }
  308.     /**
  309.      * @return mixed
  310.      */
  311.     public function getStaticContent()
  312.     {
  313.         return $this->staticContent;
  314.     }
  316.     /**
  317.      * @param $staticContent
  318.      * @return $this
  319.      */
  320.     public function setStaticContent($staticContent): self
  321.     {
  322.         $this->staticContent = $staticContent;
  323.         return $this;
  324.     }
  326.     /**
  327.      * @return string|null
  328.      */
  329.     public function getStyle(): ?string
  330.     {
  331.         return $this->style;
  332.     }
  334.     /**
  335.      * @param string|null $style
  336.      * @return $this
  337.      */
  338.     public function setStyle(?string $style): self
  339.     {
  340.         $this->style = $style;
  342.         return $this;
  343.     }
  345.     /**
  346.      * @return string|null
  347.      */
  348.     public function getScript(): ?string
  349.     {
  350.         return $this->script;
  351.     }
  353.     /**
  354.      * @param string|null $script
  355.      * @return $this
  356.      */
  357.     public function setScript(?string $script): self
  358.     {
  359.         $this->script = $script;
  361.         return $this;
  362.     }
  364.     /**
  365.      * @param int $width
  366.      * @return $this
  367.      */
  368.     public function setWidth(int $width): self
  369.     {
  370.         $this->width = $width;
  371.         return $this;
  372.     }
  374.     /**
  375.      * @return int
  376.      */
  377.     public function getWidth(): int
  378.     {
  379.         return $this->width;
  380.     }
  382.     /**
  383.      * @param int|null $section
  384.      * @return $this
  385.      */
  386.     public function setSection(?int $section): self
  387.     {
  388.         $this->section = $section;
  389.         return $this;
  390.     }
  392.     /**
  393.      * @return int|null
  394.      */
  395.     public function getSection(): ?int
  396.     {
  397.         return $this->section;
  398.     }
  400.     /**
  401.      * @return ?Preset
  402.      */
  403.     public function getPreset(): ?Preset
  404.     {
  405.         return $this->preset;
  406.     }
  408.     /**
  409.      * @param Preset|null $preset
  410.      * @return $this
  411.      */
  412.     public function setPreset(?Preset $preset): self
  413.     {
  414.         $this->preset = $preset;
  416.         return $this;
  417.     }
  419.     /**
  420.      * @param string $name
  421.      * @param Growthbook|null $growthbook
  422.      * @param array|null $commonVariables
  423.      * @return false|mixed|null
  424.      */
  425.     public function getParameter(string $name, ?Growthbook $growthbook = null, ?array $commonVariables = null)
  426.     {
  427.         if ($growthbook) {
  428.             $value = $growthbook->getValue( 'w'.$this->getId().'.'.$name, null);
  429.             if (!is_null($value)) return $value;
  430.         }
  432.         if(!array_key_exists($name, $this->getParameters())){
  433.             return null;
  434.         }
  436.         $parameterValue = $this->getParameters()[$name] ?? null;
  438.         if (is_string($parameterValue) && isset($commonVariables)) {
  439.             if (WidgetHelper::isVariable($parameterValue)) {
  440.                 $normalized = WidgetHelper::normalizeVariable($parameterValue);
  441.                 if (array_key_exists($normalized, $commonVariables)) {
  442.                     return $commonVariables[$normalized];
  443.                 }
  444.             }
  445.         }
  447.         return $this->getParameters()[$name] === 'false'
  448.             ? false
  449.             : $this->getParameters()[$name];
  450.     }
  452.     public function getWidgetSummator(): ?WidgetSummator
  453.     {
  454.         return $this->widgetSummator;
  455.     }
  457.     public function setWidgetSummator(?WidgetSummator $widgetSummator): self
  458.     {
  459.         $this->widgetSummator = $widgetSummator;
  460.         return $this;
  461.     }
  463.     /**
  464.      * @return array|null
  465.      */
  466.     public function getAutoreplacedVariables(): ?array
  467.     {
  468.         return $this->autoReplacedVariables;
  469.     }
  471.     /**
  472.      * @param array|null $autoreplacedVariables
  473.      * @return $this
  474.      */
  475.     public function setAutoreplacedVariables(?array $autoreplacedVariables): self
  476.     {
  477.         $this->autoReplacedVariables = $autoreplacedVariables;
  478.         return $this;
  479.     }
  481.     /**
  482.      * Align current widget visually with the widget above
  483.      */
  484.     public function getAlignWithUpperWidget(): bool
  485.     {
  486.         return (bool)($this->alignWithUpperWidget ?? false);
  487.     }
  489.     public function setAlignWithUpperWidget(?bool $alignWithUpperWidget): self
  490.     {
  491.         $this->alignWithUpperWidget = $alignWithUpperWidget;
  492.         return $this;
  493.     }
  495.     /**
  496.      * @return Collection
  497.      */
  498.     public function getCategories(): Collection
  499.     {
  500.         return $this->categories;
  501.     }
  503.     /**
  504.      * @param WidgetCategory $category
  505.      * @return $this
  506.      */
  507.     public function addCategory(WidgetCategory $category): self
  508.     {
  509.         if (!$this->categories->contains($category)) {
  510.             $this->categories[] = $category;
  511.         }
  513.         return $this;
  514.     }
  516.     /**
  517.      * @param WidgetCategory $category
  518.      * @return $this
  519.      */
  520.     public function removeCategory(WidgetCategory $category): self
  521.     {
  522.         $this->categories->removeElement($category);
  524.         return $this;
  525.     }
  526. }