vendor/contao/news-bundle/src/Resources/contao/models/NewsModel.php line 259

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\File\ModelMetadataTrait;
  14. use Contao\Model\Collection;
  16. /**
  17.  * Reads and writes news
  18.  *
  19.  * @property string|integer $id
  20.  * @property string|integer $pid
  21.  * @property string|integer $tstamp
  22.  * @property string         $headline
  23.  * @property string         $alias
  24.  * @property string|integer $author
  25.  * @property string|integer $date
  26.  * @property string|integer $time
  27.  * @property string         $pageTitle
  28.  * @property string         $robots
  29.  * @property string|null    $description
  30.  * @property string         $subheadline
  31.  * @property string|null    $teaser
  32.  * @property string|boolean $addImage
  33.  * @property string|boolean $overwriteMeta
  34.  * @property string|null    $singleSRC
  35.  * @property string         $alt
  36.  * @property string         $imageTitle
  37.  * @property string|integer $size
  38.  * @property string|array   $imagemargin
  39.  * @property string         $imageUrl
  40.  * @property string|boolean $fullsize
  41.  * @property string         $caption
  42.  * @property string         $floating
  43.  * @property string|boolean $addEnclosure
  44.  * @property string|null    $enclosure
  45.  * @property string         $source
  46.  * @property string|integer $jumpTo
  47.  * @property string|integer $articleId
  48.  * @property string         $url
  49.  * @property string|boolean $target
  50.  * @property string         $cssClass
  51.  * @property string|boolean $noComments
  52.  * @property string|boolean $featured
  53.  * @property string|boolean $published
  54.  * @property string|integer $start
  55.  * @property string|integer $stop
  56.  *
  57.  * @method static NewsModel|null findById($id, array $opt=array())
  58.  * @method static NewsModel|null findByPk($id, array $opt=array())
  59.  * @method static NewsModel|null findByIdOrAlias($val, array $opt=array())
  60.  * @method static NewsModel|null findOneBy($col, $val, array $opt=array())
  61.  * @method static NewsModel|null findOneByPid($val, array $opt=array())
  62.  * @method static NewsModel|null findOneByTstamp($val, array $opt=array())
  63.  * @method static NewsModel|null findOneByHeadline($val, array $opt=array())
  64.  * @method static NewsModel|null findOneByAlias($val, array $opt=array())
  65.  * @method static NewsModel|null findOneByAuthor($val, array $opt=array())
  66.  * @method static NewsModel|null findOneByDate($val, array $opt=array())
  67.  * @method static NewsModel|null findOneByTime($val, array $opt=array())
  68.  * @method static NewsModel|null findOneByPageTitle($val, array $opt=array())
  69.  * @method static NewsModel|null findOneByDescription($val, array $opt=array())
  70.  * @method static NewsModel|null findOneByRobots($val, array $opt=array())
  71.  * @method static NewsModel|null findOneBySubheadline($val, array $opt=array())
  72.  * @method static NewsModel|null findOneByTeaser($val, array $opt=array())
  73.  * @method static NewsModel|null findOneByAddImage($val, array $opt=array())
  74.  * @method static NewsModel|null findOneByOverwriteMeta($val, array $opt=array())
  75.  * @method static NewsModel|null findOneBySingleSRC($val, array $opt=array())
  76.  * @method static NewsModel|null findOneByAlt($val, array $opt=array())
  77.  * @method static NewsModel|null findOneByImageTitle($val, array $opt=array())
  78.  * @method static NewsModel|null findOneBySize($val, array $opt=array())
  79.  * @method static NewsModel|null findOneByImagemargin($val, array $opt=array())
  80.  * @method static NewsModel|null findOneByImageUrl($val, array $opt=array())
  81.  * @method static NewsModel|null findOneByFullsize($val, array $opt=array())
  82.  * @method static NewsModel|null findOneByCaption($val, array $opt=array())
  83.  * @method static NewsModel|null findOneByFloating($val, array $opt=array())
  84.  * @method static NewsModel|null findOneByAddEnclosure($val, array $opt=array())
  85.  * @method static NewsModel|null findOneByEnclosure($val, array $opt=array())
  86.  * @method static NewsModel|null findOneBySource($val, array $opt=array())
  87.  * @method static NewsModel|null findOneByJumpTo($val, array $opt=array())
  88.  * @method static NewsModel|null findOneByArticleId($val, array $opt=array())
  89.  * @method static NewsModel|null findOneByUrl($val, array $opt=array())
  90.  * @method static NewsModel|null findOneByTarget($val, array $opt=array())
  91.  * @method static NewsModel|null findOneByCssClass($val, array $opt=array())
  92.  * @method static NewsModel|null findOneByNoComments($val, array $opt=array())
  93.  * @method static NewsModel|null findOneByFeatured($val, array $opt=array())
  94.  * @method static NewsModel|null findOneByPublished($val, array $opt=array())
  95.  * @method static NewsModel|null findOneByStart($val, array $opt=array())
  96.  * @method static NewsModel|null findOneByStop($val, array $opt=array())
  97.  *
  98.  * @method static Collection|NewsModel[]|NewsModel|null findByPid($val, array $opt=array())
  99.  * @method static Collection|NewsModel[]|NewsModel|null findByTstamp($val, array $opt=array())
  100.  * @method static Collection|NewsModel[]|NewsModel|null findByHeadline($val, array $opt=array())
  101.  * @method static Collection|NewsModel[]|NewsModel|null findByAlias($val, array $opt=array())
  102.  * @method static Collection|NewsModel[]|NewsModel|null findByAuthor($val, array $opt=array())
  103.  * @method static Collection|NewsModel[]|NewsModel|null findByDate($val, array $opt=array())
  104.  * @method static Collection|NewsModel[]|NewsModel|null findByTime($val, array $opt=array())
  105.  * @method static Collection|NewsModel[]|NewsModel|null findByPageTitle($val, array $opt=array())
  106.  * @method static Collection|NewsModel[]|NewsModel|null findByDescription($val, array $opt=array())
  107.  * @method static Collection|NewsModel[]|NewsModel|null findByRobots($val, array $opt=array())
  108.  * @method static Collection|NewsModel[]|NewsModel|null findBySubheadline($val, array $opt=array())
  109.  * @method static Collection|NewsModel[]|NewsModel|null findByTeaser($val, array $opt=array())
  110.  * @method static Collection|NewsModel[]|NewsModel|null findByAddImage($val, array $opt=array())
  111.  * @method static Collection|NewsModel[]|NewsModel|null findByOverwriteMeta($val, array $opt=array())
  112.  * @method static Collection|NewsModel[]|NewsModel|null findBySingleSRC($val, array $opt=array())
  113.  * @method static Collection|NewsModel[]|NewsModel|null findByAlt($val, array $opt=array())
  114.  * @method static Collection|NewsModel[]|NewsModel|null findByImageTitle($val, array $opt=array())
  115.  * @method static Collection|NewsModel[]|NewsModel|null findBySize($val, array $opt=array())
  116.  * @method static Collection|NewsModel[]|NewsModel|null findByImagemargin($val, array $opt=array())
  117.  * @method static Collection|NewsModel[]|NewsModel|null findByImageUrl($val, array $opt=array())
  118.  * @method static Collection|NewsModel[]|NewsModel|null findByFullsize($val, array $opt=array())
  119.  * @method static Collection|NewsModel[]|NewsModel|null findByCaption($val, array $opt=array())
  120.  * @method static Collection|NewsModel[]|NewsModel|null findByFloating($val, array $opt=array())
  121.  * @method static Collection|NewsModel[]|NewsModel|null findByAddEnclosure($val, array $opt=array())
  122.  * @method static Collection|NewsModel[]|NewsModel|null findByEnclosure($val, array $opt=array())
  123.  * @method static Collection|NewsModel[]|NewsModel|null findBySource($val, array $opt=array())
  124.  * @method static Collection|NewsModel[]|NewsModel|null findByJumpTo($val, array $opt=array())
  125.  * @method static Collection|NewsModel[]|NewsModel|null findByArticleId($val, array $opt=array())
  126.  * @method static Collection|NewsModel[]|NewsModel|null findByUrl($val, array $opt=array())
  127.  * @method static Collection|NewsModel[]|NewsModel|null findByTarget($val, array $opt=array())
  128.  * @method static Collection|NewsModel[]|NewsModel|null findByCssClass($val, array $opt=array())
  129.  * @method static Collection|NewsModel[]|NewsModel|null findByNoComments($val, array $opt=array())
  130.  * @method static Collection|NewsModel[]|NewsModel|null findByFeatured($val, array $opt=array())
  131.  * @method static Collection|NewsModel[]|NewsModel|null findByPublished($val, array $opt=array())
  132.  * @method static Collection|NewsModel[]|NewsModel|null findByStart($val, array $opt=array())
  133.  * @method static Collection|NewsModel[]|NewsModel|null findByStop($val, array $opt=array())
  134.  * @method static Collection|NewsModel[]|NewsModel|null findMultipleByIds($val, array $opt=array())
  135.  * @method static Collection|NewsModel[]|NewsModel|null findBy($col, $val, array $opt=array())
  136.  * @method static Collection|NewsModel[]|NewsModel|null findAll(array $opt=array())
  137.  *
  138.  * @method static integer countById($id, array $opt=array())
  139.  * @method static integer countByPid($val, array $opt=array())
  140.  * @method static integer countByTstamp($val, array $opt=array())
  141.  * @method static integer countByHeadline($val, array $opt=array())
  142.  * @method static integer countByAlias($val, array $opt=array())
  143.  * @method static integer countByAuthor($val, array $opt=array())
  144.  * @method static integer countByDate($val, array $opt=array())
  145.  * @method static integer countByTime($val, array $opt=array())
  146.  * @method static integer countByPageTitle($val, array $opt=array())
  147.  * @method static integer countByDescription($val, array $opt=array())
  148.  * @method static integer countByRobots($val, array $opt=array())
  149.  * @method static integer countBySubheadline($val, array $opt=array())
  150.  * @method static integer countByTeaser($val, array $opt=array())
  151.  * @method static integer countByAddImage($val, array $opt=array())
  152.  * @method static integer countByOverwriteMeta($val, array $opt=array())
  153.  * @method static integer countBySingleSRC($val, array $opt=array())
  154.  * @method static integer countByAlt($val, array $opt=array())
  155.  * @method static integer countByImageTitle($val, array $opt=array())
  156.  * @method static integer countBySize($val, array $opt=array())
  157.  * @method static integer countByImagemargin($val, array $opt=array())
  158.  * @method static integer countByImageUrl($val, array $opt=array())
  159.  * @method static integer countByFullsize($val, array $opt=array())
  160.  * @method static integer countByCaption($val, array $opt=array())
  161.  * @method static integer countByFloating($val, array $opt=array())
  162.  * @method static integer countByAddEnclosure($val, array $opt=array())
  163.  * @method static integer countByEnclosure($val, array $opt=array())
  164.  * @method static integer countBySource($val, array $opt=array())
  165.  * @method static integer countByJumpTo($val, array $opt=array())
  166.  * @method static integer countByArticleId($val, array $opt=array())
  167.  * @method static integer countByUrl($val, array $opt=array())
  168.  * @method static integer countByTarget($val, array $opt=array())
  169.  * @method static integer countByCssClass($val, array $opt=array())
  170.  * @method static integer countByNoComments($val, array $opt=array())
  171.  * @method static integer countByFeatured($val, array $opt=array())
  172.  * @method static integer countByPublished($val, array $opt=array())
  173.  * @method static integer countByStart($val, array $opt=array())
  174.  * @method static integer countByStop($val, array $opt=array())
  175.  */
  176. class NewsModel extends Model
  177. {
  178.     use ModelMetadataTrait;
  180.     /**
  181.      * Table name
  182.      * @var string
  183.      */
  184.     protected static $strTable = 'tl_news';
  186.     /**
  187.      * Find a published news item from one or more news archives by its ID or alias
  188.      *
  189.      * @param mixed $varId      The numeric ID or alias name
  190.      * @param array $arrPids    An array of parent IDs
  191.      * @param array $arrOptions An optional options array
  192.      *
  193.      * @return NewsModel|null The model or null if there are no news
  194.      */
  195.     public static function findPublishedByParentAndIdOrAlias($varId, $arrPids, array $arrOptions=array())
  196.     {
  197.         if (empty($arrPids) || !\is_array($arrPids))
  198.         {
  199.             return null;
  200.         }
  202.         $t = static::$strTable;
  203.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  204.         $arrColumns[] = "$t.pid IN(" . implode(',', array_map('\intval', $arrPids)) . ")";
  206.         if (!static::isPreviewMode($arrOptions))
  207.         {
  208.             $time = Date::floorToMinute();
  209.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  210.         }
  212.         return static::findOneBy($arrColumns, $varId, $arrOptions);
  213.     }
  215.     /**
  216.      * Find published news items by their parent ID
  217.      *
  218.      * @param array   $arrPids     An array of news archive IDs
  219.      * @param boolean $blnFeatured If true, return only featured news, if false, return only unfeatured news
  220.      * @param integer $intLimit    An optional limit
  221.      * @param integer $intOffset   An optional offset
  222.      * @param array   $arrOptions  An optional options array
  223.      *
  224.      * @return Collection|NewsModel[]|NewsModel|null A collection of models or null if there are no news
  225.      */
  226.     public static function findPublishedByPids($arrPids, $blnFeatured=null, $intLimit=0, $intOffset=0, array $arrOptions=array())
  227.     {
  228.         if (empty($arrPids) || !\is_array($arrPids))
  229.         {
  230.             return null;
  231.         }
  233.         $t = static::$strTable;
  234.         $arrColumns = array("$t.pid IN(" . implode(',', array_map('\intval', $arrPids)) . ")");
  236.         if ($blnFeatured === true)
  237.         {
  238.             $arrColumns[] = "$t.featured='1'";
  239.         }
  240.         elseif ($blnFeatured === false)
  241.         {
  242.             $arrColumns[] = "$t.featured=''";
  243.         }
  245.         if (!static::isPreviewMode($arrOptions))
  246.         {
  247.             $time = Date::floorToMinute();
  248.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  249.         }
  251.         if (!isset($arrOptions['order']))
  252.         {
  253.             $arrOptions['order']  = "$t.date DESC";
  254.         }
  256.         $arrOptions['limit']  = $intLimit;
  257.         $arrOptions['offset'] = $intOffset;
  259.         return static::findBy($arrColumns, null, $arrOptions);
  260.     }
  262.     /**
  263.      * Count published news items by their parent ID
  264.      *
  265.      * @param array   $arrPids     An array of news archive IDs
  266.      * @param boolean $blnFeatured If true, return only featured news, if false, return only unfeatured news
  267.      * @param array   $arrOptions  An optional options array
  268.      *
  269.      * @return integer The number of news items
  270.      */
  271.     public static function countPublishedByPids($arrPids, $blnFeatured=null, array $arrOptions=array())
  272.     {
  273.         if (empty($arrPids) || !\is_array($arrPids))
  274.         {
  275.             return 0;
  276.         }
  278.         $t = static::$strTable;
  279.         $arrColumns = array("$t.pid IN(" . implode(',', array_map('\intval', $arrPids)) . ")");
  281.         if ($blnFeatured === true)
  282.         {
  283.             $arrColumns[] = "$t.featured='1'";
  284.         }
  285.         elseif ($blnFeatured === false)
  286.         {
  287.             $arrColumns[] = "$t.featured=''";
  288.         }
  290.         if (!static::isPreviewMode($arrOptions))
  291.         {
  292.             $time = Date::floorToMinute();
  293.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  294.         }
  296.         return static::countBy($arrColumns, null, $arrOptions);
  297.     }
  299.     /**
  300.      * Find published news items with the default redirect target by their parent ID
  301.      *
  302.      * @param integer $intPid     The news archive ID
  303.      * @param array   $arrOptions An optional options array
  304.      *
  305.      * @return Collection|NewsModel[]|NewsModel|null A collection of models or null if there are no news
  306.      */
  307.     public static function findPublishedDefaultByPid($intPid, array $arrOptions=array())
  308.     {
  309.         $t = static::$strTable;
  310.         $arrColumns = array("$t.pid=? AND $t.source='default'");
  312.         if (!static::isPreviewMode($arrOptions))
  313.         {
  314.             $time = Date::floorToMinute();
  315.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  316.         }
  318.         if (!isset($arrOptions['order']))
  319.         {
  320.             $arrOptions['order'] = "$t.date DESC";
  321.         }
  323.         return static::findBy($arrColumns, $intPid, $arrOptions);
  324.     }
  326.     /**
  327.      * Find published news items by their parent ID
  328.      *
  329.      * @param integer $intId      The news archive ID
  330.      * @param integer $intLimit   An optional limit
  331.      * @param array   $arrOptions An optional options array
  332.      *
  333.      * @return Collection|NewsModel[]|NewsModel|null A collection of models or null if there are no news
  334.      */
  335.     public static function findPublishedByPid($intId, $intLimit=0, array $arrOptions=array())
  336.     {
  337.         $t = static::$strTable;
  338.         $arrColumns = array("$t.pid=?");
  340.         if (!static::isPreviewMode($arrOptions))
  341.         {
  342.             $time = Date::floorToMinute();
  343.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  344.         }
  346.         if (!isset($arrOptions['order']))
  347.         {
  348.             $arrOptions['order'] = "$t.date DESC";
  349.         }
  351.         if ($intLimit > 0)
  352.         {
  353.             $arrOptions['limit'] = $intLimit;
  354.         }
  356.         return static::findBy($arrColumns, $intId, $arrOptions);
  357.     }
  359.     /**
  360.      * Find all published news items of a certain period of time by their parent ID
  361.      *
  362.      * @param integer $intFrom    The start date as Unix timestamp
  363.      * @param integer $intTo      The end date as Unix timestamp
  364.      * @param array   $arrPids    An array of news archive IDs
  365.      * @param integer $intLimit   An optional limit
  366.      * @param integer $intOffset  An optional offset
  367.      * @param array   $arrOptions An optional options array
  368.      *
  369.      * @return Collection|NewsModel[]|NewsModel|null A collection of models or null if there are no news
  370.      */
  371.     public static function findPublishedFromToByPids($intFrom, $intTo, $arrPids, $intLimit=0, $intOffset=0, array $arrOptions=array())
  372.     {
  373.         if (empty($arrPids) || !\is_array($arrPids))
  374.         {
  375.             return null;
  376.         }
  378.         $t = static::$strTable;
  379.         $arrColumns = array("$t.date>=? AND $t.date<=? AND $t.pid IN(" . implode(',', array_map('\intval', $arrPids)) . ")");
  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.         if (!isset($arrOptions['order']))
  388.         {
  389.             $arrOptions['order']  = "$t.date DESC";
  390.         }
  392.         $arrOptions['limit']  = $intLimit;
  393.         $arrOptions['offset'] = $intOffset;
  395.         return static::findBy($arrColumns, array($intFrom, $intTo), $arrOptions);
  396.     }
  398.     /**
  399.      * Count all published news items of a certain period of time by their parent ID
  400.      *
  401.      * @param integer $intFrom    The start date as Unix timestamp
  402.      * @param integer $intTo      The end date as Unix timestamp
  403.      * @param array   $arrPids    An array of news archive IDs
  404.      * @param array   $arrOptions An optional options array
  405.      *
  406.      * @return integer The number of news items
  407.      */
  408.     public static function countPublishedFromToByPids($intFrom, $intTo, $arrPids, array $arrOptions=array())
  409.     {
  410.         if (empty($arrPids) || !\is_array($arrPids))
  411.         {
  412.             return null;
  413.         }
  415.         $t = static::$strTable;
  416.         $arrColumns = array("$t.date>=? AND $t.date<=? AND $t.pid IN(" . implode(',', array_map('\intval', $arrPids)) . ")");
  418.         if (!static::isPreviewMode($arrOptions))
  419.         {
  420.             $time = Date::floorToMinute();
  421.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  422.         }
  424.         return static::countBy($arrColumns, array($intFrom, $intTo), $arrOptions);
  425.     }
  426. }
  428. class_alias(NewsModel::class, 'NewsModel');