start

libraries/src/Event/Model/ListQueryEvent.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  (C) 2020 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\CMS\Event\Model;
+
+\defined('JPATH_PLATFORM') or die;
+
+use BadMethodCallException;
+use Joomla\CMS\Event\AbstractEvent;
+use Joomla\CMS\MVC\Model\ListModelInterface;
+
+/**
+ * Event class for modifying a list query
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class ListQueryEvent extends AbstractEvent
+{
+	/**
+	 * Mandatory arguments:
+	 * subject		ListModelInterface	The model instance we are operating on.
+	 * context		string			    The model context.
+	 * query		QueryInterface		Database query.
+	 *
+	 * @param   string  $name       The event name.
+	 * @param   array   $arguments  The event arguments.
+	 *
+	 * @throws  BadMethodCallException
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function __construct($name, array $arguments = array())
+	{
+		if (!\array_key_exists('subject', $arguments))
+		{
+			throw new BadMethodCallException("Argument 'subject' of event {$this->name} is required but has not been provided");
+		}
+
+		if (!\array_key_exists('context', $arguments))
+		{
+			throw new BadMethodCallException("Argument 'context' is required for event $name");
+		}
+
+		if (!\array_key_exists('query', $arguments))
+		{
+			throw new BadMethodCallException("Argument 'query' is required for event $name");
+		}
+
+		parent::__construct($name, $arguments);
+	}
+
+	/**
+	 * Setter for the subject argument
+	 *
+	 * @param   ListModelInterface  $value  The value to set
+	 *
+	 * @return  ListModelInterface
+	 *
+	 * @throws  BadMethodCallException  If the argument is not of the expected type.
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function setSubject($value)
+	{
+		if (!\is_object($value) || !($value instanceof ListModelInterface))
+		{
+			throw new BadMethodCallException("Argument 'subject' of event {$this->name} is not of the expected type");
+		}
+
+		return $value;
+	}
+}

libraries/src/MVC/Model/ListModel.php

@@ -11,6 +11,7 @@
 \defined('JPATH_PLATFORM') or die;
 
 use Exception;
+use Joomla\CMS\Event\Model\ListQueryEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Filter\InputFilter;
 use Joomla\CMS\Form\Form;
@@ -121,6 +122,14 @@ class ListModel extends BaseDatabaseModel implements FormFactoryAwareInterface,
 	 */
 	protected $listForbiddenList = array('select');
 
+	/**
+	 * The event to trigger on list query
+	 *
+	 * @var    string
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $event_list_query;
+
 	/**
 	 * Constructor
 	 *
@@ -157,6 +166,15 @@ public function __construct($config = array(), MVCFactoryInterface $factory = nu
 		{
 			$this->listForbiddenList = array_merge($this->listBlacklist, $this->listForbiddenList);
 		}
+
+		if (isset($config['event_list_query']))
+		{
+			$this->event_list_query = $config['event_list_query'];
+		}
+		elseif (empty($this->event_list_query))
+		{
+			$this->event_list_query = 'onContentListQuery';
+		}
 	}
 
 	/**
@@ -216,6 +234,16 @@ protected function _getListQuery()
 		{
 			$this->lastQueryStoreId = $currentStoreId;
 			$this->query            = $this->getListQuery();
+
+			$event = new ListQueryEvent(
+				$this->event_list_query,
+				[
+					'subject' => $this,
+					'context' => $this->context,
+					'query' => $this->query,
+				]
+			);
+			$this->dispatchEvent($event);
 		}
 
 		return $this->query;