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

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 boolean $minifyMarkup
  96.  * @property integer $layoutId
  97.  * @property boolean $hasJQuery
  98.  * @property boolean $hasMooTools
  99.  * @property string  $template
  100.  * @property string  $templateGroup
  101.  * @property string  $enforceTwoFactor
  102.  * @property integer $twoFactorJumpTo
  103.  *
  104.  * @method static PageModel|null findById($id, array $opt=array())
  105.  * @method static PageModel|null findByPk($id, array $opt=array())
  106.  * @method static PageModel|null findByIdOrAlias($val, array $opt=array())
  107.  * @method static PageModel|null findOneBy($col, $val, array $opt=array())
  108.  * @method static PageModel|null findOneByPid($val, array $opt=array())
  109.  * @method static PageModel|null findOneBySorting($val, array $opt=array())
  110.  * @method static PageModel|null findOneByTstamp($val, array $opt=array())
  111.  * @method static PageModel|null findOneByTitle($val, array $opt=array())
  112.  * @method static PageModel|null findOneByAlias($val, array $opt=array())
  113.  * @method static PageModel|null findOneByType($val, array $opt=array())
  114.  * @method static PageModel|null findOneByPageTitle($val, array $opt=array())
  115.  * @method static PageModel|null findOneByLanguage($val, array $opt=array())
  116.  * @method static PageModel|null findOneByRobots($val, array $opt=array())
  117.  * @method static PageModel|null findOneByDescription($val, array $opt=array())
  118.  * @method static PageModel|null findOneByRedirect($val, array $opt=array())
  119.  * @method static PageModel|null findOneByJumpTo($val, array $opt=array())
  120.  * @method static PageModel|null findOneByRedirectBack($val, array $opt=array())
  121.  * @method static PageModel|null findOneByUrl($val, array $opt=array())
  122.  * @method static PageModel|null findOneByTarget($val, array $opt=array())
  123.  * @method static PageModel|null findOneByDns($val, array $opt=array())
  124.  * @method static PageModel|null findOneByStaticFiles($val, array $opt=array())
  125.  * @method static PageModel|null findOneByStaticPlugins($val, array $opt=array())
  126.  * @method static PageModel|null findOneByFallback($val, array $opt=array())
  127.  * @method static PageModel|null findOneByFavicon($val, array $opt=array())
  128.  * @method static PageModel|null findOneByRobotsTxt($val, array $opt=array())
  129.  * @method static PageModel|null findOneByAdminEmail($val, array $opt=array())
  130.  * @method static PageModel|null findOneByDateFormat($val, array $opt=array())
  131.  * @method static PageModel|null findOneByTimeFormat($val, array $opt=array())
  132.  * @method static PageModel|null findOneByDatimFormat($val, array $opt=array())
  133.  * @method static PageModel|null findOneByCreateSitemap($val, array $opt=array())
  134.  * @method static PageModel|null findOneBySitemapName($val, array $opt=array())
  135.  * @method static PageModel|null findOneByUseSSL($val, array $opt=array())
  136.  * @method static PageModel|null findOneByAutoforward($val, array $opt=array())
  137.  * @method static PageModel|null findOneByProtected($val, array $opt=array())
  138.  * @method static PageModel|null findOneByGroups($val, array $opt=array())
  139.  * @method static PageModel|null findOneByIncludeLayout($val, array $opt=array())
  140.  * @method static PageModel|null findOneByLayout($val, array $opt=array())
  141.  * @method static PageModel|null findOneByIncludeCache($val, array $opt=array())
  142.  * @method static PageModel|null findOneByCache($val, array $opt=array())
  143.  * @method static PageModel|null findOneByIncludeChmod($val, array $opt=array())
  144.  * @method static PageModel|null findOneByCuser($val, array $opt=array())
  145.  * @method static PageModel|null findOneByCgroup($val, array $opt=array())
  146.  * @method static PageModel|null findOneByChmod($val, array $opt=array())
  147.  * @method static PageModel|null findOneByNoSearch($val, array $opt=array())
  148.  * @method static PageModel|null findOneByCssClass($val, array $opt=array())
  149.  * @method static PageModel|null findOneBySitemap($val, array $opt=array())
  150.  * @method static PageModel|null findOneByHide($val, array $opt=array())
  151.  * @method static PageModel|null findOneByGuests($val, array $opt=array())
  152.  * @method static PageModel|null findOneByTabindex($val, array $opt=array())
  153.  * @method static PageModel|null findOneByAccesskey($val, array $opt=array())
  154.  * @method static PageModel|null findOneByPublished($val, array $opt=array())
  155.  * @method static PageModel|null findOneByStart($val, array $opt=array())
  156.  * @method static PageModel|null findOneByStop($val, array $opt=array())
  157.  * @method static PageModel|null findOneByEnforceTwoFactor($val, array $opt=array())
  158.  * @method static PageModel|null findOneByTwoFactorJumpTo($val, array $opt=array())
  159.  *
  160.  * @method static Collection|PageModel[]|PageModel|null findByPid($val, array $opt=array())
  161.  * @method static Collection|PageModel[]|PageModel|null findBySorting($val, array $opt=array())
  162.  * @method static Collection|PageModel[]|PageModel|null findByTstamp($val, array $opt=array())
  163.  * @method static Collection|PageModel[]|PageModel|null findByTitle($val, array $opt=array())
  164.  * @method static Collection|PageModel[]|PageModel|null findByAlias($val, array $opt=array())
  165.  * @method static Collection|PageModel[]|PageModel|null findByType($val, array $opt=array())
  166.  * @method static Collection|PageModel[]|PageModel|null findByPageTitle($val, array $opt=array())
  167.  * @method static Collection|PageModel[]|PageModel|null findByLanguage($val, array $opt=array())
  168.  * @method static Collection|PageModel[]|PageModel|null findByRobots($val, array $opt=array())
  169.  * @method static Collection|PageModel[]|PageModel|null findByDescription($val, array $opt=array())
  170.  * @method static Collection|PageModel[]|PageModel|null findByRedirect($val, array $opt=array())
  171.  * @method static Collection|PageModel[]|PageModel|null findByJumpTo($val, array $opt=array())
  172.  * @method static Collection|PageModel[]|PageModel|null findByRedirectBack($val, array $opt=array())
  173.  * @method static Collection|PageModel[]|PageModel|null findByUrl($val, array $opt=array())
  174.  * @method static Collection|PageModel[]|PageModel|null findByTarget($val, array $opt=array())
  175.  * @method static Collection|PageModel[]|PageModel|null findByDns($val, array $opt=array())
  176.  * @method static Collection|PageModel[]|PageModel|null findByStaticFiles($val, array $opt=array())
  177.  * @method static Collection|PageModel[]|PageModel|null findByStaticPlugins($val, array $opt=array())
  178.  * @method static Collection|PageModel[]|PageModel|null findByFallback($val, array $opt=array())
  179.  * @method static Collection|PageModel[]|PageModel|null findByFavicon($val, array $opt=array())
  180.  * @method static Collection|PageModel[]|PageModel|null findByRobotsTxt($val, array $opt=array())
  181.  * @method static Collection|PageModel[]|PageModel|null findByAdminEmail($val, array $opt=array())
  182.  * @method static Collection|PageModel[]|PageModel|null findByDateFormat($val, array $opt=array())
  183.  * @method static Collection|PageModel[]|PageModel|null findByTimeFormat($val, array $opt=array())
  184.  * @method static Collection|PageModel[]|PageModel|null findByDatimFormat($val, array $opt=array())
  185.  * @method static Collection|PageModel[]|PageModel|null findByCreateSitemap($val, array $opt=array())
  186.  * @method static Collection|PageModel[]|PageModel|null findBySitemapName($val, array $opt=array())
  187.  * @method static Collection|PageModel[]|PageModel|null findByUseSSL($val, array $opt=array())
  188.  * @method static Collection|PageModel[]|PageModel|null findByAutoforward($val, array $opt=array())
  189.  * @method static Collection|PageModel[]|PageModel|null findByProtected($val, array $opt=array())
  190.  * @method static Collection|PageModel[]|PageModel|null findByGroups($val, array $opt=array())
  191.  * @method static Collection|PageModel[]|PageModel|null findByIncludeLayout($val, array $opt=array())
  192.  * @method static Collection|PageModel[]|PageModel|null findByLayout($val, array $opt=array())
  193.  * @method static Collection|PageModel[]|PageModel|null findByIncludeCache($val, array $opt=array())
  194.  * @method static Collection|PageModel[]|PageModel|null findByCache($val, array $opt=array())
  195.  * @method static Collection|PageModel[]|PageModel|null findByIncludeChmod($val, array $opt=array())
  196.  * @method static Collection|PageModel[]|PageModel|null findByCuser($val, array $opt=array())
  197.  * @method static Collection|PageModel[]|PageModel|null findByCgroup($val, array $opt=array())
  198.  * @method static Collection|PageModel[]|PageModel|null findByChmod($val, array $opt=array())
  199.  * @method static Collection|PageModel[]|PageModel|null findByNoSearch($val, array $opt=array())
  200.  * @method static Collection|PageModel[]|PageModel|null findByCssClass($val, array $opt=array())
  201.  * @method static Collection|PageModel[]|PageModel|null findBySitemap($val, array $opt=array())
  202.  * @method static Collection|PageModel[]|PageModel|null findByHide($val, array $opt=array())
  203.  * @method static Collection|PageModel[]|PageModel|null findByGuests($val, array $opt=array())
  204.  * @method static Collection|PageModel[]|PageModel|null findByTabindex($val, array $opt=array())
  205.  * @method static Collection|PageModel[]|PageModel|null findByAccesskey($val, array $opt=array())
  206.  * @method static Collection|PageModel[]|PageModel|null findByPublished($val, array $opt=array())
  207.  * @method static Collection|PageModel[]|PageModel|null findByStart($val, array $opt=array())
  208.  * @method static Collection|PageModel[]|PageModel|null findByStop($val, array $opt=array())
  209.  * @method static Collection|PageModel[]|PageModel|null findByEnforceTwoFactor($val, array $opt=array())
  210.  * @method static Collection|PageModel[]|PageModel|null findByTwoFactorJumpTo($val, array $opt=array())
  211.  * @method static Collection|PageModel[]|PageModel|null findMultipleByIds($val, array $opt=array())
  212.  * @method static Collection|PageModel[]|PageModel|null findBy($col, $val, array $opt=array())
  213.  * @method static Collection|PageModel[]|PageModel|null findAll(array $opt=array())
  214.  *
  215.  * @method static integer countById($id, array $opt=array())
  216.  * @method static integer countByPid($val, array $opt=array())
  217.  * @method static integer countBySorting($val, array $opt=array())
  218.  * @method static integer countByTstamp($val, array $opt=array())
  219.  * @method static integer countByTitle($val, array $opt=array())
  220.  * @method static integer countByAlias($val, array $opt=array())
  221.  * @method static integer countByType($val, array $opt=array())
  222.  * @method static integer countByPageTitle($val, array $opt=array())
  223.  * @method static integer countByLanguage($val, array $opt=array())
  224.  * @method static integer countByRobots($val, array $opt=array())
  225.  * @method static integer countByDescription($val, array $opt=array())
  226.  * @method static integer countByRedirect($val, array $opt=array())
  227.  * @method static integer countByJumpTo($val, array $opt=array())
  228.  * @method static integer countByRedirectBack($val, array $opt=array())
  229.  * @method static integer countByUrl($val, array $opt=array())
  230.  * @method static integer countByTarget($val, array $opt=array())
  231.  * @method static integer countByDns($val, array $opt=array())
  232.  * @method static integer countByStaticFiles($val, array $opt=array())
  233.  * @method static integer countByStaticPlugins($val, array $opt=array())
  234.  * @method static integer countByFallback($val, array $opt=array())
  235.  * @method static integer countByFavicon($val, array $opt=array())
  236.  * @method static integer countByRobotsTxt($val, array $opt=array())
  237.  * @method static integer countByAdminEmail($val, array $opt=array())
  238.  * @method static integer countByDateFormat($val, array $opt=array())
  239.  * @method static integer countByTimeFormat($val, array $opt=array())
  240.  * @method static integer countByDatimFormat($val, array $opt=array())
  241.  * @method static integer countByCreateSitemap($val, array $opt=array())
  242.  * @method static integer countBySitemapName($val, array $opt=array())
  243.  * @method static integer countByUseSSL($val, array $opt=array())
  244.  * @method static integer countByAutoforward($val, array $opt=array())
  245.  * @method static integer countByProtected($val, array $opt=array())
  246.  * @method static integer countByGroups($val, array $opt=array())
  247.  * @method static integer countByIncludeLayout($val, array $opt=array())
  248.  * @method static integer countByLayout($val, array $opt=array())
  249.  * @method static integer countByIncludeCache($val, array $opt=array())
  250.  * @method static integer countByCache($val, array $opt=array())
  251.  * @method static integer countByIncludeChmod($val, array $opt=array())
  252.  * @method static integer countByCuser($val, array $opt=array())
  253.  * @method static integer countByCgroup($val, array $opt=array())
  254.  * @method static integer countByChmod($val, array $opt=array())
  255.  * @method static integer countByNoSearch($val, array $opt=array())
  256.  * @method static integer countByCssClass($val, array $opt=array())
  257.  * @method static integer countBySitemap($val, array $opt=array())
  258.  * @method static integer countByHide($val, array $opt=array())
  259.  * @method static integer countByGuests($val, array $opt=array())
  260.  * @method static integer countByTabindex($val, array $opt=array())
  261.  * @method static integer countByAccesskey($val, array $opt=array())
  262.  * @method static integer countByPublished($val, array $opt=array())
  263.  * @method static integer countByStart($val, array $opt=array())
  264.  * @method static integer countByStop($val, array $opt=array())
  265.  * @method static integer countByEnforceTwoFactor($val, array $opt=array())
  266.  * @method static integer countByTwoFactorJumpTo($val, array $opt=array())
  267.  *
  268.  * @author Leo Feyer <https://github.com/leofeyer>
  269.  */
  270. class PageModel extends Model
  271. {
  272.     /**
  273.      * Table name
  274.      * @var string
  275.      */
  276.     protected static $strTable = 'tl_page';
  278.     /**
  279.      * Details loaded
  280.      * @var boolean
  281.      */
  282.     protected $blnDetailsLoaded = false;
  284.     /**
  285.      * Find a published page by its ID
  286.      *
  287.      * @param integer $intId      The page ID
  288.      * @param array   $arrOptions An optional options array
  289.      *
  290.      * @return PageModel|null The model or null if there is no published page
  291.      */
  292.     public static function findPublishedById($intId, array $arrOptions=array())
  293.     {
  294.         $t = static::$strTable;
  295.         $arrColumns = array("$t.id=?");
  297.         if (!static::isPreviewMode($arrOptions))
  298.         {
  299.             $time = Date::floorToMinute();
  300.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  301.         }
  303.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  304.     }
  306.     /**
  307.      * Find published pages by their PID
  308.      *
  309.      * @param integer $intPid     The parent ID
  310.      * @param array   $arrOptions An optional options array
  311.      *
  312.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  313.      */
  314.     public static function findPublishedByPid($intPid, array $arrOptions=array())
  315.     {
  316.         $t = static::$strTable;
  317.         $arrColumns = array("$t.pid=?");
  319.         if (!static::isPreviewMode($arrOptions))
  320.         {
  321.             $time = Date::floorToMinute();
  322.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  323.         }
  325.         return static::findBy($arrColumns, $intPid, $arrOptions);
  326.     }
  328.     /**
  329.      * Find the first published root page by its host name and language
  330.      *
  331.      * @param string $strHost     The host name
  332.      * @param mixed  $varLanguage An ISO language code or an array of ISO language codes
  333.      * @param array  $arrOptions  An optional options array
  334.      *
  335.      * @return PageModel|null The model or null if there is no matching root page
  336.      *
  337.      * @deprecated Deprecated since Contao 4.7, to be removed in Contao 5.0.
  338.      */
  339.     public static function findFirstPublishedRootByHostAndLanguage($strHost, $varLanguage, array $arrOptions=array())
  340.     {
  341.         @trigger_error('Using PageModel::findFirstPublishedRootByHostAndLanguage() has been deprecated and will no longer work Contao 5.0.', E_USER_DEPRECATED);
  343.         $t = static::$strTable;
  344.         $objDatabase = Database::getInstance();
  346.         if (\is_array($varLanguage))
  347.         {
  348.             $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='')");
  350.             if (!empty($varLanguage))
  351.             {
  352.                 $arrColumns[] = "($t.language IN('" . implode("','", $varLanguage) . "') OR $t.fallback='1')";
  353.             }
  354.             else
  355.             {
  356.                 $arrColumns[] = "$t.fallback='1'";
  357.             }
  359.             if (!isset($arrOptions['order']))
  360.             {
  361.                 $arrOptions['order'] = "$t.dns DESC" . (!empty($varLanguage) ? ", " . $objDatabase->findInSet("$t.language", array_reverse($varLanguage)) . " DESC" : "") . ", $t.sorting";
  362.             }
  364.             if (!static::isPreviewMode($arrOptions))
  365.             {
  366.                 $time = Date::floorToMinute();
  367.                 $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  368.             }
  370.             return static::findOneBy($arrColumns, $strHost, $arrOptions);
  371.         }
  373.         $arrColumns = array("$t.type='root' AND ($t.dns=? OR $t.dns='') AND ($t.language=? OR $t.fallback='1')");
  374.         $arrValues = array($strHost, $varLanguage);
  376.         if (!isset($arrOptions['order']))
  377.         {
  378.             $arrOptions['order'] = "$t.dns DESC, $t.fallback";
  379.         }
  381.         if (!static::isPreviewMode($arrOptions))
  382.         {
  383.             $time = Date::floorToMinute();
  384.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  385.         }
  387.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  388.     }
  390.     /**
  391.      * Find the first published page by its parent ID
  392.      *
  393.      * @param integer $intPid     The parent page's ID
  394.      * @param array   $arrOptions An optional options array
  395.      *
  396.      * @return PageModel|null The model or null if there is no published page
  397.      */
  398.     public static function findFirstPublishedByPid($intPid, array $arrOptions=array())
  399.     {
  400.         $t = static::$strTable;
  401.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  403.         if (!static::isPreviewMode($arrOptions))
  404.         {
  405.             $time = Date::floorToMinute();
  406.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  407.         }
  409.         if (!isset($arrOptions['order']))
  410.         {
  411.             $arrOptions['order'] = "$t.sorting";
  412.         }
  414.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  415.     }
  417.     /**
  418.      * Find the first published regular page by its parent ID
  419.      *
  420.      * @param integer $intPid     The parent page's ID
  421.      * @param array   $arrOptions An optional options array
  422.      *
  423.      * @return PageModel|null The model or null if there is no published regular page
  424.      */
  425.     public static function findFirstPublishedRegularByPid($intPid, array $arrOptions=array())
  426.     {
  427.         $t = static::$strTable;
  428.         $arrColumns = array("$t.pid=? AND $t.type='regular'");
  430.         if (!static::isPreviewMode($arrOptions))
  431.         {
  432.             $time = Date::floorToMinute();
  433.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  434.         }
  436.         if (!isset($arrOptions['order']))
  437.         {
  438.             $arrOptions['order'] = "$t.sorting";
  439.         }
  441.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  442.     }
  444.     /**
  445.      * Find an error 401 page by its parent ID
  446.      *
  447.      * @param integer $intPid     The parent page's ID
  448.      * @param array   $arrOptions An optional options array
  449.      *
  450.      * @return PageModel|null The model or null if there is no 401 page
  451.      */
  452.     public static function find401ByPid($intPid, array $arrOptions=array())
  453.     {
  454.         $t = static::$strTable;
  455.         $arrColumns = array("$t.pid=? AND $t.type='error_401'");
  457.         if (!static::isPreviewMode($arrOptions))
  458.         {
  459.             $time = Date::floorToMinute();
  460.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  461.         }
  463.         if (!isset($arrOptions['order']))
  464.         {
  465.             $arrOptions['order'] = "$t.sorting";
  466.         }
  468.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  469.     }
  471.     /**
  472.      * Find an error 403 page by its parent ID
  473.      *
  474.      * @param integer $intPid     The parent page's ID
  475.      * @param array   $arrOptions An optional options array
  476.      *
  477.      * @return PageModel|null The model or null if there is no 403 page
  478.      */
  479.     public static function find403ByPid($intPid, array $arrOptions=array())
  480.     {
  481.         $t = static::$strTable;
  482.         $arrColumns = array("$t.pid=? AND $t.type='error_403'");
  484.         if (!static::isPreviewMode($arrOptions))
  485.         {
  486.             $time = Date::floorToMinute();
  487.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  488.         }
  490.         if (!isset($arrOptions['order']))
  491.         {
  492.             $arrOptions['order'] = "$t.sorting";
  493.         }
  495.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  496.     }
  498.     /**
  499.      * Find an error 404 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 404 page
  505.      */
  506.     public static function find404ByPid($intPid, array $arrOptions=array())
  507.     {
  508.         $t = static::$strTable;
  509.         $arrColumns = array("$t.pid=? AND $t.type='error_404'");
  511.         if (!static::isPreviewMode($arrOptions))
  512.         {
  513.             $time = Date::floorToMinute();
  514.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  515.         }
  517.         if (!isset($arrOptions['order']))
  518.         {
  519.             $arrOptions['order'] = "$t.sorting";
  520.         }
  522.         return static::findOneBy($arrColumns, $intPid, $arrOptions);
  523.     }
  525.     /**
  526.      * Find pages matching a list of possible alias names
  527.      *
  528.      * @param array $arrAliases An array of possible alias names
  529.      * @param array $arrOptions An optional options array
  530.      *
  531.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  532.      */
  533.     public static function findByAliases($arrAliases, array $arrOptions=array())
  534.     {
  535.         if (empty($arrAliases) || !\is_array($arrAliases))
  536.         {
  537.             return null;
  538.         }
  540.         // Remove everything that is not an alias
  541.         $arrAliases = array_filter(array_map(static function ($v) { return preg_match('/^[\w\/.-]+$/u', $v) ? $v : null; }, $arrAliases));
  543.         // Return if nothing is left
  544.         if (empty($arrAliases))
  545.         {
  546.             return null;
  547.         }
  549.         $t = static::$strTable;
  550.         $arrColumns = array("$t.alias IN('" . implode("','", array_filter($arrAliases)) . "')");
  552.         // Check the publication status (see #4652)
  553.         if (!static::isPreviewMode($arrOptions))
  554.         {
  555.             $time = Date::floorToMinute();
  556.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  557.         }
  559.         if (!isset($arrOptions['order']))
  560.         {
  561.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.alias", $arrAliases);
  562.         }
  564.         return static::findBy($arrColumns, null, $arrOptions);
  565.     }
  567.     /**
  568.      * Find published pages by their ID or aliases
  569.      *
  570.      * @param mixed $varId      The numeric ID or the alias name
  571.      * @param array $arrOptions An optional options array
  572.      *
  573.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  574.      */
  575.     public static function findPublishedByIdOrAlias($varId, array $arrOptions=array())
  576.     {
  577.         $t = static::$strTable;
  578.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  580.         if (!static::isPreviewMode($arrOptions))
  581.         {
  582.             $time = Date::floorToMinute();
  583.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  584.         }
  586.         return static::findBy($arrColumns, $varId, $arrOptions);
  587.     }
  589.     /**
  590.      * Find all published subpages by their parent ID and exclude pages only visible for guests
  591.      *
  592.      * @param integer $intPid        The parent page's ID
  593.      * @param boolean $blnShowHidden If true, hidden pages will be included
  594.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  595.      *
  596.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  597.      *
  598.      * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0. Use Module::getPublishedSubpagesWithoutGuestsByPid() instead.
  599.      */
  600.     public static function findPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false)
  601.     {
  602.         @trigger_error('Using PageModel::findPublishedSubpagesWithoutGuestsByPid() has been deprecated and will no longer work Contao 5.0. Use Module::getPublishedSubpagesWithoutGuestsByPid() instead.', E_USER_DEPRECATED);
  604.         $time = Date::floorToMinute();
  605.         $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  606.         $blnFeUserLoggedIn = $tokenChecker->hasFrontendUser();
  607.         $blnBeUserLoggedIn = $tokenChecker->hasBackendUser() && $tokenChecker->isPreviewMode();
  609.         $objSubpages = Database::getInstance()->prepare("SELECT p1.*, (SELECT COUNT(*) FROM tl_page p2 WHERE p2.pid=p1.id AND p2.type!='root' AND p2.type!='error_401' AND p2.type!='error_403' AND p2.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p2.hide='' OR sitemap='map_always')" : " AND p2.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p2.guests=''" : "") . (!$blnBeUserLoggedIn ? " AND p2.published='1' AND (p2.start='' OR p2.start<='$time') AND (p2.stop='' OR p2.stop>'$time')" : "") . ") AS subpages FROM tl_page p1 WHERE p1.pid=? AND p1.type!='root' AND p1.type!='error_401' AND p1.type!='error_403' AND p1.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p1.hide='' OR sitemap='map_always')" : " AND p1.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p1.guests=''" : "") . (!$blnBeUserLoggedIn ? " AND p1.published='1' AND (p1.start='' OR p1.start<='$time') AND (p1.stop='' OR p1.stop>'$time')" : "") . " ORDER BY p1.sorting")
  610.                                               ->execute($intPid);
  612.         if ($objSubpages->numRows < 1)
  613.         {
  614.             return null;
  615.         }
  617.         return static::createCollectionFromDbResult($objSubpages, 'tl_page');
  618.     }
  620.     /**
  621.      * Find all published regular pages by their IDs and exclude pages only visible for guests
  622.      *
  623.      * @param array $arrIds     An array of page IDs
  624.      * @param array $arrOptions An optional options array
  625.      *
  626.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no pages
  627.      */
  628.     public static function findPublishedRegularWithoutGuestsByIds($arrIds, array $arrOptions=array())
  629.     {
  630.         if (empty($arrIds) || !\is_array($arrIds))
  631.         {
  632.             return null;
  633.         }
  635.         $t = static::$strTable;
  636.         $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'");
  638.         if (empty($arrOptions['includeRoot']))
  639.         {
  640.             $arrColumns[] = "$t.type!='root'";
  641.         }
  643.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  644.         {
  645.             $arrColumns[] = "$t.guests=''";
  646.         }
  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'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  657.         }
  659.         return static::findBy($arrColumns, null, $arrOptions);
  660.     }
  662.     /**
  663.      * Find all published regular pages by their parent IDs and exclude pages only visible for guests
  664.      *
  665.      * @param integer $intPid     The parent page's ID
  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 findPublishedRegularWithoutGuestsByPid($intPid, array $arrOptions=array())
  671.     {
  672.         $t = static::$strTable;
  673.         $arrColumns = array("$t.pid=? AND $t.type!='root' AND $t.type!='error_401' AND $t.type!='error_403' AND $t.type!='error_404'");
  675.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  676.         {
  677.             $arrColumns[] = "$t.guests=''";
  678.         }
  680.         if (!static::isPreviewMode($arrOptions))
  681.         {
  682.             $time = Date::floorToMinute();
  683.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  684.         }
  686.         if (!isset($arrOptions['order']))
  687.         {
  688.             $arrOptions['order'] = "$t.sorting";
  689.         }
  691.         return static::findBy($arrColumns, $intPid, $arrOptions);
  692.     }
  694.     /**
  695.      * Find the language fallback page by hostname
  696.      *
  697.      * @param string $strHost    The hostname
  698.      * @param array  $arrOptions An optional options array
  699.      *
  700.      * @return PageModel|Model|null The model or null if there is not fallback page
  701.      */
  702.     public static function findPublishedFallbackByHostname($strHost, array $arrOptions=array())
  703.     {
  704.         // Try to load from the registry (see #8544)
  705.         if (empty($arrOptions))
  706.         {
  707.             $objModel = Registry::getInstance()->fetch(static::$strTable, $strHost, 'contao.dns-fallback');
  709.             if ($objModel !== null)
  710.             {
  711.                 return $objModel;
  712.             }
  713.         }
  715.         $t = static::$strTable;
  716.         $arrColumns = array("$t.dns=? AND $t.fallback='1'");
  718.         if (isset($arrOptions['fallbackToEmpty']) && $arrOptions['fallbackToEmpty'] === true)
  719.         {
  720.             $arrColumns = array("($t.dns=? OR $t.dns='') AND $t.fallback='1'");
  721.         }
  723.         if (!static::isPreviewMode($arrOptions))
  724.         {
  725.             $time = Date::floorToMinute();
  726.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  727.         }
  729.         return static::findOneBy($arrColumns, $strHost, $arrOptions);
  730.     }
  732.     /**
  733.      * Finds the published root pages
  734.      *
  735.      * @param array $arrOptions An optional options array
  736.      *
  737.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  738.      */
  739.     public static function findPublishedRootPages(array $arrOptions=array())
  740.     {
  741.         $t = static::$strTable;
  742.         $arrColumns = array("$t.type='root'");
  744.         if (isset($arrOptions['dns']))
  745.         {
  746.             $arrColumns = array("$t.type='root' AND $t.dns=?");
  747.         }
  749.         if (!static::isPreviewMode($arrOptions))
  750.         {
  751.             $time = Date::floorToMinute();
  752.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  753.         }
  755.         return static::findBy($arrColumns, $arrOptions['dns'] ?? null, $arrOptions);
  756.     }
  758.     /**
  759.      * Find the parent pages of a page
  760.      *
  761.      * @param integer $intId The page's ID
  762.      *
  763.      * @return Collection|PageModel[]|PageModel|null A collection of models or null if there are no parent pages
  764.      */
  765.     public static function findParentsById($intId)
  766.     {
  767.         $arrModels = array();
  769.         while ($intId > 0 && ($objPage = static::findByPk($intId)) !== null)
  770.         {
  771.             $intId = $objPage->pid;
  772.             $arrModels[] = $objPage;
  773.         }
  775.         if (empty($arrModels))
  776.         {
  777.             return null;
  778.         }
  780.         return static::createCollection($arrModels, 'tl_page');
  781.     }
  783.     /**
  784.      * Find the first active page by its member groups
  785.      *
  786.      * @param array $arrIds An array of member group IDs
  787.      *
  788.      * @return PageModel|null The model or null if there is no matching member group
  789.      */
  790.     public static function findFirstActiveByMemberGroups($arrIds)
  791.     {
  792.         if (empty($arrIds) || !\is_array($arrIds))
  793.         {
  794.             return null;
  795.         }
  797.         $time = Date::floorToMinute();
  798.         $objDatabase = Database::getInstance();
  799.         $arrIds = array_map('\intval', $arrIds);
  801.         $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))
  802.                                  ->limit(1)
  803.                                  ->execute();
  805.         if ($objResult->numRows < 1)
  806.         {
  807.             return null;
  808.         }
  810.         $objRegistry = Registry::getInstance();
  812.         /** @var PageModel|Model $objPage */
  813.         if ($objPage = $objRegistry->fetch('tl_page', $objResult->id))
  814.         {
  815.             return $objPage;
  816.         }
  818.         return new static($objResult);
  819.     }
  821.     /**
  822.      * Find a page by its ID and return it with the inherited details
  823.      *
  824.      * @param integer $intId The page's ID
  825.      *
  826.      * @return PageModel|null The model or null if there is no matching page
  827.      */
  828.     public static function findWithDetails($intId)
  829.     {
  830.         $objPage = static::findByPk($intId);
  832.         if ($objPage === null)
  833.         {
  834.             return null;
  835.         }
  837.         return $objPage->loadDetails();
  838.     }
  840.     /**
  841.      * Register the contao.dns-fallback alias when the model is attached to the registry
  842.      *
  843.      * @param Registry $registry The model registry
  844.      */
  845.     public function onRegister(Registry $registry)
  846.     {
  847.         parent::onRegister($registry);
  849.         // Register this model as being the fallback page for a given dns
  850.         if ($this->fallback && $this->type == 'root' && !$registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  851.         {
  852.             $registry->registerAlias($this, 'contao.dns-fallback', $this->dns);
  853.         }
  854.     }
  856.     /**
  857.      * Unregister the contao.dns-fallback alias when the model is detached from the registry
  858.      *
  859.      * @param Registry $registry The model registry
  860.      */
  861.     public function onUnregister(Registry $registry)
  862.     {
  863.         parent::onUnregister($registry);
  865.         // Unregister the fallback page
  866.         if ($this->fallback && $this->type == 'root' && $registry->isRegisteredAlias($this, 'contao.dns-fallback', $this->dns))
  867.         {
  868.             $registry->unregisterAlias($this, 'contao.dns-fallback', $this->dns);
  869.         }
  870.     }
  872.     /**
  873.      * Get the details of a page including inherited parameters
  874.      *
  875.      * @return PageModel The page model
  876.      *
  877.      * @throws NoRootPageFoundException If no root page is found
  878.      */
  879.     public function loadDetails()
  880.     {
  881.         // Loaded already
  882.         if ($this->blnDetailsLoaded)
  883.         {
  884.             return $this;
  885.         }
  887.         // Set some default values
  888.         $this->protected = (bool) $this->protected;
  889.         $this->groups = $this->protected ? StringUtil::deserialize($this->groups) : false;
  890.         $this->layout = $this->includeLayout ? $this->layout : false;
  891.         $this->cache = $this->includeCache ? $this->cache : false;
  892.         $this->alwaysLoadFromCache = $this->includeCache ? $this->alwaysLoadFromCache : false;
  893.         $this->clientCache = $this->includeCache ? $this->clientCache : false;
  895.         $pid = $this->pid;
  896.         $type = $this->type;
  897.         $alias = $this->alias;
  898.         $name = $this->title;
  899.         $title = $this->pageTitle ?: $this->title;
  900.         $folderUrl = '';
  901.         $palias = '';
  902.         $pname = '';
  903.         $ptitle = '';
  904.         $trail = array($this->id, $pid);
  905.         $time = time();
  907.         // Inherit the settings
  908.         if ($this->type == 'root')
  909.         {
  910.             $objParentPage = $this; // see #4610
  911.         }
  912.         else
  913.         {
  914.             // Load all parent pages
  915.             $objParentPage = self::findParentsById($pid);
  917.             if ($objParentPage !== null)
  918.             {
  919.                 while ($pid > 0 && $type != 'root' && $objParentPage->next())
  920.                 {
  921.                     $pid = $objParentPage->pid;
  922.                     $type = $objParentPage->type;
  924.                     // Parent title
  925.                     if (!$ptitle)
  926.                     {
  927.                         $palias = $objParentPage->alias;
  928.                         $pname = $objParentPage->title;
  929.                         $ptitle = $objParentPage->pageTitle ?: $objParentPage->title;
  930.                     }
  932.                     // Page title
  933.                     if ($type != 'root')
  934.                     {
  935.                         // If $folderUrl is not yet set, use the alias of the first
  936.                         // parent page if it is not a root page (see #2129)
  937.                         if (!$folderUrl && $objParentPage->alias)
  938.                         {
  939.                             $folderUrl = $objParentPage->alias . '/';
  940.                         }
  942.                         $alias = $objParentPage->alias;
  943.                         $name = $objParentPage->title;
  944.                         $title = $objParentPage->pageTitle ?: $objParentPage->title;
  945.                         $trail[] = $objParentPage->pid;
  946.                     }
  948.                     // Cache
  949.                     if ($objParentPage->includeCache)
  950.                     {
  951.                         $this->cache = $this->cache !== false ? $this->cache : $objParentPage->cache;
  952.                         $this->alwaysLoadFromCache = $this->alwaysLoadFromCache !== false ? $this->alwaysLoadFromCache : $objParentPage->alwaysLoadFromCache;
  953.                         $this->clientCache = $this->clientCache !== false ? $this->clientCache : $objParentPage->clientCache;
  954.                     }
  956.                     // Layout
  957.                     if ($objParentPage->includeLayout && $this->layout === false)
  958.                     {
  959.                         $this->layout = $objParentPage->layout;
  960.                     }
  962.                     // Protection
  963.                     if ($objParentPage->protected && $this->protected === false)
  964.                     {
  965.                         $this->protected = true;
  966.                         $this->groups = StringUtil::deserialize($objParentPage->groups);
  967.                     }
  968.                 }
  969.             }
  971.             // Set the titles
  972.             $this->mainAlias = $alias;
  973.             $this->mainTitle = $name;
  974.             $this->mainPageTitle = $title;
  975.             $this->parentAlias = $palias;
  976.             $this->parentTitle = $pname;
  977.             $this->parentPageTitle = $ptitle;
  978.             $this->folderUrl = $folderUrl;
  979.         }
  981.         // Set the root ID and title
  982.         if ($objParentPage !== null && $objParentPage->type == 'root')
  983.         {
  984.             $this->rootId = $objParentPage->id;
  985.             $this->rootAlias = $objParentPage->alias;
  986.             $this->rootTitle = $objParentPage->title;
  987.             $this->rootPageTitle = $objParentPage->pageTitle ?: $objParentPage->title;
  988.             $this->rootSorting = $objParentPage->sorting;
  989.             $this->domain = $objParentPage->dns;
  990.             $this->rootLanguage = $objParentPage->language;
  991.             $this->language = $objParentPage->language;
  992.             $this->staticFiles = $objParentPage->staticFiles;
  993.             $this->staticPlugins = $objParentPage->staticPlugins;
  994.             $this->dateFormat = $objParentPage->dateFormat;
  995.             $this->timeFormat = $objParentPage->timeFormat;
  996.             $this->datimFormat = $objParentPage->datimFormat;
  997.             $this->validAliasCharacters = $objParentPage->validAliasCharacters;
  998.             $this->adminEmail = $objParentPage->adminEmail;
  999.             $this->enforceTwoFactor = $objParentPage->enforceTwoFactor;
  1000.             $this->twoFactorJumpTo = $objParentPage->twoFactorJumpTo;
  1002.             // Store whether the root page has been published
  1003.             $this->rootIsPublic = ($objParentPage->published && (!$objParentPage->start || $objParentPage->start <= $time) && (!$objParentPage->stop || $objParentPage->stop > $time));
  1004.             $this->rootIsFallback = (bool) $objParentPage->fallback;
  1005.             $this->rootUseSSL = $objParentPage->useSSL;
  1006.             $this->rootFallbackLanguage = $objParentPage->language;
  1008.             // Store the fallback language (see #6874)
  1009.             if (!$objParentPage->fallback)
  1010.             {
  1011.                 $this->rootFallbackLanguage = null;
  1013.                 $objFallback = static::findPublishedFallbackByHostname($objParentPage->dns);
  1015.                 if ($objFallback !== null)
  1016.                 {
  1017.                     $this->rootFallbackLanguage = $objFallback->language;
  1018.                 }
  1019.             }
  1020.         }
  1022.         // No root page found
  1023.         elseif (TL_MODE == 'FE' && $this->type != 'root')
  1024.         {
  1025.             System::log('Page ID "' . $this->id . '" does not belong to a root page', __METHOD__, TL_ERROR);
  1027.             throw new NoRootPageFoundException('No root page found');
  1028.         }
  1030.         $this->trail = array_reverse($trail);
  1032.         // Use the global date format if none is set (see #6104)
  1033.         if (!$this->dateFormat)
  1034.         {
  1035.             $this->dateFormat = Config::get('dateFormat');
  1036.         }
  1038.         if (!$this->timeFormat)
  1039.         {
  1040.             $this->timeFormat = Config::get('timeFormat');
  1041.         }
  1043.         if (!$this->datimFormat)
  1044.         {
  1045.             $this->datimFormat = Config::get('datimFormat');
  1046.         }
  1048.         $this->isPublic = ($this->published && (!$this->start || $this->start <= $time) && (!$this->stop || $this->stop > $time));
  1050.         // HOOK: add custom logic
  1051.         if (!empty($GLOBALS['TL_HOOKS']['loadPageDetails']) && \is_array($GLOBALS['TL_HOOKS']['loadPageDetails']))
  1052.         {
  1053.             $parentModels = array();
  1055.             if ($objParentPage instanceof Collection)
  1056.             {
  1057.                 $parentModels = $objParentPage->getModels();
  1058.             }
  1060.             foreach ($GLOBALS['TL_HOOKS']['loadPageDetails'] as $callback)
  1061.             {
  1062.                 System::importStatic($callback[0])->{$callback[1]}($parentModels, $this);
  1063.             }
  1064.         }
  1066.         // Prevent saving (see #6506 and #7199)
  1067.         $this->preventSaving();
  1068.         $this->blnDetailsLoaded = true;
  1070.         return $this;
  1071.     }
  1073.     /**
  1074.      * Generate a front end URL
  1075.      *
  1076.      * @param string $strParams    An optional string of URL parameters
  1077.      * @param string $strForceLang Force a certain language
  1078.      *
  1079.      * @return string An URL that can be used in the front end
  1080.      */
  1081.     public function getFrontendUrl($strParams=null, $strForceLang=null)
  1082.     {
  1083.         if ($strForceLang !== null)
  1084.         {
  1085.             @trigger_error('Using PageModel::getFrontendUrl() with $strForceLang has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  1086.         }
  1088.         $this->loadDetails();
  1090.         $objUrlGenerator = System::getContainer()->get('contao.routing.url_generator');
  1092.         $strUrl = $objUrlGenerator->generate
  1093.         (
  1094.             ($this->alias ?: $this->id) . $strParams,
  1095.             array
  1096.             (
  1097.                 '_locale' => ($strForceLang ?: $this->rootLanguage),
  1098.                 '_domain' => $this->domain,
  1099.                 '_ssl' => (bool) $this->rootUseSSL,
  1100.             )
  1101.         );
  1103.         // Make the URL relative to the base path
  1104.         if (0 === strncmp($strUrl, '/', 1))
  1105.         {
  1106.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1107.         }
  1109.         return $this->applyLegacyLogic($strUrl, $strParams);
  1110.     }
  1112.     /**
  1113.      * Generate an absolute URL depending on the current rewriteURL setting
  1114.      *
  1115.      * @param string $strParams An optional string of URL parameters
  1116.      *
  1117.      * @return string An absolute URL that can be used in the front end
  1118.      */
  1119.     public function getAbsoluteUrl($strParams=null)
  1120.     {
  1121.         $this->loadDetails();
  1123.         $objUrlGenerator = System::getContainer()->get('contao.routing.url_generator');
  1125.         $strUrl = $objUrlGenerator->generate
  1126.         (
  1127.             ($this->alias ?: $this->id) . $strParams,
  1128.             array
  1129.             (
  1130.                 '_locale' => $this->rootLanguage,
  1131.                 '_domain' => $this->domain,
  1132.                 '_ssl' => (bool) $this->rootUseSSL,
  1133.             ),
  1134.             UrlGeneratorInterface::ABSOLUTE_URL
  1135.         );
  1137.         return $this->applyLegacyLogic($strUrl, $strParams);
  1138.     }
  1140.     /**
  1141.      * Generate the front end preview URL
  1142.      *
  1143.      * @param string $strParams An optional string of URL parameters
  1144.      *
  1145.      * @return string The front end preview URL
  1146.      */
  1147.     public function getPreviewUrl($strParams=null)
  1148.     {
  1149.         $container = System::getContainer();
  1151.         if (!$previewScript = $container->getParameter('contao.preview_script'))
  1152.         {
  1153.             return $this->getAbsoluteUrl($strParams);
  1154.         }
  1156.         $context = $container->get('router')->getContext();
  1157.         $baseUrl = $context->getBaseUrl();
  1159.         // Add the preview script
  1160.         $context->setBaseUrl($previewScript);
  1162.         $objUrlGenerator = $container->get('contao.routing.url_generator');
  1164.         $strUrl = $objUrlGenerator->generate
  1165.         (
  1166.             ($this->alias ?: $this->id) . $strParams,
  1167.             array
  1168.             (
  1169.                 '_locale' => $this->rootLanguage,
  1170.                 '_domain' => $this->domain,
  1171.                 '_ssl' => (bool) $this->rootUseSSL,
  1172.             ),
  1173.             UrlGeneratorInterface::ABSOLUTE_URL
  1174.         );
  1176.         $context->setBaseUrl($baseUrl);
  1178.         return $this->applyLegacyLogic($strUrl, $strParams);
  1179.     }
  1181.     /**
  1182.      * Return the slug options
  1183.      *
  1184.      * @return array The slug options
  1185.      */
  1186.     public function getSlugOptions()
  1187.     {
  1188.         $slugOptions = array('locale'=>$this->language);
  1190.         if ($this->validAliasCharacters)
  1191.         {
  1192.             $slugOptions['validChars'] = $this->validAliasCharacters;
  1193.         }
  1195.         return $slugOptions;
  1196.     }
  1198.     /**
  1199.      * Modifies a URL from the URL generator.
  1200.      *
  1201.      * @param string      $strUrl
  1202.      * @param string|null $strParams
  1203.      *
  1204.      * @return string
  1205.      */
  1206.     private function applyLegacyLogic($strUrl, $strParams)
  1207.     {
  1208.         // Decode sprintf placeholders
  1209.         if ($strParams !== null && strpos($strParams, '%') !== false)
  1210.         {
  1211.             @trigger_error('Using sprintf placeholders in URLs has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  1213.             $arrMatches = array();
  1214.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1216.             foreach (array_unique($arrMatches[1]) as $v)
  1217.             {
  1218.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1219.             }
  1220.         }
  1222.         // HOOK: add custom logic
  1223.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1224.         {
  1225.             @trigger_error('Using the "generateFrontendUrl" hook has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  1227.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1228.             {
  1229.                 $strUrl = System::importStatic($callback[0])->{$callback[1]}($this->row(), $strParams ?? '', $strUrl);
  1230.             }
  1232.             return $strUrl;
  1233.         }
  1235.         return $strUrl;
  1236.     }
  1237. }
  1239. class_alias(PageModel::class, 'PageModel');