first commit

This commit is contained in:
2025-06-17 11:53:18 +02:00
commit 9f0f7ba12b
8804 changed files with 1369176 additions and 0 deletions

View File

@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<extension type="plugin" group="finder" method="upgrade">
<name>plg_finder_categories</name>
<author>Joomla! Project</author>
<creationDate>2011-08</creationDate>
<copyright>(C) 2011 Open Source Matters, Inc.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>admin@joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>3.0.0</version>
<description>PLG_FINDER_CATEGORIES_XML_DESCRIPTION</description>
<namespace path="src">Joomla\Plugin\Finder\Categories</namespace>
<files>
<folder plugin="categories">services</folder>
<folder>src</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/plg_finder_categories.ini</language>
<language tag="en-GB">language/en-GB/plg_finder_categories.sys.ini</language>
</languages>
<config>
<fields name="params">
<fieldset name="basic" addfieldprefix="Joomla\Component\Finder\Administrator\Field">
<field
name="search_archived"
type="radio"
layout="joomla.form.field.radio.switcher"
label="PLG_FINDER_CATEGORIES_FIELD_SEARCH_ARCHIVED_LABEL"
description="PLG_FINDER_CATEGORIES_FIELD_SEARCH_ARCHIVED_DESC"
default="1"
filter="integer"
>
<option value="0">JNO</option>
<option value="1">JYES</option>
</field>
<field
name="taxonomies"
type="taxonomytypes"
label="PLG_FINDER_CATEGORIES_TAXONOMIES_LABEL"
default="type,language"
multiple="true"
>
<option value="language">PLG_FINDER_CATEGORIES_TAXONOMIES_LANGUAGE</option>
<option value="type">PLG_FINDER_CATEGORIES_TAXONOMIES_TYPE</option>
</field>
</fieldset>
</fields>
</config>
</extension>

View File

@ -0,0 +1,48 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.categories
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
\defined('_JEXEC') or die;
use Joomla\CMS\Extension\PluginInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Joomla\Event\DispatcherInterface;
use Joomla\Plugin\Finder\Categories\Extension\Categories;
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since 4.3.0
*/
public function register(Container $container)
{
$container->set(
PluginInterface::class,
function (Container $container) {
$plugin = new Categories(
$container->get(DispatcherInterface::class),
(array) PluginHelper::getPlugin('finder', 'categories')
);
$plugin->setApplication(Factory::getApplication());
$plugin->setDatabase($container->get(DatabaseInterface::class));
return $plugin;
}
);
}
};

View File

