vendor/contao/core-bundle/src/Resources/contao/models/PageModel.php line 294

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. use Contao\CoreBundle\Exception\NoRootPageFoundException;
  14. use Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag\HtmlHeadBag;
  15. use Contao\CoreBundle\Routing\ResponseContext\JsonLd\ContaoPageSchema;
  16. use Contao\CoreBundle\Routing\ResponseContext\JsonLd\JsonLdManager;
  17. use Contao\CoreBundle\Routing\ResponseContext\ResponseContext;
  18. use Contao\CoreBundle\Routing\ResponseContext\ResponseContextAccessor;
  19. use Contao\CoreBundle\Util\LocaleUtil;
  20. use Contao\Model\Collection;
  21. use Contao\Model\Registry;
  22. use Symfony\Cmf\Component\Routing\RouteObjectInterface;
  23. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  25. /**
  26.  * Reads and writes pages
  27.  *
  28.  * @property string|integer         $id
  29.  * @property string|integer         $pid
  30.  * @property string|integer         $sorting
  31.  * @property string|integer         $tstamp
  32.  * @property string                 $title
  33.  * @property string                 $alias
  34.  * @property string                 $type
  35.  * @property string                 $pageTitle
  36.  * @property string                 $language
  37.  * @property string                 $robots
  38.  * @property string|null            $description
  39.  * @property string                 $redirect
  40.  * @property string|integer         $jumpTo
  41.  * @property string|boolean         $redirectBack
  42.  * @property string                 $url
  43.  * @property string|boolean         $target
  44.  * @property string                 $dns
  45.  * @property string                 $staticFiles
  46.  * @property string                 $staticPlugins
  47.  * @property string|boolean         $fallback
  48.  * @property string|boolean         $disableLanguageRedirect
  49.  * @property string|null            $favicon
  50.  * @property string|null            $robotsTxt
  51.  * @property string                 $mailerTransport
  52.  * @property string                 $adminEmail
  53.  * @property string                 $dateFormat
  54.  * @property string                 $timeFormat
  55.  * @property string                 $datimFormat
  56.  * @property string                 $validAliasCharacters
  57.  * @property string|boolean         $useFolderUrl
  58.  * @property string                 $urlPrefix
  59.  * @property string                 $urlSuffix
  60.  * @property string|boolean         $useSSL
  61.  * @property string|boolean         $autoforward
  62.  * @property string|boolean         $protected
  63.  * @property string|array|null      $groups
  64.  * @property string|boolean         $includeLayout
  65.  * @property string|integer         $layout
  66.  * @property string|boolean         $includeCache
  67.  * @property string|integer|boolean $cache
  68.  * @property string|boolean         $alwaysLoadFromCache
  69.  * @property string|integer|boolean $clientCache
  70.  * @property string|boolean         $includeChmod
  71.  * @property string|integer         $cuser
  72.  * @property string|integer         $cgroup
  73.  * @property string                 $chmod
  74.  * @property string|boolean         $noSearch
  75.  * @property string|boolean         $requireItem
  76.  * @property string                 $cssClass
  77.  * @property string                 $sitemap
  78.  * @property string|boolean         $hide
  79.  * @property string|boolean         $guests
  80.  * @property string|integer         $tabindex
  81.  * @property string                 $accesskey
  82.  * @property string|boolean         $published
  83.  * @property string|integer         $start
  84.  * @property string|integer         $stop
  85.  * @property string|boolean         $enforceTwoFactor
  86.  * @property string|integer         $twoFactorJumpTo
  87.  *
  88.  * @property array          $trail
  89.  * @property string         $mainAlias
  90.  * @property string         $mainTitle
  91.  * @property string         $mainPageTitle
  92.  * @property string         $parentAlias
  93.  * @property string         $parentTitle
  94.  * @property string         $parentPageTitle
  95.  * @property string         $folderUrl
  96.  * @property boolean        $isPublic
  97.  * @property integer        $rootId
  98.  * @property string         $rootAlias
  99.  * @property string         $rootTitle
  100.  * @property string         $rootPageTitle
  101.  * @property integer        $rootSorting
  102.  * @property string         $domain
  103.  * @property string         $rootLanguage
  104.  * @property boolean        $rootIsPublic
  105.  * @property boolean        $rootIsFallback
  106.  * @property string|boolean $rootUseSSL
  107.  * @property string         $rootFallbackLanguage
  108.  * @property boolean        $minifyMarkup
  109.  * @property integer        $layoutId
  110.  * @property boolean        $hasJQuery
  111.  * @property boolean        $hasMooTools
  112.  * @property string         $template
  113.  * @property string         $templateGroup
  114.  * @property boolean        $useAutoItem
  115.  *
  116.  * @method static PageModel|null findById($id, array $opt=array())
  117.  * @method static PageModel|null findByPk($id, array $opt=array())
  118.  * @method static PageModel|null findByIdOrAlias($val, array $opt=array())
  119.  * @method static PageModel|null findOneBy($col, $val, array $opt=array())
  120.  * @method static PageModel|null findOneByPid($val, array $opt=array())
  121.  * @method static PageModel|null findOneBySorting($val, array $opt=array())
  122.  * @method static PageModel|null findOneByTstamp($val, array $opt=array())
  123.  * @method static PageModel|null findOneByTitle($val, array $opt=array())
  124.  * @method static PageModel|null findOneByAlias($val, array $opt=array())
  125.  * @method static PageModel|null findOneByType($val, array $opt=array())
  126.  * @method static PageModel|null findOneByPageTitle($val, array $opt=array())
  127.  * @method static PageModel|null findOneByLanguage($val, array $opt=array())
  128.  * @method static PageModel|null findOneByRobots($val, array $opt=array())
  129.  * @method static PageModel|null findOneByDescription($val, array $opt=array())
  130.  * @method static PageModel|null findOneByRedirect($val, array $opt=array())
  131.  * @method static PageModel|null findOneByJumpTo($val, array $opt=array())
  132.  * @method static PageModel|null findOneByRedirectBack($val, array $opt=array())
  133.  * @method static PageModel|null findOneByUrl($val, array $opt=array())
  134.  * @method static PageModel|null findOneByTarget($val, array $opt=array())
  135.  * @method static PageModel|null findOneByDns($val, array $opt=array())
  136.  * @method static PageModel|null findOneByStaticFiles($val, array $opt=array())
  137.  * @method static PageModel|null findOneByStaticPlugins($val, array $opt=array())
  138.  * @method static PageModel|null findOneByFallback($val, array $opt=array())
  139.  * @method static PageModel|null findOneByDisableLanguageRedirect($val, array $opt=array())
  140.  * @method static PageModel|null findOneByFavicon($val, array $opt=array())
  141.  * @method static PageModel|null findOneByRobotsTxt($val, array $opt=array())
  142.  * @method static PageModel|null findOneByMailerTransport($val, array $opt=array())
  143.  * @method static PageModel|null findOneByAdminEmail($val, array $opt=array())
  144.  * @method static PageModel|null findOneByDateFormat($val, array $opt=array())
  145.  * @method static PageModel|null findOneByTimeFormat($val, array $opt=array())
  146.  * @method static PageModel|null findOneByDatimFormat($val, array $opt=array())
  147.  * @method static PageModel|null findOneByValidAliasCharacters($val, array $opt=array())
  148.  * @method static PageModel|null findOneByUseFolderUrl($val, array $opt=array())
  149.  * @method static PageModel|null findOneByUrlPrefix($val, array $opt=array())
  150.  * @method static PageModel|null findOneByUrlSuffix($val, array $opt=array())
  151.  * @method static PageModel|null findOneByUseSSL($val, array $opt=array())
  152.  * @method static PageModel|null findOneByAutoforward($val, array $opt=array())
  153.  * @method static PageModel|null findOneByProtected($val, array $opt=array())
  154.  * @method static PageModel|null findOneByGroups($val, array $opt=array())
  155.  * @method static PageModel|null findOneByIncludeLayout($val, array $opt=array())
  156.  * @method static PageModel|null findOneByLayout($val, array $opt=array())
  157.  * @method static PageModel|null findOneByIncludeCache($val, array $opt=array())
  158.  * @method static PageModel|null findOneByCache($val, array $opt=array())
  159.  * @method static PageModel|null findOneByIncludeChmod($val, array $opt=array())
  160.  * @method static PageModel|null findOneByCuser($val, array $opt=array())
  161.  * @method static PageModel|null findOneByCgroup($val, array $opt=array())
  162.  * @method static PageModel|null findOneByChmod($val, array $opt=array())
  163.  * @method static PageModel|null findOneByNoSearch($val, array $opt=array())
  164.  * @method static PageModel|null findOneByCssClass($val, array $opt=array())
  165.  * @method static PageModel|null findOneBySitemap($val, array $opt=array())
  166.  * @method static PageModel|null findOneByHide($val, array $opt=array())
  167.  * @method static PageModel|null findOneByGuests($val, array $opt=array())
  168.  * @method static PageModel|null findOneByTabindex($val, array $opt=array())
  169.  * @method static PageModel|null findOneByAccesskey($val, array $opt=array())
  170.  * @method static PageModel|null findOneByPublished($val, array $opt=array())
  171.  * @method static PageModel|null findOneByStart($val, array $opt=array())
  172.  * @method static PageModel|null findOneByStop($val, array $opt=array())
  173.  * @method static PageModel|null findOneByEnforceTwoFactor($val, array $opt=array())
  174.  * @method static PageModel|null findOneByTwoFactorJumpTo($val, array $opt=array())
  175.  *
  176.  * @method static Collection|PageModel[]|PageModel|null findByPid($val, array $opt=array())
  177.  * @method static Collection|PageModel[]|PageModel|null findBySorting($val, array $opt=array())
  178.  * @method static Collection|PageModel[]|PageModel|null findByTstamp($val, array $opt=array())
  179.  * @method static Collection|PageModel[]|PageModel|null findByTitle($val, array $opt=array())
  180.  * @method static Collection|PageModel[]|PageModel|null findByAlias($val, array $opt=array())
  181.  * @method static Collection|PageModel[]|PageModel|null findByType($val, array $opt=array())
  182.  * @method static Collection|PageModel[]|PageModel|null findByPageTitle($val, array $opt=array())
  183.  * @method static Collection|PageModel[]|PageModel|null findByLanguage($val, array $opt=array())
  184.  * @method static Collection|PageModel[]|PageModel|null findByRobots($val, array $opt=array())
  185.  * @method static Collection|PageModel[]|PageModel|null findByDescription($val, array $opt=array())
  186.  * @method static Collection|PageModel[]|PageModel|null findByRedirect($val, array $opt=array())
  187.  * @method static Collection|PageModel[]|PageModel|null findByJumpTo($val, array $opt=array())
  188.  * @method static Collection|PageModel[]|PageModel|null findByRedirectBack($val, array $opt=array())
  189.  * @method static Collection|PageModel[]|PageModel|null findByUrl($val, array $opt=array())
  190.  * @method static Collection|PageModel[]|PageModel|null findByTarget($val, array $opt=array())
  191.  * @method static Collection|PageModel[]|PageModel|null findByDns($val, array $opt=array())
  192.  * @method static Collection|PageModel[]|PageModel|null findByStaticFiles($val, array $opt=array())
  193.  * @method static Collection|PageModel[]|PageModel|null findByStaticPlugins($val, array $opt=array())
  194.  * @method static Collection|PageModel[]|PageModel|null findByFallback($val, array $opt=array())
  195.  * @method static Collection|PageModel[]|PageModel|null findByDisableLanguageRedirect($val, array $opt=array())
  196.  * @method static Collection|PageModel[]|PageModel|null findByFavicon($val, array $opt=array())
  197.  * @method static Collection|PageModel[]|PageModel|null findByRobotsTxt($val, array $opt=array())
  198.  * @method static Collection|PageModel[]|PageModel|null findByMailerTransport($val, array $opt=array())
  199.  * @method static Collection|PageModel[]|PageModel|null findByAdminEmail($val, array $opt=array())
  200.  * @method static Collection|PageModel[]|PageModel|null findByDateFormat($val, array $opt=array())
  201.  * @method static Collection|PageModel[]|PageModel|null findByTimeFormat($val, array $opt=array())
  202.  * @method static Collection|PageModel[]|PageModel|null findByDatimFormat($val, array $opt=array())
  203.  * @method static Collection|PageModel[]|PageModel|null findByValidAliasCharacters($val, array $opt=array())
  204.  * @method static Collection|PageModel[]|PageModel|null findByUseFolderUrl($val, array $opt=array())
  205.  * @method static Collection|PageModel[]|PageModel|null findByUrlPrefix($val, array $opt=array())
  206.  * @method static Collection|PageModel[]|PageModel|null findByUrlSuffix($val, array $opt=array())
  207.  * @method static Collection|PageModel[]|PageModel|null findByUseSSL($val, array $opt=array())
  208.  * @method static Collection|PageModel[]|PageModel|null findByAutoforward($val, array $opt=array())
  209.  * @method static Collection|PageModel[]|PageModel|null findByProtected($val, array $opt=array())
  210.  * @method static Collection|PageModel[]|PageModel|null findByGroups($val, array $opt=array())
  211.  * @method static Collection|PageModel[]|PageModel|null findByIncludeLayout($val, array $opt=array())
  212.  * @method static Collection|PageModel[]|PageModel|null findByLayout($val, array $opt=array())
  213.  * @method static Collection|PageModel[]|PageModel|null findByIncludeCache($val, array $opt=array())
  214.  * @method static Collection|PageModel[]|PageModel|null findByCache($val, array $opt=array())
  215.  * @method static Collection|PageModel[]|PageModel|null findByIncludeChmod($val, array $opt=array())
  216.  * @method static Collection|PageModel[]|PageModel|null findByCuser($val, array $opt=array())
  217.  * @method static Collection|PageModel[]|PageModel|null findByCgroup($val, array $opt=array())
  218.  * @method static Collection|PageModel[]|PageModel|null findByChmod($val, array $opt=array())
  219.  * @method static Collection|PageModel[]|PageModel|null findByNoSearch($val, array $opt=array())
  220.  * @method static Collection|PageModel[]|PageModel|null findByCssClass($val, array $opt=array())
  221.  * @method static Collection|PageModel[]|PageModel|null findBySitemap($val, array $opt=array())
  222.  * @method static Collection|PageModel[]|PageModel|null findByHide($val, array $opt=array())
  223.  * @method static Collection|PageModel[]|PageModel|null findByGuests($val, array $opt=array())
  224.  * @method static Collection|PageModel[]|PageModel|null findByTabindex($val, array $opt=array())
  225.  * @method static Collection|PageModel[]|PageModel|null findByAccesskey($val, array $opt=array())
  226.  * @method static Collection|PageModel[]|PageModel|null findByPublished($val, array $opt=array())
  227.  * @method static Collection|PageModel[]|PageModel|null findByStart($val, array $opt=array())
  228.  * @method static Collection|PageModel[]|PageModel|null findByStop($val, array $opt=array())
  229.  * @method static Collection|PageModel[]|PageModel|null findByEnforceTwoFactor($val, array $opt=array())
  230.  * @method static Collection|PageModel[]|PageModel|null findByTwoFactorJumpTo($val, array $opt=array())
  231.  * @method static Collection|PageModel[]|PageModel|null findMultipleByIds($val, array $opt=array())
  232.  * @method static Collection|PageModel[]|PageModel|null findBy($col, $val, array $opt=array())
  233.  * @method static Collection|PageModel[]|PageModel|null findAll(array $opt=array())
  234.  *
  235.  * @method static integer countById($id, array $opt=array())
  236.  * @method static integer countByPid($val, array $opt=array())
  237.  * @method static integer countBySorting($val, array $opt=array())
  238.  * @method static integer countByTstamp($val, array $opt=array())
  239.  * @method static integer countByTitle($val, array $opt=array())
  240.  * @method static integer countByAlias($val, array $opt=array())
  241.  * @method static integer countByType($val, array $opt=array())
  242.  * @method static integer countByPageTitle($val, array $opt=array())
  243.  * @method static integer countByLanguage($val, array $opt=array())
  244.  * @method static integer countByRobots($val, array $opt=array())
  245.  * @method static integer countByDescription($val, array $opt=array())
  246.  * @method static integer countByRedirect($val, array $opt=array())
  247.  * @method static integer countByJumpTo($val, array $opt=array())
  248.  * @method static integer countByRedirectBack($val, array $opt=array())
  249.  * @method static integer countByUrl($val, array $opt=array())
  250.  * @method static integer countByTarget($val, array $opt=array())
  251.  * @method static integer countByDns($val, array $opt=array())
  252.  * @method static integer countByStaticFiles($val, array $opt=array())
  253.  * @method static integer countByStaticPlugins($val, array $opt=array())
  254.  * @method static integer countByFallback($val, array $opt=array())
  255.  * @method static integer countByDisableLanguageRedirect($val, array $opt=array())
  256.  * @method static integer countByFavicon($val, array $opt=array())
  257.  * @method static integer countByRobotsTxt($val, array $opt=array())
  258.  * @method static integer countByMailerTransport($val, array $opt=array())
  259.  * @method static integer countByAdminEmail($val, array $opt=array())
  260.  * @method static integer countByDateFormat($val, array $opt=array())
  261.  * @method static integer countByTimeFormat($val, array $opt=array())
  262.  * @method static integer countByDatimFormat($val, array $opt=array())
  263.  * @method static integer countByValidAliasCharacters($val, array $opt=array())
  264.  * @method static integer countByUseFolderUrl($val, array $opt=array())
  265.  * @method static integer countByUrlPrefix($val, array $opt=array())
  266.  * @method static integer countByUrlSuffix($val, array $opt=array())
  267.  * @method static integer countByUseSSL($val, array $opt=array())
  268.  * @method static integer countByAutoforward($val, array $opt=array())
  269.  * @method static integer countByProtected($val, array $opt=array())
  270.  * @method static integer countByGroups($val, array $opt=array())
  271.  * @method static integer countByIncludeLayout($val, array $opt=array())
  272.  * @method static integer countByLayout($val, array $opt=array())
  273.  * @method static integer countByIncludeCache($val, array $opt=array())
  274.  * @method static integer countByCache($val, array $opt=array())
  275.  * @method static integer countByIncludeChmod($val, array $opt=array())
  276.  * @method static integer countByCuser($val, array $opt=array())
  277.  * @method static integer countByCgroup($val, array $opt=array())
  278.  * @method static integer countByChmod($val, array $opt=array())
  279.  * @method static integer countByNoSearch($val, array $opt=array())
  280.  * @method static integer countByCssClass($val, array $opt=array())
  281.  * @method static integer countBySitemap($val, array $opt=array())
  282.  * @method static integer countByHide($val, array $opt=array())
  283.  * @method static integer countByGuests($val, array $opt=array())
  284.  * @method static integer countByTabindex($val, array $opt=array())
  285.  * @method static integer countByAccesskey($val, array $opt=array())
  286.  * @method static integer countByPublished($val, array $opt=array())
  287.  * @method static integer countByStart($val, array $opt=array())
  288.  * @method static integer countByStop($val, array $opt=array())
  289.  * @method static integer countByEnforceTwoFactor($val, array $opt=array())
  290.  * @method static integer countByTwoFactorJumpTo($val, array $opt=array())
  291.  *
  292.  * @author Leo Feyer <https://github.com/leofeyer>
  293.  */
  294. class PageModel extends Model
  295. {
  296.     /**
  297.      * Table name
  298.      * @var string
  299.      */
  300.     protected static $strTable = 'tl_page';
  302.     /**
  303.      * Details loaded
  304.      * @var boolean
  305.      */
  306.     protected $blnDetailsLoaded = false;
  308.     public function __set($strKey, $varValue)
  309.     {
  310.         // Deprecate setting dynamic page attributes if they are set on the global $objPage
  311.         if (\in_array($strKey, array('pageTitle', 'description', 'robots', 'noSearch'), true) && ($GLOBALS['objPage'] ?? null) === $this)
  312.         {
  313.             trigger_deprecation('contao/core-bundle', '4.12', sprintf('Overriding "%s" is deprecated and will not work in Contao 5.0 anymore. Use the ResponseContext instead.', $strKey));
  315.             /** @var ResponseContext|null $responseContext */
  316.             $responseContext = System::getContainer()->get(ResponseContextAccessor::class)->getResponseContext();
  318.             if (!$responseContext)
  319.             {
  320.                 parent::__set($strKey, $varValue);
  322.                 return;
  323.             }
  325.             if (\in_array($strKey, array('pageTitle', 'description', 'robots')) && $responseContext->has(HtmlHeadBag::class))
  326.             {
  327.                 /** @var HtmlHeadBag $htmlHeadBag */
  328.                 $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  330.                 switch ($strKey)
  331.                 {
  332.                     case 'pageTitle':
  333.                         $htmlHeadBag->setTitle(StringUtil::inputEncodedToPlainText($varValue ?? ''));
  334.                         break;
  336.                     case 'description':
  337.                         $htmlHeadBag->setMetaDescription(StringUtil::inputEncodedToPlainText($varValue ?? ''));
  338.                         break;
  340.                     case 'robots':
  341.                         $htmlHeadBag->setMetaRobots($varValue);
  342.                         break;
  343.                 }
  344.             }
  346.             if ('noSearch' === $strKey && $responseContext->has(JsonLdManager::class))
  347.             {
  348.                 /** @var JsonLdManager $jsonLdManager */
  349.                 $jsonLdManager = $responseContext->get(JsonLdManager::class);
  351.                 if ($jsonLdManager->getGraphForSchema(JsonLdManager::SCHEMA_CONTAO)->has(ContaoPageSchema::class))
  352.                 {
  353.                     /** @var ContaoPageSchema $schema */
  354.                     $schema = $jsonLdManager->getGraphForSchema(JsonLdManager::SCHEMA_CONTAO)->get(ContaoPageSchema::class);
  355.                     $schema->setNoSearch((bool) $varValue);
  356.                 }
  357.             }
  358.         }
  360.         parent::__set($strKey, $varValue);
  361.     }
  363.     /**
  364.      * Find a published page by its ID
  365.      *
  366.      * @param integer $intId      The page ID
  367.      * @param array   $arrOptions An optional options array
  368.      *
  369.      * @return PageModel|null The model or null if there is no published page
  370.      */
  371.     public static function findPublishedById($intId, array $arrOptions=array())
  372.     {
  373.         $t = static::$strTable;
  374.         $arrColumns = array("$t.id=?");
  376.         if (!static::isPreviewMode($arrOptions))
  377.         {
  378.             $time = Date::floorToMinute();
  379.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  380.         }
  382.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  383.     }
  385.     /**
  386.      * Find published pages by their PID
  387.      *
  388.      * @param integer $intPid     The parent ID
  389.      * @param array   $arrOptions An optional options array
  390.      *
  391.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  392.      */
  393.     public static function findPublishedByPid($intPid, array $arrOptions=array())
  394.     {
  395.         $t = static::$strTable;
  396.         $arrColumns = array("$t.pid=?");
  398.         if (!static::isPreviewMode($arrOptions))
  399.         {
  400.             $time = Date::floorToMinute();
  401.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  402.         }
  404.         return static::findBy($arrColumns, $intPid, $arrOptions);
  405.     }
  407.     /**
  408.      * Find the first published root page by its host name and language
  409.      *
  410.      * @param string $strHost     The host name
  411.      * @param mixed  $varLanguage An ISO language code or an array of ISO language codes
  412.      * @param array  $arrOptions  An optional options array
  413.      *
  414.      * @return PageModel|null The model or null if there is no matching root page
  415.      *
  416.      * @deprecated Deprecated since Contao 4.7, to be removed in Contao 5.0.
  417.      */
  418.     public static function findFirstPublishedRootByHostAndLanguage($strHost, $varLanguage, array $arrOptions=array())
  419.     {
  420.         trigger_deprecation('contao/core-bundle', '4.7', 'Using "Contao\PageModel::findFirstPublishedRootByHostAndLanguage()" has been deprecated and will no longer work Contao 5.0.');
  422.         $t = static::$strTable;
  423.         $objDatabase = Database::getInstance();
  425.         if (\is_array($varLanguage))
  426.         {
  427.             $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='')");
  429.             if (!empty($varLanguage))
  430.             {
  431.                 $arrColumns[] = "($t.language IN('" . implode("','", $varLanguage) . "') OR $t.fallback='1')";
  432.             }
  433.             else
  434.             {
  435.                 $arrColumns[] = "$t.fallback='1'";
  436.             }
  438.             if (!isset($arrOptions['order']))
  439.             {
  440.                 $arrOptions['order'] = "$t.dns DESC" . (!empty($varLanguage) ? ", " . $objDatabase->findInSet("$t.language", array_reverse($varLanguage)) . " DESC" : "") . ", $t.sorting";
  441.             }
  443.             if (!static::isPreviewMode($arrOptions))
  444.             {
  445.                 $time = Date::floorToMinute();
  446.                 $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  447.             }
  449.             return static::findOneBy($arrColumns, $strHost, $arrOptions);
  450.         }
  452.         $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='') AND ($t.language=? OR $t.fallback='1')");
  453.         $arrValues = array($strHost, $varLanguage);
  455.         if (!isset($arrOptions['order']))
  456.         {
  457.             $arrOptions['order'] = "$t.dns DESC, $t.fallback";
  458.         }
  460.         if (!static::isPreviewMode($arrOptions))
  461.         {
  462.             $time = Date::floorToMinute();
  463.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  464.         }
  466.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  467.     }
  469.     /**
  470.      * Find the first published page by its parent ID
  471.      *
  472.      * @param integer $intPid     The parent page's ID
  473.      * @param array   $arrOptions An optional options array
  474.      *
  475.      * @return PageModel|null The model or null if there is no published page
  476.      */
  477.     public static function findFirstPublishedByPid($intPid, array $arrOptions=array())
  478.     {
  479.         $t = static::$strTable;
  480.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  482.         if (!static::isPreviewMode($arrOptions))
  483.         {
  484.             $time = Date::floorToMinute();
  485.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  486.         }
  488.         if (!isset($arrOptions['order']))
  489.         {
  490.             $arrOptions['order'] = "$t.sorting";
  491.         }
  493.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  494.     }
  496.     /**
  497.      * Find the first published regular page by its parent ID
  498.      *
  499.      * @param integer $intPid     The parent page's ID
  500.      * @param array   $arrOptions An optional options array
  501.      *
  502.      * @return PageModel|null The model or null if there is no published regular page
  503.      */
  504.     public static function findFirstPublishedRegularByPid($intPid, array $arrOptions=array())
  505.     {
  506.         $t = static::$strTable;
  507.         $arrColumns = array("$t.pid=? AND $t.type='regular'");
  509.         if (!static::isPreviewMode($arrOptions))
  510.         {
  511.             $time = Date::floorToMinute();
  512.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  513.         }
  515.         if (!isset($arrOptions['order']))
  516.         {
  517.             $arrOptions['order'] = "$t.sorting";
  518.         }
  520.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  521.     }
  523.     /**
  524.      * Find an error 401 page by its parent ID
  525.      *
  526.      * @param integer $intPid     The parent page's ID
  527.      * @param array   $arrOptions An optional options array
  528.      *
  529.      * @return PageModel|null The model or null if there is no 401 page
  530.      */
  531.     public static function find401ByPid($intPid, array $arrOptions=array())
  532.     {
  533.         $t = static::$strTable;
  534.         $arrColumns = array("$t.pid=? AND $t.type='error_401'");
  536.         if (!static::isPreviewMode($arrOptions))
  537.         {
  538.             $time = Date::floorToMinute();
  539.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  540.         }
  542.         if (!isset($arrOptions['order']))
  543.         {
  544.             $arrOptions['order'] = "$t.sorting";
  545.         }
  547.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  548.     }
  550.     /**
  551.      * Find an error 403 page by its parent ID
  552.      *
  553.      * @param integer $intPid     The parent page's ID
  554.      * @param array   $arrOptions An optional options array
  555.      *
  556.      * @return PageModel|null The model or null if there is no 403 page
  557.      */
  558.     public static function find403ByPid($intPid, array $arrOptions=array())
  559.     {
  560.         $t = static::$strTable;
  561.         $arrColumns = array("$t.pid=? AND $t.type='error_403'");
  563.         if (!static::isPreviewMode($arrOptions))
  564.         {
  565.             $time = Date::floorToMinute();
  566.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  567.         }
  569.         if (!isset($arrOptions['order']))
  570.         {
  571.             $arrOptions['order'] = "$t.sorting";
  572.         }
  574.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  575.     }
  577.     /**
  578.      * Find an error 404 page by its parent ID
  579.      *
  580.      * @param integer $intPid     The parent page's ID
  581.      * @param array   $arrOptions An optional options array
  582.      *
  583.      * @return PageModel|null The model or null if there is no 404 page
  584.      */
  585.     public static function find404ByPid($intPid, array $arrOptions=array())
  586.     {
  587.         $t = static::$strTable;
  588.         $arrColumns = array("$t.pid=? AND $t.type='error_404'");
  590.         if (!static::isPreviewMode($arrOptions))
  591.         {
  592.             $time = Date::floorToMinute();
  593.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  594.         }
  596.         if (!isset($arrOptions['order']))
  597.         {
  598.             $arrOptions['order'] = "$t.sorting";
  599.         }
  601.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  602.     }
  604.     /**
  605.      * Find pages matching a list of possible alias names
  606.      *
  607.      * @param array $arrAliases An array of possible alias names
  608.      * @param array $arrOptions An optional options array
  609.      *
  610.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  611.      */
  612.     public static function findByAliases($arrAliases, array $arrOptions=array())
  613.     {
  614.         if (empty($arrAliases) || !\is_array($arrAliases))
  615.         {
  616.             return null;
  617.         }
  619.         // Remove everything that is not an alias
  620.         $arrAliases = array_filter(array_map(static function ($v) { return preg_match('/^[\w\/.-]+$/u', $v) ? $v : null; }, $arrAliases));
  622.         // Return if nothing is left
  623.         if (empty($arrAliases))
  624.         {
  625.             return null;
  626.         }
  628.         $t = static::$strTable;
  629.         $arrColumns = array("$t.alias IN('" . implode("','", array_filter($arrAliases)) . "')");
  631.         // Check the publication status (see #4652)
  632.         if (!static::isPreviewMode($arrOptions))
  633.         {
  634.             $time = Date::floorToMinute();
  635.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  636.         }
  638.         if (!isset($arrOptions['order']))
  639.         {
  640.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.alias", $arrAliases);
  641.         }
  643.         return static::findBy($arrColumns, null, $arrOptions);
  644.     }
  646.     /**
  647.      * Find published pages by their ID or aliases
  648.      *
  649.      * @param mixed $varId      The numeric ID or the alias name
  650.      * @param array $arrOptions An optional options array
  651.      *
  652.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  653.      */
  654.     public static function findPublishedByIdOrAlias($varId, array $arrOptions=array())
  655.     {
  656.         $t = static::$strTable;
  657.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  659.         if (!static::isPreviewMode($arrOptions))
  660.         {
  661.             $time = Date::floorToMinute();
  662.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  663.         }
  665.         return static::findBy($arrColumns, $varId, $arrOptions);
  666.     }
  668.     /**
  669.      * Find all published subpages by their parent ID and exclude pages only visible for guests
  670.      *
  671.      * @param integer $intPid        The parent page's ID
  672.      * @param boolean $blnShowHidden If true, hidden pages will be included
  673.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  674.      *
  675.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  676.      *
  677.      * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0;
  678.      *             use PageModel::findPublishedByPid() instead and filter the guests pages yourself
  679.      */
  680.     public static function findPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false)
  681.     {
  682.         @trigger_error('Using PageModel::findPublishedSubpagesWithoutGuestsByPid() has been deprecated and will no longer work Contao 5.0. Use PageModel::findPublishedByPid() instead and filter the guests pages yourself.', E_USER_DEPRECATED);
  684.         $time = Date::floorToMinute();
  685.         $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  686.         $blnFeUserLoggedIn = $tokenChecker->hasFrontendUser();
  687.         $blnBeUserLoggedIn = $tokenChecker->hasBackendUser() && $tokenChecker->isPreviewMode();
  689.         $objSubpages = Database::getInstance()->prepare("SELECT p1.*, (SELECT COUNT(*) FROM tl_page p2 WHERE p2.pid=p1.id AND p2.type!='root' AND p2.type!='error_401' AND p2.type!='error_403' AND p2.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p2.hide='' OR sitemap='map_always')" : " AND p2.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p2.guests=''" : "") . (!$blnBeUserLoggedIn ? " AND p2.published='1' AND (p2.start='' OR p2.start<='$time') AND (p2.stop='' OR p2.stop>'$time')" : "") . ") AS subpages FROM tl_page p1 WHERE p1.pid=? AND p1.type!='root' AND p1.type!='error_401' AND p1.type!='error_403' AND p1.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p1.hide='' OR sitemap='map_always')" : " AND p1.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p1.guests=''" : "") . (!$blnBeUserLoggedIn ? " AND p1.published='1' AND (p1.start='' OR p1.start<='$time') AND (p1.stop='' OR p1.stop>'$time')" : "") . " ORDER BY p1.sorting")
  690.                                               ->execute($intPid);
  692.         if ($objSubpages->numRows < 1)
  693.         {
  694.             return null;
  695.         }
  697.         return static::createCollectionFromDbResult($objSubpages, 'tl_page');
  698.     }
  700.     /**
  701.      * Find all published regular pages by their IDs
  702.      *
  703.      * @param array $arrIds     An array of page IDs
  704.      * @param array $arrOptions An optional options array
  705.      *
  706.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  707.      */
  708.     public static function findPublishedRegularByIds($arrIds, array $arrOptions=array())
  709.     {
  710.         if (empty($arrIds) || !\is_array($arrIds))
  711.         {
  712.             return null;
  713.         }
  715.         $t = static::$strTable;
  716.         $arrColumns = array("$t.id IN(" . implode(',', array_map('\intval', $arrIds)) . ") AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  718.         if (empty($arrOptions['includeRoot']))
  719.         {
  720.             $arrColumns[] = "$t.type!='root'";
  721.         }
  723.         if (!static::isPreviewMode($arrOptions))
  724.         {
  725.             $time = Date::floorToMinute();
  726.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  727.         }
  729.         if (!isset($arrOptions['order']))
  730.         {
  731.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  732.         }
  734.         return static::findBy($arrColumns, null, $arrOptions);
  735.     }
  737.     /**
  738.      * Find all published regular pages by their IDs and exclude pages only visible for guests
  739.      *
  740.      * @param array $arrIds     An array of page IDs
  741.      * @param array $arrOptions An optional options array
  742.      *
  743.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  744.      *
  745.      * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5;
  746.      *             use PageModel::findPublishedRegularByIds() instead.
  747.      */
  748.     public static function findPublishedRegularWithoutGuestsByIds($arrIds, array $arrOptions=array())
  749.     {
  750.         trigger_deprecation('contao/core-bundle', '4.12', 'Using PageModel::findPublishedRegularWithoutGuestsByIds() has been deprecated and will no longer work in Contao 5.0. Use PageModel::findPublishedRegularByIds() instead.');
  752.         if (empty($arrIds) || !\is_array($arrIds))
  753.         {
  754.             return null;
  755.         }
  757.         $t = static::$strTable;
  758.         $arrColumns = array("$t.id IN(" . implode(',', array_map('\intval', $arrIds)) . ") AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  760.         if (empty($arrOptions['includeRoot']))
  761.         {
  762.             $arrColumns[] = "$t.type!='root'";
  763.         }
  765.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  766.         {
  767.             $arrColumns[] = "$t.guests=''";
  768.         }
  770.         if (!static::isPreviewMode($arrOptions))
  771.         {
  772.             $time = Date::floorToMinute();
  773.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  774.         }
  776.         if (!isset($arrOptions['order']))
  777.         {
  778.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  779.         }
  781.         return static::findBy($arrColumns, null, $arrOptions);
  782.     }
  784.     /**
  785.      * Find all published regular pages by their parent IDs
  786.      *
  787.      * @param integer $intPid     The parent page's ID
  788.      * @param array   $arrOptions An optional options array
  789.      *
  790.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  791.      */
  792.     public static function findPublishedRegularByPid($intPid, array $arrOptions=array())
  793.     {
  794.         $t = static::$strTable;
  795.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  797.         if (!static::isPreviewMode($arrOptions))
  798.         {
  799.             $time = Date::floorToMinute();
  800.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  801.         }
  803.         if (!isset($arrOptions['order']))
  804.         {
  805.             $arrOptions['order'] = "$t.sorting";
  806.         }
  808.         return static::findBy($arrColumns, $intPid, $arrOptions);
  809.     }
  811.     /**
  812.      * Find all published regular pages by their parent IDs and exclude pages only visible for guests
  813.      *
  814.      * @param integer $intPid     The parent page's ID
  815.      * @param array   $arrOptions An optional options array
  816.      *
  817.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  818.      *
  819.      * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5;
  820.      *             use PageModel::findPublishedRegularByPid() instead.
  821.      */
  822.     public static function findPublishedRegularWithoutGuestsByPid($intPid, array $arrOptions=array())
  823.     {
  824.         trigger_deprecation('contao/core-bundle', '4.12', 'Using PageModel::findPublishedRegularWithoutGuestsByPid() has been deprecated and will no longer work in Contao 5.0. Use PageModel::findPublishedRegularByPid() instead.');
  826.         $t = static::$strTable;
  827.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  829.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  830.         {
  831.             $arrColumns[] = "$t.guests=''";
  832.         }
  834.         if (!static::isPreviewMode($arrOptions))
  835.         {
  836.             $time = Date::floorToMinute();
  837.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  838.         }
  840.         if (!isset($arrOptions['order']))
  841.         {
  842.             $arrOptions['order'] = "$t.sorting";
  843.         }
  845.         return static::findBy($arrColumns, $intPid, $arrOptions);
  846.     }
  848.     /**
  849.      * Find the language fallback page by hostname
  850.      *
  851.      * @param string $strHost    The hostname
  852.      * @param array  $arrOptions An optional options array
  853.      *
  854.      * @return PageModel|Model|null The model or null if there is not fallback page
  855.      */
  856.     public static function findPublishedFallbackByHostname($strHost, array $arrOptions=array())
  857.     {
  858.         // Try to load from the registry (see #8544)
  859.         if (empty($arrOptions))
  860.         {
  861.             $objModel = Registry::getInstance()->fetch(static::$strTable, $strHost, 'contao.dns-fallback');
  863.             if ($objModel !== null)
  864.             {
  865.                 return $objModel;
  866.             }
  867.         }
  869.         $t = static::$strTable;
  870.         $arrColumns = array("$t.dns=? AND $t.fallback='1'");
  872.         if (isset($arrOptions['fallbackToEmpty']) && $arrOptions['fallbackToEmpty'] === true)
  873.         {
  874.             $arrColumns = array("($t.dns=? OR $t.dns='') AND $t.fallback='1'");
  875.         }
  877.         if (!static::isPreviewMode($arrOptions))
  878.         {
  879.             $time = Date::floorToMinute();
  880.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  881.         }
  883.         return static::findOneBy($arrColumns, $strHost, $arrOptions);
  884.     }
  886.     /**
  887.      * Finds the published root pages
  888.      *
  889.      * @param array $arrOptions An optional options array
  890.      *
  891.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  892.      */
  893.     public static function findPublishedRootPages(array $arrOptions=array())
  894.     {
  895.         $t = static::$strTable;
  896.         $arrColumns = array("$t.type='root'");
  898.         if (isset($arrOptions['dns']))
  899.         {
  900.             $arrColumns = array("$t.type='root' AND $t.dns=?");
  901.         }
  903.         if (!static::isPreviewMode($arrOptions))
  904.         {
  905.             $time = Date::floorToMinute();
  906.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  907.         }
  909.         return static::findBy($arrColumns, $arrOptions['dns'] ?? null, $arrOptions);
  910.     }
  912.     /**
  913.      * Find the parent pages of a page
  914.      *
  915.      * @param integer $intId The page's ID
  916.      *
  917.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  918.      */
  919.     public static function findParentsById($intId)
  920.     {
  921.         $arrModels = array();
  923.         while ($intId > 0 && ($objPage = static::findByPk($intId)) !== null)
  924.         {
  925.             $intId = $objPage->pid;
  926.             $arrModels[] = $objPage;
  927.         }
  929.         if (empty($arrModels))
  930.         {
  931.             return null;
  932.         }
  934.         return static::createCollection($arrModels, 'tl_page');
  935.     }
  937.     /**
  938.      * Find the first active page by its member groups
  939.      *
  940.      * @param array $arrIds An array of member group IDs
  941.      *
  942.      * @return PageModel|null The model or null if there is no matching member group
  943.      */
  944.     public static function findFirstActiveByMemberGroups($arrIds)
  945.     {
  946.         if (empty($arrIds) || !\is_array($arrIds))
  947.         {
  948.             return null;
  949.         }
  951.         $time = Date::floorToMinute();
  952.         $objDatabase = Database::getInstance();
  953.         $arrIds = array_map('\intval', $arrIds);
  955.         $objResult = $objDatabase->prepare("SELECT p.* FROM tl_member_group g LEFT JOIN tl_page p ON g.jumpTo=p.id WHERE g.id IN(" . implode(',', $arrIds) . ") AND g.jumpTo>0 AND g.redirect='1' AND g.disable!='1' AND (g.start='' OR g.start<='$time') AND (g.stop='' OR g.stop>'$time') AND p.published='1' AND (p.start='' OR p.start<='$time') AND (p.stop='' OR p.stop>'$time') ORDER BY " . $objDatabase->findInSet('g.id', $arrIds))
  956.                                  ->limit(1)
  957.                                  ->execute();
  959.         if ($objResult->numRows < 1)
  960.         {
  961.             return null;
  962.         }
  964.         $objRegistry = Registry::getInstance();
  966.         /** @var PageModel|Model $objPage */
  967.         if ($objPage = $objRegistry->fetch('tl_page', $objResult->id))
  968.         {
  969.             return $objPage;
  970.         }
  972.         return new static($objResult);
  973.     }
  975.     /**
  976.      * Find a page by its ID and return it with the inherited details
  977.      *
  978.      * @param integer|string $intId The page's ID
  979.      *
  980.      * @return PageModel|null The model or null if there is no matching page
  981.      */
  982.     public static function findWithDetails($intId)
  983.     {
  984.         $objPage = static::findByPk($intId);
  986.         if ($objPage === null)
  987.         {
  988.             return null;
  989.         }
  991.         return $objPage->loadDetails();
  992.     }
  994.     /**
  995.      * Register the contao.dns-fallback alias when the model is attached to the registry
  996.      *
  997.      * @param Registry $registry The model registry
  998.      */
  999.     public function onRegister(Registry $registry)
  1000.     {
  1001.         parent::onRegister($registry);
  1003.         // Register this model as being the fallback page for a given dns
  1004.         if ($this->fallback && $this->type == 'root' && !$registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  1005.         {
  1006.             $registry->registerAlias($this, 'contao.dns-fallback', $this->dns);
  1007.         }
  1008.     }
  1010.     /**
  1011.      * Unregister the contao.dns-fallback alias when the model is detached from the registry
  1012.      *
  1013.      * @param Registry $registry The model registry
  1014.      */
  1015.     public function onUnregister(Registry $registry)
  1016.     {
  1017.         parent::onUnregister($registry);
  1019.         // Unregister the fallback page
  1020.         if ($this->fallback && $this->type == 'root' && $registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  1021.         {
  1022.             $registry->unregisterAlias($this, 'contao.dns-fallback', $this->dns);
  1023.         }
  1024.     }
  1026.     /**
  1027.      * Get the details of a page including inherited parameters
  1028.      *
  1029.      * @return PageModel The page model
  1030.      *
  1031.      * @throws NoRootPageFoundException If no root page is found
  1032.      */
  1033.     public function loadDetails()
  1034.     {
  1035.         // Loaded already
  1036.         if ($this->blnDetailsLoaded)
  1037.         {
  1038.             return $this;
  1039.         }
  1041.         // Set some default values
  1042.         $this->protected = (bool) $this->protected;
  1043.         $this->groups = $this->protected ? StringUtil::deserialize($this->groups, true) : array();
  1044.         $this->layout = $this->includeLayout ? $this->layout : false;
  1045.         $this->cache = $this->includeCache ? $this->cache : false;
  1046.         $this->alwaysLoadFromCache = $this->includeCache ? $this->alwaysLoadFromCache : false;
  1047.         $this->clientCache = $this->includeCache ? $this->clientCache : false;
  1049.         $pid = $this->pid;
  1050.         $type = $this->type;
  1051.         $alias = $this->alias;
  1052.         $name = $this->title;
  1053.         $title = $this->pageTitle ?: $this->title;
  1054.         $folderUrl = '';
  1055.         $palias = '';
  1056.         $pname = '';
  1057.         $ptitle = '';
  1058.         $trail = array($this->id, $pid);
  1059.         $time = time();
  1061.         // Inherit the settings
  1062.         if ($this->type == 'root')
  1063.         {
  1064.             $objParentPage = $this; // see #4610
  1065.         }
  1066.         else
  1067.         {
  1068.             // Load all parent pages
  1069.             $objParentPage = self::findParentsById($pid);
  1071.             if ($objParentPage !== null)
  1072.             {
  1073.                 while ($pid > 0 && $type != 'root' && $objParentPage->next())
  1074.                 {
  1075.                     $pid = $objParentPage->pid;
  1076.                     $type = $objParentPage->type;
  1078.                     // Parent title
  1079.                     if (!$ptitle)
  1080.                     {
  1081.                         $palias = $objParentPage->alias;
  1082.                         $pname = $objParentPage->title;
  1083.                         $ptitle = $objParentPage->pageTitle ?: $objParentPage->title;
  1084.                     }
  1086.                     // Page title
  1087.                     if ($type != 'root')
  1088.                     {
  1089.                         // If $folderUrl is not yet set, use the alias of the first
  1090.                         // parent page if it is not a root page (see #2129)
  1091.                         if (!$folderUrl && $objParentPage->alias)
  1092.                         {
  1093.                             $folderUrl = $objParentPage->alias . '/';
  1094.                         }
  1096.                         $alias = $objParentPage->alias;
  1097.                         $name = $objParentPage->title;
  1098.                         $title = $objParentPage->pageTitle ?: $objParentPage->title;
  1099.                         $trail[] = $objParentPage->pid;
  1100.                     }
  1102.                     // Cache
  1103.                     if ($objParentPage->includeCache)
  1104.                     {
  1105.                         $this->cache = $this->cache !== false ? $this->cache : $objParentPage->cache;
  1106.                         $this->alwaysLoadFromCache = $this->alwaysLoadFromCache !== false ? $this->alwaysLoadFromCache : $objParentPage->alwaysLoadFromCache;
  1107.                         $this->clientCache = $this->clientCache !== false ? $this->clientCache : $objParentPage->clientCache;
  1108.                     }
  1110.                     // Layout
  1111.                     if ($objParentPage->includeLayout && $this->layout === false)
  1112.                     {
  1113.                         $this->layout = $objParentPage->layout;
  1114.                     }
  1116.                     // Protection
  1117.                     if ($objParentPage->protected && $this->protected === false)
  1118.                     {
  1119.                         $this->protected = true;
  1120.                         $this->groups = StringUtil::deserialize($objParentPage->groups, true);
  1121.                     }
  1122.                 }
  1123.             }
  1125.             // Set the titles
  1126.             $this->mainAlias = $alias;
  1127.             $this->mainTitle = $name;
  1128.             $this->mainPageTitle = $title;
  1129.             $this->parentAlias = $palias;
  1130.             $this->parentTitle = $pname;
  1131.             $this->parentPageTitle = $ptitle;
  1132.             $this->folderUrl = $folderUrl;
  1133.         }
  1135.         // Set the root ID and title
  1136.         if ($objParentPage !== null && $objParentPage->type == 'root')
  1137.         {
  1138.             $this->rootId = $objParentPage->id;
  1139.             $this->rootAlias = $objParentPage->alias;
  1140.             $this->rootTitle = $objParentPage->title;
  1141.             $this->rootPageTitle = $objParentPage->pageTitle ?: $objParentPage->title;
  1142.             $this->rootSorting = $objParentPage->sorting;
  1143.             $this->domain = $objParentPage->dns;
  1144.             $this->rootLanguage = $objParentPage->language;
  1145.             $this->language = $objParentPage->language;
  1146.             $this->staticFiles = $objParentPage->staticFiles;
  1147.             $this->staticPlugins = $objParentPage->staticPlugins;
  1148.             $this->dateFormat = $objParentPage->dateFormat;
  1149.             $this->timeFormat = $objParentPage->timeFormat;
  1150.             $this->datimFormat = $objParentPage->datimFormat;
  1151.             $this->validAliasCharacters = $objParentPage->validAliasCharacters;
  1152.             $this->urlPrefix = $objParentPage->urlPrefix;
  1153.             $this->urlSuffix = $objParentPage->urlSuffix;
  1154.             $this->disableLanguageRedirect = $objParentPage->disableLanguageRedirect;
  1155.             $this->adminEmail = $objParentPage->adminEmail;
  1156.             $this->enforceTwoFactor = $objParentPage->enforceTwoFactor;
  1157.             $this->twoFactorJumpTo = $objParentPage->twoFactorJumpTo;
  1158.             $this->useFolderUrl = $objParentPage->useFolderUrl;
  1159.             $this->mailerTransport = $objParentPage->mailerTransport;
  1160.             $this->useAutoItem = Config::get('useAutoItem');
  1162.             // Store whether the root page has been published
  1163.             $this->rootIsPublic = ($objParentPage->published && (!$objParentPage->start || $objParentPage->start <= $time) && (!$objParentPage->stop || $objParentPage->stop > $time));
  1164.             $this->rootIsFallback = (bool) $objParentPage->fallback;
  1165.             $this->rootUseSSL = $objParentPage->useSSL;
  1166.             $this->rootFallbackLanguage = $objParentPage->language;
  1168.             // Store the fallback language (see #6874)
  1169.             if (!$objParentPage->fallback)
  1170.             {
  1171.                 $this->rootFallbackLanguage = null;
  1173.                 $objFallback = static::findPublishedFallbackByHostname($objParentPage->dns);
  1175.                 if ($objFallback !== null)
  1176.                 {
  1177.                     $this->rootFallbackLanguage = $objFallback->language;
  1178.                 }
  1179.             }
  1181.             if (System::getContainer()->getParameter('contao.legacy_routing'))
  1182.             {
  1183.                 $this->urlPrefix = System::getContainer()->getParameter('contao.prepend_locale') ? LocaleUtil::formatAsLanguageTag($objParentPage->language) : '';
  1184.                 $this->urlSuffix = System::getContainer()->getParameter('contao.url_suffix');
  1185.             }
  1186.         }
  1188.         // No root page found
  1189.         elseif (TL_MODE == 'FE' && $this->type != 'root')
  1190.         {
  1191.             System::log('Page ID "' . $this->id . '" does not belong to a root page', __METHOD__, TL_ERROR);
  1193.             throw new NoRootPageFoundException('No root page found');
  1194.         }
  1196.         $this->trail = array_reverse($trail);
  1198.         // Use the global date format if none is set (see #6104)
  1199.         if (!$this->dateFormat)
  1200.         {
  1201.             $this->dateFormat = Config::get('dateFormat');
  1202.         }
  1204.         if (!$this->timeFormat)
  1205.         {
  1206.             $this->timeFormat = Config::get('timeFormat');
  1207.         }
  1209.         if (!$this->datimFormat)
  1210.         {
  1211.             $this->datimFormat = Config::get('datimFormat');
  1212.         }
  1214.         $this->isPublic = ($this->published && (!$this->start || $this->start <= $time) && (!$this->stop || $this->stop > $time));
  1216.         // HOOK: add custom logic
  1217.         if (!empty($GLOBALS['TL_HOOKS']['loadPageDetails']) && \is_array($GLOBALS['TL_HOOKS']['loadPageDetails']))
  1218.         {
  1219.             $parentModels = array();
  1221.             if ($objParentPage instanceof Collection)
  1222.             {
  1223.                 $parentModels = $objParentPage->getModels();
  1224.             }
  1226.             foreach ($GLOBALS['TL_HOOKS']['loadPageDetails'] as $callback)
  1227.             {
  1228.                 System::importStatic($callback[0])->{$callback[1]}($parentModels, $this);
  1229.             }
  1230.         }
  1232.         // Prevent saving (see #6506 and #7199)
  1233.         $this->preventSaving();
  1234.         $this->blnDetailsLoaded = true;
  1236.         return $this;
  1237.     }
  1239.     /**
  1240.      * Generate a front end URL
  1241.      *
  1242.      * @param string $strParams    An optional string of URL parameters
  1243.      * @param string $strForceLang Force a certain language
  1244.      *
  1245.      * @return string An URL that can be used in the front end
  1246.      */
  1247.     public function getFrontendUrl($strParams=null, $strForceLang=null)
  1248.     {
  1249.         $page = $this;
  1250.         $page->loadDetails();
  1252.         if ($strForceLang !== null)
  1253.         {
  1254.             trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\PageModel::getFrontendUrl()" with $strForceLang has been deprecated and will no longer work in Contao 5.0.');
  1256.             $strForceLang = LocaleUtil::formatAsLanguageTag($strForceLang);
  1258.             $page = $page->cloneOriginal();
  1259.             $page->preventSaving(false);
  1260.             $page->language = $strForceLang;
  1261.             $page->rootLanguage = $strForceLang;
  1263.             if (System::getContainer()->getParameter('contao.legacy_routing'))
  1264.             {
  1265.                 $page->urlPrefix = System::getContainer()->getParameter('contao.prepend_locale') ? $strForceLang : '';
  1266.             }
  1267.         }
  1269.         $objRouter = System::getContainer()->get('router');
  1270.         $strUrl = $objRouter->generate(RouteObjectInterface::OBJECT_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $this, 'parameters' => $strParams));
  1272.         // Make the URL relative to the base path
  1273.         if (0 === strncmp($strUrl, '/', 1) && 0 !== strncmp($strUrl, '//', 2))
  1274.         {
  1275.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1276.         }
  1278.         return $this->applyLegacyLogic($strUrl, $strParams);
  1279.     }
  1281.     /**
  1282.      * Generate an absolute URL depending on the current rewriteURL setting
  1283.      *
  1284.      * @param string $strParams An optional string of URL parameters
  1285.      *
  1286.      * @return string An absolute URL that can be used in the front end
  1287.      */
  1288.     public function getAbsoluteUrl($strParams=null)
  1289.     {
  1290.         $this->loadDetails();
  1292.         $objRouter = System::getContainer()->get('router');
  1293.         $strUrl = $objRouter->generate(RouteObjectInterface::OBJECT_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $this, 'parameters' => $strParams), UrlGeneratorInterface::ABSOLUTE_URL);
  1295.         return $this->applyLegacyLogic($strUrl, $strParams);
  1296.     }
  1298.     /**
  1299.      * Generate the front end preview URL
  1300.      *
  1301.      * @param string $strParams An optional string of URL parameters
  1302.      *
  1303.      * @return string The front end preview URL
  1304.      */
  1305.     public function getPreviewUrl($strParams=null)
  1306.     {
  1307.         $container = System::getContainer();
  1309.         if (!$previewScript = $container->getParameter('contao.preview_script'))
  1310.         {
  1311.             return $this->getAbsoluteUrl($strParams);
  1312.         }
  1314.         $this->loadDetails();
  1316.         $context = $container->get('router')->getContext();
  1317.         $baseUrl = $context->getBaseUrl();
  1319.         // Add the preview script
  1320.         $context->setBaseUrl($previewScript);
  1322.         $objRouter = System::getContainer()->get('router');
  1323.         $strUrl = $objRouter->generate(RouteObjectInterface::OBJECT_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $this, 'parameters' => $strParams), UrlGeneratorInterface::ABSOLUTE_URL);
  1325.         $context->setBaseUrl($baseUrl);
  1327.         return $this->applyLegacyLogic($strUrl, $strParams);
  1328.     }
  1330.     /**
  1331.      * Return the slug options
  1332.      *
  1333.      * @return array The slug options
  1334.      */
  1335.     public function getSlugOptions()
  1336.     {
  1337.         $slugOptions = array('locale'=>$this->language);
  1339.         if ($this->validAliasCharacters)
  1340.         {
  1341.             $slugOptions['validChars'] = $this->validAliasCharacters;
  1342.         }
  1344.         return $slugOptions;
  1345.     }
  1347.     /**
  1348.      * Modifies a URL from the URL generator.
  1349.      *
  1350.      * @param string      $strUrl
  1351.      * @param string|null $strParams
  1352.      *
  1353.      * @return string
  1354.      */
  1355.     private function applyLegacyLogic($strUrl, $strParams)
  1356.     {
  1357.         // Decode sprintf placeholders
  1358.         if ($strParams !== null && strpos($strParams, '%') !== false)
  1359.         {
  1360.             trigger_deprecation('contao/core-bundle', '4.2', 'Using sprintf placeholders in URLs has been deprecated and will no longer work in Contao 5.0.');
  1362.             $arrMatches = array();
  1363.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1365.             foreach (array_unique($arrMatches[1]) as $v)
  1366.             {
  1367.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1368.             }
  1369.         }
  1371.         // HOOK: add custom logic
  1372.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1373.         {
  1374.             trigger_deprecation('contao/core-bundle', '4.0', 'Using the "generateFrontendUrl" hook has been deprecated and will no longer work in Contao 5.0.');
  1376.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1377.             {
  1378.                 $strUrl = System::importStatic($callback[0])->{$callback[1]}($this->row(), $strParams ?? '', $strUrl);
  1379.             }
  1381.             return $strUrl;
  1382.         }
  1384.         return $strUrl;
  1385.     }
  1386. }
  1388. class_alias(PageModel::class, 'PageModel');