vendor/contao/calendar-bundle/src/Resources/contao/models/CalendarEventsModel.php line 257

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 events
  18.  *
  19.  * @property string|integer      $id
  20.  * @property string|integer      $pid
  21.  * @property string|integer      $tstamp
  22.  * @property string              $title
  23.  * @property string              $alias
  24.  * @property string|integer      $author
  25.  * @property string|boolean      $addTime
  26.  * @property string|integer|null $startTime
  27.  * @property string|integer|null $endTime
  28.  * @property string|integer|null $startDate
  29.  * @property string|integer|null $endDate
  30.  * @property string              $pageTitle
  31.  * @property string              $robots
  32.  * @property string|null         $description
  33.  * @property string              $location
  34.  * @property string              $address
  35.  * @property string|null         $teaser
  36.  * @property string|boolean      $addImage
  37.  * @property string|boolean      $overwriteMeta
  38.  * @property string|null         $singleSRC
  39.  * @property string              $alt
  40.  * @property string              $imageTitle
  41.  * @property string|integer      $size
  42.  * @property string|array        $imagemargin
  43.  * @property string              $imageUrl
  44.  * @property string|boolean      $fullsize
  45.  * @property string              $caption
  46.  * @property string              $floating
  47.  * @property string|boolean      $recurring
  48.  * @property string              $repeatEach
  49.  * @property string|integer      $repeatEnd
  50.  * @property string|integer      $recurrences
  51.  * @property string|boolean      $addEnclosure
  52.  * @property string|array|null   $enclosure
  53.  * @property string              $source
  54.  * @property string|integer      $jumpTo
  55.  * @property string|integer      $articleId
  56.  * @property string              $url
  57.  * @property string|boolean      $target
  58.  * @property string              $cssClass
  59.  * @property string|boolean      $noComments
  60.  * @property string|boolean      $featured
  61.  * @property string|boolean      $published
  62.  * @property string|integer      $start
  63.  * @property string|integer      $stop
  64.  *
  65.  * @method static CalendarEventsModel|null findById($id, array $opt=array())
  66.  * @method static CalendarEventsModel|null findByPk($id, array $opt=array())
  67.  * @method static CalendarEventsModel|null findByIdOrAlias($val, array $opt=array())
  68.  * @method static CalendarEventsModel|null findOneBy($col, $val, array $opt=array())
  69.  * @method static CalendarEventsModel|null findOneByPid($val, array $opt=array())
  70.  * @method static CalendarEventsModel|null findOneByTstamp($val, array $opt=array())
  71.  * @method static CalendarEventsModel|null findOneByTitle($val, array $opt=array())
  72.  * @method static CalendarEventsModel|null findOneByAlias($val, array $opt=array())
  73.  * @method static CalendarEventsModel|null findOneByAuthor($val, array $opt=array())
  74.  * @method static CalendarEventsModel|null findOneByAddTime($val, array $opt=array())
  75.  * @method static CalendarEventsModel|null findOneByStartTime($val, array $opt=array())
  76.  * @method static CalendarEventsModel|null findOneByEndTime($val, array $opt=array())
  77.  * @method static CalendarEventsModel|null findOneByStartDate($val, array $opt=array())
  78.  * @method static CalendarEventsModel|null findOneByEndDate($val, array $opt=array())
  79.  * @method static CalendarEventsModel|null findOneByPageTitle($val, array $opt=array())
  80.  * @method static CalendarEventsModel|null findOneByRobots($val, array $opt=array())
  81.  * @method static CalendarEventsModel|null findOneByDescription($val, array $opt=array())
  82.  * @method static CalendarEventsModel|null findOneByLocation($val, array $opt=array())
  83.  * @method static CalendarEventsModel|null findOneByAddress($val, array $opt=array())
  84.  * @method static CalendarEventsModel|null findOneByTeaser($val, array $opt=array())
  85.  * @method static CalendarEventsModel|null findOneByAddImage($val, array $opt=array())
  86.  * @method static CalendarEventsModel|null findOneByOverwriteMeta($val, array $opt=array())
  87.  * @method static CalendarEventsModel|null findOneBySingleSRC($val, array $opt=array())
  88.  * @method static CalendarEventsModel|null findOneByAlt($val, array $opt=array())
  89.  * @method static CalendarEventsModel|null findOneByImageTitle($val, array $opt=array())
  90.  * @method static CalendarEventsModel|null findOneBySize($val, array $opt=array())
  91.  * @method static CalendarEventsModel|null findOneByImagemargin($val, array $opt=array())
  92.  * @method static CalendarEventsModel|null findOneByImageUrl($val, array $opt=array())
  93.  * @method static CalendarEventsModel|null findOneByFullsize($val, array $opt=array())
  94.  * @method static CalendarEventsModel|null findOneByCaption($val, array $opt=array())
  95.  * @method static CalendarEventsModel|null findOneByFloating($val, array $opt=array())
  96.  * @method static CalendarEventsModel|null findOneByRecurring($val, array $opt=array())
  97.  * @method static CalendarEventsModel|null findOneByRepeatEach($val, array $opt=array())
  98.  * @method static CalendarEventsModel|null findOneByRepeatEnd($val, array $opt=array())
  99.  * @method static CalendarEventsModel|null findOneByRecurrences($val, array $opt=array())
  100.  * @method static CalendarEventsModel|null findOneByAddEnclosure($val, array $opt=array())
  101.  * @method static CalendarEventsModel|null findOneByEnclosure($val, array $opt=array())
  102.  * @method static CalendarEventsModel|null findOneBySource($val, array $opt=array())
  103.  * @method static CalendarEventsModel|null findOneByJumpTo($val, array $opt=array())
  104.  * @method static CalendarEventsModel|null findOneByArticleId($val, array $opt=array())
  105.  * @method static CalendarEventsModel|null findOneByUrl($val, array $opt=array())
  106.  * @method static CalendarEventsModel|null findOneByTarget($val, array $opt=array())
  107.  * @method static CalendarEventsModel|null findOneByCssClass($val, array $opt=array())
  108.  * @method static CalendarEventsModel|null findOneByNoComments($val, array $opt=array())
  109.  * @method static CalendarEventsModel|null findOneByFeatured($val, array $opt=array())
  110.  * @method static CalendarEventsModel|null findOneByPublished($val, array $opt=array())
  111.  * @method static CalendarEventsModel|null findOneByStart($val, array $opt=array())
  112.  * @method static CalendarEventsModel|null findOneByStop($val, array $opt=array())
  113.  *
  114.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByPid($val, array $opt=array())
  115.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByTstamp($val, array $opt=array())
  116.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByTitle($val, array $opt=array())
  117.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAlias($val, array $opt=array())
  118.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAuthor($val, array $opt=array())
  119.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAddTime($val, array $opt=array())
  120.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByStartTime($val, array $opt=array())
  121.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByEndTime($val, array $opt=array())
  122.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByStartDate($val, array $opt=array())
  123.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByEndDate($val, array $opt=array())
  124.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByPageTitle($val, array $opt=array())
  125.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByRobots($val, array $opt=array())
  126.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByDescription($val, array $opt=array())
  127.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByLocation($val, array $opt=array())
  128.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAddress($val, array $opt=array())
  129.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByTeaser($val, array $opt=array())
  130.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAddImage($val, array $opt=array())
  131.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByOverwriteMeta($val, array $opt=array())
  132.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findBySingleSRC($val, array $opt=array())
  133.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAlt($val, array $opt=array())
  134.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByImageTitle($val, array $opt=array())
  135.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findBySize($val, array $opt=array())
  136.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByImagemargin($val, array $opt=array())
  137.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByImageUrl($val, array $opt=array())
  138.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByFullsize($val, array $opt=array())
  139.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByCaption($val, array $opt=array())
  140.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByFloating($val, array $opt=array())
  141.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByRecurring($val, array $opt=array())
  142.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByRepeatEach($val, array $opt=array())
  143.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByRepeatEnd($val, array $opt=array())
  144.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByRecurrences($val, array $opt=array())
  145.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByAddEnclosure($val, array $opt=array())
  146.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByEnclosure($val, array $opt=array())
  147.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findBySource($val, array $opt=array())
  148.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByJumpTo($val, array $opt=array())
  149.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByArticleId($val, array $opt=array())
  150.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByUrl($val, array $opt=array())
  151.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByTarget($val, array $opt=array())
  152.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByCssClass($val, array $opt=array())
  153.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByNoComments($val, array $opt=array())
  154.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByFeatured($val, array $opt=array())
  155.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByPublished($val, array $opt=array())
  156.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByStart($val, array $opt=array())
  157.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findByStop($val, array $opt=array())
  158.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findMultipleByIds($val, array $opt=array())
  159.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findBy($col, $val, array $opt=array())
  160.  * @method static Collection|CalendarEventsModel[]|CalendarEventsModel|null findAll(array $opt=array())
  161.  *
  162.  * @method static integer countById($id, array $opt=array())
  163.  * @method static integer countByPid($val, array $opt=array())
  164.  * @method static integer countByTstamp($val, array $opt=array())
  165.  * @method static integer countByTitle($val, array $opt=array())
  166.  * @method static integer countByAlias($val, array $opt=array())
  167.  * @method static integer countByAuthor($val, array $opt=array())
  168.  * @method static integer countByAddTime($val, array $opt=array())
  169.  * @method static integer countByStartTime($val, array $opt=array())
  170.  * @method static integer countByEndTime($val, array $opt=array())
  171.  * @method static integer countByStartDate($val, array $opt=array())
  172.  * @method static integer countByEndDate($val, array $opt=array())
  173.  * @method static integer countByPageTitle($val, array $opt=array())
  174.  * @method static integer countByRobots($val, array $opt=array())
  175.  * @method static integer countByDescription($val, array $opt=array())
  176.  * @method static integer countByLocation($val, array $opt=array())
  177.  * @method static integer countByAddress($val, array $opt=array())
  178.  * @method static integer countByTeaser($val, array $opt=array())
  179.  * @method static integer countByAddImage($val, array $opt=array())
  180.  * @method static integer countByOverwriteMeta($val, array $opt=array())
  181.  * @method static integer countBySingleSRC($val, array $opt=array())
  182.  * @method static integer countByAlt($val, array $opt=array())
  183.  * @method static integer countByImageTitle($val, array $opt=array())
  184.  * @method static integer countBySize($val, array $opt=array())
  185.  * @method static integer countByImagemargin($val, array $opt=array())
  186.  * @method static integer countByImageUrl($val, array $opt=array())
  187.  * @method static integer countByFullsize($val, array $opt=array())
  188.  * @method static integer countByCaption($val, array $opt=array())
  189.  * @method static integer countByFloating($val, array $opt=array())
  190.  * @method static integer countByRecurring($val, array $opt=array())
  191.  * @method static integer countByRepeatEach($val, array $opt=array())
  192.  * @method static integer countByRepeatEnd($val, array $opt=array())
  193.  * @method static integer countByRecurrences($val, array $opt=array())
  194.  * @method static integer countByAddEnclosure($val, array $opt=array())
  195.  * @method static integer countByEnclosure($val, array $opt=array())
  196.  * @method static integer countBySource($val, array $opt=array())
  197.  * @method static integer countByJumpTo($val, array $opt=array())
  198.  * @method static integer countByArticleId($val, array $opt=array())
  199.  * @method static integer countByUrl($val, array $opt=array())
  200.  * @method static integer countByTarget($val, array $opt=array())
  201.  * @method static integer countByCssClass($val, array $opt=array())
  202.  * @method static integer countByNoComments($val, array $opt=array())
  203.  * @method static integer countByFeatured($val, array $opt=array())
  204.  * @method static integer countByPublished($val, array $opt=array())
  205.  * @method static integer countByStart($val, array $opt=array())
  206.  * @method static integer countByStop($val, array $opt=array())
  207.  */
  208. class CalendarEventsModel extends Model
  209. {
  210.     use ModelMetadataTrait;
  212.     /**
  213.      * Table name
  214.      * @var string
  215.      */
  216.     protected static $strTable = 'tl_calendar_events';
  218.     /**
  219.      * Find a published event from one or more calendars by its ID or alias
  220.      *
  221.      * @param mixed $varId      The numeric ID or alias name
  222.      * @param array $arrPids    An array of calendar IDs
  223.      * @param array $arrOptions An optional options array
  224.      *
  225.      * @return CalendarEventsModel|null The model or null if there is no event
  226.      */
  227.     public static function findPublishedByParentAndIdOrAlias($varId, $arrPids, array $arrOptions=array())
  228.     {
  229.         if (empty($arrPids) || !\is_array($arrPids))
  230.         {
  231.             return null;
  232.         }
  234.         $t = static::$strTable;
  235.         $arrColumns = !preg_match('/^[1-9]\d*$/', $varId) ? array("BINARY $t.alias=?") : array("$t.id=?");
  236.         $arrColumns[] = "$t.pid IN(" . implode(',', array_map('\intval', $arrPids)) . ")";
  238.         if (!static::isPreviewMode($arrOptions))
  239.         {
  240.             $time = Date::floorToMinute();
  241.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  242.         }
  244.         return static::findOneBy($arrColumns, $varId, $arrOptions);
  245.     }
  247.     /**
  248.      * Find events of the current period by their parent ID
  249.      *
  250.      * @param integer $intPid     The calendar ID
  251.      * @param integer $intStart   The start date as Unix timestamp
  252.      * @param integer $intEnd     The end date as Unix timestamp
  253.      * @param array   $arrOptions An optional options array
  254.      *
  255.      * @return Collection|CalendarEventsModel[]|CalendarEventsModel|null A collection of models or null if there are no events
  256.      */
  257.     public static function findCurrentByPid($intPid, $intStart, $intEnd, array $arrOptions=array())
  258.     {
  259.         $t = static::$strTable;
  260.         $intStart = (int) $intStart;
  261.         $intEnd = (int) $intEnd;
  263.         $arrColumns = array("$t.pid=? AND (($t.startTime>=$intStart AND $t.startTime<=$intEnd) OR ($t.endTime>=$intStart AND $t.endTime<=$intEnd) OR ($t.startTime<=$intStart AND $t.endTime>=$intEnd) OR ($t.recurring='1' AND ($t.recurrences=0 OR $t.repeatEnd>=$intStart) AND $t.startTime<=$intEnd))");
  265.         if (isset($arrOptions['showFeatured']))
  266.         {
  267.             if ($arrOptions['showFeatured'] === true)
  268.             {
  269.                 $arrColumns[] = "$t.featured='1'";
  270.             }
  271.             elseif ($arrOptions['showFeatured'] === false)
  272.             {
  273.                 $arrColumns[] = "$t.featured=''";
  274.             }
  275.         }
  277.         if (!static::isPreviewMode($arrOptions))
  278.         {
  279.             $time = Date::floorToMinute();
  280.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  281.         }
  283.         if (!isset($arrOptions['order']))
  284.         {
  285.             $arrOptions['order']  = "$t.startTime";
  286.         }
  288.         return static::findBy($arrColumns, $intPid, $arrOptions);
  289.     }
  291.     /**
  292.      * Find published events with the default redirect target by their parent ID
  293.      *
  294.      * @param integer $intPid     The calendar ID
  295.      * @param array   $arrOptions An optional options array
  296.      *
  297.      * @return Collection|CalendarEventsModel[]|CalendarEventsModel|null A collection of models or null if there are no events
  298.      */
  299.     public static function findPublishedDefaultByPid($intPid, array $arrOptions=array())
  300.     {
  301.         $t = static::$strTable;
  302.         $arrColumns = array("$t.pid=? AND $t.source='default'");
  304.         if (!static::isPreviewMode($arrOptions))
  305.         {
  306.             $time = Date::floorToMinute();
  307.             $arrColumns[] = "$t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time')";
  308.         }
  310.         if (!isset($arrOptions['order']))
  311.         {
  312.             $arrOptions['order']  = "$t.startTime DESC";
  313.         }
  315.         return static::findBy($arrColumns, $intPid, $arrOptions);
  316.     }
  318.     /**
  319.      * Find upcoming events by their parent IDs
  320.      *
  321.      * @param array   $arrIds     An array of calendar IDs
  322.      * @param integer $intLimit   An optional limit
  323.      * @param array   $arrOptions An optional options array
  324.      *
  325.      * @return Collection|CalendarEventsModel[]|CalendarEventsModel|null A collection of models or null if there are no events
  326.      */
  327.     public static function findUpcomingByPids($arrIds, $intLimit=0, array $arrOptions=array())
  328.     {
  329.         if (empty($arrIds) || !\is_array($arrIds))
  330.         {
  331.             return null;
  332.         }
  334.         $t = static::$strTable;
  335.         $time = Date::floorToMinute();
  337.         // Get upcoming events using endTime instead of startTime (see #3917)
  338.         $arrColumns = array("$t.pid IN(" . implode(',', array_map('\intval', $arrIds)) . ") AND $t.published='1' AND ($t.start='' OR $t.start<='$time') AND ($t.stop='' OR $t.stop>'$time') AND ($t.endTime>=$time OR ($t.recurring='1' AND ($t.recurrences=0 OR $t.repeatEnd>=$time)))");
  340.         if ($intLimit > 0)
  341.         {
  342.             $arrOptions['limit'] = $intLimit;
  343.         }
  345.         if (!isset($arrOptions['order']))
  346.         {
  347.             $arrOptions['order'] = "$t.startTime";
  348.         }
  350.         return static::findBy($arrColumns, null, $arrOptions);
  351.     }
  352. }
  354. class_alias(CalendarEventsModel::class, 'CalendarEventsModel');