<?php
/**
* @package Joomla.Site
* @subpackage com_content
*
* @copyright (C) 2006 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Component\Content\Site\View\Featured;
\defined('_JEXEC') or die;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\View\GenericDataException;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Router\Route;
/**
* Frontpage View class
*
* @since 1.5
*/
class HtmlView extends BaseHtmlView
{
/**
* The model state
*
* @var \JObject
*/
protected $state = null;
/**
* The featured articles array
*
* @var \stdClass[]
*/
protected $items = null;
/**
* The pagination object.
*
* @var \JPagination
*/
protected $pagination = null;
/**
* The featured articles to be displayed as lead items.
*
* @var \stdClass[]
*/
protected $lead_items = array();
/**
* The featured articles to be displayed as intro items.
*
* @var \stdClass[]
*/
protected $intro_items = array();
/**
* The featured articles to be displayed as link items.
*
* @var \stdClass[]
*/
protected $link_items = array();
/**
* An instance of JDatabaseDriver.
*
* @var \JDatabaseDriver
* @since 3.6.3
*/
protected $db;
/**
* The user object
*
* @var \JUser|null
*/
protected $user = null;
/**
* The page class suffix
*
* @var string
* @since 4.0.0
*/
protected $pageclass_sfx = '';
/**
* The page parameters
*
* @var \Joomla\Registry\Registry|null
* @since 4.0.0
*/
protected $params = null;
/**
* Execute and display a template script.
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public function display($tpl = null)
{
$user = Factory::getUser();
$state = $this->get('State');
$items = $this->get('Items');
$pagination = $this->get('Pagination');
// Flag indicates to not add limitstart=0 to URL
$pagination->hideEmptyLimitstart = true;
// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new GenericDataException(implode("\n", $errors), 500);
}
/** @var \Joomla\Registry\Registry $params */
$params = &$state->params;
// PREPARE THE DATA
// Get the metrics for the structural page layout.
$numLeading = (int) $params->def('num_leading_articles', 1);
$numIntro = (int) $params->def('num_intro_articles', 4);
PluginHelper::importPlugin('content');
// Compute the article slugs and prepare introtext (runs content plugins).
foreach ($items as &$item)
{
$item->slug = $item->alias ? ($item->id . ':' . $item->alias) : $item->id;
// No link for ROOT category
if ($item->parent_alias === 'root')
{
$item->parent_id = null;
}
$item->event = new \stdClass;
// Old plugins: Ensure that text property is available
if (!isset($item->text))
{
$item->text = $item->introtext;
}
Factory::getApplication()->triggerEvent('onContentPrepare', array('com_content.featured', &$item, &$item->params, 0));
// Old plugins: Use processed text as introtext
$item->introtext = $item->text;
$results = Factory::getApplication()->triggerEvent('onContentAfterTitle', array('com_content.featured', &$item, &$item->params, 0));
$item->event->afterDisplayTitle = trim(implode("\n", $results));
$results = Factory::getApplication()->triggerEvent('onContentBeforeDisplay', array('com_content.featured', &$item, &$item->params, 0));
$item->event->beforeDisplayContent = trim(implode("\n", $results));
$results = Factory::getApplication()->triggerEvent('onContentAfterDisplay', array('com_content.featured', &$item, &$item->params, 0));
$item->event->afterDisplayContent = trim(implode("\n", $results));
}
// Preprocess the breakdown of leading, intro and linked articles.
// This makes it much easier for the designer to just integrate the arrays.
$max = count($items);
// The first group is the leading articles.
$limit = $numLeading;
for ($i = 0; $i < $limit && $i < $max; $i++)
{
$this->lead_items[$i] = &$items[$i];
}
// The second group is the intro articles.
$limit = $numLeading + $numIntro;
// Order articles across, then down (or single column mode)
for ($i = $numLeading; $i < $limit && $i < $max; $i++)
{
$this->intro_items[$i] = &$items[$i];
}
// The remainder are the links.
for ($i = $numLeading + $numIntro; $i < $max; $i++)
{
$this->link_items[$i] = &$items[$i];
}
// Escape strings for HTML output
$this->pageclass_sfx = htmlspecialchars($params->get('pageclass_sfx'));
$this->params = &$params;
$this->items = &$items;
$this->pagination = &$pagination;
$this->user = &$user;
$this->db = Factory::getDbo();
$this->_prepareDocument();
parent::display($tpl);
}
/**
* Prepares the document.
*
* @return void
*/
protected function _prepareDocument()
{
// Because the application sets a default page title,
// we need to get it from the menu item itself
$menu = Factory::getApplication()->getMenu()->getActive();
if ($menu)
{
$this->params->def('page_heading', $this->params->get('page_title', $menu->title));
}
else
{
$this->params->def('page_heading', Text::_('JGLOBAL_ARTICLES'));
}
$this->setDocumentTitle($this->params->get('page_title', ''));
if ($this->params->get('menu-meta_description'))
{
$this->document->setDescription($this->params->get('menu-meta_description'));
}
if ($this->params->get('robots'))
{
$this->document->setMetaData('robots', $this->params->get('robots'));
}
// Add feed links
if ($this->params->get('show_feed_link', 1))
{
$link = '&format=feed&limitstart=';
$attribs = array('type' => 'application/rss+xml', 'title' => 'RSS 2.0');
$this->document->addHeadLink(Route::_($link . '&type=rss'), 'alternate', 'rel', $attribs);
$attribs = array('type' => 'application/atom+xml', 'title' => 'Atom 1.0');
$this->document->addHeadLink(Route::_($link . '&type=atom'), 'alternate', 'rel', $attribs);
}
}
}