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

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.  * @author Leo Feyer <https://github.com/leofeyer>
  115.  */
  116. class ArticleModel extends Model
  117. {
  118.     /**
  119.      * Table name
  120.      * @var string
  121.      */
  122.     protected static $strTable = 'tl_article';
  124.     /**
  125.      * Find an article by its ID or alias and its page
  126.      *
  127.      * @param mixed   $varId      The numeric ID or alias name
  128.      * @param integer $intPid     The page ID
  129.      * @param array   $arrOptions An optional options array
  130.      *
  131.      * @return ArticleModel|null The model or null if there is no article
  132.      */
  133.     public static function findByIdOrAliasAndPid($varId, $intPid, array $arrOptions=array())
  134.     {
  135.         $t = static::$strTable;
  136.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  137.         $arrValues = array($varId);
  139.         if ($intPid)
  140.         {
  141.             $arrColumns[] = "$t.pid=?";
  142.             $arrValues[] = $intPid;
  143.         }
  145.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  146.     }
  148.     /**
  149.      * Find a published article by its ID or alias and its page
  150.      *
  151.      * @param mixed   $varId      The numeric ID or alias name
  152.      * @param integer $intPid     The page ID
  153.      * @param array   $arrOptions An optional options array
  154.      *
  155.      * @return ArticleModel|null The model or null if there is no article
  156.      */
  157.     public static function findPublishedByIdOrAliasAndPid($varId, $intPid, array $arrOptions=array())
  158.     {
  159.         $t = static::$strTable;
  160.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  161.         $arrValues = array($varId);
  163.         if ($intPid)
  164.         {
  165.             $arrColumns[] = "$t.pid=?";
  166.             $arrValues[] = $intPid;
  167.         }
  169.         if (!static::isPreviewMode($arrOptions))
  170.         {
  171.             $time = Date::floorToMinute();
  172.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  173.         }
  175.         return static::findOneBy($arrColumns, $arrValues, $arrOptions);
  176.     }
  178.     /**
  179.      * Find a published article by its ID
  180.      *
  181.      * @param integer $intId      The article ID
  182.      * @param array   $arrOptions An optional options array
  183.      *
  184.      * @return ArticleModel|null The model or null if there is no published article
  185.      */
  186.     public static function findPublishedById($intId, array $arrOptions=array())
  187.     {
  188.         $t = static::$strTable;
  189.         $arrColumns = array("$t.id=?");
  191.         if (!static::isPreviewMode($arrOptions))
  192.         {
  193.             $time = Date::floorToMinute();
  194.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  195.         }
  197.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  198.     }
  200.     /**
  201.      * Find all published articles by their parent ID and column
  202.      *
  203.      * @param integer $intPid     The page ID
  204.      * @param string  $strColumn  The column name
  205.      * @param array   $arrOptions An optional options array
  206.      *
  207.      * @return Collection|ArticleModel[]|ArticleModel|null A collection of models or null if there are no articles in the given column
  208.      */
  209.     public static function findPublishedByPidAndColumn($intPid, $strColumn, array $arrOptions=array())
  210.     {
  211.         $t = static::$strTable;
  212.         $arrColumns = array("$t.pid=? AND $t.inColumn=?");
  213.         $arrValues = array($intPid, $strColumn);
  215.         if (!static::isPreviewMode($arrOptions))
  216.         {
  217.             $time = Date::floorToMinute();
  218.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  219.         }
  221.         if (!isset($arrOptions['order']))
  222.         {
  223.             $arrOptions['order'] = "$t.sorting";
  224.         }
  226.         return static::findBy($arrColumns, $arrValues, $arrOptions);
  227.     }
  229.     /**
  230.      * Find all published articles with teaser by their parent ID
  231.      *
  232.      * @param integer $intPid     The page ID
  233.      * @param array   $arrOptions An optional options array
  234.      *
  235.      * @return Collection|ArticleModel[]|ArticleModel|null A collection of models or null if there are no articles in the given column
  236.      */
  237.     public static function findPublishedWithTeaserByPid($intPid, array $arrOptions=array())
  238.     {
  239.         $t = static::$strTable;
  240.         $arrColumns = array("$t.pid=? AND $t.showTeaser=1");
  242.         if (!static::isPreviewMode($arrOptions))
  243.         {
  244.             $time = Date::floorToMinute();
  245.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  246.         }
  248.         if (!isset($arrOptions['order']))
  249.         {
  250.             $arrOptions['order'] = "$t.sorting";
  251.         }
  253.         return static::findBy($arrColumns, $intPid, $arrOptions);
  254.     }
  256.     /**
  257.      * Find all published articles with teaser by their parent ID and column
  258.      *
  259.      * @param integer $intPid     The page ID
  260.      * @param string  $strColumn  The column name
  261.      * @param array   $arrOptions An optional options array
  262.      *
  263.      * @return Collection|ArticleModel[]|ArticleModel|null A collection of models or null if there are no articles in the given column
  264.      */
  265.     public static function findPublishedWithTeaserByPidAndColumn($intPid, $strColumn, array $arrOptions=array())
  266.     {
  267.         $t = static::$strTable;
  268.         $arrColumns = array("$t.pid=? AND $t.inColumn=? AND $t.showTeaser=1");
  269.         $arrValues = array($intPid, $strColumn);
  271.         if (!static::isPreviewMode($arrOptions))
  272.         {
  273.             $time = Date::floorToMinute();
  274.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  275.         }
  277.         if (!isset($arrOptions['order']))
  278.         {
  279.             $arrOptions['order'] = "$t.sorting";
  280.         }
  282.         return static::findBy($arrColumns, $arrValues, $arrOptions);
  283.     }
  284. }
  286. class_alias(ArticleModel::class, 'ArticleModel');