vendor/contao/core-bundle/src/Resources/contao/models/ArticleModel.php line 224

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\Model\Collection;
  15. /**
  16.  * Reads and writes articles
  17.  *
  18.  * @property string|integer $id
  19.  * @property string|integer $pid
  20.  * @property string|integer $sorting
  21.  * @property string|integer $tstamp
  22.  * @property string         $title
  23.  * @property string         $alias
  24.  * @property string|integer $author
  25.  * @property string         $inColumn
  26.  * @property string|null    $keywords
  27.  * @property string|boolean $showTeaser
  28.  * @property string         $teaserCssID
  29.  * @property string|null    $teaser
  30.  * @property string         $printable
  31.  * @property string         $customTpl
  32.  * @property string|boolean $protected
  33.  * @property string|null    $groups
  34.  * @property string|boolean $guests
  35.  * @property string|array   $cssID
  36.  * @property string|boolean $published
  37.  * @property string|integer $start
  38.  * @property string|integer $stop
  39.  *
  40.  * @method static ArticleModel|null findById($id, array $opt=array())
  41.  * @method static ArticleModel|null findByPk($id, array $opt=array())
  42.  * @method static ArticleModel|null findByIdOrAlias($val, array $opt=array())
  43.  * @method static ArticleModel|null findOneBy($col, $val, array $opt=array())
  44.  * @method static ArticleModel|null findOneByPid($val, array $opt=array())
  45.  * @method static ArticleModel|null findOneBySorting($val, array $opt=array())
  46.  * @method static ArticleModel|null findOneByTstamp($val, array $opt=array())
  47.  * @method static ArticleModel|null findOneByTitle($val, array $opt=array())
  48.  * @method static ArticleModel|null findOneByAlias($val, array $opt=array())
  49.  * @method static ArticleModel|null findOneByAuthor($val, array $opt=array())
  50.  * @method static ArticleModel|null findOneByInColumn($val, array $opt=array())
  51.  * @method static ArticleModel|null findOneByKeywords($val, array $opt=array())
  52.  * @method static ArticleModel|null findOneByShowTeaser($val, array $opt=array())
  53.  * @method static ArticleModel|null findOneByTeaserCssID($val, array $opt=array())
  54.  * @method static ArticleModel|null findOneByTeaser($val, array $opt=array())
  55.  * @method static ArticleModel|null findOneByPrintable($val, array $opt=array())
  56.  * @method static ArticleModel|null findOneByCustomTpl($val, array $opt=array())
  57.  * @method static ArticleModel|null findOneByProtected($val, array $opt=array())
  58.  * @method static ArticleModel|null findOneByGroups($val, array $opt=array())
  59.  * @method static ArticleModel|null findOneByGuests($val, array $opt=array())
  60.  * @method static ArticleModel|null findOneByCssID($val, array $opt=array())
  61.  * @method static ArticleModel|null findOneBySpace($val, array $opt=array())
  62.  * @method static ArticleModel|null findOneByPublished($val, array $opt=array())
  63.  * @method static ArticleModel|null findOneByStart($val, array $opt=array())
  64.  * @method static ArticleModel|null findOneByStop($val, array $opt=array())
  65.  *
  66.  * @method static Collection|ArticleModel[]|ArticleModel|null findByPid($val, array $opt=array())
  67.  * @method static Collection|ArticleModel[]|ArticleModel|null findBySorting($val, array $opt=array())
  68.  * @method static Collection|ArticleModel[]|ArticleModel|null findByTstamp($val, array $opt=array())
  69.  * @method static Collection|ArticleModel[]|ArticleModel|null findByTitle($val, array $opt=array())
  70.  * @method static Collection|ArticleModel[]|ArticleModel|null findByAlias($val, array $opt=array())
  71.  * @method static Collection|ArticleModel[]|ArticleModel|null findByAuthor($val, array $opt=array())
  72.  * @method static Collection|ArticleModel[]|ArticleModel|null findByInColumn($val, array $opt=array())
  73.  * @method static Collection|ArticleModel[]|ArticleModel|null findByKeywords($val, array $opt=array())
  74.  * @method static Collection|ArticleModel[]|ArticleModel|null findByShowTeaser($val, array $opt=array())
  75.  * @method static Collection|ArticleModel[]|ArticleModel|null findByTeaserCssID($val, array $opt=array())
  76.  * @method static Collection|ArticleModel[]|ArticleModel|null findByTeaser($val, array $opt=array())
  77.  * @method static Collection|ArticleModel[]|ArticleModel|null findByPrintable($val, array $opt=array())
  78.  * @method static Collection|ArticleModel[]|ArticleModel|null findByCustomTpl($val, array $opt=array())
  79.  * @method static Collection|ArticleModel[]|ArticleModel|null findByProtected($val, array $opt=array())
  80.  * @method static Collection|ArticleModel[]|ArticleModel|null findByGroups($val, array $opt=array())
  81.  * @method static Collection|ArticleModel[]|ArticleModel|null findByGuests($val, array $opt=array())
  82.  * @method static Collection|ArticleModel[]|ArticleModel|null findByCssID($val, array $opt=array())
  83.  * @method static Collection|ArticleModel[]|ArticleModel|null findBySpace($val, array $opt=array())
  84.  * @method static Collection|ArticleModel[]|ArticleModel|null findByPublished($val, array $opt=array())
  85.  * @method static Collection|ArticleModel[]|ArticleModel|null findByStart($val, array $opt=array())
  86.  * @method static Collection|ArticleModel[]|ArticleModel|null findByStop($val, array $opt=array())
  87.  * @method static Collection|ArticleModel[]|ArticleModel|null findMultipleByIds($var, array $opt=array())
  88.  * @method static Collection|ArticleModel[]|ArticleModel|null findBy($col, $val, array $opt=array())
  89.  * @method static Collection|ArticleModel[]|ArticleModel|null findAll(array $opt=array())
  90.  *
  91.  * @method static integer countById($id, array $opt=array())
  92.  * @method static integer countByPid($val, array $opt=array())
  93.  * @method static integer countBySorting($val, array $opt=array())
  94.  * @method static integer countByTstamp($val, array $opt=array())
  95.  * @method static integer countByTitle($val, array $opt=array())
  96.  * @method static integer countByAlias($val, array $opt=array())
  97.  * @method static integer countByAuthor($val, array $opt=array())
  98.  * @method static integer countByInColumn($val, array $opt=array())
  99.  * @method static integer countByKeywords($val, array $opt=array())
  100.  * @method static integer countByShowTeaser($val, array $opt=array())
  101.  * @method static integer countByTeaserCssID($val, array $opt=array())
  102.  * @method static integer countByTeaser($val, array $opt=array())
  103.  * @method static integer countByPrintable($val, array $opt=array())
  104.  * @method static integer countByCustomTpl($val, array $opt=array())
  105.  * @method static integer countByProtected($val, array $opt=array())
  106.  * @method static integer countByGroups($val, array $opt=array())
  107.  * @method static integer countByGuests($val, array $opt=array())
  108.  * @method static integer countByCssID($val, array $opt=array())
  109.  * @method static integer countBySpace($val, array $opt=array())
  110.  * @method static integer countByPublished($val, array $opt=array())
  111.  * @method static integer countByStart($val, array $opt=array())
  112.  * @method static integer countByStop($val, array $opt=array())
  113.  */
  114. class ArticleModel extends Model
  115. {
  116.     /**
  117.      * Table name
  118.      * @var string
  119.      */
  120.     protected static $strTable = 'tl_article';
  122.     /**
  123.      * Find an article by its ID or alias and its page
  124.      *
  125.      * @param mixed   $varId      The numeric ID or alias name
  126.      * @param integer $intPid     The page ID
  127.      * @param array   $arrOptions An optional options array
  128.      *
  129.      * @return ArticleModel|null The model or null if there is no article
  130.      */
  131.     public static function findByIdOrAliasAndPid($varId, $intPid, array $arrOptions=array())
  132.     {
  133.         $t = static::$strTable;
  134.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  135.         $arrValues = array($varId);
  137.         if ($intPid)
  138.         {
  139.             $arrColumns[] = "$t.pid=?";
  140.             $arrValues[] = $intPid;
  141.         }
  143.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  144.     }
  146.     /**
  147.      * Find a published article by its ID or alias and its page
  148.      *
  149.      * @param mixed   $varId      The numeric ID or alias name
  150.      * @param integer $intPid     The page ID
  151.      * @param array   $arrOptions An optional options array
  152.      *
  153.      * @return ArticleModel|null The model or null if there is no article
  154.      */
  155.     public static function findPublishedByIdOrAliasAndPid($varId, $intPid, array $arrOptions=array())
  156.     {
  157.         $t = static::$strTable;
  158.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  159.         $arrValues = array($varId);
  161.         if ($intPid)
  162.         {
  163.             $arrColumns[] = "$t.pid=?";
  164.             $arrValues[] = $intPid;
  165.         }
  167.         if (!static::isPreviewMode($arrOptions))
  168.         {
  169.             $time = Date::floorToMinute();
  170.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  171.         }
  173.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  174.     }
  176.     /**
  177.      * Find a published article by its ID
  178.      *
  179.      * @param integer $intId      The article ID
  180.      * @param array   $arrOptions An optional options array
  181.      *
  182.      * @return ArticleModel|null The model or null if there is no published article
  183.      */
  184.     public static function findPublishedById($intId, array $arrOptions=array())
  185.     {
  186.         $t = static::$strTable;
  187.         $arrColumns = array("$t.id=?");
  189.         if (!static::isPreviewMode($arrOptions))
  190.         {
  191.             $time = Date::floorToMinute();
  192.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  193.         }
  195.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  196.     }
  198.     /**
  199.      * Find all published articles by their parent ID and column
  200.      *
  201.      * @param integer $intPid     The page ID
  202.      * @param string  $strColumn  The column name
  203.      * @param array   $arrOptions An optional options array
  204.      *
  205.      * @return Collection|ArticleModel[]|ArticleModel|null A collection of models or null if there are no articles in the given column
  206.      */
  207.     public static function findPublishedByPidAndColumn($intPid, $strColumn, array $arrOptions=array())
  208.     {
  209.         $t = static::$strTable;
  210.         $arrColumns = array("$t.pid=? AND $t.inColumn=?");
  211.         $arrValues = array($intPid, $strColumn);
  213.         if (!static::isPreviewMode($arrOptions))
  214.         {
  215.             $time = Date::floorToMinute();
  216.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  217.         }
  219.         if (!isset($arrOptions['order']))
  220.         {
  221.             $arrOptions['order'] = "$t.sorting";
  222.         }
  224.         return static::findBy($arrColumns, $arrValues, $arrOptions);
  225.     }
  227.     /**
  228.      * Find all published articles with teaser by their parent ID
  229.      *
  230.      * @param integer $intPid     The page ID
  231.      * @param array   $arrOptions An optional options array
  232.      *
  233.      * @return Collection|ArticleModel[]|ArticleModel|null A collection of models or null if there are no articles in the given column
  234.      */
  235.     public static function findPublishedWithTeaserByPid($intPid, array $arrOptions=array())
  236.     {
  237.         $t = static::$strTable;
  238.         $arrColumns = array("$t.pid=? AND $t.showTeaser=1");
  240.         if (!static::isPreviewMode($arrOptions))
  241.         {
  242.             $time = Date::floorToMinute();
  243.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  244.         }
  246.         if (!isset($arrOptions['order']))
  247.         {
  248.             $arrOptions['order'] = "$t.sorting";
  249.         }
  251.         return static::findBy($arrColumns, $intPid, $arrOptions);
  252.     }
  254.     /**
  255.      * Find all published articles with teaser by their parent ID and column
  256.      *
  257.      * @param integer $intPid     The page ID
  258.      * @param string  $strColumn  The column name
  259.      * @param array   $arrOptions An optional options array
  260.      *
  261.      * @return Collection|ArticleModel[]|ArticleModel|null A collection of models or null if there are no articles in the given column
  262.      */
  263.     public static function findPublishedWithTeaserByPidAndColumn($intPid, $strColumn, array $arrOptions=array())
  264.     {
  265.         $t = static::$strTable;
  266.         $arrColumns = array("$t.pid=? AND $t.inColumn=? AND $t.showTeaser=1");
  267.         $arrValues = array($intPid, $strColumn);
  269.         if (!static::isPreviewMode($arrOptions))
  270.         {
  271.             $time = Date::floorToMinute();
  272.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  273.         }
  275.         if (!isset($arrOptions['order']))
  276.         {
  277.             $arrOptions['order'] = "$t.sorting";
  278.         }
  280.         return static::findBy($arrColumns, $arrValues, $arrOptions);
  281.     }
  282. }
  284. class_alias(ArticleModel::class, 'ArticleModel');