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

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\Model\Collection;
  15. use Contao\Model\Registry;
  16. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  18. /**
  19.  * Reads and writes pages
  20.  *
  21.  * @property integer $id
  22.  * @property integer $pid
  23.  * @property integer $sorting
  24.  * @property integer $tstamp
  25.  * @property string  $title
  26.  * @property string  $alias
  27.  * @property string  $type
  28.  * @property string  $pageTitle
  29.  * @property string  $language
  30.  * @property string  $robots
  31.  * @property string  $description
  32.  * @property string  $redirect
  33.  * @property integer $jumpTo
  34.  * @property string  $redirectBack
  35.  * @property string  $url
  36.  * @property string  $target
  37.  * @property string  $dns
  38.  * @property string  $staticFiles
  39.  * @property string  $staticPlugins
  40.  * @property string  $fallback
  41.  * @property string  $favicon
  42.  * @property string  $robotsTxt
  43.  * @property string  $adminEmail
  44.  * @property string  $dateFormat
  45.  * @property string  $timeFormat
  46.  * @property string  $datimFormat
  47.  * @property string  $validAliasCharacters
  48.  * @property string  $createSitemap
  49.  * @property string  $sitemapName
  50.  * @property string  $useSSL
  51.  * @property string  $autoforward
  52.  * @property string  $protected
  53.  * @property string  $groups
  54.  * @property string  $includeLayout
  55.  * @property integer $layout
  56.  * @property string  $includeCache
  57.  * @property integer $cache
  58.  * @property string  $alwaysLoadFromCache
  59.  * @property integer $clientCache
  60.  * @property string  $includeChmod
  61.  * @property integer $cuser
  62.  * @property integer $cgroup
  63.  * @property string  $chmod
  64.  * @property string  $noSearch
  65.  * @property string  $requireItem
  66.  * @property string  $cssClass
  67.  * @property string  $sitemap
  68.  * @property string  $hide
  69.  * @property string  $guests
  70.  * @property integer $tabindex
  71.  * @property string  $accesskey
  72.  * @property string  $published
  73.  * @property string  $start
  74.  * @property string  $stop
  75.  * @property array   $trail
  76.  * @property string  $mainAlias
  77.  * @property string  $mainTitle
  78.  * @property string  $mainPageTitle
  79.  * @property string  $parentAlias
  80.  * @property string  $parentTitle
  81.  * @property string  $parentPageTitle
  82.  * @property string  $folderUrl
  83.  * @property boolean $isPublic
  84.  * @property integer $rootId
  85.  * @property string  $rootAlias
  86.  * @property string  $rootTitle
  87.  * @property string  $rootPageTitle
  88.  * @property integer $rootSorting
  89.  * @property string  $domain
  90.  * @property string  $rootLanguage
  91.  * @property boolean $rootIsPublic
  92.  * @property boolean $rootIsFallback
  93.  * @property boolean $rootUseSSL
  94.  * @property string  $rootFallbackLanguage
  95.  * @property array   $subpages
  96.  * @property boolean $minifyMarkup
  97.  * @property integer $layoutId
  98.  * @property boolean $hasJQuery
  99.  * @property boolean $hasMooTools
  100.  * @property string  $template
  101.  * @property string  $templateGroup
  102.  * @property string  $enforceTwoFactor
  103.  * @property integer $twoFactorJumpTo
  104.  *
  105.  * @method static PageModel|null findById($id, array $opt=array())
  106.  * @method static PageModel|null findByPk($id, array $opt=array())
  107.  * @method static PageModel|null findByIdOrAlias($val, array $opt=array())
  108.  * @method static PageModel|null findOneBy($col, $val, array $opt=array())
  109.  * @method static PageModel|null findOneByPid($val, array $opt=array())
  110.  * @method static PageModel|null findOneBySorting($val, array $opt=array())
  111.  * @method static PageModel|null findOneByTstamp($val, array $opt=array())
  112.  * @method static PageModel|null findOneByTitle($val, array $opt=array())
  113.  * @method static PageModel|null findOneByAlias($val, array $opt=array())
  114.  * @method static PageModel|null findOneByType($val, array $opt=array())
  115.  * @method static PageModel|null findOneByPageTitle($val, array $opt=array())
  116.  * @method static PageModel|null findOneByLanguage($val, array $opt=array())
  117.  * @method static PageModel|null findOneByRobots($val, array $opt=array())
  118.  * @method static PageModel|null findOneByDescription($val, array $opt=array())
  119.  * @method static PageModel|null findOneByRedirect($val, array $opt=array())
  120.  * @method static PageModel|null findOneByJumpTo($val, array $opt=array())
  121.  * @method static PageModel|null findOneByRedirectBack($val, array $opt=array())
  122.  * @method static PageModel|null findOneByUrl($val, array $opt=array())
  123.  * @method static PageModel|null findOneByTarget($val, array $opt=array())
  124.  * @method static PageModel|null findOneByDns($val, array $opt=array())
  125.  * @method static PageModel|null findOneByStaticFiles($val, array $opt=array())
  126.  * @method static PageModel|null findOneByStaticPlugins($val, array $opt=array())
  127.  * @method static PageModel|null findOneByFallback($val, array $opt=array())
  128.  * @method static PageModel|null findOneByFavicon($val, array $opt=array())
  129.  * @method static PageModel|null findOneByRobotsTxt($val, array $opt=array())
  130.  * @method static PageModel|null findOneByAdminEmail($val, array $opt=array())
  131.  * @method static PageModel|null findOneByDateFormat($val, array $opt=array())
  132.  * @method static PageModel|null findOneByTimeFormat($val, array $opt=array())
  133.  * @method static PageModel|null findOneByDatimFormat($val, array $opt=array())
  134.  * @method static PageModel|null findOneByCreateSitemap($val, array $opt=array())
  135.  * @method static PageModel|null findOneBySitemapName($val, array $opt=array())
  136.  * @method static PageModel|null findOneByUseSSL($val, array $opt=array())
  137.  * @method static PageModel|null findOneByAutoforward($val, array $opt=array())
  138.  * @method static PageModel|null findOneByProtected($val, array $opt=array())
  139.  * @method static PageModel|null findOneByGroups($val, array $opt=array())
  140.  * @method static PageModel|null findOneByIncludeLayout($val, array $opt=array())
  141.  * @method static PageModel|null findOneByLayout($val, array $opt=array())
  142.  * @method static PageModel|null findOneByIncludeCache($val, array $opt=array())
  143.  * @method static PageModel|null findOneByCache($val, array $opt=array())
  144.  * @method static PageModel|null findOneByIncludeChmod($val, array $opt=array())
  145.  * @method static PageModel|null findOneByCuser($val, array $opt=array())
  146.  * @method static PageModel|null findOneByCgroup($val, array $opt=array())
  147.  * @method static PageModel|null findOneByChmod($val, array $opt=array())
  148.  * @method static PageModel|null findOneByNoSearch($val, array $opt=array())
  149.  * @method static PageModel|null findOneByCssClass($val, array $opt=array())
  150.  * @method static PageModel|null findOneBySitemap($val, array $opt=array())
  151.  * @method static PageModel|null findOneByHide($val, array $opt=array())
  152.  * @method static PageModel|null findOneByGuests($val, array $opt=array())
  153.  * @method static PageModel|null findOneByTabindex($val, array $opt=array())
  154.  * @method static PageModel|null findOneByAccesskey($val, array $opt=array())
  155.  * @method static PageModel|null findOneByPublished($val, array $opt=array())
  156.  * @method static PageModel|null findOneByStart($val, array $opt=array())
  157.  * @method static PageModel|null findOneByStop($val, array $opt=array())
  158.  * @method static PageModel|null findOneByEnforceTwoFactor($val, array $opt=array())
  159.  * @method static PageModel|null findOneByTwoFactorJumpTo($val, array $opt=array())
  160.  *
  161.  * @method static Collection|PageModel[]|PageModel|null findByPid($val, array $opt=array())
  162.  * @method static Collection|PageModel[]|PageModel|null findBySorting($val, array $opt=array())
  163.  * @method static Collection|PageModel[]|PageModel|null findByTstamp($val, array $opt=array())
  164.  * @method static Collection|PageModel[]|PageModel|null findByTitle($val, array $opt=array())
  165.  * @method static Collection|PageModel[]|PageModel|null findByAlias($val, array $opt=array())
  166.  * @method static Collection|PageModel[]|PageModel|null findByType($val, array $opt=array())
  167.  * @method static Collection|PageModel[]|PageModel|null findByPageTitle($val, array $opt=array())
  168.  * @method static Collection|PageModel[]|PageModel|null findByLanguage($val, array $opt=array())
  169.  * @method static Collection|PageModel[]|PageModel|null findByRobots($val, array $opt=array())
  170.  * @method static Collection|PageModel[]|PageModel|null findByDescription($val, array $opt=array())
  171.  * @method static Collection|PageModel[]|PageModel|null findByRedirect($val, array $opt=array())
  172.  * @method static Collection|PageModel[]|PageModel|null findByJumpTo($val, array $opt=array())
  173.  * @method static Collection|PageModel[]|PageModel|null findByRedirectBack($val, array $opt=array())
  174.  * @method static Collection|PageModel[]|PageModel|null findByUrl($val, array $opt=array())
  175.  * @method static Collection|PageModel[]|PageModel|null findByTarget($val, array $opt=array())
  176.  * @method static Collection|PageModel[]|PageModel|null findByDns($val, array $opt=array())
  177.  * @method static Collection|PageModel[]|PageModel|null findByStaticFiles($val, array $opt=array())
  178.  * @method static Collection|PageModel[]|PageModel|null findByStaticPlugins($val, array $opt=array())
  179.  * @method static Collection|PageModel[]|PageModel|null findByFallback($val, array $opt=array())
  180.  * @method static Collection|PageModel[]|PageModel|null findByFavicon($val, array $opt=array())
  181.  * @method static Collection|PageModel[]|PageModel|null findByRobotsTxt($val, array $opt=array())
  182.  * @method static Collection|PageModel[]|PageModel|null findByAdminEmail($val, array $opt=array())
  183.  * @method static Collection|PageModel[]|PageModel|null findByDateFormat($val, array $opt=array())
  184.  * @method static Collection|PageModel[]|PageModel|null findByTimeFormat($val, array $opt=array())
  185.  * @method static Collection|PageModel[]|PageModel|null findByDatimFormat($val, array $opt=array())
  186.  * @method static Collection|PageModel[]|PageModel|null findByCreateSitemap($val, array $opt=array())
  187.  * @method static Collection|PageModel[]|PageModel|null findBySitemapName($val, array $opt=array())
  188.  * @method static Collection|PageModel[]|PageModel|null findByUseSSL($val, array $opt=array())
  189.  * @method static Collection|PageModel[]|PageModel|null findByAutoforward($val, array $opt=array())
  190.  * @method static Collection|PageModel[]|PageModel|null findByProtected($val, array $opt=array())
  191.  * @method static Collection|PageModel[]|PageModel|null findByGroups($val, array $opt=array())
  192.  * @method static Collection|PageModel[]|PageModel|null findByIncludeLayout($val, array $opt=array())
  193.  * @method static Collection|PageModel[]|PageModel|null findByLayout($val, array $opt=array())
  194.  * @method static Collection|PageModel[]|PageModel|null findByIncludeCache($val, array $opt=array())
  195.  * @method static Collection|PageModel[]|PageModel|null findByCache($val, array $opt=array())
  196.  * @method static Collection|PageModel[]|PageModel|null findByIncludeChmod($val, array $opt=array())
  197.  * @method static Collection|PageModel[]|PageModel|null findByCuser($val, array $opt=array())
  198.  * @method static Collection|PageModel[]|PageModel|null findByCgroup($val, array $opt=array())
  199.  * @method static Collection|PageModel[]|PageModel|null findByChmod($val, array $opt=array())
  200.  * @method static Collection|PageModel[]|PageModel|null findByNoSearch($val, array $opt=array())
  201.  * @method static Collection|PageModel[]|PageModel|null findByCssClass($val, array $opt=array())
  202.  * @method static Collection|PageModel[]|PageModel|null findBySitemap($val, array $opt=array())
  203.  * @method static Collection|PageModel[]|PageModel|null findByHide($val, array $opt=array())
  204.  * @method static Collection|PageModel[]|PageModel|null findByGuests($val, array $opt=array())
  205.  * @method static Collection|PageModel[]|PageModel|null findByTabindex($val, array $opt=array())
  206.  * @method static Collection|PageModel[]|PageModel|null findByAccesskey($val, array $opt=array())
  207.  * @method static Collection|PageModel[]|PageModel|null findByPublished($val, array $opt=array())
  208.  * @method static Collection|PageModel[]|PageModel|null findByStart($val, array $opt=array())
  209.  * @method static Collection|PageModel[]|PageModel|null findByStop($val, array $opt=array())
  210.  * @method static Collection|PageModel[]|PageModel|null findByEnforceTwoFactor($val, array $opt=array())
  211.  * @method static Collection|PageModel[]|PageModel|null findByTwoFactorJumpTo($val, array $opt=array())
  212.  * @method static Collection|PageModel[]|PageModel|null findMultipleByIds($val, array $opt=array())
  213.  * @method static Collection|PageModel[]|PageModel|null findBy($col, $val, array $opt=array())
  214.  * @method static Collection|PageModel[]|PageModel|null findAll(array $opt=array())
  215.  *
  216.  * @method static integer countById($id, array $opt=array())
  217.  * @method static integer countByPid($val, array $opt=array())
  218.  * @method static integer countBySorting($val, array $opt=array())
  219.  * @method static integer countByTstamp($val, array $opt=array())
  220.  * @method static integer countByTitle($val, array $opt=array())
  221.  * @method static integer countByAlias($val, array $opt=array())
  222.  * @method static integer countByType($val, array $opt=array())
  223.  * @method static integer countByPageTitle($val, array $opt=array())
  224.  * @method static integer countByLanguage($val, array $opt=array())
  225.  * @method static integer countByRobots($val, array $opt=array())
  226.  * @method static integer countByDescription($val, array $opt=array())
  227.  * @method static integer countByRedirect($val, array $opt=array())
  228.  * @method static integer countByJumpTo($val, array $opt=array())
  229.  * @method static integer countByRedirectBack($val, array $opt=array())
  230.  * @method static integer countByUrl($val, array $opt=array())
  231.  * @method static integer countByTarget($val, array $opt=array())
  232.  * @method static integer countByDns($val, array $opt=array())
  233.  * @method static integer countByStaticFiles($val, array $opt=array())
  234.  * @method static integer countByStaticPlugins($val, array $opt=array())
  235.  * @method static integer countByFallback($val, array $opt=array())
  236.  * @method static integer countByFavicon($val, array $opt=array())
  237.  * @method static integer countByRobotsTxt($val, array $opt=array())
  238.  * @method static integer countByAdminEmail($val, array $opt=array())
  239.  * @method static integer countByDateFormat($val, array $opt=array())
  240.  * @method static integer countByTimeFormat($val, array $opt=array())
  241.  * @method static integer countByDatimFormat($val, array $opt=array())
  242.  * @method static integer countByCreateSitemap($val, array $opt=array())
  243.  * @method static integer countBySitemapName($val, array $opt=array())
  244.  * @method static integer countByUseSSL($val, array $opt=array())
  245.  * @method static integer countByAutoforward($val, array $opt=array())
  246.  * @method static integer countByProtected($val, array $opt=array())
  247.  * @method static integer countByGroups($val, array $opt=array())
  248.  * @method static integer countByIncludeLayout($val, array $opt=array())
  249.  * @method static integer countByLayout($val, array $opt=array())
  250.  * @method static integer countByIncludeCache($val, array $opt=array())
  251.  * @method static integer countByCache($val, array $opt=array())
  252.  * @method static integer countByIncludeChmod($val, array $opt=array())
  253.  * @method static integer countByCuser($val, array $opt=array())
  254.  * @method static integer countByCgroup($val, array $opt=array())
  255.  * @method static integer countByChmod($val, array $opt=array())
  256.  * @method static integer countByNoSearch($val, array $opt=array())
  257.  * @method static integer countByCssClass($val, array $opt=array())
  258.  * @method static integer countBySitemap($val, array $opt=array())
  259.  * @method static integer countByHide($val, array $opt=array())
  260.  * @method static integer countByGuests($val, array $opt=array())
  261.  * @method static integer countByTabindex($val, array $opt=array())
  262.  * @method static integer countByAccesskey($val, array $opt=array())
  263.  * @method static integer countByPublished($val, array $opt=array())
  264.  * @method static integer countByStart($val, array $opt=array())
  265.  * @method static integer countByStop($val, array $opt=array())
  266.  * @method static integer countByEnforceTwoFactor($val, array $opt=array())
  267.  * @method static integer countByTwoFactorJumpTo($val, array $opt=array())
  268.  *
  269.  * @author Leo Feyer <https://github.com/leofeyer>
  270.  */
  271. class PageModel extends Model
  272. {
  273.     /**
  274.      * Table name
  275.      * @var string
  276.      */
  277.     protected static $strTable = 'tl_page';
  279.     /**
  280.      * Details loaded
  281.      * @var boolean
  282.      */
  283.     protected $blnDetailsLoaded = false;
  285.     /**
  286.      * Find a published page by its ID
  287.      *
  288.      * @param integer $intId      The page ID
  289.      * @param array   $arrOptions An optional options array
  290.      *
  291.      * @return PageModel|null The model or null if there is no published page
  292.      */
  293.     public static function findPublishedById($intId, array $arrOptions=array())
  294.     {
  295.         $t = static::$strTable;
  296.         $arrColumns = array("$t.id=?");
  298.         if (!static::isPreviewMode($arrOptions))
  299.         {
  300.             $time = Date::floorToMinute();
  301.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  302.         }
  304.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  305.     }
  307.     /**
  308.      * Find published pages by their PID
  309.      *
  310.      * @param integer $intPid     The parent ID
  311.      * @param array   $arrOptions An optional options array
  312.      *
  313.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  314.      */
  315.     public static function findPublishedByPid($intPid, array $arrOptions=array())
  316.     {
  317.         $t = static::$strTable;
  318.         $arrColumns = array("$t.pid=?");
  320.         if (!static::isPreviewMode($arrOptions))
  321.         {
  322.             $time = Date::floorToMinute();
  323.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  324.         }
  326.         return static::findBy($arrColumns, $intPid, $arrOptions);
  327.     }
  329.     /**
  330.      * Find the first published root page by its host name and language
  331.      *
  332.      * @param string $strHost     The host name
  333.      * @param mixed  $varLanguage An ISO language code or an array of ISO language codes
  334.      * @param array  $arrOptions  An optional options array
  335.      *
  336.      * @return PageModel|null The model or null if there is no matching root page
  337.      *
  338.      * @deprecated Deprecated since Contao 4.7, to be removed in Contao 5.0.
  339.      */
  340.     public static function findFirstPublishedRootByHostAndLanguage($strHost, $varLanguage, array $arrOptions=array())
  341.     {
  342.         @trigger_error('Using PageModel::findFirstPublishedRootByHostAndLanguage() has been deprecated and will no longer work Contao 5.0.', E_USER_DEPRECATED);
  344.         $t = static::$strTable;
  345.         $objDatabase = Database::getInstance();
  347.         if (\is_array($varLanguage))
  348.         {
  349.             $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='')");
  351.             if (!empty($varLanguage))
  352.             {
  353.                 $arrColumns[] = "($t.language IN('" . implode("','", $varLanguage) . "') OR $t.fallback='1')";
  354.             }
  355.             else
  356.             {
  357.                 $arrColumns[] = "$t.fallback='1'";
  358.             }
  360.             if (!isset($arrOptions['order']))
  361.             {
  362.                 $arrOptions['order'] = "$t.dns DESC" . (!empty($varLanguage) ? ", " . $objDatabase->findInSet("$t.language", array_reverse($varLanguage)) . " DESC" : "") . ", $t.sorting";
  363.             }
  365.             if (!static::isPreviewMode($arrOptions))
  366.             {
  367.                 $time = Date::floorToMinute();
  368.                 $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  369.             }
  371.             return static::findOneBy($arrColumns, $strHost, $arrOptions);
  372.         }
  374.         $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='') AND ($t.language=? OR $t.fallback='1')");
  375.         $arrValues = array($strHost, $varLanguage);
  377.         if (!isset($arrOptions['order']))
  378.         {
  379.             $arrOptions['order'] = "$t.dns DESC, $t.fallback";
  380.         }
  382.         if (!static::isPreviewMode($arrOptions))
  383.         {
  384.             $time = Date::floorToMinute();
  385.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  386.         }
  388.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  389.     }
  391.     /**
  392.      * Find the first published page by its parent ID
  393.      *
  394.      * @param integer $intPid     The parent page's 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 findFirstPublishedByPid($intPid, array $arrOptions=array())
  400.     {
  401.         $t = static::$strTable;
  402.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  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.         if (!isset($arrOptions['order']))
  411.         {
  412.             $arrOptions['order'] = "$t.sorting";
  413.         }
  415.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  416.     }
  418.     /**
  419.      * Find the first published regular page by its parent ID
  420.      *
  421.      * @param integer $intPid     The parent page's ID
  422.      * @param array   $arrOptions An optional options array
  423.      *
  424.      * @return PageModel|null The model or null if there is no published regular page
  425.      */
  426.     public static function findFirstPublishedRegularByPid($intPid, array $arrOptions=array())
  427.     {
  428.         $t = static::$strTable;
  429.         $arrColumns = array("$t.pid=? AND $t.type='regular'");
  431.         if (!static::isPreviewMode($arrOptions))
  432.         {
  433.             $time = Date::floorToMinute();
  434.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  435.         }
  437.         if (!isset($arrOptions['order']))
  438.         {
  439.             $arrOptions['order'] = "$t.sorting";
  440.         }
  442.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  443.     }
  445.     /**
  446.      * Find an error 401 page by its parent ID
  447.      *
  448.      * @param integer $intPid     The parent page's ID
  449.      * @param array   $arrOptions An optional options array
  450.      *
  451.      * @return PageModel|null The model or null if there is no 401 page
  452.      */
  453.     public static function find401ByPid($intPid, array $arrOptions=array())
  454.     {
  455.         $t = static::$strTable;
  456.         $arrColumns = array("$t.pid=? AND $t.type='error_401'");
  458.         if (!static::isPreviewMode($arrOptions))
  459.         {
  460.             $time = Date::floorToMinute();
  461.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  462.         }
  464.         if (!isset($arrOptions['order']))
  465.         {
  466.             $arrOptions['order'] = "$t.sorting";
  467.         }
  469.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  470.     }
  472.     /**
  473.      * Find an error 403 page by its parent ID
  474.      *
  475.      * @param integer $intPid     The parent page's ID
  476.      * @param array   $arrOptions An optional options array
  477.      *
  478.      * @return PageModel|null The model or null if there is no 403 page
  479.      */
  480.     public static function find403ByPid($intPid, array $arrOptions=array())
  481.     {
  482.         $t = static::$strTable;
  483.         $arrColumns = array("$t.pid=? AND $t.type='error_403'");
  485.         if (!static::isPreviewMode($arrOptions))
  486.         {
  487.             $time = Date::floorToMinute();
  488.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  489.         }
  491.         if (!isset($arrOptions['order']))
  492.         {
  493.             $arrOptions['order'] = "$t.sorting";
  494.         }
  496.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  497.     }
  499.     /**
  500.      * Find an error 404 page by its parent ID
  501.      *
  502.      * @param integer $intPid     The parent page's ID
  503.      * @param array   $arrOptions An optional options array
  504.      *
  505.      * @return PageModel|null The model or null if there is no 404 page
  506.      */
  507.     public static function find404ByPid($intPid, array $arrOptions=array())
  508.     {
  509.         $t = static::$strTable;
  510.         $arrColumns = array("$t.pid=? AND $t.type='error_404'");
  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 pages matching a list of possible alias names
  528.      *
  529.      * @param array $arrAliases An array of possible alias names
  530.      * @param array $arrOptions An optional options array
  531.      *
  532.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  533.      */
  534.     public static function findByAliases($arrAliases, array $arrOptions=array())
  535.     {
  536.         if (empty($arrAliases) || !\is_array($arrAliases))
  537.         {
  538.             return null;
  539.         }
  541.         // Remove everything that is not an alias
  542.         $arrAliases = array_filter(array_map(static function ($v) { return preg_match('/^[\w\/.-]+$/u', $v) ? $v : null; }, $arrAliases));
  544.         // Return if nothing is left
  545.         if (empty($arrAliases))
  546.         {
  547.             return null;
  548.         }
  550.         $t = static::$strTable;
  551.         $arrColumns = array("$t.alias IN('" . implode("','", array_filter($arrAliases)) . "')");
  553.         // Check the publication status (see #4652)
  554.         if (!static::isPreviewMode($arrOptions))
  555.         {
  556.             $time = Date::floorToMinute();
  557.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  558.         }
  560.         if (!isset($arrOptions['order']))
  561.         {
  562.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.alias", $arrAliases);
  563.         }
  565.         return static::findBy($arrColumns, null, $arrOptions);
  566.     }
  568.     /**
  569.      * Find published pages by their ID or aliases
  570.      *
  571.      * @param mixed $varId      The numeric ID or the alias name
  572.      * @param array $arrOptions An optional options array
  573.      *
  574.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  575.      */
  576.     public static function findPublishedByIdOrAlias($varId, array $arrOptions=array())
  577.     {
  578.         $t = static::$strTable;
  579.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  581.         if (!static::isPreviewMode($arrOptions))
  582.         {
  583.             $time = Date::floorToMinute();
  584.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  585.         }
  587.         return static::findBy($arrColumns, $varId, $arrOptions);
  588.     }
  590.     /**
  591.      * Find all published subpages by their parent ID and exclude pages only visible for guests
  592.      *
  593.      * @param integer $intPid        The parent page's ID
  594.      * @param boolean $blnShowHidden If true, hidden pages will be included
  595.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  596.      *
  597.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  598.      */
  599.     public static function findPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false)
  600.     {
  601.         $time = Date::floorToMinute();
  602.         $blnFeUserLoggedIn = System::getContainer()->get('contao.security.token_checker')->hasFrontendUser();
  604.         $objSubpages = Database::getInstance()->prepare("SELECT p1.*, (SELECT COUNT(*) FROM tl_page p2 WHERE p2.pid=p1.id AND p2.type!='root' AND p2.type!='error_401' AND p2.type!='error_403' AND p2.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p2.hide='' OR sitemap='map_always')" : " AND p2.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p2.guests=''" : "") . (!BE_USER_LOGGED_IN ? " AND p2.published='1' AND (p2.start='' OR p2.start<='$time') AND (p2.stop='' OR p2.stop>'$time')" : "") . ") AS subpages FROM tl_page p1 WHERE p1.pid=? AND p1.type!='root' AND p1.type!='error_401' AND p1.type!='error_403' AND p1.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p1.hide='' OR sitemap='map_always')" : " AND p1.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p1.guests=''" : "") . (!BE_USER_LOGGED_IN ? " AND p1.published='1' AND (p1.start='' OR p1.start<='$time') AND (p1.stop='' OR p1.stop>'$time')" : "") . " ORDER BY p1.sorting")
  605.                                               ->execute($intPid);
  607.         if ($objSubpages->numRows < 1)
  608.         {
  609.             return null;
  610.         }
  612.         return static::createCollectionFromDbResult($objSubpages, 'tl_page');
  613.     }
  615.     /**
  616.      * Find all published regular pages by their IDs and exclude pages only visible for guests
  617.      *
  618.      * @param array $arrIds     An array of page IDs
  619.      * @param array $arrOptions An optional options array
  620.      *
  621.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  622.      */
  623.     public static function findPublishedRegularWithoutGuestsByIds($arrIds, array $arrOptions=array())
  624.     {
  625.         if (empty($arrIds) || !\is_array($arrIds))
  626.         {
  627.             return null;
  628.         }
  630.         $t = static::$strTable;
  631.         $arrColumns = array("$t.id IN(" . implode(',', array_map('\intval', $arrIds)) . ") AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  633.         if (empty($arrOptions['includeRoot']))
  634.         {
  635.             $arrColumns[] = "$t.type!='root'";
  636.         }
  638.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  639.         {
  640.             $arrColumns[] = "$t.guests=''";
  641.         }
  643.         if (!static::isPreviewMode($arrOptions))
  644.         {
  645.             $time = Date::floorToMinute();
  646.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  647.         }
  649.         if (!isset($arrOptions['order']))
  650.         {
  651.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  652.         }
  654.         return static::findBy($arrColumns, null, $arrOptions);
  655.     }
  657.     /**
  658.      * Find all published regular pages by their parent IDs and exclude pages only visible for guests
  659.      *
  660.      * @param integer $intPid     The parent page's ID
  661.      * @param array   $arrOptions An optional options array
  662.      *
  663.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  664.      */
  665.     public static function findPublishedRegularWithoutGuestsByPid($intPid, array $arrOptions=array())
  666.     {
  667.         $t = static::$strTable;
  668.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  670.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  671.         {
  672.             $arrColumns[] = "$t.guests=''";
  673.         }
  675.         if (!static::isPreviewMode($arrOptions))
  676.         {
  677.             $time = Date::floorToMinute();
  678.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  679.         }
  681.         if (!isset($arrOptions['order']))
  682.         {
  683.             $arrOptions['order'] = "$t.sorting";
  684.         }
  686.         return static::findBy($arrColumns, $intPid, $arrOptions);
  687.     }
  689.     /**
  690.      * Find the language fallback page by hostname
  691.      *
  692.      * @param string $strHost    The hostname
  693.      * @param array  $arrOptions An optional options array
  694.      *
  695.      * @return PageModel|Model|null The model or null if there is not fallback page
  696.      */
  697.     public static function findPublishedFallbackByHostname($strHost, array $arrOptions=array())
  698.     {
  699.         // Try to load from the registry (see #8544)
  700.         if (empty($arrOptions))
  701.         {
  702.             $objModel = Registry::getInstance()->fetch(static::$strTable, $strHost, 'contao.dns-fallback');
  704.             if ($objModel !== null)
  705.             {
  706.                 return $objModel;
  707.             }
  708.         }
  710.         $t = static::$strTable;
  711.         $arrColumns = array("$t.dns=? AND $t.fallback='1'");
  713.         if (isset($arrOptions['fallbackToEmpty']) && $arrOptions['fallbackToEmpty'] === true)
  714.         {
  715.             $arrColumns = array("($t.dns=? OR $t.dns='') AND $t.fallback='1'");
  716.         }
  718.         if (!static::isPreviewMode($arrOptions))
  719.         {
  720.             $time = Date::floorToMinute();
  721.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  722.         }
  724.         return static::findOneBy($arrColumns, $strHost, $arrOptions);
  725.     }
  727.     /**
  728.      * Finds the published root pages
  729.      *
  730.      * @param array $arrOptions An optional options array
  731.      *
  732.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  733.      */
  734.     public static function findPublishedRootPages(array $arrOptions=array())
  735.     {
  736.         $t = static::$strTable;
  737.         $arrColumns = array("$t.type='root'");
  739.         if (isset($arrOptions['dns']))
  740.         {
  741.             $arrColumns = array("$t.type='root' AND $t.dns=?");
  742.         }
  744.         if (!static::isPreviewMode($arrOptions))
  745.         {
  746.             $time = Date::floorToMinute();
  747.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  748.         }
  750.         return static::findBy($arrColumns, $arrOptions['dns'] ?? null, $arrOptions);
  751.     }
  753.     /**
  754.      * Find the parent pages of a page
  755.      *
  756.      * @param integer $intId The page's ID
  757.      *
  758.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  759.      */
  760.     public static function findParentsById($intId)
  761.     {
  762.         $arrModels = array();
  764.         while ($intId > 0 && ($objPage = static::findByPk($intId)) !== null)
  765.         {
  766.             $intId = $objPage->pid;
  767.             $arrModels[] = $objPage;
  768.         }
  770.         if (empty($arrModels))
  771.         {
  772.             return null;
  773.         }
  775.         return static::createCollection($arrModels, 'tl_page');
  776.     }
  778.     /**
  779.      * Find the first active page by its member groups
  780.      *
  781.      * @param array $arrIds An array of member group IDs
  782.      *
  783.      * @return PageModel|null The model or null if there is no matching member group
  784.      */
  785.     public static function findFirstActiveByMemberGroups($arrIds)
  786.     {
  787.         if (empty($arrIds) || !\is_array($arrIds))
  788.         {
  789.             return null;
  790.         }
  792.         $time = Date::floorToMinute();
  793.         $objDatabase = Database::getInstance();
  794.         $arrIds = array_map('\intval', $arrIds);
  796.         $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))
  797.                                  ->limit(1)
  798.                                  ->execute();
  800.         if ($objResult->numRows < 1)
  801.         {
  802.             return null;
  803.         }
  805.         $objRegistry = Registry::getInstance();
  807.         /** @var PageModel|Model $objPage */
  808.         if ($objPage = $objRegistry->fetch('tl_page', $objResult->id))
  809.         {
  810.             return $objPage;
  811.         }
  813.         return new static($objResult);
  814.     }
  816.     /**
  817.      * Find a page by its ID and return it with the inherited details
  818.      *
  819.      * @param integer $intId The page's ID
  820.      *
  821.      * @return PageModel|null The model or null if there is no matching page
  822.      */
  823.     public static function findWithDetails($intId)
  824.     {
  825.         $objPage = static::findByPk($intId);
  827.         if ($objPage === null)
  828.         {
  829.             return null;
  830.         }
  832.         return $objPage->loadDetails();
  833.     }
  835.     /**
  836.      * Register the contao.dns-fallback alias when the model is attached to the registry
  837.      *
  838.      * @param Registry $registry The model registry
  839.      */
  840.     public function onRegister(Registry $registry)
  841.     {
  842.         parent::onRegister($registry);
  844.         // Register this model as being the fallback page for a given dns
  845.         if ($this->fallback && $this->type == 'root' && !$registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  846.         {
  847.             $registry->registerAlias($this, 'contao.dns-fallback', $this->dns);
  848.         }
  849.     }
  851.     /**
  852.      * Unregister the contao.dns-fallback alias when the model is detached from the registry
  853.      *
  854.      * @param Registry $registry The model registry
  855.      */
  856.     public function onUnregister(Registry $registry)
  857.     {
  858.         parent::onUnregister($registry);
  860.         // Unregister the fallback page
  861.         if ($this->fallback && $this->type == 'root' && $registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  862.         {
  863.             $registry->unregisterAlias($this, 'contao.dns-fallback', $this->dns);
  864.         }
  865.     }
  867.     /**
  868.      * Get the details of a page including inherited parameters
  869.      *
  870.      * @return PageModel The page model
  871.      *
  872.      * @throws NoRootPageFoundException If no root page is found
  873.      */
  874.     public function loadDetails()
  875.     {
  876.         // Loaded already
  877.         if ($this->blnDetailsLoaded)
  878.         {
  879.             return $this;
  880.         }
  882.         // Set some default values
  883.         $this->protected = (bool) $this->protected;
  884.         $this->groups = $this->protected ? StringUtil::deserialize($this->groups) : false;
  885.         $this->layout = $this->includeLayout ? $this->layout : false;
  886.         $this->cache = $this->includeCache ? $this->cache : false;
  887.         $this->alwaysLoadFromCache = $this->includeCache ? $this->alwaysLoadFromCache : false;
  888.         $this->clientCache = $this->includeCache ? $this->clientCache : false;
  890.         $pid = $this->pid;
  891.         $type = $this->type;
  892.         $alias = $this->alias;
  893.         $name = $this->title;
  894.         $title = $this->pageTitle ?: $this->title;
  895.         $folderUrl = '';
  896.         $palias = '';
  897.         $pname = '';
  898.         $ptitle = '';
  899.         $trail = array($this->id, $pid);
  900.         $time = time();
  902.         // Inherit the settings
  903.         if ($this->type == 'root')
  904.         {
  905.             $objParentPage = $this; // see #4610
  906.         }
  907.         else
  908.         {
  909.             // Load all parent pages
  910.             $objParentPage = self::findParentsById($pid);
  912.             if ($objParentPage !== null)
  913.             {
  914.                 while ($pid > 0 && $type != 'root' && $objParentPage->next())
  915.                 {
  916.                     $pid = $objParentPage->pid;
  917.                     $type = $objParentPage->type;
  919.                     // Parent title
  920.                     if (!$ptitle)
  921.                     {
  922.                         $palias = $objParentPage->alias;
  923.                         $pname = $objParentPage->title;
  924.                         $ptitle = $objParentPage->pageTitle ?: $objParentPage->title;
  925.                     }
  927.                     // Page title
  928.                     if ($type != 'root')
  929.                     {
  930.                         // If $folderUrl is not yet set, use the alias of the first
  931.                         // parent page if it is not a root page (see #2129)
  932.                         if (!$folderUrl && $objParentPage->alias)
  933.                         {
  934.                             $folderUrl = $objParentPage->alias . '/';
  935.                         }
  937.                         $alias = $objParentPage->alias;
  938.                         $name = $objParentPage->title;
  939.                         $title = $objParentPage->pageTitle ?: $objParentPage->title;
  940.                         $trail[] = $objParentPage->pid;
  941.                     }
  943.                     // Cache
  944.                     if ($objParentPage->includeCache)
  945.                     {
  946.                         $this->cache = $this->cache !== false ? $this->cache : $objParentPage->cache;
  947.                         $this->alwaysLoadFromCache = $this->alwaysLoadFromCache !== false ? $this->alwaysLoadFromCache : $objParentPage->alwaysLoadFromCache;
  948.                         $this->clientCache = $this->clientCache !== false ? $this->clientCache : $objParentPage->clientCache;
  949.                     }
  951.                     // Layout
  952.                     if ($objParentPage->includeLayout && $this->layout === false)
  953.                     {
  954.                         $this->layout = $objParentPage->layout;
  955.                     }
  957.                     // Protection
  958.                     if ($objParentPage->protected && $this->protected === false)
  959.                     {
  960.                         $this->protected = true;
  961.                         $this->groups = StringUtil::deserialize($objParentPage->groups);
  962.                     }
  963.                 }
  964.             }
  966.             // Set the titles
  967.             $this->mainAlias = $alias;
  968.             $this->mainTitle = $name;
  969.             $this->mainPageTitle = $title;
  970.             $this->parentAlias = $palias;
  971.             $this->parentTitle = $pname;
  972.             $this->parentPageTitle = $ptitle;
  973.             $this->folderUrl = $folderUrl;
  974.         }
  976.         // Set the root ID and title
  977.         if ($objParentPage !== null && $objParentPage->type == 'root')
  978.         {
  979.             $this->rootId = $objParentPage->id;
  980.             $this->rootAlias = $objParentPage->alias;
  981.             $this->rootTitle = $objParentPage->title;
  982.             $this->rootPageTitle = $objParentPage->pageTitle ?: $objParentPage->title;
  983.             $this->rootSorting = $objParentPage->sorting;
  984.             $this->domain = $objParentPage->dns;
  985.             $this->rootLanguage = $objParentPage->language;
  986.             $this->language = $objParentPage->language;
  987.             $this->staticFiles = $objParentPage->staticFiles;
  988.             $this->staticPlugins = $objParentPage->staticPlugins;
  989.             $this->dateFormat = $objParentPage->dateFormat;
  990.             $this->timeFormat = $objParentPage->timeFormat;
  991.             $this->datimFormat = $objParentPage->datimFormat;
  992.             $this->validAliasCharacters = $objParentPage->validAliasCharacters;
  993.             $this->adminEmail = $objParentPage->adminEmail;
  994.             $this->enforceTwoFactor = $objParentPage->enforceTwoFactor;
  995.             $this->twoFactorJumpTo = $objParentPage->twoFactorJumpTo;
  997.             // Store whether the root page has been published
  998.             $this->rootIsPublic = ($objParentPage->published && (!$objParentPage->start || $objParentPage->start <= $time) && (!$objParentPage->stop || $objParentPage->stop > $time));
  999.             $this->rootIsFallback = true;
  1000.             $this->rootUseSSL = $objParentPage->useSSL;
  1001.             $this->rootFallbackLanguage = $objParentPage->language;
  1003.             // Store the fallback language (see #6874)
  1004.             if (!$objParentPage->fallback)
  1005.             {
  1006.                 $this->rootIsFallback = false;
  1007.                 $this->rootFallbackLanguage = null;
  1009.                 $objFallback = static::findPublishedFallbackByHostname($objParentPage->dns);
  1011.                 if ($objFallback !== null)
  1012.                 {
  1013.                     $this->rootFallbackLanguage = $objFallback->language;
  1014.                 }
  1015.             }
  1016.         }
  1018.         // No root page found
  1019.         elseif (TL_MODE == 'FE' && $this->type != 'root')
  1020.         {
  1021.             System::log('Page ID "' . $this->id . '" does not belong to a root page', __METHOD__, TL_ERROR);
  1023.             throw new NoRootPageFoundException('No root page found');
  1024.         }
  1026.         $this->trail = array_reverse($trail);
  1028.         // Use the global date format if none is set (see #6104)
  1029.         if (!$this->dateFormat)
  1030.         {
  1031.             $this->dateFormat = Config::get('dateFormat');
  1032.         }
  1034.         if (!$this->timeFormat)
  1035.         {
  1036.             $this->timeFormat = Config::get('timeFormat');
  1037.         }
  1039.         if (!$this->datimFormat)
  1040.         {
  1041.             $this->datimFormat = Config::get('datimFormat');
  1042.         }
  1044.         $this->isPublic = ($this->published && (!$this->start || $this->start <= $time) && (!$this->stop || $this->stop > $time));
  1046.         // HOOK: add custom logic
  1047.         if (!empty($GLOBALS['TL_HOOKS']['loadPageDetails']) && \is_array($GLOBALS['TL_HOOKS']['loadPageDetails']))
  1048.         {
  1049.             $parentModels = array();
  1051.             if ($objParentPage instanceof Collection)
  1052.             {
  1053.                 $parentModels = $objParentPage->getModels();
  1054.             }
  1056.             foreach ($GLOBALS['TL_HOOKS']['loadPageDetails'] as $callback)
  1057.             {
  1058.                 System::importStatic($callback[0])->{$callback[1]}($parentModels, $this);
  1059.             }
  1060.         }
  1062.         // Prevent saving (see #6506 and #7199)
  1063.         $this->preventSaving();
  1064.         $this->blnDetailsLoaded = true;
  1066.         return $this;
  1067.     }
  1069.     /**
  1070.      * Generate a front end URL
  1071.      *
  1072.      * @param string $strParams    An optional string of URL parameters
  1073.      * @param string $strForceLang Force a certain language
  1074.      *
  1075.      * @return string An URL that can be used in the front end
  1076.      */
  1077.     public function getFrontendUrl($strParams=null, $strForceLang=null)
  1078.     {
  1079.         if ($strForceLang !== null)
  1080.         {
  1081.             @trigger_error('Using PageModel::getFrontendUrl() with $strForceLang has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  1082.         }
  1084.         $this->loadDetails();
  1086.         $objUrlGenerator = System::getContainer()->get('contao.routing.url_generator');
  1088.         $strUrl = $objUrlGenerator->generate
  1089.         (
  1090.             ($this->alias ?: $this->id) . $strParams,
  1091.             array
  1092.             (
  1093.                 '_locale' => ($strForceLang ?: $this->rootLanguage),
  1094.                 '_domain' => $this->domain,
  1095.                 '_ssl' => (bool) $this->rootUseSSL,
  1096.             )
  1097.         );
  1099.         // Make the URL relative to the base path
  1100.         if (0 === strncmp($strUrl, '/', 1))
  1101.         {
  1102.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1103.         }
  1105.         return $this->applyLegacyLogic($strUrl, $strParams);
  1106.     }
  1108.     /**
  1109.      * Generate an absolute URL depending on the current rewriteURL setting
  1110.      *
  1111.      * @param string $strParams An optional string of URL parameters
  1112.      *
  1113.      * @return string An absolute URL that can be used in the front end
  1114.      */
  1115.     public function getAbsoluteUrl($strParams=null)
  1116.     {
  1117.         $this->loadDetails();
  1119.         $objUrlGenerator = System::getContainer()->get('contao.routing.url_generator');
  1121.         $strUrl = $objUrlGenerator->generate
  1122.         (
  1123.             ($this->alias ?: $this->id) . $strParams,
  1124.             array
  1125.             (
  1126.                 '_locale' => $this->rootLanguage,
  1127.                 '_domain' => $this->domain,
  1128.                 '_ssl' => (bool) $this->rootUseSSL,
  1129.             ),
  1130.             UrlGeneratorInterface::ABSOLUTE_URL
  1131.         );
  1133.         return $this->applyLegacyLogic($strUrl, $strParams);
  1134.     }
  1136.     /**
  1137.      * Generate the front end preview URL
  1138.      *
  1139.      * @param string $strParams An optional string of URL parameters
  1140.      *
  1141.      * @return string The front end preview URL
  1142.      */
  1143.     public function getPreviewUrl($strParams=null)
  1144.     {
  1145.         $container = System::getContainer();
  1147.         if (!$previewScript = $container->getParameter('contao.preview_script'))
  1148.         {
  1149.             return $this->getAbsoluteUrl($strParams);
  1150.         }
  1152.         $context = $container->get('router')->getContext();
  1153.         $baseUrl = $context->getBaseUrl();
  1155.         // Add the preview script
  1156.         $context->setBaseUrl($previewScript);
  1158.         $objUrlGenerator = $container->get('contao.routing.url_generator');
  1160.         $strUrl = $objUrlGenerator->generate
  1161.         (
  1162.             ($this->alias ?: $this->id) . $strParams,
  1163.             array
  1164.             (
  1165.                 '_locale' => $this->rootLanguage,
  1166.                 '_domain' => $this->domain,
  1167.                 '_ssl' => (bool) $this->rootUseSSL,
  1168.             ),
  1169.             UrlGeneratorInterface::ABSOLUTE_URL
  1170.         );
  1172.         $context->setBaseUrl($baseUrl);
  1174.         return $this->applyLegacyLogic($strUrl, $strParams);
  1175.     }
  1177.     /**
  1178.      * Return the slug options
  1179.      *
  1180.      * @return array The slug options
  1181.      */
  1182.     public function getSlugOptions()
  1183.     {
  1184.         $slugOptions = array('locale'=>$this->language);
  1186.         if ($this->validAliasCharacters)
  1187.         {
  1188.             $slugOptions['validChars'] = $this->validAliasCharacters;
  1189.         }
  1191.         return $slugOptions;
  1192.     }
  1194.     /**
  1195.      * Modifies a URL from the URL generator.
  1196.      *
  1197.      * @param string $strUrl
  1198.      * @param string $strParams
  1199.      *
  1200.      * @return string
  1201.      */
  1202.     private function applyLegacyLogic($strUrl, $strParams)
  1203.     {
  1204.         // Decode sprintf placeholders
  1205.         if (strpos($strParams, '%') !== false)
  1206.         {
  1207.             @trigger_error('Using sprintf placeholders in URLs has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  1209.             $arrMatches = array();
  1210.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1212.             foreach (array_unique($arrMatches[1]) as $v)
  1213.             {
  1214.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1215.             }
  1216.         }
  1218.         // HOOK: add custom logic
  1219.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1220.         {
  1221.             @trigger_error('Using the "generateFrontendUrl" hook has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  1223.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1224.             {
  1225.                 $strUrl = System::importStatic($callback[0])->{$callback[1]}($this->row(), $strParams, $strUrl);
  1226.             }
  1228.             return $strUrl;
  1229.         }
  1231.         return $strUrl;
  1232.     }
  1233. }
  1235. class_alias(PageModel::class, 'PageModel');