vendor/codefog/contao-news_categories/src/Model/NewsCategoryModel.php line 302

Open in your IDE?
  1. <?php
  3. /*
  4.  * News Categories bundle for Contao Open Source CMS.
  5.  *
  6.  * @copyright  Copyright (c) 2017, Codefog
  7.  * @author     Codefog <https://codefog.pl>
  8.  * @license    MIT
  9.  */
  11. namespace Codefog\NewsCategoriesBundle\Model;
  13. use Codefog\NewsCategoriesBundle\MultilingualHelper;
  14. use Contao\Database;
  15. use Contao\Date;
  16. use Contao\FilesModel;
  17. use Contao\Model\Collection;
  18. use Contao\NewsModel;
  19. use Haste\Model\Model;
  20. use Haste\Model\Relations;
  22. /*
  23.  * Use the multilingual model if available
  24.  */
  25. if (MultilingualHelper::isActive()) {
  26.     class ParentModel extends \Terminal42\DcMultilingualBundle\Model\Multilingual
  27.     {
  28.     }
  29. } else {
  30.     class ParentModel extends \Contao\Model
  31.     {
  32.     }
  33. }
  35. class NewsCategoryModel extends ParentModel
  36. {
  37.     /**
  38.      * Table name.
  39.      *
  40.      * @var string
  41.      */
  42.     protected static $strTable = 'tl_news_category';
  44.     /**
  45.      * @inheritDoc
  46.      */
  47.     public function __get($name)
  48.     {
  49.         // Fix the compatibility with DC_Multilingual v4 (#184)
  50.         if ($name === 'id' && MultilingualHelper::isActive() && $this->lid) {
  51.             return $this->lid;
  52.         }
  54.         return parent::__get($name);
  55.     }
  57.     /**
  58.      * Get the CSS class.
  59.      *
  60.      * @return string
  61.      */
  62.     public function getCssClass()
  63.     {
  64.         $cssClasses = [
  65.             'news_category_'.$this->id,
  66.             'category_'.$this->id,
  67.         ];
  69.         if ($this->cssClass) {
  70.             $cssClasses[] = $this->cssClass;
  71.         }
  73.         return \implode(' ', \array_unique($cssClasses));
  74.     }
  76.     /**
  77.      * Get the image.
  78.      *
  79.      * @return FilesModel|null
  80.      */
  81.     public function getImage()
  82.     {
  83.         return $this->image ? FilesModel::findByPk($this->image) : null;
  84.     }
  86.     /**
  87.      * Get the title.
  88.      *
  89.      * @return string
  90.      */
  91.     public function getTitle()
  92.     {
  93.         return $this->frontendTitle ?: $this->title;
  94.     }
  96.     /**
  97.      * Find published news categories by news criteria.
  98.      *
  99.      * @param array $archives
  100.      * @param array $ids
  101.      * @param array $aliases
  102.      * @param array $excludedIds
  103.      *
  104.      * @return Collection|null
  105.      */
  106.     public static function findPublishedByArchives(array $archives, array $ids = [], array $aliases = [], array $excludedIds = [])
  107.     {
  108.         if (0 === \count($archives) || false === ($relation = Relations::getRelation('tl_news', 'categories'))) {
  109.             return null;
  110.         }
  112.         $t = static::getTableAlias();
  113.         $values = [];
  115.         // Start sub select query for relations
  116.         $subSelect = "SELECT {$relation['related_field']} 
  117. FROM {$relation['table']} 
  118. WHERE {$relation['reference_field']} IN (SELECT id FROM tl_news WHERE pid IN (".\implode(',', \array_map('intval', $archives)).')';
  120.         // Include only the published news items
  121.         if (!BE_USER_LOGGED_IN) {
  122.             $time = Date::floorToMinute();
  123.             $subSelect .= ' AND (start=? OR start<=?) AND (stop=? OR stop>?) AND published=?';
  124.             $values = \array_merge($values, ['', $time, '', $time + 60, 1]);
  125.         }
  127.         // Finish sub select query for relations
  128.         $subSelect .= ')';
  130.         // Columns definition start
  131.         $columns = ["$t.id IN ($subSelect)"];
  133.         // Filter by custom categories
  134.         if (\count($ids) > 0) {
  135.             $columns[] = "$t.id IN (".\implode(',', \array_map('intval', $ids)).')';
  136.         }
  138.         // Filter by excluded IDs
  139.         if (\count($excludedIds) > 0) {
  140.             $columns[] = "$t.id NOT IN (".\implode(',', \array_map('intval', $excludedIds)).')';
  141.         }
  143.         // Filter by custom aliases
  144.         if (\count($aliases) > 0) {
  145.             if (MultilingualHelper::isActive()) {
  146.                 $columns[] = "($t.alias IN ('".\implode("','", $aliases)."') OR translation.alias IN ('".\implode("','", $aliases)."'))";
  147.             } else {
  148.                 $columns[] = "$t.alias IN ('".\implode("','", $aliases)."')";
  149.             }
  150.         }
  152.         if (!BE_USER_LOGGED_IN) {
  153.             $columns[] = "$t.published=?";
  154.             $values[] = 1;
  155.         }
  157.         return static::findBy($columns, $values, ['order' => "$t.sorting"]);
  158.     }
  160.     /**
  161.      * Find published category by ID or alias.
  162.      *
  163.      * @param string $idOrAlias
  164.      *
  165.      * @return NewsCategoryModel|null
  166.      */
  167.     public static function findPublishedByIdOrAlias($idOrAlias)
  168.     {
  169.         $values = [];
  170.         $columns = [];
  171.         $t = static::getTableAlias();
  173.         // Determine the alias condition
  174.         if (is_numeric($idOrAlias)) {
  175.             $columns[] = "$t.id=?";
  176.             $values[] = (int) $idOrAlias;
  177.         } else {
  178.             if (MultilingualHelper::isActive()) {
  179.                 $columns[] = "($t.alias=? OR translation.alias=?)";
  180.                 $values[] = $idOrAlias;
  181.                 $values[] = $idOrAlias;
  182.             } else {
  183.                 $columns[] = "$t.alias=?";
  184.                 $values[] = $idOrAlias;
  185.             }
  186.         }
  188.         if (!BE_USER_LOGGED_IN) {
  189.             $columns[] = "$t.published=?";
  190.             $values[] = 1;
  191.         }
  193.         return static::findOneBy($columns, $values);
  194.     }
  196.     /**
  197.      * Find published news categories.
  198.      *
  199.      * @return Collection|null
  200.      */
  201.     public static function findPublished()
  202.     {
  203.         $t = static::getTableAlias();
  204.         $options = ['order' => "$t.sorting"];
  206.         if (BE_USER_LOGGED_IN) {
  207.             return static::findAll($options);
  208.         }
  210.         return static::findBy('published', 1, $options);
  211.     }
  213.     /**
  214.      * Find published news categories by parent ID and IDs.
  215.      *
  216.      * @param array    $ids
  217.      * @param int|null $pid
  218.      *
  219.      * @return Collection|null
  220.      */
  221.     public static function findPublishedByIds(array $ids, $pid = null)
  222.     {
  223.         if (0 === \count($ids)) {
  224.             return null;
  225.         }
  227.         $t = static::getTableAlias();
  228.         $columns = ["$t.id IN (".\implode(',', \array_map('intval', $ids)).')'];
  229.         $values = [];
  231.         // Filter by pid
  232.         if (null !== $pid) {
  233.             $columns[] = "$t.pid=?";
  234.             $values[] = $pid;
  235.         }
  237.         if (!BE_USER_LOGGED_IN) {
  238.             $columns[] = "$t.published=?";
  239.             $values[] = 1;
  240.         }
  242.         return static::findBy($columns, $values, ['order' => "$t.sorting"]);
  243.     }
  245.     /**
  246.      * Find published news categories by parent ID.
  247.      *
  248.      * @param int $pid
  249.      *
  250.      * @return Collection|null
  251.      */
  252.     public static function findPublishedByPid($pid)
  253.     {
  254.         $t = static::getTableAlias();
  255.         $columns = ["$t.pid=?"];
  256.         $values = [$pid];
  258.         if (!BE_USER_LOGGED_IN) {
  259.             $columns[] = "$t.published=?";
  260.             $values[] = 1;
  261.         }
  263.         return static::findBy($columns, $values, ['order' => "$t.sorting"]);
  264.     }
  266.     /**
  267.      * Find the published categories by news.
  268.      *
  269.      * @param int|array $newsId
  270.      *
  271.      * @return Collection|null
  272.      */
  273.     public static function findPublishedByNews($newsId)
  274.     {
  275.         if (0 === \count($ids = Model::getRelatedValues('tl_news', 'categories', $newsId))) {
  276.             return null;
  277.         }
  279.         $t = static::getTableAlias();
  280.         $columns = ["$t.id IN (".\implode(',', \array_map('intval', \array_unique($ids))).')'];
  281.         $values = [];
  283.         if (!BE_USER_LOGGED_IN) {
  284.             $columns[] = "$t.published=?";
  285.             $values[] = 1;
  286.         }
  288.         return static::findBy($columns, $values, ['order' => "$t.sorting"]);
  289.     }
  291.     /**
  292.      * Count the published news by archives.
  293.      *
  294.      * @param array    $archives
  295.      * @param int|null $category
  296.      * @param bool     $includeSubcategories
  297.      * @param array    $cumulativeCategories
  298.      * @param bool     $unionFiltering
  299.      *
  300.      * @return int
  301.      */
  302.     public static function getUsage(array $archives = [], $category = null, $includeSubcategories = false, array $cumulativeCategories = [], $unionFiltering = false)
  303.     {
  304.         $t = NewsModel::getTable();
  306.         // Include the subcategories
  307.         if (null !== $category && $includeSubcategories) {
  308.             $category = static::getAllSubcategoriesIds($category);
  309.         }
  311.         $ids = Model::getReferenceValues($t, 'categories', $category);
  312.         $ids = array_map('intval', $ids);
  314.         // Also filter by cumulative categories
  315.         if (count($cumulativeCategories) > 0) {
  316.             $cumulativeIds = null;
  318.             foreach ($cumulativeCategories as $cumulativeCategory) {
  319.                 // Include the subcategories
  320.                 if ($includeSubcategories) {
  321.                     $cumulativeCategory = static::getAllSubcategoriesIds($cumulativeCategory);
  322.                 }
  324.                 $newsIds = Model::getReferenceValues($t, 'categories', $cumulativeCategory);
  325.                 $newsIds = array_map('intval', $newsIds);
  327.                 if ($cumulativeIds === null) {
  328.                     $cumulativeIds = $newsIds;
  329.                 } else {
  330.                     $cumulativeIds = $unionFiltering ? array_merge($cumulativeIds, $newsIds) : array_intersect($cumulativeIds, $newsIds);
  331.                 }
  332.             }
  334.             $ids = $unionFiltering ? array_merge($ids, $cumulativeIds) : array_intersect($ids, $cumulativeIds);
  335.         }
  337.         if (0 === \count($ids)) {
  338.             return 0;
  339.         }
  341.         $columns = ["$t.id IN (".\implode(',', \array_unique($ids)).')'];
  342.         $values = [];
  344.         // Filter by archives
  345.         if (\count($archives)) {
  346.             $columns[] = "$t.pid IN (".\implode(',', \array_map('intval', $archives)).')';
  347.         }
  349.         if (!BE_USER_LOGGED_IN) {
  350.             $time = Date::floorToMinute();
  351.             $columns[] = "($t.start=? OR $t.start<=?) AND ($t.stop=? OR $t.stop>?) AND $t.published=?";
  352.             $values = \array_merge($values, ['', $time, '', $time + 60, 1]);
  353.         }
  355.         return NewsModel::countBy($columns, $values);
  356.     }
  358.     /**
  359.      * Get all subcategory IDs.
  360.      *
  361.      * @param array|int $category
  362.      *
  363.      * @return array
  364.      */
  365.     public static function getAllSubcategoriesIds($category)
  366.     {
  367.         $ids = Database::getInstance()->getChildRecords($category, static::$strTable, false, (array) $category, (!BE_USER_LOGGED_IN ? 'published=1' : ''));
  368.         $ids = \array_map('intval', $ids);
  370.         return $ids;
  371.     }
  373.     /**
  374.      * {@inheritdoc}
  375.      */
  376.     public static function findMultipleByIds($arrIds, array $arrOptions = [])
  377.     {
  378.         if (!MultilingualHelper::isActive()) {
  379.             return parent::findMultipleByIds($arrIds, $arrOptions);
  380.         }
  382.         $t = static::getTableAlias();
  384.         if (!isset($arrOptions['order'])) {
  385.             $arrOptions['order'] = Database::getInstance()->findInSet("$t.id", $arrIds);
  386.         }
  388.         return static::findBy(["$t.id IN (".\implode(',', \array_map('intval', $arrIds)).')'], null);
  389.     }
  391.     /**
  392.      * Get the table alias.
  393.      *
  394.      * @return string
  395.      */
  396.     public static function getTableAlias()
  397.     {
  398.         return static::$strTable;
  399.     }
  400. }