modules/CDev/SimpleCMS/src/Model/Page.php line 14

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 CDev\SimpleCMS\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  11. use XLite\Core\Layout;
  13. /**
  14.  * @ORM\Entity
  15.  * @ORM\Table  (name="pages",
  16.  *      indexes={
  17.  *          @ORM\Index (name="enabled", columns={"enabled"}),
  18.  *      }
  19.  * )
  20.  */
  21. class Page extends \XLite\Model\Base\Catalog
  22. {
  23.     public const TYPE_PRIMARY = 'primary';
  24.     public const TYPE_DEFAULT = 'content';
  25.     public const TYPE_SERVICE = 'service';
  27.     /**
  28.      * Unique ID
  29.      *
  30.      * @var integer
  31.      *
  32.      * @ORM\Id
  33.      * @ORM\GeneratedValue (strategy="AUTO")
  34.      * @ORM\Column         (type="integer", options={ "unsigned": true })
  35.      */
  36.     protected $id;
  38.     /**
  39.      * Is menu enabled or not
  40.      *
  41.      * @var boolean
  42.      *
  43.      * @ORM\Column (type="boolean")
  44.      */
  45.     protected $enabled = true;
  47.     /**
  48.      * One-to-one relation with page_images table
  49.      *
  50.      * @var \CDev\SimpleCMS\Model\Image\Page\Image
  51.      *
  52.      * @ORM\OneToOne  (targetEntity="CDev\SimpleCMS\Model\Image\Page\Image", mappedBy="page", cascade={"all"})
  53.      */
  54.     protected $image;
  56.     /**
  57.      * Clean URLs
  58.      *
  59.      * @var \Doctrine\Common\Collections\Collection
  60.      *
  61.      * @ORM\OneToMany (targetEntity="XLite\Model\CleanURL", mappedBy="page", cascade={"all"})
  62.      * @ORM\OrderBy   ({"id" = "ASC"})
  63.      */
  64.     protected $cleanURLs;
  66.     /**
  67.      * Meta description type
  68.      *
  69.      * @var string
  70.      *
  71.      * @ORM\Column (type="string", length=1)
  72.      */
  73.     protected $metaDescType = 'A';
  75.     /**
  76.      * Tab position
  77.      *
  78.      * @var integer
  79.      *
  80.      * @ORM\Column (type="integer")
  81.      */
  82.     protected $position = 0;
  84.     /**
  85.      * @var string
  86.      *
  87.      * @ORM\Column (type="string", length=10, options={"default": "content"})
  88.      */
  89.     protected $type = self::TYPE_DEFAULT;
  91.     /**
  92.      * @var string
  93.      *
  94.      * @ORM\Column (type="string", length=10, options={"default": "default"})
  95.      */
  96.     protected $layoutGroup = Layout::LAYOUT_GROUP_DEFAULT;
  98.     /**
  99.      * @var string
  100.      *
  101.      * @ORM\Column (type="string", length=255, nullable = true)
  102.      */
  103.     protected $adminUrl;
  105.     /**
  106.      * @var string
  107.      *
  108.      * @ORM\Column (type="string", length=255, nullable = true)
  109.      */
  110.     protected $frontUrl;
  112.     /**
  113.      * @var string
  114.      *
  115.      * @ORM\Column (type="string", length=255, nullable = true)
  116.      */
  117.     protected $tooltipText;
  119.     /**
  120.      * @var string
  121.      *
  122.      * @ORM\Column (type="string", length=128, nullable = true)
  123.      */
  124.     protected $module;
  126.     /**
  127.      * @var \Doctrine\Common\Collections\Collection
  128.      *
  129.      * @ORM\OneToMany (targetEntity="CDev\SimpleCMS\Model\PageTranslation", mappedBy="owner", cascade={"all"})
  130.      */
  131.     protected $translations;
  133.     /**
  134.      * Returns meta description
  135.      * todo: rename to getMetaDesc()
  136.      *
  137.      * @return string
  138.      */
  139.     public function getTeaser()
  140.     {
  141.         return $this->getMetaDescType() === 'A' || !$this->getSoftTranslation()->getTeaser()
  142.             ? static::postprocessMetaDescription($this->getBody())
  143.             : $this->getSoftTranslation()->getTeaser();
  144.     }
  146.     /**
  147.      * Returns meta description type
  148.      *
  149.      * @return string
  150.      */
  151.     public function getMetaDescType()
  152.     {
  153.         $result = $this->metaDescType;
  155.         if (!$result) {
  156.             $metaDescPresent = array_reduce($this->getTranslations()->toArray(), static function ($carry, $item) {
  157.                 return $carry ?: (bool) $item->getMetaDesc();
  158.             }, false);
  160.             $result = $metaDescPresent ? 'C' : 'A';
  161.         }
  163.         return $result;
  164.     }
  166.     /**
  167.      * Get id
  168.      *
  169.      * @return integer
  170.      */
  171.     public function getId()
  172.     {
  173.         return $this->id;
  174.     }
  176.     /**
  177.      * Set enabled
  178.      *
  179.      * @param boolean $enabled
  180.      * @return Page
  181.      */
  182.     public function setEnabled($enabled)
  183.     {
  184.         $this->enabled = (bool)$enabled;
  185.         return $this;
  186.     }
  188.     /**
  189.      * Get enabled
  190.      *
  191.      * @return boolean
  192.      */
  193.     public function getEnabled()
  194.     {
  195.         return $this->enabled;
  196.     }
  198.     /**
  199.      * Set metaDescType
  200.      *
  201.      * @param string $metaDescType
  202.      * @return Page
  203.      */
  204.     public function setMetaDescType($metaDescType)
  205.     {
  206.         $this->metaDescType = $metaDescType;
  207.         return $this;
  208.     }
  210.     /**
  211.      * Set image
  212.      *
  213.      * @param \CDev\SimpleCMS\Model\Image\Page\Image $image
  214.      * @return Page
  215.      */
  216.     public function setImage(\CDev\SimpleCMS\Model\Image\Page\Image $image = null)
  217.     {
  218.         $this->image = $image;
  219.         return $this;
  220.     }
  222.     /**
  223.      * Get image
  224.      *
  225.      * @return \CDev\SimpleCMS\Model\Image\Page\Image
  226.      */
  227.     public function getImage()
  228.     {
  229.         return $this->image;
  230.     }
  232.     /**
  233.      * Add cleanURLs
  234.      *
  235.      * @param \XLite\Model\CleanURL $cleanURLs
  236.      * @return Page
  237.      */
  238.     public function addCleanURLs(\XLite\Model\CleanURL $cleanURLs)
  239.     {
  240.         $this->cleanURLs[] = $cleanURLs;
  241.         return $this;
  242.     }
  244.     /**
  245.      * Get cleanURLs
  246.      *
  247.      * @return \Doctrine\Common\Collections\Collection
  248.      */
  249.     public function getCleanURLs()
  250.     {
  251.         return $this->cleanURLs;
  252.     }
  254.     /**
  255.      * Return Position
  256.      *
  257.      * @return int
  258.      */
  259.     public function getPosition()
  260.     {
  261.         return $this->position;
  262.     }
  264.     /**
  265.      * Set Position
  266.      *
  267.      * @param int $position
  268.      *
  269.      * @return $this
  270.      */
  271.     public function setPosition($position)
  272.     {
  273.         $this->position = $position;
  274.         return $this;
  275.     }
  277.     /**
  278.      * @return string
  279.      */
  280.     public function getType()
  281.     {
  282.         return $this->type;
  283.     }
  285.     /**
  286.      * @param string $type
  287.      * @return Page
  288.      */
  289.     public function setType($type)
  290.     {
  291.         $this->type = $type;
  292.         return $this;
  293.     }
  295.     /**
  296.      * @return string
  297.      */
  298.     public function getLayoutGroup()
  299.     {
  300.         return $this->layoutGroup;
  301.     }
  303.     /**
  304.      * @param string $layoutGroup
  305.      * @return Page
  306.      */
  307.     public function setLayoutGroup($layoutGroup)
  308.     {
  309.         $this->layoutGroup = $layoutGroup;
  310.         return $this;
  311.     }
  313.     /**
  314.      * @return string
  315.      */
  316.     public function getFrontUrl()
  317.     {
  318.         return $this->frontUrl;
  319.     }
  321.     /**
  322.      * @return string
  323.      */
  324.     public function getAdminUrl()
  325.     {
  326.         return $this->adminUrl;
  327.     }
  329.     /**
  330.      * @return string|null
  331.      */
  332.     public function getModule()
  333.     {
  334.         return $this->module;
  335.     }
  337.     /**
  338.      * @return bool
  339.      */
  340.     public function isPrimaryPage()
  341.     {
  342.         return $this->getType() === self::TYPE_PRIMARY;
  343.     }
  345.     /**
  346.      * @return bool
  347.      */
  348.     public function isServicePage()
  349.     {
  350.         return $this->getType() === self::TYPE_SERVICE;
  351.     }
  353.     /**
  354.      * @return string
  355.      */
  356.     public function getLayoutType()
  357.     {
  358.         return Layout::getInstance()->getLayoutTypeByGroup($this->getLayoutGroup());
  359.     }
  361.     /**
  362.      * @return string
  363.      */
  364.     public function getLayoutTypeImageUrl()
  365.     {
  366.         return Layout::getInstance()->getResourceWebPath('modules/CDev/SimpleCMS/items_list/cells/layout/images/' . $this->getLayoutType() . '.svg');
  367.     }
  369.     /**
  370.      * @return string
  371.      */
  372.     public function getTooltipText()
  373.     {
  374.         return $this->tooltipText;
  375.     }
  377.     /**
  378.      * @return bool
  379.      */
  380.     public function isCategoryPage()
  381.     {
  382.         return str_contains($this->getFrontUrl() ?? '', 'target=category');
  383.     }
  385.     /**
  386.      * @return bool
  387.      */
  388.     public function isProductPage()
  389.     {
  390.         return str_contains($this->getFrontUrl() ?? '', 'target=product');
  391.     }
  393.     /**
  394.      * @return bool
  395.      */
  396.     public function isFrontPage()
  397.     {
  398.         return $this->getFrontUrl() === '/';
  399.     }
  401.     /**
  402.      * @return bool
  403.      */
  404.     public function isBrandPage()
  405.     {
  406.         return str_contains($this->getFrontUrl() ?? '', 'target=brand');
  407.     }
  409.     // {{{ Translation Getters / setters
  411.     /**
  412.      * @param string $teaser
  413.      *
  414.      * @return \XLite\Model\Base\Translation
  415.      */
  416.     public function setTeaser($teaser)
  417.     {
  418.         return $this->setTranslationField(__FUNCTION__, $teaser);
  419.     }
  421.     /**
  422.      * @return string
  423.      */
  424.     public function getBody()
  425.     {
  426.         return $this->getTranslationField(__FUNCTION__);
  427.     }
  429.     /**
  430.      * @param string $body
  431.      *
  432.      * @return \XLite\Model\Base\Translation
  433.      */
  434.     public function setBody($body)
  435.     {
  436.         return $this->setTranslationField(__FUNCTION__, $body);
  437.     }
  439.     /**
  440.      * @return string
  441.      */
  442.     public function getMetaKeywords()
  443.     {
  444.         return $this->getTranslationField(__FUNCTION__);
  445.     }
  447.     /**
  448.      * @param string $metaKeywords
  449.      *
  450.      * @return \XLite\Model\Base\Translation
  451.      */
  452.     public function setMetaKeywords($metaKeywords)
  453.     {
  454.         return $this->setTranslationField(__FUNCTION__, $metaKeywords);
  455.     }
  457.     /**
  458.      * @return string
  459.      */
  460.     public function getMetaTitle()
  461.     {
  462.         return $this->getTranslationField(__FUNCTION__);
  463.     }
  465.     /**
  466.      * @param string $metaTitle
  467.      *
  468.      * @return \XLite\Model\Base\Translation
  469.      */
  470.     public function setMetaTitle($metaTitle)
  471.     {
  472.         return $this->setTranslationField(__FUNCTION__, $metaTitle);
  473.     }
  475.     /**
  476.      * @return bool
  477.      */
  478.     public function isOneItemPage()
  479.     {
  480.         return $this->isCategoryPage()
  481.             || $this->isProductPage()
  482.             || $this->isBrandPage();
  483.     }
  485.     /**
  486.      * @return string
  487.      */
  488.     public function getCleanURLbyFrontURL()
  489.     {
  490.         $result = '';
  492.         $frontUrl = $this->getFrontUrl();
  493.         if (
  494.             $frontUrl
  495.             && !$this->isOneItemPage()
  496.             && !$this->isFrontPage()
  497.         ) {
  498.             $urlParams = [];
  499.             $urlData = explode('&', str_replace('?', '', $frontUrl));
  500.             if (is_string($urlData)) {
  501.                 $urlData = [$urlData];
  502.             }
  503.             foreach ($urlData as $keyval) {
  504.                 $keyval = explode('=', $keyval);
  505.                 if (count($keyval) == 2) {
  506.                     $name = $keyval[0];
  507.                     $value = $keyval[1];
  508.                     $urlParams[$name] = $value;
  509.                 }
  510.             }
  512.             if ($urlParams && isset($urlParams['target'])) {
  513.                 $target = $urlParams['target'];
  514.                 $action = $urlParams['action'] ?? '';
  515.                 unset($urlParams['target'], $urlParams['action']);
  516.                 $result = \XLite\Core\Converter::buildCleanURL($target, $action, $urlParams);
  517.             }
  518.         }
  520.         return $result;
  521.     }
  523.     /**
  524.      * @return bool
  525.      */
  526.     public function isIncludeToSitemap()
  527.     {
  528.         return !$this->isOneItemPage()
  529.             && !$this->isFrontPage()
  530.             && !$this->isServicePage();
  531.     }
  533.     // }}}
  534. }