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.     /**
  114.      * @ORM\Column(name="anchor_scroll_navigation", type="string", length=255, nullable=true)
  115.      */
  116.     private ?string $anchorScrollNavigation = null;
  118.     private ?array $autoReplacedVariables = null;
  119.     /**
  120.      * @ORM\Column(name="align_with_upper_widget", type="boolean", nullable=true)
  121.      */
  122.     private ?bool $alignWithUpperWidget = null;
  123.     public function __construct()
  124.     {
  125.         $this->categories = new ArrayCollection();
  126.         $this->setPosition(WidgetPosition::BLOCK_1);
  127.         $this->parameters = json_encode([]);
  128.         $this->setWidth(12);
  129.     }
  131.     public function __toString(): string
  132.     {
  133.         return $this->getTitle() ?? '';
  134.     }
  136.     /**
  137.      * @return int
  138.      */
  139.     public function getId(): ?int
  140.     {
  141.         return $this->id;
  142.     }
  144.     /**
  145.      * @param int $id
  146.      */
  147.     public function setId(int $id): void
  148.     {
  149.         $this->id = $id;
  150.     }
  152.     /**
  153.      * @return int|null
  154.      */
  155.     public function getPosition(): ?int
  156.     {
  157.         return $this->position;
  158.     }
  160.     /**
  161.      * @return string
  162.      */
  163.     public function getPositionStr(): string
  164.     {
  165.         return WidgetPosition::getKey($this->position);
  166.     }
  168.     /**
  169.      * @param int|null $position
  170.      * @return $this
  171.      */
  172.     public function setPosition(?int $position): self
  173.     {
  174.         $this->position = $position;
  175.         return $this;
  176.     }
  178.     /**
  179.      * @return string|null
  180.      */
  181.     public function getHandler(): ?string
  182.     {
  183.         return $this->handler;
  184.     }
  186.     /**
  187.      * @param string|null $handler
  188.      * @return $this
  189.      */
  190.     public function setHandler(?string $handler): self
  191.     {
  192.         $this->handler = $handler;
  193.         return $this;
  194.     }
  196.     /**
  197.      * @return bool
  198.      */
  199.     public function getGenerateSlugs(): bool
  200.     {
  201.         return (is_null($this->generateSlugs))
  202.             ? false
  203.             : (bool)$this->generateSlugs;
  204.     }
  206.     /**
  207.      * @param bool $generateSlugs
  208.      * @return $this
  209.      */
  210.     public function setGenerateSlugs(bool $generateSlugs): self
  211.     {
  212.         $this->generateSlugs = $generateSlugs;
  213.         return $this;
  214.     }
  216.     /**
  217.      * @return bool
  218.      */
  219.     public function getDisplayTitle(): bool
  220.     {
  221.         return is_null($this->displayTitle) || (bool)$this->displayTitle;
  222.     }
  224.     /**
  225.      * @param bool $displayTitle
  226.      * @return $this
  227.      */
  228.     public function setDisplayTitle(bool $displayTitle): self
  229.     {
  230.         $this->displayTitle = $displayTitle;
  231.         return $this;
  232.     }
  234.     /**
  235.      * @return Route|null
  236.      */
  237.     public function getRoute(): ?Route
  238.     {
  239.         return $this->route;
  240.     }
  242.     /**
  243.      * @param Route|null $route
  244.      * @return $this
  245.      */
  246.     public function setRoute(?Route $route): self
  247.     {
  248.         $this->route = $route;
  249.         if ($route) $route->addWidget($this);
  251.         return $this;
  252.     }
  254.     /**
  255.      * @return Template|null
  256.      */
  257.     public function getTemplate(): ?Template
  258.     {
  259.         return $this->template;
  260.     }
  262.     /**
  263.      * @param Template|null $template
  264.      * @return $this
  265.      */
  266.     public function setTemplate(?Template $template): self
  267.     {
  268.         $this->template = $template;
  269.         if ($template) {
  270.             $template->addWidget($this);
  271.             $this->setRoute($template->getRoute());
  272.         }
  274.         return $this;
  275.     }
  277.     /**
  278.      * @return string|null
  279.      */
  280.     public function getHtmlContent(): ?string
  281.     {
  282.         return $this->htmlContent;
  283.     }
  285.     /**
  286.      * @param string|null $htmlContent
  287.      * @return $this
  288.      */
  289.     public function setHtmlContent(?string $htmlContent = null): self
  290.     {
  291.         $this->htmlContent = $htmlContent;
  292.         return $this;
  293.     }
  295.     /**
  296.      * @return mixed
  297.      */
  298.     public function getContent()
  299.     {
  300.         return $this->content;
  301.     }
  303.     /**
  304.      * @param $content
  305.      * @return $this
  306.      */
  307.     public function setContent($content): self
  308.     {
  309.         $this->content = $content;
  310.         return $this;
  311.     }
  313.     /**
  314.      * @return mixed
  315.      */
  316.     public function getStaticContent()
  317.     {
  318.         return $this->staticContent;
  319.     }
  321.     /**
  322.      * @param $staticContent
  323.      * @return $this
  324.      */
  325.     public function setStaticContent($staticContent): self
  326.     {
  327.         $this->staticContent = $staticContent;
  328.         return $this;
  329.     }
  331.     /**
  332.      * @return string|null
  333.      */
  334.     public function getStyle(): ?string
  335.     {
  336.         return $this->style;
  337.     }
  339.     /**
  340.      * @param string|null $style
  341.      * @return $this
  342.      */
  343.     public function setStyle(?string $style): self
  344.     {
  345.         $this->style = $style;
  347.         return $this;
  348.     }
  350.     /**
  351.      * @return string|null
  352.      */
  353.     public function getScript(): ?string
  354.     {
  355.         return $this->script;
  356.     }
  358.     /**
  359.      * @param string|null $script
  360.      * @return $this
  361.      */
  362.     public function setScript(?string $script): self
  363.     {
  364.         $this->script = $script;
  366.         return $this;
  367.     }
  369.     /**
  370.      * @return string|null
  371.      */
  372.     public function getAnchorScrollNavigation(): ?string
  373.     {
  374.         return $this->anchorScrollNavigation;
  375.     }
  377.     /**
  378.      * @param string|null $anchorScrollNavigation
  379.      * @return $this
  380.      */
  381.     public function setAnchorScrollNavigation(?string $anchorScrollNavigation): self
  382.     {
  383.         $this->anchorScrollNavigation = $anchorScrollNavigation;
  384.         return $this;
  385.     }
  387.     /**
  388.      * @param int $width
  389.      * @return $this
  390.      */
  391.     public function setWidth(int $width): self
  392.     {
  393.         $this->width = $width;
  394.         return $this;
  395.     }
  397.     /**
  398.      * @return int
  399.      */
  400.     public function getWidth(): int
  401.     {
  402.         return $this->width;
  403.     }
  405.     /**
  406.      * @param int|null $section
  407.      * @return $this
  408.      */
  409.     public function setSection(?int $section): self
  410.     {
  411.         $this->section = $section;
  412.         return $this;
  413.     }
  415.     /**
  416.      * @return int|null
  417.      */
  418.     public function getSection(): ?int
  419.     {
  420.         return $this->section;
  421.     }
  423.     /**
  424.      * @return ?Preset
  425.      */
  426.     public function getPreset(): ?Preset
  427.     {
  428.         return $this->preset;
  429.     }
  431.     /**
  432.      * @param Preset|null $preset
  433.      * @return $this
  434.      */
  435.     public function setPreset(?Preset $preset): self
  436.     {
  437.         $this->preset = $preset;
  439.         return $this;
  440.     }
  442.     /**
  443.      * @param string $name
  444.      * @param Growthbook|null $growthbook
  445.      * @param array|null $commonVariables
  446.      * @return false|mixed|null
  447.      */
  448.     public function getParameter(string $name, ?Growthbook $growthbook = null, ?array $commonVariables = null)
  449.     {
  450.         if ($growthbook) {
  451.             $value = $growthbook->getValue( 'w'.$this->getId().'.'.$name, null);
  452.             if (!is_null($value)) return $value;
  453.         }
  455.         if(!array_key_exists($name, $this->getParameters())){
  456.             return null;
  457.         }
  459.         $parameterValue = $this->getParameters()[$name] ?? null;
  461.         if (is_string($parameterValue) && isset($commonVariables)) {
  462.             if (WidgetHelper::isVariable($parameterValue)) {
  463.                 $normalized = WidgetHelper::normalizeVariable($parameterValue);
  464.                 if (array_key_exists($normalized, $commonVariables)) {
  465.                     return $commonVariables[$normalized];
  466.                 }
  467.             }
  468.         }
  470.         return $this->getParameters()[$name] === 'false'
  471.             ? false
  472.             : $this->getParameters()[$name];
  473.     }
  475.     public function getWidgetSummator(): ?WidgetSummator
  476.     {
  477.         return $this->widgetSummator;
  478.     }
  480.     public function setWidgetSummator(?WidgetSummator $widgetSummator): self
  481.     {
  482.         $this->widgetSummator = $widgetSummator;
  483.         return $this;
  484.     }
  486.     /**
  487.      * @return array|null
  488.      */
  489.     public function getAutoreplacedVariables(): ?array
  490.     {
  491.         return $this->autoReplacedVariables;
  492.     }
  494.     /**
  495.      * @param array|null $autoreplacedVariables
  496.      * @return $this
  497.      */
  498.     public function setAutoreplacedVariables(?array $autoreplacedVariables): self
  499.     {
  500.         $this->autoReplacedVariables = $autoreplacedVariables;
  501.         return $this;
  502.     }
  504.     /**
  505.      * Align current widget visually with the widget above
  506.      */
  507.     public function getAlignWithUpperWidget(): bool
  508.     {
  509.         return (bool)($this->alignWithUpperWidget ?? false);
  510.     }
  512.     public function setAlignWithUpperWidget(?bool $alignWithUpperWidget): self
  513.     {
  514.         $this->alignWithUpperWidget = $alignWithUpperWidget;
  515.         return $this;
  516.     }
  518.     /**
  519.      * @return Collection
  520.      */
  521.     public function getCategories(): Collection
  522.     {
  523.         return $this->categories;
  524.     }
  526.     /**
  527.      * @param WidgetCategory $category
  528.      * @return $this
  529.      */
  530.     public function addCategory(WidgetCategory $category): self
  531.     {
  532.         if (!$this->categories->contains($category)) {
  533.             $this->categories[] = $category;
  534.         }
  536.         return $this;
  537.     }
  539.     /**
  540.      * @param WidgetCategory $category
  541.      * @return $this
  542.      */
  543.     public function removeCategory(WidgetCategory $category): self
  544.     {
  545.         $this->categories->removeElement($category);
  547.         return $this;
  548.     }
  549. }