vendor/contao/core-bundle/src/Resources/contao/models/MemberGroupModel.php line 96

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 member groups
  17.  *
  18.  * @property string|integer $id
  19.  * @property string|integer $tstamp
  20.  * @property string         $name
  21.  * @property string|boolean $redirect
  22.  * @property string|integer $jumpTo
  23.  * @property string|boolean $disable
  24.  * @property string|integer $start
  25.  * @property string|integer $stop
  26.  *
  27.  * @method static MemberGroupModel|null findById($id, array $opt=array())
  28.  * @method static MemberGroupModel|null findByPk($id, array $opt=array())
  29.  * @method static MemberGroupModel|null findByIdOrAlias($val, array $opt=array())
  30.  * @method static MemberGroupModel|null findOneBy($col, $val, array $opt=array())
  31.  * @method static MemberGroupModel|null findOneByTstamp($val, array $opt=array())
  32.  * @method static MemberGroupModel|null findOneByName($val, array $opt=array())
  33.  * @method static MemberGroupModel|null findOneByRedirect($val, array $opt=array())
  34.  * @method static MemberGroupModel|null findOneByJumpTo($val, array $opt=array())
  35.  * @method static MemberGroupModel|null findOneByDisable($val, array $opt=array())
  36.  * @method static MemberGroupModel|null findOneByStart($val, array $opt=array())
  37.  * @method static MemberGroupModel|null findOneByStop($val, array $opt=array())
  38.  *
  39.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByTstamp($val, array $opt=array())
  40.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByName($val, array $opt=array())
  41.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByRedirect($val, array $opt=array())
  42.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByJumpTo($val, array $opt=array())
  43.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByDisable($val, array $opt=array())
  44.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByStart($val, array $opt=array())
  45.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findByStop($val, array $opt=array())
  46.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findMultipleByIds($val, array $opt=array())
  47.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findBy($col, $val, array $opt=array())
  48.  * @method static Collection|MemberGroupModel[]|MemberGroupModel|null findAll(array $opt=array())
  49.  *
  50.  * @method static integer countById($id, array $opt=array())
  51.  * @method static integer countByTstamp($val, array $opt=array())
  52.  * @method static integer countByName($val, array $opt=array())
  53.  * @method static integer countByRedirect($val, array $opt=array())
  54.  * @method static integer countByJumpTo($val, array $opt=array())
  55.  * @method static integer countByDisable($val, array $opt=array())
  56.  * @method static integer countByStart($val, array $opt=array())
  57.  * @method static integer countByStop($val, array $opt=array())
  58.  */
  59. class MemberGroupModel extends Model
  60. {
  61.     /**
  62.      * Table name
  63.      * @var string
  64.      */
  65.     protected static $strTable = 'tl_member_group';
  67.     /**
  68.      * Find a published group by its ID
  69.      *
  70.      * @param integer $intId      The member group ID
  71.      * @param array   $arrOptions An optional options array
  72.      *
  73.      * @return MemberGroupModel|null The model or null if there is no member group
  74.      */
  75.     public static function findPublishedById($intId, array $arrOptions=array())
  76.     {
  77.         $t = static::$strTable;
  78.         $arrColumns = array("$t.id=?");
  80.         if (!static::isPreviewMode($arrOptions))
  81.         {
  82.             $time = Date::floorToMinute();
  83.             $arrColumns[] = "$t.disable='' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)";
  84.         }
  86.         return static::findOneBy($arrColumns, $intId, $arrOptions);
  87.     }
  89.     /**
  90.      * Find all active groups
  91.      *
  92.      * @param array $arrOptions An optional options array
  93.      *
  94.      * @return Collection|MemberGroupModel|null A collection of models or null if there are no member groups
  95.      */
  96.     public static function findAllActive(array $arrOptions=array())
  97.     {
  98.         $t = static::$strTable;
  99.         $time = Date::floorToMinute();
  101.         return static::findBy(array("$t.disable='' AND ($t.start='' OR $t.start<=$time) AND ($t.stop='' OR $t.stop>$time)"), null, $arrOptions);
  102.     }
  104.     /**
  105.      * Find the first active group with a published jumpTo page
  106.      *
  107.      * @param array $arrIds An array of member group IDs
  108.      *
  109.      * @return MemberGroupModel|null The model or null if there is no matching member group
  110.      *
  111.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  112.      *             Use PageModel::findFirstActiveByMemberGroups() instead.
  113.      */
  114.     public static function findFirstActiveWithJumpToByIds($arrIds)
  115.     {
  116.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\MemberGroupModel::findFirstActiveWithJumpToByIds()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\PageModel::findFirstActiveByMemberGroups()" instead.');
  118.         if (empty($arrIds) || !\is_array($arrIds))
  119.         {
  120.             return null;
  121.         }
  123.         $time = Date::floorToMinute();
  124.         $objDatabase = Database::getInstance();
  125.         $arrIds = array_map('\intval', $arrIds);
  127.         $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))
  128.                                  ->limit(1)
  129.                                  ->execute();
  131.         if ($objResult->numRows < 1)
  132.         {
  133.             return null;
  134.         }
  136.         return new static($objResult);
  137.     }
  138. }
  140. class_alias(MemberGroupModel::class, 'MemberGroupModel');