396 lines
10 KiB
PHP
396 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Plugin
|
|
* @subpackage Finder.Categories
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
|
*/
|
|
|
|
defined('JPATH_BASE') or die;
|
|
|
|
require_once JPATH_ADMINISTRATOR . '/components/com_finder/helpers/indexer/adapter.php';
|
|
|
|
/**
|
|
* Finder adapter for Joomla Categories.
|
|
*
|
|
* @package Joomla.Plugin
|
|
* @subpackage Finder.Categories
|
|
* @since 2.5
|
|
*/
|
|
class PlgFinderCategories extends FinderIndexerAdapter
|
|
{
|
|
/**
|
|
* The plugin identifier.
|
|
*
|
|
* @var string
|
|
* @since 2.5
|
|
*/
|
|
protected $context = 'Categories';
|
|
|
|
/**
|
|
* The extension name.
|
|
*
|
|
* @var string
|
|
* @since 2.5
|
|
*/
|
|
protected $extension = 'com_categories';
|
|
|
|
/**
|
|
* The sublayout to use when rendering the results.
|
|
*
|
|
* @var string
|
|
* @since 2.5
|
|
*/
|
|
protected $layout = 'category';
|
|
|
|
/**
|
|
* The type of content that the adapter indexes.
|
|
*
|
|
* @var string
|
|
* @since 2.5
|
|
*/
|
|
protected $type_title = 'Category';
|
|
|
|
/**
|
|
* The table name.
|
|
*
|
|
* @var string
|
|
* @since 2.5
|
|
*/
|
|
protected $table = '#__categories';
|
|
|
|
/**
|
|
* The field the published state is stored in.
|
|
*
|
|
* @var string
|
|
* @since 2.5
|
|
*/
|
|
protected $state_field = 'published';
|
|
|
|
/**
|
|
* Load the language file on instantiation.
|
|
*
|
|
* @var boolean
|
|
* @since 3.1
|
|
*/
|
|
protected $autoloadLanguage = true;
|
|
|
|
/**
|
|
* Method to remove the link information for items that have been deleted.
|
|
*
|
|
* @param string $context The context of the action being performed.
|
|
* @param JTable $table A JTable object containing the record to be deleted
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 2.5
|
|
* @throws Exception on database error.
|
|
*/
|
|
public function onFinderDelete($context, $table)
|
|
{
|
|
if ($context == 'com_categories.category')
|
|
{
|
|
$id = $table->id;
|
|
}
|
|
elseif ($context == 'com_finder.index')
|
|
{
|
|
$id = $table->link_id;
|
|
}
|
|
else
|
|
{
|
|
return true;
|
|
}
|
|
// Remove the items.
|
|
return $this->remove($id);
|
|
}
|
|
|
|
/**
|
|
* Method to determine if the access level of an item changed.
|
|
*
|
|
* @param string $context The context of the content passed to the plugin.
|
|
* @param JTable $row A JTable object
|
|
* @param boolean $isNew If the content has just been created
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 2.5
|
|
* @throws Exception on database error.
|
|
*/
|
|
public function onFinderAfterSave($context, $row, $isNew)
|
|
{
|
|
// We only want to handle categories here
|
|
if ($context == 'com_categories.category')
|
|
{
|
|
// Check if the access levels are different
|
|
if (!$isNew && $this->old_access != $row->access)
|
|
{
|
|
// Process the change.
|
|
$this->itemAccessChange($row);
|
|
|
|
// Reindex the item
|
|
$this->reindex($row->id);
|
|
}
|
|
|
|
// Check if the parent access level is different
|
|
if (!$isNew && $this->old_cataccess != $row->access)
|
|
{
|
|
$this->categoryAccessChange($row);
|
|
}
|
|
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method to reindex the link information for an item that has been saved.
|
|
* This event is fired before the data is actually saved so we are going
|
|
* to queue the item to be indexed later.
|
|
*
|
|
* @param string $context The context of the content passed to the plugin.
|
|
* @param JTable $row A JTable object
|
|
* @param boolean $isNew If the content is just about to be created
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 2.5
|
|
* @throws Exception on database error.
|
|
*/
|
|
public function onFinderBeforeSave($context, $row, $isNew)
|
|
{
|
|
// We only want to handle categories here
|
|
if ($context == 'com_categories.category')
|
|
{
|
|
// Query the database for the old access level and the parent if the item isn't new
|
|
if (!$isNew)
|
|
{
|
|
$this->checkItemAccess($row);
|
|
$this->checkCategoryAccess($row);
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method to update the link information for items that have been changed
|
|
* from outside the edit screen. This is fired when the item is published,
|
|
* unpublished, archived, or unarchived from the list view.
|
|
*
|
|
* @param string $context The context for the content passed to the plugin.
|
|
* @param array $pks A list of primary key ids of the content that has changed state.
|
|
* @param integer $value The value of the state that the content has been changed to.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
public function onFinderChangeState($context, $pks, $value)
|
|
{
|
|
// We only want to handle categories here
|
|
if ($context == 'com_categories.category')
|
|
{
|
|
// The category published state is tied to the parent category
|
|
// published state so we need to look up all published states
|
|
// before we change anything.
|
|
foreach ($pks as $pk)
|
|
{
|
|
/* TODO: The $item variable does not seem to be used at all
|
|
$query = clone($this->getStateQuery());
|
|
$query->where('a.id = ' . (int) $pk);
|
|
|
|
// Get the published states.
|
|
$this->db->setQuery($query);
|
|
$item = $this->db->loadObject();
|
|
*/
|
|
|
|
// Translate the state.
|
|
$state = null;
|
|
|
|
if ($item->parent_id != 1)
|
|
{
|
|
$state = $item->cat_state;
|
|
}
|
|
|
|
$temp = $this->translateState($value, $state);
|
|
|
|
// Update the item.
|
|
$this->change($pk, 'state', $temp);
|
|
|
|
// Reindex the item
|
|
$this->reindex($pk);
|
|
}
|
|
}
|
|
|
|
// Handle when the plugin is disabled
|
|
if ($context == 'com_plugins.plugin' && $value === 0)
|
|
{
|
|
$this->pluginDisable($pks);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Method to index an item. The item must be a FinderIndexerResult object.
|
|
*
|
|
* @param FinderIndexerResult $item The item to index as an FinderIndexerResult object.
|
|
* @param string $format The item format
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 2.5
|
|
* @throws Exception on database error.
|
|
*/
|
|
protected function index(FinderIndexerResult $item, $format = 'html')
|
|
{
|
|
// Check if the extension is enabled
|
|
if (JComponentHelper::isEnabled($this->extension) == false)
|
|
{
|
|
return;
|
|
}
|
|
|
|
$item->setLanguage();
|
|
|
|
// Need to import component route helpers dynamically, hence the reason it's handled here
|
|
$path = JPATH_SITE . '/components/' . $item->extension . '/helpers/route.php';
|
|
if (is_file($path))
|
|
{
|
|
include_once $path;
|
|
}
|
|
|
|
$extension = ucfirst(substr($item->extension, 4));
|
|
|
|
// Initialize the item parameters.
|
|
$registry = new JRegistry;
|
|
$registry->loadString($item->params);
|
|
$item->params = $registry;
|
|
|
|
$registry = new JRegistry;
|
|
$registry->loadString($item->metadata);
|
|
$item->metadata = $registry;
|
|
|
|
/* Add the meta-data processing instructions based on the categories
|
|
* configuration parameters.
|
|
*/
|
|
// Add the meta-author.
|
|
$item->metaauthor = $item->metadata->get('author');
|
|
|
|
// Handle the link to the meta-data.
|
|
$item->addInstruction(FinderIndexer::META_CONTEXT, 'link');
|
|
$item->addInstruction(FinderIndexer::META_CONTEXT, 'metakey');
|
|
$item->addInstruction(FinderIndexer::META_CONTEXT, 'metadesc');
|
|
$item->addInstruction(FinderIndexer::META_CONTEXT, 'metaauthor');
|
|
$item->addInstruction(FinderIndexer::META_CONTEXT, 'author');
|
|
//$item->addInstruction(FinderIndexer::META_CONTEXT, 'created_by_alias');
|
|
|
|
// Trigger the onContentPrepare event.
|
|
$item->summary = FinderIndexerHelper::prepareContent($item->summary, $item->params);
|
|
|
|
// Build the necessary route and path information.
|
|
$item->url = $this->getURL($item->id, $item->extension, $this->layout);
|
|
|
|
$class = $extension . 'HelperRoute';
|
|
if (class_exists($class) && method_exists($class, 'getCategoryRoute'))
|
|
{
|
|
$item->route = $class::getCategoryRoute($item->id);
|
|
}
|
|
else
|
|
{
|
|
$item->route = ContentHelperRoute::getCategoryRoute($item->slug, $item->catid);
|
|
}
|
|
$item->path = FinderIndexerHelper::getContentPath($item->route);
|
|
|
|
// Get the menu title if it exists.
|
|
$title = $this->getItemMenuTitle($item->url);
|
|
|
|
// Adjust the title if necessary.
|
|
if (!empty($title) && $this->params->get('use_menu_title', true))
|
|
{
|
|
$item->title = $title;
|
|
}
|
|
|
|
// Translate the state. Categories should only be published if the parent category is published.
|
|
$item->state = $this->translateState($item->state);
|
|
|
|
// Add the type taxonomy data.
|
|
$item->addTaxonomy('Type', 'Category');
|
|
|
|
// Add the language taxonomy data.
|
|
$item->addTaxonomy('Language', $item->language);
|
|
|
|
// Get content extras.
|
|
FinderIndexerHelper::getContentExtras($item);
|
|
|
|
// Index the item.
|
|
$this->indexer->index($item);
|
|
}
|
|
|
|
/**
|
|
* Method to setup the indexer to be run.
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
protected function setup()
|
|
{
|
|
// Load com_content route helper as it is the fallback for routing in the indexer in this instance.
|
|
include_once JPATH_SITE . '/components/com_content/helpers/route.php';
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method to get the SQL query used to retrieve the list of content items.
|
|
*
|
|
* @param mixed $query A JDatabaseQuery object or null.
|
|
*
|
|
* @return JDatabaseQuery A database object.
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
protected function getListQuery($query = null)
|
|
{
|
|
$db = JFactory::getDbo();
|
|
// Check if we can use the supplied SQL query.
|
|
$query = $query instanceof JDatabaseQuery ? $query : $db->getQuery(true)
|
|
->select('a.id, a.title, a.alias, a.description AS summary, a.extension')
|
|
->select('a.created_user_id AS created_by, a.modified_time AS modified, a.modified_user_id AS modified_by')
|
|
->select('a.metakey, a.metadesc, a.metadata, a.language, a.lft, a.parent_id, a.level')
|
|
->select('a.created_time AS start_date, a.published AS state, a.access, a.params');
|
|
|
|
// Handle the alias CASE WHEN portion of the query
|
|
$case_when_item_alias = ' CASE WHEN ';
|
|
$case_when_item_alias .= $query->charLength('a.alias', '!=', '0');
|
|
$case_when_item_alias .= ' THEN ';
|
|
$a_id = $query->castAsChar('a.id');
|
|
$case_when_item_alias .= $query->concatenate(array($a_id, 'a.alias'), ':');
|
|
$case_when_item_alias .= ' ELSE ';
|
|
$case_when_item_alias .= $a_id.' END as slug';
|
|
$query->select($case_when_item_alias)
|
|
->from('#__categories AS a')
|
|
->where($db->quoteName('a.id') . ' > 1');
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Method to get a SQL query to load the published and access states for
|
|
* an article and category.
|
|
*
|
|
* @return JDatabaseQuery A database object.
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
protected function getStateQuery()
|
|
{
|
|
$query = $this->db->getQuery(true)
|
|
->select($this->db->quoteName('a.id'))
|
|
->select('a.' . $this->state_field . ' AS state, c.published AS cat_state')
|
|
->select('a.access, c.access AS cat_access')
|
|
->from($this->db->quoteName('#__categories') . ' AS a')
|
|
->join('LEFT', '#__categories AS c ON c.id = a.parent_id');
|
|
|
|
return $query;
|
|
}
|
|
}
|