@ -0,0 +1,474 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.categories
*
* @copyright (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Finder\Categories\Extension;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Table\Table;
use Joomla\Component\Finder\Administrator\Indexer\Adapter;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Component\Finder\Administrator\Indexer\Indexer;
use Joomla\Component\Finder\Administrator\Indexer\Result;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseQuery;
use Joomla\Database\ParameterType;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Smart Search adapter for Joomla Categories.
*
* @since 2.5
*/
final class Categories extends Adapter
{
use DatabaseAwareTrait;
/**
* 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 setup the indexer to be run.
*
* @return boolean True on success.
*
* @since 2.5
*/
protected function setup()
{
return true;
}
/**
* Method to remove the link information for items that have been deleted.
*
* @param string $context The context of the action being performed.
* @param Table $table A Table 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 item from the index.
return $this->remove($id);
}
/**
* Smart Search after save content method.
* Reindexes the link information for a category that has been saved.
* It also makes adjustments if the access level of the category has changed.
*
* @param string $context The context of the category passed to the plugin.
* @param Table $row A Table object.
* @param boolean $isNew True if the category has just been created.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterSave($context, $row, $isNew): void
{
// 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 category item.
$this->reindex($row->id);
// Check if the parent access level is different.
if (!$isNew && $this->old_cataccess != $row->access) {
$this->categoryAccessChange($row);
}
}
}
/**
* Smart Search before content save method.
* This event is fired before the data is actually saved.
*
* @param string $context The context of the category passed to the plugin.
* @param Table $row A Table object.
* @param boolean $isNew True if the category 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 category passed to the plugin.
* @param array $pks An array of primary key ids of the category that has changed state.
* @param integer $value The value of the state that the category 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) {
$pk = (int) $pk;
$query = clone $this->getStateQuery();
$query->where($this->getDatabase()->quoteName('a.id') . ' = :plgFinderCategoriesId')
->bind(':plgFinderCategoriesId', $pk, ParameterType::INTEGER);
$this->getDatabase()->setQuery($query);
$item = $this->getDatabase()->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 Result object.
*
* @param Result $item The item to index as a Result object.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
protected function index(Result $item)
{
// Check if the extension is enabled.
if (ComponentHelper::isEnabled($this->extension) === false) {
return;
}
// Extract the extension element
$parts = explode('.', $item->extension);
$extension_element = $parts[0];
// Check if the extension that owns the category is also enabled.
if (ComponentHelper::isEnabled($extension_element) === false) {
return;
}
$item->setLanguage();
$extension = ucfirst(substr($extension_element, 4));
// Initialize the item parameters.
$item->params = new Registry($item->params);
$item->metadata = new Registry($item->metadata);
/*
* Add the metadata processing instructions based on the category's
* configuration parameters.
*/
// Add the meta author.
$item->metaauthor = $item->metadata->get('author');
// Handle the link to the metadata.
$item->addInstruction(Indexer::META_CONTEXT, 'link');
$item->addInstruction(Indexer::META_CONTEXT, 'metakey');
$item->addInstruction(Indexer::META_CONTEXT, 'metadesc');
$item->addInstruction(Indexer::META_CONTEXT, 'metaauthor');
$item->addInstruction(Indexer::META_CONTEXT, 'author');
// Deactivated Methods
// $item->addInstruction(Indexer::META_CONTEXT, 'created_by_alias');
// Trigger the onContentPrepare event.
$item->summary = Helper::prepareContent($item->summary, $item->params);
// Create a URL as identifier to recognise items again.
$item->url = $this->getUrl($item->id, $item->extension, $this->layout);
/*
* Build the necessary route information.
* Need to import component route helpers dynamically, hence the reason it's handled here.
*/
$class = $extension . 'HelperRoute';
// Need to import component route helpers dynamically, hence the reason it's handled here.
\JLoader::register($class, JPATH_SITE . '/components/' . $extension_element . '/helpers/route.php');
if (class_exists($class) && method_exists($class, 'getCategoryRoute')) {
$item->route = $class::getCategoryRoute($item->id, $item->language);
} else {
$class = 'Joomla\\Component\\' . $extension . '\\Site\\Helper\\RouteHelper';
if (class_exists($class) && method_exists($class, 'getCategoryRoute')) {
$item->route = $class::getCategoryRoute($item->id, $item->language);
} else {
// This category has no frontend route.
return;
}
}
// 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);
// Get taxonomies to display
$taxonomies = $this->params->get('taxonomies', ['type', 'language']);
// Add the type taxonomy data.
if (\in_array('type', $taxonomies)) {
$item->addTaxonomy('Type', 'Category');
}
// Add the language taxonomy data.
if (\in_array('language', $taxonomies)) {
$item->addTaxonomy('Language', $item->language);
}
// Get content extras.
Helper::getContentExtras($item);
// Index the item.
$this->indexer->index($item);
}
/**
* Method to get the SQL query used to retrieve the list of content items.
*
* @param mixed $query A DatabaseQuery object or null.
*
* @return DatabaseQuery A database object.
*
* @since 2.5
*/
protected function getListQuery($query = null)
{
$db = $this->getDatabase();
// Check if we can use the supplied SQL query.
$query = $query instanceof DatabaseQuery ? $query : $db->getQuery(true);
$query->select(
$db->quoteName(
[
'a.id',
'a.title',
'a.alias',
'a.extension',
'a.metakey',
'a.metadesc',
'a.metadata',
'a.language',
'a.lft',
'a.parent_id',
'a.level',
'a.access',
'a.params',
]
)
)
->select(
$db->quoteName(
[
'a.description',
'a.created_user_id',
'a.modified_time',
'a.modified_user_id',
'a.created_time',
'a.published',
],
[
'summary',
'created_by',
'modified',
'modified_by',
'start_date',
'state',
]
)
);
// Handle the alias CASE WHEN portion of the query.
$case_when_item_alias = ' CASE WHEN ';
$case_when_item_alias .= $query->charLength($db->quoteName('a.alias'), '!=', '0');
$case_when_item_alias .= ' THEN ';
$a_id = $query->castAsChar($db->quoteName('a.id'));
$case_when_item_alias .= $query->concatenate([$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($db->quoteName('#__categories', 'a'))
->where($db->quoteName('a.id') . ' > 1');
return $query;
}
/**
* Method to get a SQL query to load the published and access states for
* a category and its parents.
*
* @return DatabaseQuery A database object.
*
* @since 2.5
*/
protected function getStateQuery()
{
$query = $this->getDatabase()->getQuery(true);
$query->select(
$this->getDatabase()->quoteName(
[
'a.id',
'a.parent_id',
'a.access',
]
)
)
->select(
$this->getDatabase()->quoteName(
[
'a.' . $this->state_field,
'c.published',
'c.access',
],
[
'state',
'cat_state',
'cat_access',
]
)
)
->from($this->getDatabase()->quoteName('#__categories', 'a'))
->join(
'INNER',
$this->getDatabase()->quoteName('#__categories', 'c'),
$this->getDatabase()->quoteName('c.id') . ' = ' . $this->getDatabase()->quoteName('a.parent_id')
);
return $query;
}
}

View File

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="UTF-8"?>
<extension type="plugin" group="finder" method="upgrade">
<name>plg_finder_contacts</name>
<author>Joomla! Project</author>
<creationDate>2011-08</creationDate>
<copyright>(C) 2011 Open Source Matters, Inc.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>admin@joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>3.0.0</version>
<description>PLG_FINDER_CONTACTS_XML_DESCRIPTION</description>
<namespace path="src">Joomla\Plugin\Finder\Contacts</namespace>
<files>
<folder plugin="contacts">services</folder>
<folder>src</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/plg_finder_contacts.ini</language>
<language tag="en-GB">language/en-GB/plg_finder_contacts.sys.ini</language>
</languages>
<config>
<fields name="params">
<fieldset name="basic" addfieldprefix="Joomla\Component\Finder\Administrator\Field">
<field
name="search_archived"
type="radio"
layout="joomla.form.field.radio.switcher"
label="PLG_FINDER_CONTACTS_FIELD_SEARCH_ARCHIVED_LABEL"
description="PLG_FINDER_CONTACTS_FIELD_SEARCH_ARCHIVED_DESC"
default="1"
filter="integer"
>
<option value="0">JNO</option>
<option value="1">JYES</option>
</field>
<field
name="taxonomies"
type="taxonomytypes"
label="PLG_FINDER_CONTACTS_TAXONOMIES_LABEL"
default="type,category,language,region,country"
multiple="true"
>
<option value="category">PLG_FINDER_CONTACTS_TAXONOMIES_CATEGORY</option>
<option value="country">PLG_FINDER_CONTACTS_TAXONOMIES_COUNTRY</option>
<option value="language">PLG_FINDER_CONTACTS_TAXONOMIES_LANGUAGE</option>
<option value="region">PLG_FINDER_CONTACTS_TAXONOMIES_REGION</option>
<option value="type">PLG_FINDER_CONTACTS_TAXONOMIES_TYPE</option>
</field>
</fieldset>
</fields>
</config>
</extension>

View File

@ -0,0 +1,48 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.contacts
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
\defined('_JEXEC') or die;
use Joomla\CMS\Extension\PluginInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Joomla\Event\DispatcherInterface;
use Joomla\Plugin\Finder\Contacts\Extension\Contacts;
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since 4.3.0
*/
public function register(Container $container)
{
$container->set(
PluginInterface::class,
function (Container $container) {
$plugin = new Contacts(
$container->get(DispatcherInterface::class),
(array) PluginHelper::getPlugin('finder', 'contacts')
);
$plugin->setApplication(Factory::getApplication());
$plugin->setDatabase($container->get(DatabaseInterface::class));
return $plugin;
}
);
}
};

View File

@ -0,0 +1,449 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.contacts
*
* @copyright (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Finder\Contacts\Extension;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Table\Table;
use Joomla\Component\Contact\Site\Helper\RouteHelper;
use Joomla\Component\Finder\Administrator\Indexer\Adapter;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Component\Finder\Administrator\Indexer\Indexer;
use Joomla\Component\Finder\Administrator\Indexer\Result;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseQuery;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Finder adapter for Joomla Contacts.
*
* @since 2.5
*/
final class Contacts extends Adapter
{
use DatabaseAwareTrait;
/**
* The plugin identifier.
*
* @var string
* @since 2.5
*/
protected $context = 'Contacts';
/**
* The extension name.
*
* @var string
* @since 2.5
*/
protected $extension = 'com_contact';
/**
* The sublayout to use when rendering the results.
*
* @var string
* @since 2.5
*/
protected $layout = 'contact';
/**
* The type of content that the adapter indexes.
*
* @var string
* @since 2.5
*/
protected $type_title = 'Contact';
/**
* The table name.
*
* @var string
* @since 2.5
*/
protected $table = '#__contact_details';
/**
* 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 update the item link information when the item category is
* changed. This is fired when the item category is published or unpublished
* from the list view.
*
* @param string $extension The extension whose category has been updated.
* @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 onFinderCategoryChangeState($extension, $pks, $value)
{
// Make sure we're handling com_contact categories
if ($extension === 'com_contact') {
$this->categoryStateChange($pks, $value);
}
}
/**
* Method to remove the link information for items that have been deleted.
*
* This event will fire when contacts are deleted and when an indexed item is deleted.
*
* @param string $context The context of the action being performed.
* @param Table $table A Table object containing the record to be deleted
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterDelete($context, $table): void
{
if ($context === 'com_contact.contact') {
$id = $table->id;
} elseif ($context === 'com_finder.index') {
$id = $table->link_id;
} else {
return;
}
// Remove the items.
$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 Table $row A Table object
* @param boolean $isNew If the content has just been created
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterSave($context, $row, $isNew): void
{
// We only want to handle contacts here
if ($context === 'com_contact.contact') {
// 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 for access changes in the category
if ($context === 'com_categories.category') {
// Check if the access levels are different
if (!$isNew && $this->old_cataccess != $row->access) {
$this->categoryAccessChange($row);
}
}
}
/**
* 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 Table $row A Table 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 contacts here
if ($context === 'com_contact.contact') {
// Query the database for the old access level if the item isn't new
if (!$isNew) {
$this->checkItemAccess($row);
}
}
// Check for access levels from the category
if ($context === 'com_categories.category') {
// Query the database for the old access level if the item isn't new
if (!$isNew) {
$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 contacts here
if ($context === 'com_contact.contact') {
$this->itemStateChange($pks, $value);
}
// 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 Result object.
*
* @param Result $item The item to index as a Result object.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
protected function index(Result $item)
{
// Check if the extension is enabled
if (ComponentHelper::isEnabled($this->extension) === false) {
return;
}
$item->setLanguage();
// Initialize the item parameters.
$item->params = new Registry($item->params);
// Create a URL as identifier to recognise items again.
$item->url = $this->getUrl($item->id, $this->extension, $this->layout);
// Build the necessary route and path information.
$item->route = RouteHelper::getContactRoute($item->slug, $item->catslug, $item->language);
// 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;
}
// Add the image.
if ($item->image) {
$item->imageUrl = $item->image;
$item->imageAlt = $item->title ?? '';
}
/*
* Add the metadata processing instructions based on the contact
* configuration parameters.
*/
// Handle the contact position.
if ($item->params->get('show_position', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'position');
}
// Handle the contact street address.
if ($item->params->get('show_street_address', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'address');
}
// Handle the contact city.
if ($item->params->get('show_suburb', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'city');
}
// Handle the contact region.
if ($item->params->get('show_state', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'region');
}
// Handle the contact country.
if ($item->params->get('show_country', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'country');
}
// Handle the contact zip code.
if ($item->params->get('show_postcode', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'zip');
}
// Handle the contact telephone number.
if ($item->params->get('show_telephone', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'telephone');
}
// Handle the contact fax number.
if ($item->params->get('show_fax', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'fax');
}
// Handle the contact email address.
if ($item->params->get('show_email', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'email');
}
// Handle the contact mobile number.
if ($item->params->get('show_mobile', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'mobile');
}
// Handle the contact webpage.
if ($item->params->get('show_webpage', true)) {
$item->addInstruction(Indexer::META_CONTEXT, 'webpage');
}
// Handle the contact user name.
$item->addInstruction(Indexer::META_CONTEXT, 'user');
// Get taxonomies to display
$taxonomies = $this->params->get('taxonomies', ['type', 'category', 'language', 'region', 'country']);
// Add the type taxonomy data.
if (\in_array('type', $taxonomies)) {
$item->addTaxonomy('Type', 'Contact');
}
// Add the category taxonomy data.
$categories = $this->getApplication()->bootComponent('com_contact')->getCategory(['published' => false, 'access' => false]);
$category = $categories->get($item->catid);
if (!$category) {
return;
}
// Add the category taxonomy data.
if (\in_array('category', $taxonomies)) {
$item->addNestedTaxonomy('Category', $category, $this->translateState($category->published), $category->access, $category->language);
}
// Add the language taxonomy data.
if (\in_array('language', $taxonomies)) {
$item->addTaxonomy('Language', $item->language);
}
// Add the region taxonomy data.
if (\in_array('region', $taxonomies) && !empty($item->region) && $this->params->get('tax_add_region', true)) {
$item->addTaxonomy('Region', $item->region);
}
// Add the country taxonomy data.
if (\in_array('country', $taxonomies) && !empty($item->country) && $this->params->get('tax_add_country', true)) {
$item->addTaxonomy('Country', $item->country);
}
// Get content extras.
Helper::getContentExtras($item);
Helper::addCustomFields($item, 'com_contact.contact');
// 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()
{
return true;
}
/**
* Method to get the SQL query used to retrieve the list of content items.
*
* @param mixed $query A DatabaseQuery object or null.
*
* @return DatabaseQuery A database object.
*
* @since 2.5
*/
protected function getListQuery($query = null)
{
$db = $this->getDatabase();
// Check if we can use the supplied SQL query.
$query = $query instanceof DatabaseQuery ? $query : $db->getQuery(true)
->select('a.id, a.name AS title, a.alias, a.con_position AS position, a.address, a.created AS start_date')
->select('a.created_by_alias, a.modified, a.modified_by')
->select('a.metakey, a.metadesc, a.metadata, a.language')
->select('a.sortname1, a.sortname2, a.sortname3')
->select('a.publish_up AS publish_start_date, a.publish_down AS publish_end_date')
->select('a.suburb AS city, a.state AS region, a.country, a.postcode AS zip')
->select('a.telephone, a.fax, a.misc AS summary, a.email_to AS email, a.mobile')
->select('a.image, a.webpage, a.access, a.published AS state, a.ordering, a.params, a.catid')
->select('c.title AS category, c.published AS cat_state, c.access AS cat_access');
// 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([$a_id, 'a.alias'], ':');
$case_when_item_alias .= ' ELSE ';
$case_when_item_alias .= $a_id . ' END as slug';
$query->select($case_when_item_alias);
$case_when_category_alias = ' CASE WHEN ';
$case_when_category_alias .= $query->charLength('c.alias', '!=', '0');
$case_when_category_alias .= ' THEN ';
$c_id = $query->castAsChar('c.id');
$case_when_category_alias .= $query->concatenate([$c_id, 'c.alias'], ':');
$case_when_category_alias .= ' ELSE ';
$case_when_category_alias .= $c_id . ' END as catslug';
$query->select($case_when_category_alias)
->select('u.name')
->from('#__contact_details AS a')
->join('LEFT', '#__categories AS c ON c.id = a.catid')
->join('LEFT', '#__users AS u ON u.id = a.user_id');
return $query;
}
}

View File

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8"?>
<extension type="plugin" group="finder" method="upgrade">
<name>plg_finder_content</name>
<author>Joomla! Project</author>
<creationDate>2011-08</creationDate>
<copyright>(C) 2011 Open Source Matters, Inc.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>admin@joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>3.0.0</version>
<description>PLG_FINDER_CONTENT_XML_DESCRIPTION</description>
<namespace path="src">Joomla\Plugin\Finder\Content</namespace>
<files>
<folder plugin="content">services</folder>
<folder>src</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/plg_finder_content.ini</language>
<language tag="en-GB">language/en-GB/plg_finder_content.sys.ini</language>
</languages>
<config>
<fields name="params">
<fieldset name="basic" addfieldprefix="Joomla\Component\Finder\Administrator\Field">
<field
name="search_archived"
type="radio"
layout="joomla.form.field.radio.switcher"
label="PLG_FINDER_CONTENT_FIELD_SEARCH_ARCHIVED_LABEL"
description="PLG_FINDER_CONTENT_FIELD_SEARCH_ARCHIVED_DESC"
default="1"
filter="integer"
>
<option value="0">JNO</option>
<option value="1">JYES</option>
</field>
<field
name="taxonomies"
type="taxonomytypes"
label="PLG_FINDER_CONTENT_TAXONOMIES_LABEL"
default="type,category,language,author"
multiple="true"
>
<option value="author">PLG_FINDER_CONTENT_TAXONOMIES_AUTHOR</option>
<option value="category">PLG_FINDER_CONTENT_TAXONOMIES_CATEGORY</option>
<option value="language">PLG_FINDER_CONTENT_TAXONOMIES_LANGUAGE</option>
<option value="type">PLG_FINDER_CONTENT_TAXONOMIES_TYPE</option>
</field>
</fieldset>
</fields>
</config>
</extension>

View File

@ -0,0 +1,48 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.content
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
\defined('_JEXEC') or die;
use Joomla\CMS\Extension\PluginInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Joomla\Event\DispatcherInterface;
use Joomla\Plugin\Finder\Content\Extension\Content;
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since 4.3.0
*/
public function register(Container $container)
{
$container->set(
PluginInterface::class,
function (Container $container) {
$plugin = new Content(
$container->get(DispatcherInterface::class),
(array) PluginHelper::getPlugin('finder', 'content')
);
$plugin->setApplication(Factory::getApplication());
$plugin->setDatabase($container->get(DatabaseInterface::class));
return $plugin;
}
);
}
};

View File

@ -0,0 +1,421 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.content
*
* @copyright (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Finder\Content\Extension;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Event\Finder as FinderEvent;
use Joomla\Component\Content\Site\Helper\RouteHelper;
use Joomla\Component\Finder\Administrator\Indexer\Adapter;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Component\Finder\Administrator\Indexer\Indexer;
use Joomla\Component\Finder\Administrator\Indexer\Result;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseQuery;
use Joomla\Event\SubscriberInterface;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Smart Search adapter for com_content.
*
* @since 2.5
*/
final class Content extends Adapter implements SubscriberInterface
{
use DatabaseAwareTrait;
/**
* The plugin identifier.
*
* @var string
* @since 2.5
*/
protected $context = 'Content';
/**
* The extension name.
*
* @var string
* @since 2.5
*/
protected $extension = 'com_content';
/**
* The sublayout to use when rendering the results.
*
* @var string
* @since 2.5
*/
protected $layout = 'article';
/**
* The type of content that the adapter indexes.
*
* @var string
* @since 2.5
*/
protected $type_title = 'Article';
/**
* The table name.
*
* @var string
* @since 2.5
*/
protected $table = '#__content';
/**
* Load the language file on instantiation.
*
* @var boolean
* @since 3.1
*/
protected $autoloadLanguage = true;
/**
* Returns an array of events this subscriber will listen to.
*
* @return array
*
* @since 5.0.0
*/
public static function getSubscribedEvents(): array
{
return array_merge([
'onFinderCategoryChangeState' => 'onFinderCategoryChangeState',
'onFinderChangeState' => 'onFinderChangeState',
'onFinderAfterDelete' => 'onFinderAfterDelete',
'onFinderBeforeSave' => 'onFinderBeforeSave',
'onFinderAfterSave' => 'onFinderAfterSave',
], parent::getSubscribedEvents());
}
/**
* Method to setup the indexer to be run.
*
* @return boolean True on success.
*
* @since 2.5
*/
protected function setup()
{
return true;
}
/**
* Method to update the item link information when the item category is
* changed. This is fired when the item category is published or unpublished
* from the list view.
*
* @param FinderEvent\AfterCategoryChangeStateEvent $event The event instance.
*
* @return void
*
* @since 2.5
*/
public function onFinderCategoryChangeState(FinderEvent\AfterCategoryChangeStateEvent $event)
{
// Make sure we're handling com_content categories.
if ($event->getExtension() === 'com_content') {
$this->categoryStateChange($event->getPks(), $event->getValue());
}
}
/**
* Method to remove the link information for items that have been deleted.
*
* @param FinderEvent\AfterDeleteEvent $event The event instance.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterDelete(FinderEvent\AfterDeleteEvent $event): void
{
$context = $event->getContext();
$table = $event->getItem();
if ($context === 'com_content.article') {
$id = $table->id;
} elseif ($context === 'com_finder.index') {
$id = $table->link_id;
} else {
return;
}
// Remove item from the index.
$this->remove($id);
}
/**
* Smart Search after save content method.
* Reindexes the link information for an article that has been saved.
* It also makes adjustments if the access level of an item or the
* category to which it belongs has changed.
*
* @param FinderEvent\AfterSaveEvent $event The event instance.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterSave(FinderEvent\AfterSaveEvent $event): void
{
$context = $event->getContext();
$row = $event->getItem();
$isNew = $event->getIsNew();
// We only want to handle articles here.
if ($context === 'com_content.article' || $context === 'com_content.form') {
// 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 for access changes in the category.
if ($context === 'com_categories.category') {
// Check if the access levels are different.
if (!$isNew && $this->old_cataccess != $row->access) {
$this->categoryAccessChange($row);
}
}
}
/**
* Smart Search before content save method.
* This event is fired before the data is actually saved.
*
* @param FinderEvent\BeforeSaveEvent $event The event instance.
*
* @return boolean True on success.
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderBeforeSave(FinderEvent\BeforeSaveEvent $event)
{
$context = $event->getContext();
$row = $event->getItem();
$isNew = $event->getIsNew();
// We only want to handle articles here.
if ($context === 'com_content.article' || $context === 'com_content.form') {
// Query the database for the old access level if the item isn't new.
if (!$isNew) {
$this->checkItemAccess($row);
}
}
// Check for access levels from the category.
if ($context === 'com_categories.category') {
// Query the database for the old access level if the item isn't new.
if (!$isNew) {
$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 FinderEvent\AfterChangeStateEvent $event The event instance.
*
* @return void
*
* @since 2.5
*/
public function onFinderChangeState(FinderEvent\AfterChangeStateEvent $event)
{
$context = $event->getContext();
$pks = $event->getPks();
$value = $event->getValue();
// We only want to handle articles here.
if ($context === 'com_content.article' || $context === 'com_content.form') {
$this->itemStateChange($pks, $value);
}
// 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 Result object.
*
* @param Result $item The item to index as a Result object.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
protected function index(Result $item)
{
$item->setLanguage();
// Check if the extension is enabled.
if (ComponentHelper::isEnabled($this->extension) === false) {
return;
}
$item->context = 'com_content.article';
// Initialise the item parameters.
$registry = new Registry($item->params);
$item->params = clone ComponentHelper::getParams('com_content', true);
$item->params->merge($registry);
$item->metadata = new Registry($item->metadata);
// Trigger the onContentPrepare event.
$item->summary = Helper::prepareContent($item->summary, $item->params, $item);
$item->body = Helper::prepareContent($item->body, $item->params, $item);
// Create a URL as identifier to recognise items again.
$item->url = $this->getUrl($item->id, $this->extension, $this->layout);
// Build the necessary route and path information.
$item->route = RouteHelper::getArticleRoute($item->slug, $item->catid, $item->language);
// 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;
}
$images = $item->images ? json_decode($item->images) : false;
// Add the image.
if ($images && !empty($images->image_intro)) {
$item->imageUrl = $images->image_intro;
$item->imageAlt = $images->image_intro_alt ?? '';
}
// Add the meta author.
$item->metaauthor = $item->metadata->get('author');
// Add the metadata processing instructions.
$item->addInstruction(Indexer::META_CONTEXT, 'metakey');
$item->addInstruction(Indexer::META_CONTEXT, 'metadesc');
$item->addInstruction(Indexer::META_CONTEXT, 'metaauthor');
$item->addInstruction(Indexer::META_CONTEXT, 'author');
$item->addInstruction(Indexer::META_CONTEXT, 'created_by_alias');
// Translate the state. Articles should only be published if the category is published.
$item->state = $this->translateState($item->state, $item->cat_state);
// Get taxonomies to display
$taxonomies = $this->params->get('taxonomies', ['type', 'author', 'category', 'language']);
// Add the type taxonomy data.
if (\in_array('type', $taxonomies)) {
$item->addTaxonomy('Type', 'Article');
}
// Add the author taxonomy data.
if (\in_array('author', $taxonomies) && (!empty($item->author) || !empty($item->created_by_alias))) {
$item->addTaxonomy('Author', !empty($item->created_by_alias) ? $item->created_by_alias : $item->author, $item->state);
}
// Add the category taxonomy data.
$categories = $this->getApplication()->bootComponent('com_content')->getCategory(['published' => false, 'access' => false]);
$category = $categories->get($item->catid);
if (!$category) {
return;
}
// Add the category taxonomy data.
if (\in_array('category', $taxonomies)) {
$item->addNestedTaxonomy('Category', $category, $this->translateState($category->published), $category->access, $category->language);
}
// Add the language taxonomy data.
if (\in_array('language', $taxonomies)) {
$item->addTaxonomy('Language', $item->language);
}
// Get content extras.
Helper::getContentExtras($item);
Helper::addCustomFields($item, 'com_content.article');
// Index the item.
$this->indexer->index($item);
}
/**
* Method to get the SQL query used to retrieve the list of content items.
*
* @param mixed $query A DatabaseQuery object or null.
*
* @return DatabaseQuery A database object.
*
* @since 2.5
*/
protected function getListQuery($query = null)
{
$db = $this->getDatabase();
// Check if we can use the supplied SQL query.
$query = $query instanceof DatabaseQuery ? $query : $db->getQuery(true)
->select('a.id, a.title, a.alias, a.introtext AS summary, a.fulltext AS body')
->select('a.images')
->select('a.state, a.catid, a.created AS start_date, a.created_by')
->select('a.created_by_alias, a.modified, a.modified_by, a.attribs AS params')
->select('a.metakey, a.metadesc, a.metadata, a.language, a.access, a.version, a.ordering')
->select('a.publish_up AS publish_start_date, a.publish_down AS publish_end_date')
->select('c.title AS category, c.published AS cat_state, c.access AS cat_access');
// 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([$a_id, 'a.alias'], ':');
$case_when_item_alias .= ' ELSE ';
$case_when_item_alias .= $a_id . ' END as slug';
$query->select($case_when_item_alias);
$case_when_category_alias = ' CASE WHEN ';
$case_when_category_alias .= $query->charLength('c.alias', '!=', '0');
$case_when_category_alias .= ' THEN ';
$c_id = $query->castAsChar('c.id');
$case_when_category_alias .= $query->concatenate([$c_id, 'c.alias'], ':');
$case_when_category_alias .= ' ELSE ';
$case_when_category_alias .= $c_id . ' END as catslug';
$query->select($case_when_category_alias)
->select('u.name AS author')
->from('#__content AS a')
->join('LEFT', '#__categories AS c ON c.id = a.catid')
->join('LEFT', '#__users AS u ON u.id = a.created_by');
return $query;
}
}

View File

@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<extension type="plugin" group="finder" method="upgrade">
<name>plg_finder_newsfeeds</name>
<author>Joomla! Project</author>
<creationDate>2011-08</creationDate>
<copyright>(C) 2011 Open Source Matters, Inc.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>admin@joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>3.0.0</version>
<description>PLG_FINDER_NEWSFEEDS_XML_DESCRIPTION</description>
<namespace path="src">Joomla\Plugin\Finder\Newsfeeds</namespace>
<files>
<folder plugin="newsfeeds">services</folder>
<folder>src</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/plg_finder_newsfeeds.ini</language>
<language tag="en-GB">language/en-GB/plg_finder_newsfeeds.sys.ini</language>
</languages>
<config>
<fields name="params">
<fieldset name="basic" addfieldprefix="Joomla\Component\Finder\Administrator\Field">
<field
name="search_archived"
type="radio"
layout="joomla.form.field.radio.switcher"
label="PLG_FINDER_NEWSFEEDS_FIELD_SEARCH_ARCHIVED_LABEL"
description="PLG_FINDER_NEWSFEEDS_FIELD_SEARCH_ARCHIVED_DESC"
default="1"
filter="integer"
>
<option value="0">JNO</option>
<option value="1">JYES</option>
</field>
<field
name="taxonomies"
type="taxonomytypes"
label="PLG_FINDER_NEWSFEEDS_TAXONOMIES_LABEL"
default="type,category,language"
multiple="true"
>
<option value="category">PLG_FINDER_NEWSFEEDS_TAXONOMIES_CATEGORY</option>
<option value="language">PLG_FINDER_NEWSFEEDS_TAXONOMIES_LANGUAGE</option>
<option value="type">PLG_FINDER_NEWSFEEDS_TAXONOMIES_TYPE</option>
</field>
</fieldset>
</fields>
</config>
</extension>

View File

@ -0,0 +1,48 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.newsfeeds
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
\defined('_JEXEC') or die;
use Joomla\CMS\Extension\PluginInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Joomla\Event\DispatcherInterface;
use Joomla\Plugin\Finder\Newsfeeds\Extension\Newsfeeds;
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since 4.3.0
*/
public function register(Container $container)
{
$container->set(
PluginInterface::class,
function (Container $container) {
$plugin = new Newsfeeds(
$container->get(DispatcherInterface::class),
(array) PluginHelper::getPlugin('finder', 'newsfeeds')
);
$plugin->setApplication(Factory::getApplication());
$plugin->setDatabase($container->get(DatabaseInterface::class));
return $plugin;
}
);
}
};

View File

@ -0,0 +1,375 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.newsfeeds
*
* @copyright (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Finder\Newsfeeds\Extension;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Table\Table;
use Joomla\Component\Finder\Administrator\Indexer\Adapter;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Component\Finder\Administrator\Indexer\Indexer;
use Joomla\Component\Finder\Administrator\Indexer\Result;
use Joomla\Component\Newsfeeds\Site\Helper\RouteHelper;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseQuery;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Smart Search adapter for Joomla Newsfeeds.
*
* @since 2.5
*/
final class Newsfeeds extends Adapter
{
use DatabaseAwareTrait;
/**
* The plugin identifier.
*
* @var string
* @since 2.5
*/
protected $context = 'Newsfeeds';
/**
* The extension name.
*
* @var string
* @since 2.5
*/
protected $extension = 'com_newsfeeds';
/**
* The sublayout to use when rendering the results.
*
* @var string
* @since 2.5
*/
protected $layout = 'newsfeed';
/**
* The type of content that the adapter indexes.
*
* @var string
* @since 2.5
*/
protected $type_title = 'News Feed';
/**
* The table name.
*
* @var string
* @since 2.5
*/
protected $table = '#__newsfeeds';
/**
* 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 update the item link information when the item category is
* changed. This is fired when the item category is published or unpublished
* from the list view.
*
* @param string $extension The extension whose category has been updated.
* @param array $pks An array 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 onFinderCategoryChangeState($extension, $pks, $value)
{
// Make sure we're handling com_newsfeeds categories.
if ($extension === 'com_newsfeeds') {
$this->categoryStateChange($pks, $value);
}
}
/**
* Method to remove the link information for items that have been deleted.
*
* @param string $context The context of the action being performed.
* @param Table $table A Table object containing the record to be deleted.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterDelete($context, $table): void
{
if ($context === 'com_newsfeeds.newsfeed') {
$id = $table->id;
} elseif ($context === 'com_finder.index') {
$id = $table->link_id;
} else {
return;
}
// Remove the item from the index.
$this->remove($id);
}
/**
* Smart Search after save content method.
* Reindexes the link information for a newsfeed that has been saved.
* It also makes adjustments if the access level of a newsfeed item or
* the category to which it belongs has changed.
*
* @param string $context The context of the content passed to the plugin.
* @param Table $row A Table object.
* @param boolean $isNew True if the content has just been created.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
public function onFinderAfterSave($context, $row, $isNew): void
{
// We only want to handle newsfeeds here.
if ($context === 'com_newsfeeds.newsfeed') {
// 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 for access changes in the category.
if ($context === 'com_categories.category') {
// Check if the access levels are different.
if (!$isNew && $this->old_cataccess != $row->access) {
$this->categoryAccessChange($row);
}
}
}
/**
* Smart Search before content save method.
* This event is fired before the data is actually saved.
*
* @param string $context The context of the content passed to the plugin.
* @param Table $row A Table object.
* @param boolean $isNew True 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 newsfeeds here.
if ($context === 'com_newsfeeds.newsfeed') {
// Query the database for the old access level if the item isn't new.
if (!$isNew) {
$this->checkItemAccess($row);
}
}
// Check for access levels from the category.
if ($context === 'com_categories.category') {
// Query the database for the old access level if the item isn't new.
if (!$isNew) {
$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 An array 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 newsfeeds here.
if ($context === 'com_newsfeeds.newsfeed') {
$this->itemStateChange($pks, $value);
}
// 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 Result object.
*
* @param Result $item The item to index as a Result object.
*
* @return void
*
* @since 2.5
* @throws \Exception on database error.
*/
protected function index(Result $item)
{
// Check if the extension is enabled.
if (ComponentHelper::isEnabled($this->extension) === false) {
return;
}
$item->setLanguage();
// Initialize the item parameters.
$item->params = new Registry($item->params);
$item->metadata = new Registry($item->metadata);
// Create a URL as identifier to recognise items again.
$item->url = $this->getUrl($item->id, $this->extension, $this->layout);
// Build the necessary route and path information.
$item->route = RouteHelper::getNewsfeedRoute($item->slug, $item->catslug, $item->language);
/*
* Add the metadata processing instructions based on the newsfeeds
* configuration parameters.
*/
// Add the meta author.
$item->metaauthor = $item->metadata->get('author');
// Handle the link to the metadata.
$item->addInstruction(Indexer::META_CONTEXT, 'link');
$item->addInstruction(Indexer::META_CONTEXT, 'metakey');
$item->addInstruction(Indexer::META_CONTEXT, 'metadesc');
$item->addInstruction(Indexer::META_CONTEXT, 'metaauthor');
$item->addInstruction(Indexer::META_CONTEXT, 'author');
$item->addInstruction(Indexer::META_CONTEXT, 'created_by_alias');
// Get taxonomies to display
$taxonomies = $this->params->get('taxonomies', ['type', 'category', 'language']);
// Add the type taxonomy data.
if (\in_array('type', $taxonomies)) {
$item->addTaxonomy('Type', 'News Feed');
}
// Add the category taxonomy data.
$categories = $this->getApplication()->bootComponent('com_newsfeeds')->getCategory(['published' => false, 'access' => false]);
$category = $categories->get($item->catid);
if (!$category) {
return;
}
// Add the category taxonomy data.
if (\in_array('category', $taxonomies)) {
$item->addNestedTaxonomy('Category', $category, $this->translateState($category->published), $category->access, $category->language);
}
// Add the language taxonomy data.
if (\in_array('language', $taxonomies)) {
$item->addTaxonomy('Language', $item->language);
}
// Get content extras.
Helper::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()
{
return true;
}
/**
* Method to get the SQL query used to retrieve the list of content items.
*
* @param mixed $query A DatabaseQuery object or null.
*
* @return DatabaseQuery A database object.
*
* @since 2.5
*/
protected function getListQuery($query = null)
{
$db = $this->getDatabase();
// Check if we can use the supplied SQL query.
$query = $query instanceof DatabaseQuery ? $query : $db->getQuery(true)
->select('a.id, a.catid, a.name AS title, a.alias, a.link AS link')
->select('a.published AS state, a.ordering, a.created AS start_date, a.params, a.access')
->select('a.publish_up AS publish_start_date, a.publish_down AS publish_end_date')
->select('a.metakey, a.metadesc, a.metadata, a.language')
->select('a.created_by, a.created_by_alias, a.modified, a.modified_by')
->select('c.title AS category, c.published AS cat_state, c.access AS cat_access');
// 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([$a_id, 'a.alias'], ':');
$case_when_item_alias .= ' ELSE ';
$case_when_item_alias .= $a_id . ' END as slug';
$query->select($case_when_item_alias);
$case_when_category_alias = ' CASE WHEN ';
$case_when_category_alias .= $query->charLength('c.alias', '!=', '0');
$case_when_category_alias .= ' THEN ';
$c_id = $query->castAsChar('c.id');
$case_when_category_alias .= $query->concatenate([$c_id, 'c.alias'], ':');
$case_when_category_alias .= ' ELSE ';
$case_when_category_alias .= $c_id . ' END as catslug';
$query->select($case_when_category_alias)
->from('#__newsfeeds AS a')
->join('LEFT', '#__categories AS c ON c.id = a.catid');
return $query;
}
}

View File

@ -0,0 +1,48 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.tags
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
\defined('_JEXEC') or die;
use Joomla\CMS\Extension\PluginInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Database\DatabaseInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Joomla\Event\DispatcherInterface;
use Joomla\Plugin\Finder\Tags\Extension\Tags;
return new class () implements ServiceProviderInterface {
/**
* Registers the service provider with a DI container.
*
* @param Container $container The DI container.
*
* @return void
*
* @since 4.3.0
*/
public function register(Container $container)
{
$container->set(
PluginInterface::class,
function (Container $container) {
$plugin = new Tags(
$container->get(DispatcherInterface::class),
(array) PluginHelper::getPlugin('finder', 'tags')
);
$plugin->setApplication(Factory::getApplication());
$plugin->setDatabase($container->get(DatabaseInterface::class));
return $plugin;
}
);
}
};

View File

@ -0,0 +1,363 @@
<?php
/**
* @package Joomla.Plugin
* @subpackage Finder.tags
*
* @copyright (C) 2013 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Plugin\Finder\Tags\Extension;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Table\Table;
use Joomla\Component\Finder\Administrator\Indexer\Adapter;
use Joomla\Component\Finder\Administrator\Indexer\Helper;
use Joomla\Component\Finder\Administrator\Indexer\Indexer;
use Joomla\Component\Finder\Administrator\Indexer\Result;
use Joomla\Component\Tags\Site\Helper\RouteHelper;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseQuery;
use Joomla\Registry\Registry;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Finder adapter for Joomla Tag.
*
* @since 3.1
*/
final class Tags extends Adapter
{
use DatabaseAwareTrait;
/**
* The plugin identifier.
*
* @var string
* @since 3.1
*/
protected $context = 'Tags';
/**
* The extension name.
*
* @var string
* @since 3.1
*/
protected $extension = 'com_tags';
/**
* The sublayout to use when rendering the results.
*
* @var string
* @since 3.1
*/
protected $layout = 'tag';
/**
* The type of content that the adapter indexes.
*
* @var string
* @since 3.1
*/
protected $type_title = 'Tag';
/**
* The table name.
*
* @var string
* @since 3.1
*/
protected $table = '#__tags';
/**
* Load the language file on instantiation.
*
* @var boolean
* @since 3.1
*/
protected $autoloadLanguage = true;
/**
* The field the published state is stored in.
*
* @var string
* @since 3.1
*/
protected $state_field = 'published';
/**
* Method to remove the link information for items that have been deleted.
*
* @param string $context The context of the action being performed.
* @param Table $table A Table object containing the record to be deleted
*
* @return void
*
* @since 3.1
* @throws \Exception on database error.
*/
public function onFinderAfterDelete($context, $table): void
{
if ($context === 'com_tags.tag') {
$id = $table->id;
} elseif ($context === 'com_finder.index') {
$id = $table->link_id;
} else {
return;
}
// Remove the items.
$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 Table $row A Table object
* @param boolean $isNew If the content has just been created
*
* @return void
*
* @since 3.1
* @throws \Exception on database error.
*/
public function onFinderAfterSave($context, $row, $isNew): void
{
// We only want to handle tags here.
if ($context === 'com_tags.tag') {
// 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);
}
}
/**
* 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 Table $row A Table object
* @param boolean $isNew If the content is just about to be created
*
* @return boolean True on success.
*
* @since 3.1
* @throws \Exception on database error.
*/
public function onFinderBeforeSave($context, $row, $isNew)
{
// We only want to handle news feeds here
if ($context === 'com_tags.tag') {
// Query the database for the old access level if the item isn't new
if (!$isNew) {
$this->checkItemAccess($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 3.1
*/
public function onFinderChangeState($context, $pks, $value)
{
// We only want to handle tags here
if ($context === 'com_tags.tag') {
$this->itemStateChange($pks, $value);
}
// 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 Result object.
*
* @param Result $item The item to index as a Result object.
*
* @return void
*
* @since 3.1
* @throws \Exception on database error.
*/
protected function index(Result $item)
{
// Check if the extension is enabled
if (ComponentHelper::isEnabled($this->extension) === false) {
return;
}
$item->setLanguage();
// Initialize the item parameters.
$registry = new Registry($item->params);
$item->params = clone ComponentHelper::getParams('com_tags', true);
$item->params->merge($registry);
$item->metadata = new Registry($item->metadata);
// Create a URL as identifier to recognise items again.
$item->url = $this->getUrl($item->id, $this->extension, $this->layout);
// Build the necessary route and path information.
$item->route = RouteHelper::getComponentTagRoute($item->slug, $item->language);
// 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;
}
// Add the meta author.
$item->metaauthor = $item->metadata->get('author');
// Handle the link to the metadata.
$item->addInstruction(Indexer::META_CONTEXT, 'link');
$item->addInstruction(Indexer::META_CONTEXT, 'metakey');
$item->addInstruction(Indexer::META_CONTEXT, 'metadesc');
$item->addInstruction(Indexer::META_CONTEXT, 'metaauthor');
$item->addInstruction(Indexer::META_CONTEXT, 'author');
$item->addInstruction(Indexer::META_CONTEXT, 'created_by_alias');
// Get taxonomies to display
$taxonomies = $this->params->get('taxonomies', ['type', 'author', 'language']);
// Add the type taxonomy data.
if (\in_array('type', $taxonomies)) {
$item->addTaxonomy('Type', 'Tag');
}
// Add the author taxonomy data.
if (\in_array('author', $taxonomies) && (!empty($item->author) || !empty($item->created_by_alias))) {
$item->addTaxonomy('Author', !empty($item->created_by_alias) ? $item->created_by_alias : $item->author);
}
// Add the language taxonomy data.
if (\in_array('language', $taxonomies)) {
$item->addTaxonomy('Language', $item->language);
}
// Get content extras.
Helper::getContentExtras($item);
// Index the item.
$this->indexer->index($item);
}
/**
* Method to setup the indexer to be run.
*
* @return boolean True on success.
*
* @since 3.1
*/
protected function setup()
{
return true;
}
/**
* Method to get the SQL query used to retrieve the list of content items.
*
* @param mixed $query A DatabaseQuery object or null.
*
* @return DatabaseQuery A database object.
*
* @since 3.1
*/
protected function getListQuery($query = null)
{
$db = $this->getDatabase();
// Check if we can use the supplied SQL query.
$query = $query instanceof DatabaseQuery ? $query : $db->getQuery(true)
->select('a.id, a.title, a.alias, a.description AS summary')
->select('a.created_time AS start_date, a.created_user_id AS created_by')
->select('a.metakey, a.metadesc, a.metadata, a.language, a.access')
->select('a.modified_time AS modified, a.modified_user_id AS modified_by')
->select('a.published AS state, a.access, a.created_time AS start_date, 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([$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('#__tags AS a');
// Join the #__users table
$query->select('u.name AS author')
->join('LEFT', '#__users AS u ON u.id = a.created_user_id');
// Exclude the ROOT item
$query->where($db->quoteName('a.id') . ' > 1');
return $query;
}
/**
* Method to get a SQL query to load the published and access states for the given tag.
*
* @return DatabaseQuery A database object.
*
* @since 3.1
*/
protected function getStateQuery()
{
$query = $this->getDatabase()->getQuery(true);
$query->select($this->getDatabase()->quoteName('a.id'))
->select($this->getDatabase()->quoteName('a.' . $this->state_field, 'state') . ', ' . $this->getDatabase()->quoteName('a.access'))
->select('NULL AS cat_state, NULL AS cat_access')
->from($this->getDatabase()->quoteName($this->table, 'a'));
return $query;
}
/**
* Method to get the query clause for getting items to update by time.
*
* @param string $time The modified timestamp.
*
* @return DatabaseQuery A database object.
*
* @since 3.1
*/
protected function getUpdateQueryByTime($time)
{
// Build an SQL query based on the modified time.
$query = $this->getDatabase()->getQuery(true)
->where('a.date >= ' . $this->getDatabase()->quote($time));
return $query;
}
}

View File

@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<extension type="plugin" group="finder" method="upgrade">
<name>plg_finder_tags</name>
<author>Joomla! Project</author>
<creationDate>2013-02</creationDate>
<copyright>(C) 2013 Open Source Matters, Inc.</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>admin@joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>3.0.0</version>
<description>PLG_FINDER_TAGS_XML_DESCRIPTION</description>
<namespace path="src">Joomla\Plugin\Finder\Tags</namespace>
<files>
<folder plugin="tags">services</folder>
<folder>src</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/plg_finder_tags.ini</language>
<language tag="en-GB">language/en-GB/plg_finder_tags.sys.ini</language>
</languages>
<config>
<fields name="params">
<fieldset name="basic" addfieldprefix="Joomla\Component\Finder\Administrator\Field">
<field
name="search_archived"
type="radio"
layout="joomla.form.field.radio.switcher"
label="PLG_FINDER_TAGS_FIELD_SEARCH_ARCHIVED_LABEL"
description="PLG_FINDER_TAGS_FIELD_SEARCH_ARCHIVED_DESC"
default="1"
filter="integer"
>
<option value="0">JNO</option>
<option value="1">JYES</option>
</field>
<field
name="taxonomies"
type="taxonomytypes"
label="PLG_FINDER_TAGS_TAXONOMIES_LABEL"
default="type,language,author"
multiple="true"
>
<option value="author">PLG_FINDER_TAGS_TAXONOMIES_AUTHOR</option>
<option value="language">PLG_FINDER_TAGS_TAXONOMIES_LANGUAGE</option>
<option value="type">PLG_FINDER_TAGS_TAXONOMIES_TYPE</option>
</field>
</fieldset>
</fields>
</config>
</extension>