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

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