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

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\Util\LocaleUtil;
  18. use Contao\Model\Collection;
  19. use Contao\Model\Registry;
  20. use Symfony\Cmf\Component\Routing\RouteObjectInterface;
  21. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  22. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  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|integer         $routePriority
  36.  * @property string                 $pageTitle
  37.  * @property string                 $language
  38.  * @property string                 $robots
  39.  * @property string|null            $description
  40.  * @property string                 $redirect
  41.  * @property string|integer         $jumpTo
  42.  * @property string|boolean         $redirectBack
  43.  * @property string                 $url
  44.  * @property string|boolean         $target
  45.  * @property string                 $dns
  46.  * @property string                 $staticFiles
  47.  * @property string                 $staticPlugins
  48.  * @property string|boolean         $fallback
  49.  * @property string|boolean         $disableLanguageRedirect
  50.  * @property string|boolean         $maintenanceMode
  51.  * @property string|null            $favicon
  52.  * @property string|null            $robotsTxt
  53.  * @property string                 $mailerTransport
  54.  * @property string|integer         $enableCanonical
  55.  * @property string                 $canonicalLink
  56.  * @property string                 $canonicalKeepParams
  57.  * @property string                 $adminEmail
  58.  * @property string                 $dateFormat
  59.  * @property string                 $timeFormat
  60.  * @property string                 $datimFormat
  61.  * @property string                 $validAliasCharacters
  62.  * @property string|boolean         $useFolderUrl
  63.  * @property string                 $urlPrefix
  64.  * @property string                 $urlSuffix
  65.  * @property string|boolean         $useSSL
  66.  * @property string|boolean         $autoforward
  67.  * @property string|boolean         $protected
  68.  * @property string|array|null      $groups
  69.  * @property string|boolean         $includeLayout
  70.  * @property string|integer         $layout
  71.  * @property string|integer         $subpageLayout
  72.  * @property string|boolean         $includeCache
  73.  * @property string|integer|boolean $cache
  74.  * @property string|boolean         $alwaysLoadFromCache
  75.  * @property string|integer|boolean $clientCache
  76.  * @property string|boolean         $includeChmod
  77.  * @property string|integer         $cuser
  78.  * @property string|integer         $cgroup
  79.  * @property string                 $chmod
  80.  * @property string|boolean         $noSearch
  81.  * @property string|boolean         $requireItem
  82.  * @property string                 $cssClass
  83.  * @property string                 $sitemap
  84.  * @property string|boolean         $hide
  85.  * @property string|boolean         $guests
  86.  * @property string|integer         $tabindex
  87.  * @property string                 $accesskey
  88.  * @property string|boolean         $published
  89.  * @property string|integer         $start
  90.  * @property string|integer         $stop
  91.  * @property string|boolean         $enforceTwoFactor
  92.  * @property string|integer         $twoFactorJumpTo
  93.  *
  94.  * @property array          $trail
  95.  * @property string         $mainAlias
  96.  * @property string         $mainTitle
  97.  * @property string         $mainPageTitle
  98.  * @property string         $parentAlias
  99.  * @property string         $parentTitle
  100.  * @property string         $parentPageTitle
  101.  * @property string         $folderUrl
  102.  * @property boolean        $isPublic
  103.  * @property integer        $rootId
  104.  * @property string         $rootAlias
  105.  * @property string         $rootTitle
  106.  * @property string         $rootPageTitle
  107.  * @property integer        $rootSorting
  108.  * @property string         $domain
  109.  * @property string         $rootLanguage
  110.  * @property boolean        $rootIsPublic
  111.  * @property boolean        $rootIsFallback
  112.  * @property string|boolean $rootUseSSL
  113.  * @property string         $rootFallbackLanguage
  114.  * @property boolean        $minifyMarkup
  115.  * @property integer        $layoutId
  116.  * @property boolean        $hasJQuery
  117.  * @property boolean        $hasMooTools
  118.  * @property string         $template
  119.  * @property string         $templateGroup
  120.  * @property boolean        $useAutoItem
  121.  *
  122.  * @method static PageModel|null findById($id, array $opt=array())
  123.  * @method static PageModel|null findByPk($id, array $opt=array())
  124.  * @method static PageModel|null findByIdOrAlias($val, array $opt=array())
  125.  * @method static PageModel|null findOneBy($col, $val, array $opt=array())
  126.  * @method static PageModel|null findOneByPid($val, array $opt=array())
  127.  * @method static PageModel|null findOneBySorting($val, array $opt=array())
  128.  * @method static PageModel|null findOneByTstamp($val, array $opt=array())
  129.  * @method static PageModel|null findOneByTitle($val, array $opt=array())
  130.  * @method static PageModel|null findOneByAlias($val, array $opt=array())
  131.  * @method static PageModel|null findOneByType($val, array $opt=array())
  132.  * @method static PageModel|null findOneByRoutePriority($val, array $opt=array())
  133.  * @method static PageModel|null findOneByPageTitle($val, array $opt=array())
  134.  * @method static PageModel|null findOneByLanguage($val, array $opt=array())
  135.  * @method static PageModel|null findOneByRobots($val, array $opt=array())
  136.  * @method static PageModel|null findOneByDescription($val, array $opt=array())
  137.  * @method static PageModel|null findOneByRedirect($val, array $opt=array())
  138.  * @method static PageModel|null findOneByJumpTo($val, array $opt=array())
  139.  * @method static PageModel|null findOneByRedirectBack($val, array $opt=array())
  140.  * @method static PageModel|null findOneByUrl($val, array $opt=array())
  141.  * @method static PageModel|null findOneByTarget($val, array $opt=array())
  142.  * @method static PageModel|null findOneByDns($val, array $opt=array())
  143.  * @method static PageModel|null findOneByStaticFiles($val, array $opt=array())
  144.  * @method static PageModel|null findOneByStaticPlugins($val, array $opt=array())
  145.  * @method static PageModel|null findOneByFallback($val, array $opt=array())
  146.  * @method static PageModel|null findOneByDisableLanguageRedirect($val, array $opt=array())
  147.  * @method static PageModel|null findOneByFavicon($val, array $opt=array())
  148.  * @method static PageModel|null findOneByRobotsTxt($val, array $opt=array())
  149.  * @method static PageModel|null findOneByMailerTransport($val, array $opt=array())
  150.  * @method static PageModel|null findOneByEnableCanonical($val, array $opt=array())
  151.  * @method static PageModel|null findOneByCanonicalLink($val, array $opt=array())
  152.  * @method static PageModel|null findOneByCanonicalKeepParams($val, array $opt=array())
  153.  * @method static PageModel|null findOneByAdminEmail($val, array $opt=array())
  154.  * @method static PageModel|null findOneByDateFormat($val, array $opt=array())
  155.  * @method static PageModel|null findOneByTimeFormat($val, array $opt=array())
  156.  * @method static PageModel|null findOneByDatimFormat($val, array $opt=array())
  157.  * @method static PageModel|null findOneByValidAliasCharacters($val, array $opt=array())
  158.  * @method static PageModel|null findOneByUseFolderUrl($val, array $opt=array())
  159.  * @method static PageModel|null findOneByUrlPrefix($val, array $opt=array())
  160.  * @method static PageModel|null findOneByUrlSuffix($val, array $opt=array())
  161.  * @method static PageModel|null findOneByUseSSL($val, array $opt=array())
  162.  * @method static PageModel|null findOneByAutoforward($val, array $opt=array())
  163.  * @method static PageModel|null findOneByProtected($val, array $opt=array())
  164.  * @method static PageModel|null findOneByGroups($val, array $opt=array())
  165.  * @method static PageModel|null findOneByIncludeLayout($val, array $opt=array())
  166.  * @method static PageModel|null findOneByLayout($val, array $opt=array())
  167.  * @method static PageModel|null findOneBySubpageLayout($val, array $opt=array())
  168.  * @method static PageModel|null findOneByIncludeCache($val, array $opt=array())
  169.  * @method static PageModel|null findOneByCache($val, array $opt=array())
  170.  * @method static PageModel|null findOneByIncludeChmod($val, array $opt=array())
  171.  * @method static PageModel|null findOneByCuser($val, array $opt=array())
  172.  * @method static PageModel|null findOneByCgroup($val, array $opt=array())
  173.  * @method static PageModel|null findOneByChmod($val, array $opt=array())
  174.  * @method static PageModel|null findOneByNoSearch($val, array $opt=array())
  175.  * @method static PageModel|null findOneByCssClass($val, array $opt=array())
  176.  * @method static PageModel|null findOneBySitemap($val, array $opt=array())
  177.  * @method static PageModel|null findOneByHide($val, array $opt=array())
  178.  * @method static PageModel|null findOneByGuests($val, array $opt=array())
  179.  * @method static PageModel|null findOneByTabindex($val, array $opt=array())
  180.  * @method static PageModel|null findOneByAccesskey($val, array $opt=array())
  181.  * @method static PageModel|null findOneByPublished($val, array $opt=array())
  182.  * @method static PageModel|null findOneByStart($val, array $opt=array())
  183.  * @method static PageModel|null findOneByStop($val, array $opt=array())
  184.  * @method static PageModel|null findOneByEnforceTwoFactor($val, array $opt=array())
  185.  * @method static PageModel|null findOneByTwoFactorJumpTo($val, array $opt=array())
  186.  *
  187.  * @method static Collection|PageModel[]|PageModel|null findByPid($val, array $opt=array())
  188.  * @method static Collection|PageModel[]|PageModel|null findBySorting($val, array $opt=array())
  189.  * @method static Collection|PageModel[]|PageModel|null findByTstamp($val, array $opt=array())
  190.  * @method static Collection|PageModel[]|PageModel|null findByTitle($val, array $opt=array())
  191.  * @method static Collection|PageModel[]|PageModel|null findByAlias($val, array $opt=array())
  192.  * @method static Collection|PageModel[]|PageModel|null findByType($val, array $opt=array())
  193.  * @method static Collection|PageModel[]|PageModel|null findByRoutePriority($val, array $opt=array())
  194.  * @method static Collection|PageModel[]|PageModel|null findByPageTitle($val, array $opt=array())
  195.  * @method static Collection|PageModel[]|PageModel|null findByLanguage($val, array $opt=array())
  196.  * @method static Collection|PageModel[]|PageModel|null findByRobots($val, array $opt=array())
  197.  * @method static Collection|PageModel[]|PageModel|null findByDescription($val, array $opt=array())
  198.  * @method static Collection|PageModel[]|PageModel|null findByRedirect($val, array $opt=array())
  199.  * @method static Collection|PageModel[]|PageModel|null findByJumpTo($val, array $opt=array())
  200.  * @method static Collection|PageModel[]|PageModel|null findByRedirectBack($val, array $opt=array())
  201.  * @method static Collection|PageModel[]|PageModel|null findByUrl($val, array $opt=array())
  202.  * @method static Collection|PageModel[]|PageModel|null findByTarget($val, array $opt=array())
  203.  * @method static Collection|PageModel[]|PageModel|null findByDns($val, array $opt=array())
  204.  * @method static Collection|PageModel[]|PageModel|null findByStaticFiles($val, array $opt=array())
  205.  * @method static Collection|PageModel[]|PageModel|null findByStaticPlugins($val, array $opt=array())
  206.  * @method static Collection|PageModel[]|PageModel|null findByFallback($val, array $opt=array())
  207.  * @method static Collection|PageModel[]|PageModel|null findByDisableLanguageRedirect($val, array $opt=array())
  208.  * @method static Collection|PageModel[]|PageModel|null findByFavicon($val, array $opt=array())
  209.  * @method static Collection|PageModel[]|PageModel|null findByRobotsTxt($val, array $opt=array())
  210.  * @method static Collection|PageModel[]|PageModel|null findByMailerTransport($val, array $opt=array())
  211.  * @method static Collection|PageModel[]|PageModel|null findByEnableCanonical($val, array $opt=array())
  212.  * @method static Collection|PageModel[]|PageModel|null findByCanonicalLink($val, array $opt=array())
  213.  * @method static Collection|PageModel[]|PageModel|null findByCanonicalKeepParams($val, array $opt=array())
  214.  * @method static Collection|PageModel[]|PageModel|null findByAdminEmail($val, array $opt=array())
  215.  * @method static Collection|PageModel[]|PageModel|null findByDateFormat($val, array $opt=array())
  216.  * @method static Collection|PageModel[]|PageModel|null findByTimeFormat($val, array $opt=array())
  217.  * @method static Collection|PageModel[]|PageModel|null findByDatimFormat($val, array $opt=array())
  218.  * @method static Collection|PageModel[]|PageModel|null findByValidAliasCharacters($val, array $opt=array())
  219.  * @method static Collection|PageModel[]|PageModel|null findByUseFolderUrl($val, array $opt=array())
  220.  * @method static Collection|PageModel[]|PageModel|null findByUrlPrefix($val, array $opt=array())
  221.  * @method static Collection|PageModel[]|PageModel|null findByUrlSuffix($val, array $opt=array())
  222.  * @method static Collection|PageModel[]|PageModel|null findByUseSSL($val, array $opt=array())
  223.  * @method static Collection|PageModel[]|PageModel|null findByAutoforward($val, array $opt=array())
  224.  * @method static Collection|PageModel[]|PageModel|null findByProtected($val, array $opt=array())
  225.  * @method static Collection|PageModel[]|PageModel|null findByGroups($val, array $opt=array())
  226.  * @method static Collection|PageModel[]|PageModel|null findByIncludeLayout($val, array $opt=array())
  227.  * @method static Collection|PageModel[]|PageModel|null findByLayout($val, array $opt=array())
  228.  * @method static Collection|PageModel[]|PageModel|null findBySubpageLayout($val, array $opt=array())
  229.  * @method static Collection|PageModel[]|PageModel|null findByIncludeCache($val, array $opt=array())
  230.  * @method static Collection|PageModel[]|PageModel|null findByCache($val, array $opt=array())
  231.  * @method static Collection|PageModel[]|PageModel|null findByIncludeChmod($val, array $opt=array())
  232.  * @method static Collection|PageModel[]|PageModel|null findByCuser($val, array $opt=array())
  233.  * @method static Collection|PageModel[]|PageModel|null findByCgroup($val, array $opt=array())
  234.  * @method static Collection|PageModel[]|PageModel|null findByChmod($val, array $opt=array())
  235.  * @method static Collection|PageModel[]|PageModel|null findByNoSearch($val, array $opt=array())
  236.  * @method static Collection|PageModel[]|PageModel|null findByCssClass($val, array $opt=array())
  237.  * @method static Collection|PageModel[]|PageModel|null findBySitemap($val, array $opt=array())
  238.  * @method static Collection|PageModel[]|PageModel|null findByHide($val, array $opt=array())
  239.  * @method static Collection|PageModel[]|PageModel|null findByGuests($val, array $opt=array())
  240.  * @method static Collection|PageModel[]|PageModel|null findByTabindex($val, array $opt=array())
  241.  * @method static Collection|PageModel[]|PageModel|null findByAccesskey($val, array $opt=array())
  242.  * @method static Collection|PageModel[]|PageModel|null findByPublished($val, array $opt=array())
  243.  * @method static Collection|PageModel[]|PageModel|null findByStart($val, array $opt=array())
  244.  * @method static Collection|PageModel[]|PageModel|null findByStop($val, array $opt=array())
  245.  * @method static Collection|PageModel[]|PageModel|null findByEnforceTwoFactor($val, array $opt=array())
  246.  * @method static Collection|PageModel[]|PageModel|null findByTwoFactorJumpTo($val, array $opt=array())
  247.  * @method static Collection|PageModel[]|PageModel|null findMultipleByIds($val, array $opt=array())
  248.  * @method static Collection|PageModel[]|PageModel|null findBy($col, $val, array $opt=array())
  249.  * @method static Collection|PageModel[]|PageModel|null findAll(array $opt=array())
  250.  *
  251.  * @method static integer countById($id, array $opt=array())
  252.  * @method static integer countByPid($val, array $opt=array())
  253.  * @method static integer countBySorting($val, array $opt=array())
  254.  * @method static integer countByTstamp($val, array $opt=array())
  255.  * @method static integer countByTitle($val, array $opt=array())
  256.  * @method static integer countByAlias($val, array $opt=array())
  257.  * @method static integer countByType($val, array $opt=array())
  258.  * @method static integer countByRoutePriority($val, array $opt=array())
  259.  * @method static integer countByPageTitle($val, array $opt=array())
  260.  * @method static integer countByLanguage($val, array $opt=array())
  261.  * @method static integer countByRobots($val, array $opt=array())
  262.  * @method static integer countByDescription($val, array $opt=array())
  263.  * @method static integer countByRedirect($val, array $opt=array())
  264.  * @method static integer countByJumpTo($val, array $opt=array())
  265.  * @method static integer countByRedirectBack($val, array $opt=array())
  266.  * @method static integer countByUrl($val, array $opt=array())
  267.  * @method static integer countByTarget($val, array $opt=array())
  268.  * @method static integer countByDns($val, array $opt=array())
  269.  * @method static integer countByStaticFiles($val, array $opt=array())
  270.  * @method static integer countByStaticPlugins($val, array $opt=array())
  271.  * @method static integer countByFallback($val, array $opt=array())
  272.  * @method static integer countByDisableLanguageRedirect($val, array $opt=array())
  273.  * @method static integer countByFavicon($val, array $opt=array())
  274.  * @method static integer countByRobotsTxt($val, array $opt=array())
  275.  * @method static integer countByMailerTransport($val, array $opt=array())
  276.  * @method static integer countByEnableCanonical($val, array $opt=array())
  277.  * @method static integer countByCanonicalLink($val, array $opt=array())
  278.  * @method static integer countByCanonicalKeepParams($val, array $opt=array())
  279.  * @method static integer countByAdminEmail($val, array $opt=array())
  280.  * @method static integer countByDateFormat($val, array $opt=array())
  281.  * @method static integer countByTimeFormat($val, array $opt=array())
  282.  * @method static integer countByDatimFormat($val, array $opt=array())
  283.  * @method static integer countByValidAliasCharacters($val, array $opt=array())
  284.  * @method static integer countByUseFolderUrl($val, array $opt=array())
  285.  * @method static integer countByUrlPrefix($val, array $opt=array())
  286.  * @method static integer countByUrlSuffix($val, array $opt=array())
  287.  * @method static integer countByUseSSL($val, array $opt=array())
  288.  * @method static integer countByAutoforward($val, array $opt=array())
  289.  * @method static integer countByProtected($val, array $opt=array())
  290.  * @method static integer countByGroups($val, array $opt=array())
  291.  * @method static integer countByIncludeLayout($val, array $opt=array())
  292.  * @method static integer countByLayout($val, array $opt=array())
  293.  * @method static integer countBySubpageLayout($val, array $opt=array())
  294.  * @method static integer countByIncludeCache($val, array $opt=array())
  295.  * @method static integer countByCache($val, array $opt=array())
  296.  * @method static integer countByIncludeChmod($val, array $opt=array())
  297.  * @method static integer countByCuser($val, array $opt=array())
  298.  * @method static integer countByCgroup($val, array $opt=array())
  299.  * @method static integer countByChmod($val, array $opt=array())
  300.  * @method static integer countByNoSearch($val, array $opt=array())
  301.  * @method static integer countByCssClass($val, array $opt=array())
  302.  * @method static integer countBySitemap($val, array $opt=array())
  303.  * @method static integer countByHide($val, array $opt=array())
  304.  * @method static integer countByGuests($val, array $opt=array())
  305.  * @method static integer countByTabindex($val, array $opt=array())
  306.  * @method static integer countByAccesskey($val, array $opt=array())
  307.  * @method static integer countByPublished($val, array $opt=array())
  308.  * @method static integer countByStart($val, array $opt=array())
  309.  * @method static integer countByStop($val, array $opt=array())
  310.  * @method static integer countByEnforceTwoFactor($val, array $opt=array())
  311.  * @method static integer countByTwoFactorJumpTo($val, array $opt=array())
  312.  */
  313. class PageModel extends Model
  314. {
  315.     /**
  316.      * Table name
  317.      * @var string
  318.      */
  319.     protected static $strTable = 'tl_page';
  321.     /**
  322.      * Details loaded
  323.      * @var boolean
  324.      */
  325.     protected $blnDetailsLoaded = false;
  327.     private static ?array $prefixes = null;
  328.     private static ?array $suffixes = null;
  330.     public function __set($strKey, $varValue)
  331.     {
  332.         // Deprecate setting dynamic page attributes if they are set on the global $objPage
  333.         if (\in_array($strKey, array('pageTitle', 'description', 'robots', 'noSearch'), true) && ($GLOBALS['objPage'] ?? null) === $this)
  334.         {
  335.             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));
  337.             $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  339.             if (!$responseContext)
  340.             {
  341.                 parent::__set($strKey, $varValue);
  343.                 return;
  344.             }
  346.             if (\in_array($strKey, array('pageTitle', 'description', 'robots')) && $responseContext->has(HtmlHeadBag::class))
  347.             {
  348.                 /** @var HtmlHeadBag $htmlHeadBag */
  349.                 $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  350.                 $htmlDecoder = System::getContainer()->get('contao.string.html_decoder');
  352.                 switch ($strKey)
  353.                 {
  354.                     case 'pageTitle':
  355.                         $htmlHeadBag->setTitle($htmlDecoder->inputEncodedToPlainText($varValue ?? ''));
  356.                         break;
  358.                     case 'description':
  359.                         $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($varValue ?? ''));
  360.                         break;
  362.                     case 'robots':
  363.                         $htmlHeadBag->setMetaRobots($varValue);
  364.                         break;
  365.                 }
  366.             }
  368.             if ('noSearch' === $strKey && $responseContext->has(JsonLdManager::class))
  369.             {
  370.                 /** @var JsonLdManager $jsonLdManager */
  371.                 $jsonLdManager = $responseContext->get(JsonLdManager::class);
  373.                 if ($jsonLdManager->getGraphForSchema(JsonLdManager::SCHEMA_CONTAO)->has(ContaoPageSchema::class))
  374.                 {
  375.                     /** @var ContaoPageSchema $schema */
  376.                     $schema = $jsonLdManager->getGraphForSchema(JsonLdManager::SCHEMA_CONTAO)->get(ContaoPageSchema::class);
  377.                     $schema->setNoSearch((bool) $varValue);
  378.                 }
  379.             }
  380.         }
  382.         parent::__set($strKey, $varValue);
  383.     }
  385.     public static function reset()
  386.     {
  387.         self::$prefixes = null;
  388.         self::$suffixes = null;
  389.     }
  391.     /**
  392.      * Find a published page by its ID
  393.      *
  394.      * @param integer $intId      The page ID
  395.      * @param array   $arrOptions An optional options array
  396.      *
  397.      * @return PageModel|null The model or null if there is no published page
  398.      */
  399.     public static function findPublishedById($intId, array $arrOptions=array())
  400.     {
  401.         $t = static::$strTable;
  402.         $arrColumns = array("$t.id=?");
  404.         if (!static::isPreviewMode($arrOptions))
  405.         {
  406.             $time = Date::floorToMinute();
  407.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  408.         }
  410.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  411.     }
  413.     /**
  414.      * Find published pages by their PID
  415.      *
  416.      * @param integer $intPid     The parent ID
  417.      * @param array   $arrOptions An optional options array
  418.      *
  419.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  420.      */
  421.     public static function findPublishedByPid($intPid, array $arrOptions=array())
  422.     {
  423.         $t = static::$strTable;
  424.         $arrColumns = array("$t.pid=?");
  426.         if (!static::isPreviewMode($arrOptions))
  427.         {
  428.             $time = Date::floorToMinute();
  429.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  430.         }
  432.         return static::findBy($arrColumns, $intPid, $arrOptions);
  433.     }
  435.     /**
  436.      * Find the first published root page by its host name and language
  437.      *
  438.      * @param string $strHost     The host name
  439.      * @param mixed  $varLanguage An ISO language code or an array of ISO language codes
  440.      * @param array  $arrOptions  An optional options array
  441.      *
  442.      * @return PageModel|null The model or null if there is no matching root page
  443.      *
  444.      * @deprecated Deprecated since Contao 4.7, to be removed in Contao 5.0.
  445.      */
  446.     public static function findFirstPublishedRootByHostAndLanguage($strHost, $varLanguage, array $arrOptions=array())
  447.     {
  448.         trigger_deprecation('contao/core-bundle', '4.7', 'Using "Contao\PageModel::findFirstPublishedRootByHostAndLanguage()" has been deprecated and will no longer work Contao 5.0.');
  450.         $t = static::$strTable;
  451.         $objDatabase = Database::getInstance();
  453.         if (\is_array($varLanguage))
  454.         {
  455.             $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='')");
  457.             if (!empty($varLanguage))
  458.             {
  459.                 $arrColumns[] = "($t.language IN('" . implode("','", $varLanguage) . "') OR $t.fallback='1')";
  460.             }
  461.             else
  462.             {
  463.                 $arrColumns[] = "$t.fallback='1'";
  464.             }
  466.             if (!isset($arrOptions['order']))
  467.             {
  468.                 $arrOptions['order'] = "$t.dns DESC" . (!empty($varLanguage) ? ", " . $objDatabase->findInSet("$t.language", array_reverse($varLanguage)) . " DESC" : "") . ", $t.sorting";
  469.             }
  471.             if (!static::isPreviewMode($arrOptions))
  472.             {
  473.                 $time = Date::floorToMinute();
  474.                 $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  475.             }
  477.             return static::findOneBy($arrColumns, $strHost, $arrOptions);
  478.         }
  480.         $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='') AND ($t.language=? OR $t.fallback='1')");
  481.         $arrValues = array($strHost, $varLanguage);
  483.         if (!isset($arrOptions['order']))
  484.         {
  485.             $arrOptions['order'] = "$t.dns DESC, $t.fallback";
  486.         }
  488.         if (!static::isPreviewMode($arrOptions))
  489.         {
  490.             $time = Date::floorToMinute();
  491.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  492.         }
  494.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  495.     }
  497.     /**
  498.      * Find the first published page by its parent ID
  499.      *
  500.      * @param integer $intPid     The parent page's ID
  501.      * @param array   $arrOptions An optional options array
  502.      *
  503.      * @return PageModel|null The model or null if there is no published page
  504.      */
  505.     public static function findFirstPublishedByPid($intPid, array $arrOptions=array())
  506.     {
  507.         $t = static::$strTable;
  508.         $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  509.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type NOT IN ('" . implode("', '", $unroutableTypes) . "')");
  511.         if (!static::isPreviewMode($arrOptions))
  512.         {
  513.             $time = Date::floorToMinute();
  514.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  515.         }
  517.         if (!isset($arrOptions['order']))
  518.         {
  519.             $arrOptions['order'] = "$t.sorting";
  520.         }
  522.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  523.     }
  525.     /**
  526.      * Find the first published regular page by its parent ID
  527.      *
  528.      * @param integer $intPid     The parent page's ID
  529.      * @param array   $arrOptions An optional options array
  530.      *
  531.      * @return PageModel|null The model or null if there is no published regular page
  532.      */
  533.     public static function findFirstPublishedRegularByPid($intPid, array $arrOptions=array())
  534.     {
  535.         $t = static::$strTable;
  536.         $arrColumns = array("$t.pid=? AND $t.type='regular'");
  538.         if (!static::isPreviewMode($arrOptions))
  539.         {
  540.             $time = Date::floorToMinute();
  541.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  542.         }
  544.         if (!isset($arrOptions['order']))
  545.         {
  546.             $arrOptions['order'] = "$t.sorting";
  547.         }
  549.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  550.     }
  552.     /**
  553.      * Find the first published page by its type and parent ID
  554.      *
  555.      * @param string  $strType    The page type
  556.      * @param integer $intPid     The parent page's ID
  557.      * @param array   $arrOptions An optional options array
  558.      *
  559.      * @return PageModel|null The model or null if there is no published regular page
  560.      */
  561.     public static function findFirstPublishedByTypeAndPid($strType, $intPid, array $arrOptions=array())
  562.     {
  563.         $t = static::$strTable;
  564.         $arrColumns = array("$t.pid=? AND $t.type=?");
  566.         if (!static::isPreviewMode($arrOptions))
  567.         {
  568.             $time = Date::floorToMinute();
  569.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  570.         }
  572.         if (!isset($arrOptions['order']))
  573.         {
  574.             $arrOptions['order'] = "$t.sorting";
  575.         }
  577.         return static::findOneBy($arrColumns, array($intPid, $strType), $arrOptions);
  578.     }
  580.     /**
  581.      * Find an error 401 page by its parent ID
  582.      *
  583.      * @param integer $intPid     The parent page's ID
  584.      * @param array   $arrOptions An optional options array
  585.      *
  586.      * @return PageModel|null The model or null if there is no 401 page
  587.      */
  588.     public static function find401ByPid($intPid, array $arrOptions=array())
  589.     {
  590.         $t = static::$strTable;
  591.         $arrColumns = array("$t.pid=? AND $t.type='error_401'");
  593.         if (!static::isPreviewMode($arrOptions))
  594.         {
  595.             $time = Date::floorToMinute();
  596.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  597.         }
  599.         if (!isset($arrOptions['order']))
  600.         {
  601.             $arrOptions['order'] = "$t.sorting";
  602.         }
  604.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  605.     }
  607.     /**
  608.      * Find an error 403 page by its parent ID
  609.      *
  610.      * @param integer $intPid     The parent page's ID
  611.      * @param array   $arrOptions An optional options array
  612.      *
  613.      * @return PageModel|null The model or null if there is no 403 page
  614.      */
  615.     public static function find403ByPid($intPid, array $arrOptions=array())
  616.     {
  617.         $t = static::$strTable;
  618.         $arrColumns = array("$t.pid=? AND $t.type='error_403'");
  620.         if (!static::isPreviewMode($arrOptions))
  621.         {
  622.             $time = Date::floorToMinute();
  623.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  624.         }
  626.         if (!isset($arrOptions['order']))
  627.         {
  628.             $arrOptions['order'] = "$t.sorting";
  629.         }
  631.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  632.     }
  634.     /**
  635.      * Find an error 404 page by its parent ID
  636.      *
  637.      * @param integer $intPid     The parent page's ID
  638.      * @param array   $arrOptions An optional options array
  639.      *
  640.      * @return PageModel|null The model or null if there is no 404 page
  641.      */
  642.     public static function find404ByPid($intPid, array $arrOptions=array())
  643.     {
  644.         $t = static::$strTable;
  645.         $arrColumns = array("$t.pid=? AND $t.type='error_404'");
  647.         if (!static::isPreviewMode($arrOptions))
  648.         {
  649.             $time = Date::floorToMinute();
  650.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  651.         }
  653.         if (!isset($arrOptions['order']))
  654.         {
  655.             $arrOptions['order'] = "$t.sorting";
  656.         }
  658.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  659.     }
  661.     /**
  662.      * Find pages matching a list of possible alias names
  663.      *
  664.      * @param array $arrAliases An array of possible alias names
  665.      * @param array $arrOptions An optional options array
  666.      *
  667.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  668.      */
  669.     public static function findByAliases($arrAliases, array $arrOptions=array())
  670.     {
  671.         if (empty($arrAliases) || !\is_array($arrAliases))
  672.         {
  673.             return null;
  674.         }
  676.         // Remove everything that is not an alias
  677.         $arrAliases = array_filter(array_map(static function ($v) { return preg_match('/^[\w\/.-]+$/u', $v) ? $v : null; }, $arrAliases));
  679.         // Return if nothing is left
  680.         if (empty($arrAliases))
  681.         {
  682.             return null;
  683.         }
  685.         $t = static::$strTable;
  686.         $arrColumns = array("$t.alias IN('" . implode("','", array_filter($arrAliases)) . "')");
  688.         // Check the publication status (see #4652)
  689.         if (!static::isPreviewMode($arrOptions))
  690.         {
  691.             $time = Date::floorToMinute();
  692.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  693.         }
  695.         if (!isset($arrOptions['order']))
  696.         {
  697.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.alias", $arrAliases);
  698.         }
  700.         return static::findBy($arrColumns, null, $arrOptions);
  701.     }
  703.     /**
  704.      * Find pages that have a similar alias
  705.      *
  706.      * @return Collection|PageModel[]|null A collection of models or null if there are no pages
  707.      */
  708.     public static function findSimilarByAlias(self $pageModel)
  709.     {
  710.         if ('' === $pageModel->alias)
  711.         {
  712.             return null;
  713.         }
  715.         $pageModel->loadDetails();
  717.         $t = static::$strTable;
  718.         $alias = '%' . self::stripPrefixesAndSuffixes($pageModel->alias, $pageModel->urlPrefix, $pageModel->urlSuffix) . '%';
  720.         return static::findBy(array("$t.alias LIKE ?", "$t.id!=?"), array($alias, $pageModel->id));
  721.     }
  723.     /**
  724.      * Find published pages by their ID or aliases
  725.      *
  726.      * @param mixed $varId      The numeric ID or the alias name
  727.      * @param array $arrOptions An optional options array
  728.      *
  729.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  730.      */
  731.     public static function findPublishedByIdOrAlias($varId, array $arrOptions=array())
  732.     {
  733.         $t = static::$strTable;
  734.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  736.         if (!static::isPreviewMode($arrOptions))
  737.         {
  738.             $time = Date::floorToMinute();
  739.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  740.         }
  742.         return static::findBy($arrColumns, $varId, $arrOptions);
  743.     }
  745.     /**
  746.      * Find all published subpages by their parent ID and exclude pages only visible for guests
  747.      *
  748.      * @param integer $intPid        The parent page's ID
  749.      * @param boolean $blnShowHidden If true, hidden pages will be included
  750.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  751.      *
  752.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  753.      *
  754.      * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0;
  755.      *             use PageModel::findPublishedByPid() instead and filter the guests pages yourself
  756.      */
  757.     public static function findPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false)
  758.     {
  759.         trigger_deprecation('contao/core-bundle', '4.9', 'Using PageModel::findPublishedSubpagesWithoutGuestsByPid() has been deprecated and will no longer work Contao 5.0. Use PageModel::findPublishedByPid() instead and filter the guests pages yourself.');
  761.         $time = Date::floorToMinute();
  762.         $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  763.         $blnFeUserLoggedIn = $tokenChecker->hasFrontendUser();
  764.         $blnBeUserLoggedIn = $tokenChecker->isPreviewMode();
  765.         $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  767.         $objSubpages = Database::getInstance()->prepare("SELECT p1.*, (SELECT COUNT(*) FROM tl_page p2 WHERE p2.pid=p1.id AND p2.type!='root' AND p2.type NOT IN ('" . implode("', '", $unroutableTypes) . "')" . (!$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 NOT IN ('" . implode("', '", $unroutableTypes) . "')" . (!$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")
  768.                                               ->execute($intPid);
  770.         if ($objSubpages->numRows < 1)
  771.         {
  772.             return null;
  773.         }
  775.         return static::createCollectionFromDbResult($objSubpages, 'tl_page');
  776.     }
  778.     /**
  779.      * Find all published regular pages by their IDs
  780.      *
  781.      * @param array $arrIds     An array of page IDs
  782.      * @param array $arrOptions An optional options array
  783.      *
  784.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  785.      */
  786.     public static function findPublishedRegularByIds($arrIds, array $arrOptions=array())
  787.     {
  788.         if (empty($arrIds) || !\is_array($arrIds))
  789.         {
  790.             return null;
  791.         }
  793.         $t = static::$strTable;
  794.         $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  795.         $arrColumns = array("$t.id IN(" . implode(',', array_map('\intval', $arrIds)) . ") AND $t.type NOT IN ('" . implode("', '", $unroutableTypes) . "')");
  797.         if (empty($arrOptions['includeRoot']))
  798.         {
  799.             $arrColumns[] = "$t.type!='root'";
  800.         }
  802.         if (!static::isPreviewMode($arrOptions))
  803.         {
  804.             $time = Date::floorToMinute();
  805.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  806.         }
  808.         if (!isset($arrOptions['order']))
  809.         {
  810.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  811.         }
  813.         return static::findBy($arrColumns, null, $arrOptions);
  814.     }
  816.     /**
  817.      * Find all published regular pages by their IDs and exclude pages only visible for guests
  818.      *
  819.      * @param array $arrIds     An array of page IDs
  820.      * @param array $arrOptions An optional options array
  821.      *
  822.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  823.      *
  824.      * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5;
  825.      *             use PageModel::findPublishedRegularByIds() instead.
  826.      */
  827.     public static function findPublishedRegularWithoutGuestsByIds($arrIds, array $arrOptions=array())
  828.     {
  829.         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.');
  831.         if (empty($arrIds) || !\is_array($arrIds))
  832.         {
  833.             return null;
  834.         }
  836.         $t = static::$strTable;
  837.         $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  838.         $arrColumns = array("$t.id IN(" . implode(',', array_map('\intval', $arrIds)) . ") AND $t.type NOT IN ('" . implode("', '", $unroutableTypes) . "')");
  840.         if (empty($arrOptions['includeRoot']))
  841.         {
  842.             $arrColumns[] = "$t.type!='root'";
  843.         }
  845.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  846.         {
  847.             $arrColumns[] = "$t.guests=''";
  848.         }
  850.         if (!static::isPreviewMode($arrOptions))
  851.         {
  852.             $time = Date::floorToMinute();
  853.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  854.         }
  856.         if (!isset($arrOptions['order']))
  857.         {
  858.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  859.         }
  861.         return static::findBy($arrColumns, null, $arrOptions);
  862.     }
  864.     /**
  865.      * Find all published regular pages by their parent IDs
  866.      *
  867.      * @param integer $intPid     The parent page's ID
  868.      * @param array   $arrOptions An optional options array
  869.      *
  870.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  871.      */
  872.     public static function findPublishedRegularByPid($intPid, array $arrOptions=array())
  873.     {
  874.         $t = static::$strTable;
  875.         $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  876.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type NOT IN ('" . implode("', '", $unroutableTypes) . "')");
  878.         if (!static::isPreviewMode($arrOptions))
  879.         {
  880.             $time = Date::floorToMinute();
  881.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  882.         }
  884.         if (!isset($arrOptions['order']))
  885.         {
  886.             $arrOptions['order'] = "$t.sorting";
  887.         }
  889.         return static::findBy($arrColumns, $intPid, $arrOptions);
  890.     }
  892.     /**
  893.      * Find all published regular pages by their parent IDs and exclude pages only visible for guests
  894.      *
  895.      * @param integer $intPid     The parent page's ID
  896.      * @param array   $arrOptions An optional options array
  897.      *
  898.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  899.      *
  900.      * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5;
  901.      *             use PageModel::findPublishedRegularByPid() instead.
  902.      */
  903.     public static function findPublishedRegularWithoutGuestsByPid($intPid, array $arrOptions=array())
  904.     {
  905.         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.');
  907.         $t = static::$strTable;
  908.         $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  909.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type NOT IN ('" . implode("', '", $unroutableTypes) . "')");
  911.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  912.         {
  913.             $arrColumns[] = "$t.guests=''";
  914.         }
  916.         if (!static::isPreviewMode($arrOptions))
  917.         {
  918.             $time = Date::floorToMinute();
  919.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  920.         }
  922.         if (!isset($arrOptions['order']))
  923.         {
  924.             $arrOptions['order'] = "$t.sorting";
  925.         }
  927.         return static::findBy($arrColumns, $intPid, $arrOptions);
  928.     }
  930.     /**
  931.      * Find the language fallback page by hostname
  932.      *
  933.      * @param string $strHost    The hostname
  934.      * @param array  $arrOptions An optional options array
  935.      *
  936.      * @return PageModel|Model|null The model or null if there is no fallback page
  937.      */
  938.     public static function findPublishedFallbackByHostname($strHost, array $arrOptions=array())
  939.     {
  940.         // Try to load from the registry (see #8544)
  941.         if (empty($arrOptions))
  942.         {
  943.             $objModel = Registry::getInstance()->fetch(static::$strTable, $strHost, 'contao.dns-fallback');
  945.             if ($objModel !== null)
  946.             {
  947.                 return $objModel;
  948.             }
  949.         }
  951.         $t = static::$strTable;
  952.         $arrColumns = array("$t.dns=? AND $t.fallback='1'");
  954.         if (isset($arrOptions['fallbackToEmpty']) && $arrOptions['fallbackToEmpty'] === true)
  955.         {
  956.             $arrColumns = array("($t.dns=? OR $t.dns='') AND $t.fallback='1'");
  957.         }
  959.         if (!static::isPreviewMode($arrOptions))
  960.         {
  961.             $time = Date::floorToMinute();
  962.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  963.         }
  965.         return static::findOneBy($arrColumns, $strHost, $arrOptions);
  966.     }
  968.     /**
  969.      * Finds the published root pages
  970.      *
  971.      * @param array $arrOptions An optional options array
  972.      *
  973.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  974.      */
  975.     public static function findPublishedRootPages(array $arrOptions=array())
  976.     {
  977.         $t = static::$strTable;
  978.         $arrColumns = array("$t.type='root'");
  980.         if (isset($arrOptions['dns']))
  981.         {
  982.             $arrColumns = array("$t.type='root' AND $t.dns=?");
  983.         }
  985.         if (!static::isPreviewMode($arrOptions))
  986.         {
  987.             $time = Date::floorToMinute();
  988.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  989.         }
  991.         return static::findBy($arrColumns, $arrOptions['dns'] ?? null, $arrOptions);
  992.     }
  994.     /**
  995.      * Find the parent pages of a page
  996.      *
  997.      * @param integer $intId The page's ID
  998.      *
  999.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  1000.      */
  1001.     public static function findParentsById($intId)
  1002.     {
  1003.         $arrModels = array();
  1005.         while ($intId > 0 && ($objPage = static::findByPk($intId)) !== null)
  1006.         {
  1007.             $intId = $objPage->pid;
  1008.             $arrModels[] = $objPage;
  1009.         }
  1011.         if (empty($arrModels))
  1012.         {
  1013.             return null;
  1014.         }
  1016.         return static::createCollection($arrModels, 'tl_page');
  1017.     }
  1019.     /**
  1020.      * Find the first active page by its member groups
  1021.      *
  1022.      * @param array $arrIds An array of member group IDs
  1023.      *
  1024.      * @return PageModel|null The model or null if there is no matching member group
  1025.      */
  1026.     public static function findFirstActiveByMemberGroups($arrIds)
  1027.     {
  1028.         if (empty($arrIds) || !\is_array($arrIds))
  1029.         {
  1030.             return null;
  1031.         }
  1033.         $time = Date::floorToMinute();
  1034.         $objDatabase = Database::getInstance();
  1035.         $arrIds = array_map('\intval', $arrIds);
  1037.         $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))
  1038.                                  ->limit(1)
  1039.                                  ->execute();
  1041.         if ($objResult->numRows < 1)
  1042.         {
  1043.             return null;
  1044.         }
  1046.         $objRegistry = Registry::getInstance();
  1048.         /** @var PageModel|Model $objPage */
  1049.         if ($objPage = $objRegistry->fetch('tl_page', $objResult->id))
  1050.         {
  1051.             return $objPage;
  1052.         }
  1054.         return new static($objResult);
  1055.     }
  1057.     /**
  1058.      * Find a page by its ID and return it with the inherited details
  1059.      *
  1060.      * @param integer|string $intId The page's ID
  1061.      *
  1062.      * @return PageModel|null The model or null if there is no matching page
  1063.      */
  1064.     public static function findWithDetails($intId)
  1065.     {
  1066.         $objPage = static::findByPk($intId);
  1068.         if ($objPage === null)
  1069.         {
  1070.             return null;
  1071.         }
  1073.         return $objPage->loadDetails();
  1074.     }
  1076.     /**
  1077.      * Register the contao.dns-fallback alias when the model is attached to the registry
  1078.      *
  1079.      * @param Registry $registry The model registry
  1080.      */
  1081.     public function onRegister(Registry $registry)
  1082.     {
  1083.         parent::onRegister($registry);
  1085.         // Register this model as being the fallback page for a given dns
  1086.         if ($this->fallback && $this->type == 'root' && !$registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  1087.         {
  1088.             $registry->registerAlias($this, 'contao.dns-fallback', $this->dns);
  1089.         }
  1090.     }
  1092.     /**
  1093.      * Unregister the contao.dns-fallback alias when the model is detached from the registry
  1094.      *
  1095.      * @param Registry $registry The model registry
  1096.      */
  1097.     public function onUnregister(Registry $registry)
  1098.     {
  1099.         parent::onUnregister($registry);
  1101.         // Unregister the fallback page
  1102.         if ($this->fallback && $this->type == 'root' && $registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  1103.         {
  1104.             $registry->unregisterAlias($this, 'contao.dns-fallback', $this->dns);
  1105.         }
  1106.     }
  1108.     /**
  1109.      * Get the details of a page including inherited parameters
  1110.      *
  1111.      * @return PageModel The page model
  1112.      *
  1113.      * @throws NoRootPageFoundException If no root page is found
  1114.      */
  1115.     public function loadDetails()
  1116.     {
  1117.         // Loaded already
  1118.         if ($this->blnDetailsLoaded)
  1119.         {
  1120.             return $this;
  1121.         }
  1123.         // Set some default values
  1124.         $this->protected = (bool) $this->protected;
  1125.         $this->groups = $this->protected ? StringUtil::deserialize($this->groups, true) : array();
  1126.         $this->layout = $this->includeLayout ? $this->layout : false;
  1127.         $this->cache = $this->includeCache ? $this->cache : false;
  1128.         $this->alwaysLoadFromCache = $this->includeCache ? $this->alwaysLoadFromCache : false;
  1129.         $this->clientCache = $this->includeCache ? $this->clientCache : false;
  1131.         $pid = $this->pid;
  1132.         $type = $this->type;
  1133.         $alias = $this->alias;
  1134.         $name = $this->title;
  1135.         $title = $this->pageTitle ?: $this->title;
  1136.         $folderUrl = '';
  1137.         $palias = '';
  1138.         $pname = '';
  1139.         $ptitle = '';
  1140.         $trail = array($this->id, $pid);
  1141.         $time = time();
  1143.         // Inherit the settings
  1144.         if ($this->type == 'root')
  1145.         {
  1146.             $objParentPage = $this; // see #4610
  1147.         }
  1148.         else
  1149.         {
  1150.             // Load all parent pages
  1151.             $objParentPage = self::findParentsById($pid);
  1153.             if ($objParentPage !== null)
  1154.             {
  1155.                 while ($pid > 0 && $type != 'root' && $objParentPage->next())
  1156.                 {
  1157.                     $pid = $objParentPage->pid;
  1158.                     $type = $objParentPage->type;
  1160.                     // Parent title
  1161.                     if (!$ptitle)
  1162.                     {
  1163.                         $palias = $objParentPage->alias;
  1164.                         $pname = $objParentPage->title;
  1165.                         $ptitle = $objParentPage->pageTitle ?: $objParentPage->title;
  1166.                     }
  1168.                     // Page title
  1169.                     if ($type != 'root')
  1170.                     {
  1171.                         // If $folderUrl is not yet set, use the alias of the first
  1172.                         // parent page if it is not a root page (see #2129)
  1173.                         if (!$folderUrl && $objParentPage->alias)
  1174.                         {
  1175.                             $folderUrl = $objParentPage->alias . '/';
  1176.                         }
  1178.                         $alias = $objParentPage->alias;
  1179.                         $name = $objParentPage->title;
  1180.                         $title = $objParentPage->pageTitle ?: $objParentPage->title;
  1181.                         $trail[] = $objParentPage->pid;
  1182.                     }
  1184.                     // Cache
  1185.                     if ($objParentPage->includeCache)
  1186.                     {
  1187.                         $this->cache = $this->cache !== false ? $this->cache : $objParentPage->cache;
  1188.                         $this->alwaysLoadFromCache = $this->alwaysLoadFromCache !== false ? $this->alwaysLoadFromCache : $objParentPage->alwaysLoadFromCache;
  1189.                         $this->clientCache = $this->clientCache !== false ? $this->clientCache : $objParentPage->clientCache;
  1190.                     }
  1192.                     // Layout
  1193.                     if ($objParentPage->includeLayout && $this->layout === false)
  1194.                     {
  1195.                         $this->layout = $objParentPage->subpageLayout ?: $objParentPage->layout;
  1196.                     }
  1198.                     // Protection
  1199.                     if ($objParentPage->protected && $this->protected === false)
  1200.                     {
  1201.                         $this->protected = true;
  1202.                         $this->groups = StringUtil::deserialize($objParentPage->groups, true);
  1203.                     }
  1204.                 }
  1205.             }
  1207.             // Set the titles
  1208.             $this->mainAlias = $alias;
  1209.             $this->mainTitle = $name;
  1210.             $this->mainPageTitle = $title;
  1211.             $this->parentAlias = $palias;
  1212.             $this->parentTitle = $pname;
  1213.             $this->parentPageTitle = $ptitle;
  1214.             $this->folderUrl = $folderUrl;
  1215.         }
  1217.         // Set the root ID and title
  1218.         if ($objParentPage !== null && $objParentPage->type == 'root')
  1219.         {
  1220.             $this->rootId = $objParentPage->id;
  1221.             $this->rootAlias = $objParentPage->alias;
  1222.             $this->rootTitle = $objParentPage->title;
  1223.             $this->rootPageTitle = $objParentPage->pageTitle ?: $objParentPage->title;
  1224.             $this->rootSorting = $objParentPage->sorting;
  1225.             $this->domain = $objParentPage->dns;
  1226.             $this->rootLanguage = $objParentPage->language;
  1227.             $this->language = $objParentPage->language;
  1228.             $this->staticFiles = $objParentPage->staticFiles;
  1229.             $this->staticPlugins = $objParentPage->staticPlugins;
  1230.             $this->dateFormat = $objParentPage->dateFormat;
  1231.             $this->timeFormat = $objParentPage->timeFormat;
  1232.             $this->datimFormat = $objParentPage->datimFormat;
  1233.             $this->validAliasCharacters = $objParentPage->validAliasCharacters;
  1234.             $this->urlPrefix = $objParentPage->urlPrefix;
  1235.             $this->urlSuffix = $objParentPage->urlSuffix;
  1236.             $this->disableLanguageRedirect = $objParentPage->disableLanguageRedirect;
  1237.             $this->adminEmail = $objParentPage->adminEmail;
  1238.             $this->enforceTwoFactor = $objParentPage->enforceTwoFactor;
  1239.             $this->twoFactorJumpTo = $objParentPage->twoFactorJumpTo;
  1240.             $this->useFolderUrl = $objParentPage->useFolderUrl;
  1241.             $this->mailerTransport = $objParentPage->mailerTransport;
  1242.             $this->enableCanonical = $objParentPage->enableCanonical;
  1243.             $this->useAutoItem = Config::get('useAutoItem');
  1244.             $this->maintenanceMode = $objParentPage->maintenanceMode;
  1246.             // Store whether the root page has been published
  1247.             $this->rootIsPublic = ($objParentPage->published && (!$objParentPage->start || $objParentPage->start <= $time) && (!$objParentPage->stop || $objParentPage->stop > $time));
  1248.             $this->rootIsFallback = (bool) $objParentPage->fallback;
  1249.             $this->rootUseSSL = $objParentPage->useSSL;
  1250.             $this->rootFallbackLanguage = $objParentPage->language;
  1252.             // Store the fallback language (see #6874)
  1253.             if (!$objParentPage->fallback)
  1254.             {
  1255.                 $this->rootFallbackLanguage = null;
  1257.                 $objFallback = static::findPublishedFallbackByHostname($objParentPage->dns);
  1259.                 if ($objFallback !== null)
  1260.                 {
  1261.                     $this->rootFallbackLanguage = $objFallback->language;
  1262.                 }
  1263.             }
  1265.             if (System::getContainer()->getParameter('contao.legacy_routing'))
  1266.             {
  1267.                 $this->urlPrefix = System::getContainer()->getParameter('contao.prepend_locale') ? LocaleUtil::formatAsLanguageTag($objParentPage->language) : '';
  1268.                 $this->urlSuffix = System::getContainer()->getParameter('contao.url_suffix');
  1269.             }
  1270.         }
  1272.         // No root page found
  1273.         elseif (TL_MODE == 'FE' && $this->type != 'root')
  1274.         {
  1275.             System::getContainer()->get('monolog.logger.contao.error')->error('Page ID "' . $this->id . '" does not belong to a root page');
  1277.             throw new NoRootPageFoundException('No root page found');
  1278.         }
  1280.         $this->trail = array_reverse($trail);
  1282.         // Use the global date format if none is set (see #6104)
  1283.         if (!$this->dateFormat)
  1284.         {
  1285.             $this->dateFormat = Config::get('dateFormat');
  1286.         }
  1288.         if (!$this->timeFormat)
  1289.         {
  1290.             $this->timeFormat = Config::get('timeFormat');
  1291.         }
  1293.         if (!$this->datimFormat)
  1294.         {
  1295.             $this->datimFormat = Config::get('datimFormat');
  1296.         }
  1298.         $this->isPublic = ($this->published && (!$this->start || $this->start <= $time) && (!$this->stop || $this->stop > $time));
  1300.         // HOOK: add custom logic
  1301.         if (!empty($GLOBALS['TL_HOOKS']['loadPageDetails']) && \is_array($GLOBALS['TL_HOOKS']['loadPageDetails']))
  1302.         {
  1303.             $parentModels = array();
  1305.             if ($objParentPage instanceof Collection)
  1306.             {
  1307.                 $parentModels = $objParentPage->getModels();
  1308.             }
  1310.             foreach ($GLOBALS['TL_HOOKS']['loadPageDetails'] as $callback)
  1311.             {
  1312.                 System::importStatic($callback[0])->{$callback[1]}($parentModels, $this);
  1313.             }
  1314.         }
  1316.         // Prevent saving (see #6506 and #7199)
  1317.         $this->preventSaving();
  1318.         $this->blnDetailsLoaded = true;
  1320.         return $this;
  1321.     }
  1323.     /**
  1324.      * Generate a front end URL
  1325.      *
  1326.      * @param string $strParams    An optional string of URL parameters
  1327.      * @param string $strForceLang Force a certain language
  1328.      *
  1329.      * @throws RouteNotFoundException
  1330.      * @throws ResourceNotFoundException
  1331.      *
  1332.      * @return string A URL that can be used in the front end
  1333.      */
  1334.     public function getFrontendUrl($strParams=null, $strForceLang=null)
  1335.     {
  1336.         $page = $this;
  1337.         $page->loadDetails();
  1339.         if ($strForceLang !== null)
  1340.         {
  1341.             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.');
  1343.             $strForceLang = LocaleUtil::formatAsLanguageTag($strForceLang);
  1345.             $page = $page->cloneOriginal();
  1346.             $page->preventSaving(false);
  1347.             $page->language = $strForceLang;
  1348.             $page->rootLanguage = $strForceLang;
  1350.             if (System::getContainer()->getParameter('contao.legacy_routing'))
  1351.             {
  1352.                 $page->urlPrefix = System::getContainer()->getParameter('contao.prepend_locale') ? $strForceLang : '';
  1353.             }
  1354.         }
  1356.         $objRouter = System::getContainer()->get('router');
  1358.         try
  1359.         {
  1360.             $strUrl = $objRouter->generate(RouteObjectInterface::OBJECT_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $this, 'parameters' => $strParams));
  1361.         }
  1362.         catch (RouteNotFoundException $e)
  1363.         {
  1364.             $pageRegistry = System::getContainer()->get('contao.routing.page_registry');
  1366.             if (!$pageRegistry->isRoutable($this))
  1367.             {
  1368.                 throw new ResourceNotFoundException(sprintf('Page ID %s is not routable', $this->id), 0, $e);
  1369.             }
  1371.             throw $e;
  1372.         }
  1374.         // Make the URL relative to the base path
  1375.         if (0 === strncmp($strUrl, '/', 1) && 0 !== strncmp($strUrl, '//', 2))
  1376.         {
  1377.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1378.         }
  1380.         return $this->applyLegacyLogic($strUrl, $strParams);
  1381.     }
  1383.     /**
  1384.      * Generate an absolute URL depending on the current rewriteURL setting
  1385.      *
  1386.      * @param string $strParams An optional string of URL parameters
  1387.      *
  1388.      * @throws RouteNotFoundException
  1389.      * @throws ResourceNotFoundException
  1390.      *
  1391.      * @return string An absolute URL that can be used in the front end
  1392.      */
  1393.     public function getAbsoluteUrl($strParams=null)
  1394.     {
  1395.         $this->loadDetails();
  1397.         $objRouter = System::getContainer()->get('router');
  1399.         try
  1400.         {
  1401.             $strUrl = $objRouter->generate(RouteObjectInterface::OBJECT_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $this, 'parameters' => $strParams), UrlGeneratorInterface::ABSOLUTE_URL);
  1402.         }
  1403.         catch (RouteNotFoundException $e)
  1404.         {
  1405.             $pageRegistry = System::getContainer()->get('contao.routing.page_registry');
  1407.             if (!$pageRegistry->isRoutable($this))
  1408.             {
  1409.                 throw new ResourceNotFoundException(sprintf('Page ID %s is not routable', $this->id), 0, $e);
  1410.             }
  1412.             throw $e;
  1413.         }
  1415.         return $this->applyLegacyLogic($strUrl, $strParams);
  1416.     }
  1418.     /**
  1419.      * Generate the front end preview URL
  1420.      *
  1421.      * @param string $strParams An optional string of URL parameters
  1422.      *
  1423.      * @throws RouteNotFoundException
  1424.      * @throws ResourceNotFoundException
  1425.      *
  1426.      * @return string The front end preview URL
  1427.      */
  1428.     public function getPreviewUrl($strParams=null)
  1429.     {
  1430.         $container = System::getContainer();
  1432.         if (!$previewScript = $container->getParameter('contao.preview_script'))
  1433.         {
  1434.             return $this->getAbsoluteUrl($strParams);
  1435.         }
  1437.         $this->loadDetails();
  1439.         $context = $container->get('router')->getContext();
  1440.         $baseUrl = $context->getBaseUrl();
  1442.         // Add the preview script
  1443.         $context->setBaseUrl($previewScript);
  1445.         $objRouter = System::getContainer()->get('router');
  1447.         try
  1448.         {
  1449.             $strUrl = $objRouter->generate(RouteObjectInterface::OBJECT_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $this, 'parameters' => $strParams), UrlGeneratorInterface::ABSOLUTE_URL);
  1450.         }
  1451.         catch (RouteNotFoundException $e)
  1452.         {
  1453.             $pageRegistry = System::getContainer()->get('contao.routing.page_registry');
  1455.             if (!$pageRegistry->isRoutable($this))
  1456.             {
  1457.                 throw new ResourceNotFoundException(sprintf('Page ID %s is not routable', $this->id), 0, $e);
  1458.             }
  1460.             throw $e;
  1461.         }
  1463.         $context->setBaseUrl($baseUrl);
  1465.         return $this->applyLegacyLogic($strUrl, $strParams);
  1466.     }
  1468.     /**
  1469.      * Return the slug options
  1470.      *
  1471.      * @return array The slug options
  1472.      */
  1473.     public function getSlugOptions()
  1474.     {
  1475.         $slugOptions = array('locale'=>$this->language);
  1477.         if ($this->validAliasCharacters)
  1478.         {
  1479.             $slugOptions['validChars'] = $this->validAliasCharacters;
  1480.         }
  1482.         return $slugOptions;
  1483.     }
  1485.     /**
  1486.      * Modifies a URL from the URL generator.
  1487.      *
  1488.      * @param string      $strUrl
  1489.      * @param string|null $strParams
  1490.      *
  1491.      * @return string
  1492.      */
  1493.     private function applyLegacyLogic($strUrl, $strParams)
  1494.     {
  1495.         // Decode sprintf placeholders
  1496.         if ($strParams !== null && strpos($strParams, '%') !== false)
  1497.         {
  1498.             trigger_deprecation('contao/core-bundle', '4.2', 'Using sprintf placeholders in URLs has been deprecated and will no longer work in Contao 5.0.');
  1500.             $arrMatches = array();
  1501.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1503.             foreach (array_unique($arrMatches[1]) as $v)
  1504.             {
  1505.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1506.             }
  1507.         }
  1509.         // HOOK: add custom logic
  1510.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1511.         {
  1512.             trigger_deprecation('contao/core-bundle', '4.0', 'Using the "generateFrontendUrl" hook has been deprecated and will no longer work in Contao 5.0.');
  1514.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1515.             {
  1516.                 $strUrl = System::importStatic($callback[0])->{$callback[1]}($this->row(), $strParams ?? '', $strUrl);
  1517.             }
  1519.             return $strUrl;
  1520.         }
  1522.         return $strUrl;
  1523.     }
  1525.     private static function stripPrefixesAndSuffixes(string $alias, string $urlPrefix, string $urlSuffix): string
  1526.     {
  1527.         if (null === self::$prefixes || null === self::$suffixes)
  1528.         {
  1529.             $rows = Database::getInstance()
  1530.                 ->execute("SELECT urlPrefix, urlSuffix FROM tl_page WHERE type='root'")
  1531.                 ->fetchAllAssoc()
  1532.             ;
  1534.             self::$prefixes = array();
  1535.             self::$suffixes = array();
  1537.             foreach (array_column($rows, 'urlPrefix') as $prefix)
  1538.             {
  1539.                 $prefix = trim($prefix, '/');
  1541.                 if ('' !== $prefix)
  1542.                 {
  1543.                     self::$prefixes[] = $prefix . '/';
  1544.                 }
  1545.             }
  1547.             foreach (array_column($rows, 'urlSuffix') as $suffix)
  1548.             {
  1549.                 self::$suffixes[] = $suffix;
  1550.             }
  1551.         }
  1553.         $prefixes = self::$prefixes;
  1555.         if (!empty($urlPrefix))
  1556.         {
  1557.             $prefixes[] = $urlPrefix . '/';
  1558.         }
  1560.         if (null !== ($prefixRegex = self::regexArray($prefixes)))
  1561.         {
  1562.             $alias = preg_replace('/^' . $prefixRegex . '/i', '', $alias);
  1563.         }
  1565.         if (null !== ($suffixRegex = self::regexArray(array_merge(array($urlSuffix), self::$suffixes))))
  1566.         {
  1567.             $alias = preg_replace('/' . $suffixRegex . '$/i', '', $alias);
  1568.         }
  1570.         return $alias;
  1571.     }
  1573.     private static function regexArray(array $data): ?string
  1574.     {
  1575.         $data = array_filter(array_unique($data));
  1577.         if (0 === \count($data))
  1578.         {
  1579.             return null;
  1580.         }
  1582.         usort($data, static fn ($v, $k) => \strlen($v));
  1584.         foreach ($data as $k => $v)
  1585.         {
  1586.             $data[$k] = preg_quote($v, '/');
  1587.         }
  1589.         return '(' . implode('|', $data) . ')';
  1590.     }
  1591. }
  1593. class_alias(PageModel::class, 'PageModel');