mirror of
https://github.com/joomla/joomla-cms.git
synced 2024-06-06 12:21:30 +00:00
552 lines
20 KiB
PHP
552 lines
20 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @package Joomla.Site
|
|
* @subpackage mod_articles_category
|
|
*
|
|
* @copyright (C) 2010 Open Source Matters, Inc. <https://www.joomla.org>
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace Joomla\Module\ArticlesCategory\Site\Helper;
|
|
|
|
use Joomla\CMS\Access\Access;
|
|
use Joomla\CMS\Application\SiteApplication;
|
|
use Joomla\CMS\Component\ComponentHelper;
|
|
use Joomla\CMS\Date\Date;
|
|
use Joomla\CMS\Factory;
|
|
use Joomla\CMS\HTML\HTMLHelper;
|
|
use Joomla\CMS\Plugin\PluginHelper;
|
|
use Joomla\CMS\Router\Route;
|
|
use Joomla\Component\Content\Administrator\Extension\ContentComponent;
|
|
use Joomla\Component\Content\Site\Helper\RouteHelper;
|
|
use Joomla\Database\DatabaseAwareInterface;
|
|
use Joomla\Database\DatabaseAwareTrait;
|
|
use Joomla\Registry\Registry;
|
|
use Joomla\String\StringHelper;
|
|
|
|
// phpcs:disable PSR1.Files.SideEffects
|
|
\defined('_JEXEC') or die;
|
|
// phpcs:enable PSR1.Files.SideEffects
|
|
|
|
/**
|
|
* Helper for mod_articles_category
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
class ArticlesCategoryHelper implements DatabaseAwareInterface
|
|
{
|
|
use DatabaseAwareTrait;
|
|
|
|
/**
|
|
* Retrieve a list of article
|
|
*
|
|
* @param Registry $params The module parameters.
|
|
* @param SiteApplication $app The current application.
|
|
*
|
|
* @return object[]
|
|
*
|
|
* @since 4.4.0
|
|
*/
|
|
public function getArticles(Registry $params, SiteApplication $app)
|
|
{
|
|
$factory = $app->bootComponent('com_content')->getMVCFactory();
|
|
|
|
// Get an instance of the generic articles model
|
|
$articles = $factory->createModel('Articles', 'Site', ['ignore_request' => true]);
|
|
|
|
// Set application parameters in model
|
|
$input = $app->getInput();
|
|
$appParams = $app->getParams();
|
|
$articles->setState('params', $appParams);
|
|
|
|
$articles->setState('list.start', 0);
|
|
$articles->setState('filter.published', ContentComponent::CONDITION_PUBLISHED);
|
|
|
|
// Set the filters based on the module params
|
|
$articles->setState('list.limit', (int) $params->get('count', 0));
|
|
$articles->setState('load_tags', $params->get('show_tags', 0) || $params->get('article_grouping', 'none') === 'tags');
|
|
|
|
// Access filter
|
|
$access = !ComponentHelper::getParams('com_content')->get('show_noauth');
|
|
$authorised = Access::getAuthorisedViewLevels($app->getIdentity()->get('id'));
|
|
$articles->setState('filter.access', $access);
|
|
|
|
// Prep for Normal or Dynamic Modes
|
|
$mode = $params->get('mode', 'normal');
|
|
|
|
switch ($mode) {
|
|
case 'dynamic':
|
|
$option = $input->get('option');
|
|
$view = $input->get('view');
|
|
|
|
if ($option === 'com_content') {
|
|
switch ($view) {
|
|
case 'category':
|
|
case 'categories':
|
|
$catids = [$input->getInt('id')];
|
|
break;
|
|
case 'article':
|
|
if ($params->get('show_on_article_page', 1)) {
|
|
$article_id = $input->getInt('id');
|
|
$catid = $input->getInt('catid');
|
|
|
|
if (!$catid) {
|
|
// Get an instance of the generic article model
|
|
$article = $factory->createModel('Article', 'Site', ['ignore_request' => true]);
|
|
|
|
$article->setState('params', $appParams);
|
|
$article->setState('filter.published', 1);
|
|
$article->setState('article.id', (int) $article_id);
|
|
$item = $article->getItem();
|
|
$catids = [$item->catid];
|
|
} else {
|
|
$catids = [$catid];
|
|
}
|
|
} else {
|
|
// Return right away if show_on_article_page option is off
|
|
return;
|
|
}
|
|
break;
|
|
|
|
default:
|
|
// Return right away if not on the category or article views
|
|
return;
|
|
}
|
|
} else {
|
|
// Return right away if not on a com_content page
|
|
return;
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
$catids = $params->get('catid');
|
|
$articles->setState('filter.category_id.include', (bool) $params->get('category_filtering_type', 1));
|
|
break;
|
|
}
|
|
|
|
// Category filter
|
|
if ($catids) {
|
|
if ($params->get('show_child_category_articles', 0) && (int) $params->get('levels', 0) > 0) {
|
|
// Get an instance of the generic categories model
|
|
$categories = $factory->createModel('Categories', 'Site', ['ignore_request' => true]);
|
|
$categories->setState('params', $appParams);
|
|
$levels = $params->get('levels', 1) ?: 9999;
|
|
$categories->setState('filter.get_children', $levels);
|
|
$categories->setState('filter.published', 1);
|
|
$categories->setState('filter.access', $access);
|
|
$additional_catids = [];
|
|
|
|
foreach ($catids as $catid) {
|
|
$categories->setState('filter.parentId', $catid);
|
|
$recursive = true;
|
|
$items = $categories->getItems($recursive);
|
|
|
|
if ($items) {
|
|
foreach ($items as $category) {
|
|
$condition = (($category->level - $categories->getParent()->level) <= $levels);
|
|
|
|
if ($condition) {
|
|
$additional_catids[] = $category->id;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$catids = array_unique(array_merge($catids, $additional_catids));
|
|
}
|
|
|
|
$articles->setState('filter.category_id', $catids);
|
|
}
|
|
|
|
// Ordering
|
|
$ordering = $params->get('article_ordering', 'a.ordering');
|
|
|
|
switch ($ordering) {
|
|
case 'random':
|
|
$articles->setState('list.ordering', $this->getDatabase()->getQuery(true)->rand());
|
|
break;
|
|
|
|
case 'rating_count':
|
|
case 'rating':
|
|
$articles->setState('list.ordering', $ordering);
|
|
$articles->setState('list.direction', $params->get('article_ordering_direction', 'ASC'));
|
|
|
|
if (!PluginHelper::isEnabled('content', 'vote')) {
|
|
$articles->setState('list.ordering', 'a.ordering');
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
$articles->setState('list.ordering', $ordering);
|
|
$articles->setState('list.direction', $params->get('article_ordering_direction', 'ASC'));
|
|
break;
|
|
}
|
|
|
|
// Filter by multiple tags
|
|
$articles->setState('filter.tag', $params->get('filter_tag', []));
|
|
|
|
$articles->setState('filter.featured', $params->get('show_front', 'show'));
|
|
$articles->setState('filter.author_id', $params->get('created_by', []));
|
|
$articles->setState('filter.author_id.include', $params->get('author_filtering_type', 1));
|
|
$articles->setState('filter.author_alias', $params->get('created_by_alias', []));
|
|
$articles->setState('filter.author_alias.include', $params->get('author_alias_filtering_type', 1));
|
|
$excluded_articles = $params->get('excluded_articles', '');
|
|
|
|
if ($excluded_articles) {
|
|
$excluded_articles = explode("\r\n", $excluded_articles);
|
|
$articles->setState('filter.article_id', $excluded_articles);
|
|
|
|
// Exclude
|
|
$articles->setState('filter.article_id.include', false);
|
|
}
|
|
|
|
$date_filtering = $params->get('date_filtering', 'off');
|
|
|
|
if ($date_filtering !== 'off') {
|
|
$articles->setState('filter.date_filtering', $date_filtering);
|
|
$articles->setState('filter.date_field', $params->get('date_field', 'a.created'));
|
|
$articles->setState('filter.start_date_range', $params->get('start_date_range', '1000-01-01 00:00:00'));
|
|
$articles->setState('filter.end_date_range', $params->get('end_date_range', '9999-12-31 23:59:59'));
|
|
$articles->setState('filter.relative_date', $params->get('relative_date', 30));
|
|
}
|
|
|
|
// Filter by language
|
|
$articles->setState('filter.language', $app->getLanguageFilter());
|
|
|
|
$items = $articles->getItems();
|
|
|
|
// Display options
|
|
$show_date = $params->get('show_date', 0);
|
|
$show_date_field = $params->get('show_date_field', 'created');
|
|
$show_date_format = $params->get('show_date_format', 'Y-m-d H:i:s');
|
|
$show_category = $params->get('show_category', 0);
|
|
$show_hits = $params->get('show_hits', 0);
|
|
$show_author = $params->get('show_author', 0);
|
|
$show_introtext = $params->get('show_introtext', 0);
|
|
$introtext_limit = $params->get('introtext_limit', 100);
|
|
|
|
// Find current Article ID if on an article page
|
|
$option = $input->get('option');
|
|
$view = $input->get('view');
|
|
|
|
if ($option === 'com_content' && $view === 'article') {
|
|
$active_article_id = $input->getInt('id');
|
|
} else {
|
|
$active_article_id = 0;
|
|
}
|
|
|
|
// Prepare data for display using display options
|
|
foreach ($items as &$item) {
|
|
$item->slug = $item->id . ':' . $item->alias;
|
|
|
|
if ($access || \in_array($item->access, $authorised)) {
|
|
// We know that user has the privilege to view the article
|
|
$item->link = Route::_(RouteHelper::getArticleRoute($item->slug, $item->catid, $item->language));
|
|
} else {
|
|
$menu = $app->getMenu();
|
|
$menuitems = $menu->getItems('link', 'index.php?option=com_users&view=login');
|
|
|
|
if (isset($menuitems[0])) {
|
|
$Itemid = $menuitems[0]->id;
|
|
} elseif ($input->getInt('Itemid') > 0) {
|
|
// Use Itemid from requesting page only if there is no existing menu
|
|
$Itemid = $input->getInt('Itemid');
|
|
}
|
|
|
|
$item->link = Route::_('index.php?option=com_users&view=login&Itemid=' . $Itemid);
|
|
}
|
|
|
|
// Used for styling the active article
|
|
$item->active = $item->id == $active_article_id ? 'active' : '';
|
|
$item->displayDate = '';
|
|
|
|
if ($show_date) {
|
|
$item->displayDate = HTMLHelper::_('date', $item->$show_date_field, $show_date_format);
|
|
}
|
|
|
|
if ($item->catid) {
|
|
$item->displayCategoryLink = Route::_(RouteHelper::getCategoryRoute($item->catid, $item->category_language));
|
|
$item->displayCategoryTitle = $show_category ? '<a href="' . $item->displayCategoryLink . '">' . $item->category_title . '</a>' : '';
|
|
} else {
|
|
$item->displayCategoryTitle = $show_category ? $item->category_title : '';
|
|
}
|
|
|
|
$item->displayHits = $show_hits ? $item->hits : '';
|
|
$item->displayAuthorName = $show_author ? $item->author : '';
|
|
|
|
if ($show_introtext) {
|
|
$item->introtext = HTMLHelper::_('content.prepare', $item->introtext, '', 'mod_articles_category.content');
|
|
$item->introtext = self::_cleanIntrotext($item->introtext);
|
|
}
|
|
|
|
$item->displayIntrotext = $show_introtext ? self::truncate($item->introtext, $introtext_limit) : '';
|
|
$item->displayReadmore = $item->alternative_readmore;
|
|
}
|
|
|
|
// Check if items need be grouped
|
|
$article_grouping = $params->get('article_grouping', 'none');
|
|
$article_grouping_direction = $params->get('article_grouping_direction', 'ksort');
|
|
$grouped = $article_grouping !== 'none';
|
|
|
|
if ($items && $grouped) {
|
|
switch ($article_grouping) {
|
|
case 'year':
|
|
case 'month_year':
|
|
$items = ArticlesCategoryHelper::groupByDate(
|
|
$items,
|
|
$article_grouping_direction,
|
|
$article_grouping,
|
|
$params->get('month_year_format', 'F Y'),
|
|
$params->get('date_grouping_field', 'created')
|
|
);
|
|
break;
|
|
case 'author':
|
|
case 'category_title':
|
|
$items = ArticlesCategoryHelper::groupBy($items, $article_grouping, $article_grouping_direction);
|
|
break;
|
|
case 'tags':
|
|
$items = ArticlesCategoryHelper::groupByTags($items, $article_grouping_direction);
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
|
|
/**
|
|
* Get a list of articles from a specific category
|
|
*
|
|
* @param Registry &$params object holding the models parameters
|
|
*
|
|
* @return array The array of users
|
|
*
|
|
* @since 1.6
|
|
*
|
|
* @deprecated 4.4.0 will be removed in 6.0
|
|
* Use the non-static method getArticles
|
|
* Example: Factory::getApplication()->bootModule('mod_articles_category', 'site')
|
|
* ->getHelper('ArticlesCategoryHelper')
|
|
* ->getArticles($params, Factory::getApplication())
|
|
*/
|
|
public static function getList(&$params)
|
|
{
|
|
/* @var SiteApplication $app */
|
|
$app = Factory::getApplication();
|
|
|
|
return (new self())->getArticles($params, $app);
|
|
}
|
|
|
|
/**
|
|
* Strips unnecessary tags from the introtext
|
|
*
|
|
* @param string $introtext introtext to sanitize
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public static function _cleanIntrotext($introtext)
|
|
{
|
|
$introtext = str_replace(['<p>', '</p>'], ' ', $introtext);
|
|
$introtext = strip_tags($introtext, '<a><em><strong><joomla-hidden-mail>');
|
|
|
|
return trim($introtext);
|
|
}
|
|
|
|
/**
|
|
* Method to truncate introtext
|
|
*
|
|
* The goal is to get the proper length plain text string with as much of
|
|
* the html intact as possible with all tags properly closed.
|
|
*
|
|
* @param string $html The content of the introtext to be truncated
|
|
* @param int $maxLength The maximum number of characters to render
|
|
*
|
|
* @return string The truncated string
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public static function truncate($html, $maxLength = 0)
|
|
{
|
|
$baseLength = \strlen($html);
|
|
|
|
// First get the plain text string. This is the rendered text we want to end up with.
|
|
$ptString = HTMLHelper::_('string.truncate', $html, $maxLength, true, false);
|
|
|
|
for ($maxLength; $maxLength < $baseLength;) {
|
|
// Now get the string if we allow html.
|
|
$htmlString = HTMLHelper::_('string.truncate', $html, $maxLength, true, true);
|
|
|
|
// Now get the plain text from the html string.
|
|
$htmlStringToPtString = HTMLHelper::_('string.truncate', $htmlString, $maxLength, true, false);
|
|
|
|
// If the new plain text string matches the original plain text string we are done.
|
|
if ($ptString === $htmlStringToPtString) {
|
|
return $htmlString;
|
|
}
|
|
|
|
// Get the number of html tag characters in the first $maxlength characters
|
|
$diffLength = \strlen($ptString) - \strlen($htmlStringToPtString);
|
|
|
|
// Set new $maxlength that adjusts for the html tags
|
|
$maxLength += $diffLength;
|
|
|
|
if ($baseLength <= $maxLength || $diffLength <= 0) {
|
|
return $htmlString;
|
|
}
|
|
}
|
|
|
|
return $ptString;
|
|
}
|
|
|
|
/**
|
|
* Groups items by field
|
|
*
|
|
* @param array $list list of items
|
|
* @param string $fieldName name of field that is used for grouping
|
|
* @param string $direction ordering direction
|
|
* @param null $fieldNameToKeep field name to keep
|
|
*
|
|
* @return array
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public static function groupBy($list, $fieldName, $direction, $fieldNameToKeep = null)
|
|
{
|
|
$grouped = [];
|
|
|
|
if (!\is_array($list)) {
|
|
if ($list === '') {
|
|
return $grouped;
|
|
}
|
|
|
|
$list = [$list];
|
|
}
|
|
|
|
foreach ($list as $key => $item) {
|
|
if (!isset($grouped[$item->$fieldName])) {
|
|
$grouped[$item->$fieldName] = [];
|
|
}
|
|
|
|
if ($fieldNameToKeep === null) {
|
|
$grouped[$item->$fieldName][$key] = $item;
|
|
} else {
|
|
$grouped[$item->$fieldName][$key] = $item->$fieldNameToKeep;
|
|
}
|
|
|
|
unset($list[$key]);
|
|
}
|
|
|
|
$direction($grouped);
|
|
|
|
return $grouped;
|
|
}
|
|
|
|
/**
|
|
* Groups items by date
|
|
*
|
|
* @param array $list list of items
|
|
* @param string $direction ordering direction
|
|
* @param string $type type of grouping
|
|
* @param string $monthYearFormat date format to use
|
|
* @param string $field date field to group by
|
|
*
|
|
* @return array
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public static function groupByDate($list, $direction = 'ksort', $type = 'year', $monthYearFormat = 'F Y', $field = 'created')
|
|
{
|
|
$grouped = [];
|
|
|
|
if (!\is_array($list)) {
|
|
if ($list === '') {
|
|
return $grouped;
|
|
}
|
|
|
|
$list = [$list];
|
|
}
|
|
|
|
foreach ($list as $key => $item) {
|
|
switch ($type) {
|
|
case 'month_year':
|
|
$month_year = StringHelper::substr($item->$field, 0, 7);
|
|
|
|
if (!isset($grouped[$month_year])) {
|
|
$grouped[$month_year] = [];
|
|
}
|
|
|
|
$grouped[$month_year][$key] = $item;
|
|
break;
|
|
|
|
default:
|
|
$year = StringHelper::substr($item->$field, 0, 4);
|
|
|
|
if (!isset($grouped[$year])) {
|
|
$grouped[$year] = [];
|
|
}
|
|
|
|
$grouped[$year][$key] = $item;
|
|
break;
|
|
}
|
|
|
|
unset($list[$key]);
|
|
}
|
|
|
|
$direction($grouped);
|
|
|
|
if ($type === 'month_year') {
|
|
foreach ($grouped as $group => $items) {
|
|
$date = new Date($group);
|
|
$formatted_group = $date->format($monthYearFormat);
|
|
$grouped[$formatted_group] = $items;
|
|
|
|
unset($grouped[$group]);
|
|
}
|
|
}
|
|
|
|
return $grouped;
|
|
}
|
|
|
|
/**
|
|
* Groups items by tags
|
|
*
|
|
* @param array $list list of items
|
|
* @param string $direction ordering direction
|
|
*
|
|
* @return array
|
|
*
|
|
* @since 3.9.0
|
|
*/
|
|
public static function groupByTags($list, $direction = 'ksort')
|
|
{
|
|
$grouped = [];
|
|
$untagged = [];
|
|
|
|
if (!$list) {
|
|
return $grouped;
|
|
}
|
|
|
|
foreach ($list as $item) {
|
|
if ($item->tags->itemTags) {
|
|
foreach ($item->tags->itemTags as $tag) {
|
|
$grouped[$tag->title][] = $item;
|
|
}
|
|
} else {
|
|
$untagged[] = $item;
|
|
}
|
|
}
|
|
|
|
$direction($grouped);
|
|
|
|
if ($untagged) {
|
|
$grouped['MOD_ARTICLES_CATEGORY_UNTAGGED'] = $untagged;
|
|
}
|
|
|
|
return $grouped;
|
|
}
|
|
}
|