[4.0] Introduce router service

administrator/components/com_content/Extension/ContentComponent.php

@@ -30,18 +30,25 @@
 use Psr\Container\ContainerInterface;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\Factory;
+use Joomla\CMS\Component\Router\RouterServiceInterface;
+use Joomla\CMS\Component\Router\RouterServiceTrait;
 
 /**
  * Component class for com_content
  *
  * @since  __DEPLOY_VERSION__
  */
 class ContentComponent extends MVCComponent implements
-	BootableExtensionInterface, MVCFactoryServiceInterface, CategoriesServiceInterface, FieldsServiceInterface,
-	AssociationServiceInterface, WorkflowServiceInterface
+	BootableExtensionInterface,
+	CategoriesServiceInterface,
+	FieldsServiceInterface,
+	AssociationServiceInterface,
+	RouterServiceInterface,
+	WorkflowServiceInterface
 {
 	use CategoriesServiceTrait;
 	use AssociationServiceTrait;
+	use RouterServiceTrait;
 	use HTMLRegistryAwareTrait;
 	use WorkflowServiceTrait;
 

administrator/components/com_content/Service/Provider/RouterFactory.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Component\Content\Administrator\Service\Provider;
+
+defined('JPATH_PLATFORM') or die;
+
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+use Joomla\CMS\Component\Router\RouterFactoryInterface;
+use Joomla\CMS\Categories\Categories;
+use Joomla\Database\DatabaseInterface;
+
+/**
+ * Service provider for the service dispatcher factory.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class RouterFactory implements ServiceProviderInterface
+{
+	/**
+	 * Registers the service provider with a DI container.
+	 *
+	 * @param   Container  $container  The DI container.
+	 *
+	 * @return  void
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function register(Container $container)
+	{
+		$container->set(
+			RouterFactoryInterface::class,
+			function (Container $container)
+			{
+				return new \Joomla\Component\Content\Site\Router\RouterFactory(
+					$container->get(Categories::class)[''],
+					$container->get(DatabaseInterface::class)
+				);
+			}
+		);
+	}
+}

administrator/components/com_content/services/provider.php

@@ -22,6 +22,8 @@
 use Joomla\Component\Content\Site\Service\Category;
 use Joomla\DI\Container;
 use Joomla\DI\ServiceProviderInterface;
+use Joomla\CMS\Component\Router\RouterFactoryInterface;
+use Joomla\Component\Content\Administrator\Service\Provider\RouterFactory;
 
 /**
  * The content service provider.
@@ -46,6 +48,7 @@ public function register(Container $container)
 
 		$container->registerServiceProvider(new MVCFactoryFactory('\\Joomla\\Component\\Content'));
 		$container->registerServiceProvider(new DispatcherFactory('\\Joomla\\Component\\Content'));
+		$container->registerServiceProvider(new RouterFactory);
 
 		$container->set(
 			ComponentInterface::class,
@@ -57,6 +60,7 @@ function (Container $container)
 				$component->setMvcFactoryFactory($container->get(MVCFactoryFactoryInterface::class));
 				$component->setCategories($container->get(Categories::class));
 				$component->setAssociationExtension($container->get(AssociationExtensionInterface::class));
+				$component->setRouterFactory($container->get(RouterFactoryInterface::class));
 
 				return $component;
 			}

components/com_content/router.php → components/com_content/Router/ContentRouter.php

@@ -7,18 +7,20 @@
  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  */
 
+namespace Joomla\Component\Content\Site\Router;
+
 defined('_JEXEC') or die;
 
-use Joomla\CMS\Application\CMSApplication;
+use Joomla\CMS\Application\SiteApplication;
+use Joomla\CMS\Categories\Categories;
 use Joomla\CMS\Component\ComponentHelper;
 use Joomla\CMS\Component\Router\RouterView;
 use Joomla\CMS\Component\Router\RouterViewConfiguration;
 use Joomla\CMS\Component\Router\Rules\MenuRules;
 use Joomla\CMS\Component\Router\Rules\NomenuRules;
 use Joomla\CMS\Component\Router\Rules\StandardRules;
 use Joomla\CMS\Menu\AbstractMenu;
-use Joomla\CMS\Categories\Categories;
-use Joomla\CMS\Factory;
+use Joomla\Database\DatabaseInterface;
 
 /**
  * Routing class of com_content
@@ -29,14 +31,37 @@ class ContentRouter extends RouterView
 {
 	protected $noIDs = false;
 
+	/**
+	 * The category
+	 *
+	 * @var Categories
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private $category;
+
+	/**
+	 * The db
+	 *
+	 * @var DatabaseInterface
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private $db;
+
 	/**
 	 * Content Component router constructor
 	 *
-	 * @param   CMSApplication  $app   The application object
-	 * @param   AbstractMenu    $menu  The menu object to work with
+	 * @param   SiteApplication    $app       The application object
+	 * @param   AbstractMenu       $menu      The menu object to work with
+	 * @param   Categories         $category  The category object
+	 * @param   DatabaseInterface  $db        The database object
 	 */
-	public function __construct($app = null, $menu = null)
+	public function __construct(SiteApplication $app, AbstractMenu $menu, Categories $category, DatabaseInterface $db)
 	{
+		$this->category = $category;
+		$this->db       = $db;
+
 		$params = ComponentHelper::getParams('com_content');
 		$this->noIDs = (bool) $params->get('sef_ids');
 		$categories = new RouterViewConfiguration('categories');
@@ -71,7 +96,8 @@ public function __construct($app = null, $menu = null)
 	 */
 	public function getCategorySegment($id, $query)
 	{
-		$category = Categories::getInstance($this->getName())->get($id);
+		$this->category->setOptions(array('access' => true));
+		$category = $this->category->get($id);
 
 		if ($category)
 		{
@@ -117,14 +143,13 @@ public function getArticleSegment($id, $query)
 	{
 		if (!strpos($id, ':'))
 		{
-			$db = Factory::getDbo();
-			$dbquery = $db->getQuery(true);
+			$dbquery = $this->db->getQuery(true);
 			$dbquery->select($dbquery->qn('alias'))
 				->from($dbquery->qn('#__content'))
 				->where('id = ' . $dbquery->q($id));
-			$db->setQuery($dbquery);
+			$this->db->setQuery($dbquery);
 
-			$id .= ':' . $db->loadResult();
+			$id .= ':' . $this->db->loadResult();
 		}
 
 		if ($this->noIDs)
@@ -164,7 +189,9 @@ public function getCategoryId($segment, $query)
 	{
 		if (isset($query['id']))
 		{
-			$category = Categories::getInstance($this->getName(), array('access' => false))->get($query['id']);
+			$this->category->setOptions(array('access' => false));
+
+			$category = $this->category->get($query['id']);
 
 			if ($category)
 			{
@@ -216,15 +243,14 @@ public function getArticleId($segment, $query)
 	{
 		if ($this->noIDs)
 		{
-			$db = Factory::getDbo();
-			$dbquery = $db->getQuery(true);
+			$dbquery = $this->db->getQuery(true);
 			$dbquery->select($dbquery->qn('id'))
 				->from($dbquery->qn('#__content'))
 				->where('alias = ' . $dbquery->q($segment))
 				->where('catid = ' . $dbquery->q($query['id']));
-			$db->setQuery($dbquery);
+			$this->db->setQuery($dbquery);
 
-			return (int) $db->loadResult();
+			return (int) $this->db->loadResult();
 		}
 
 		return (int) $segment;

components/com_content/Router/RouterFactory.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\Component\Content\Site\Router;
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Application\CMSApplicationInterface;
+use Joomla\CMS\Application\SiteApplication;
+use Joomla\CMS\Component\Router\RouterFactoryInterface;
+use Joomla\CMS\Component\Router\RouterInterface;
+use Joomla\CMS\Menu\AbstractMenu;
+use Joomla\Component\Content\Site\Service\Category;
+use Joomla\Database\DatabaseInterface;
+
+/**
+ * Content router factory.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class RouterFactory implements RouterFactoryInterface
+{
+	/**
+	 * The category
+	 *
+	 * @var Category
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private $category;
+
+	/**
+	 * The db
+	 *
+	 * @var DatabaseInterface
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private $db;
+
+	/**
+	 * Content Component router factory constructor
+	 *
+	 * @param   Category           $category  The category object
+	 * @param   DatabaseInterface  $db        The database object
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function __construct(Category $category, DatabaseInterface $db)
+	{
+		$this->category = $category;
+		$this->db       = $db;
+	}
+
+	/**
+	 * Creates a router.
+	 *
+	 * @param   CMSApplicationInterface  $application  The application
+	 * @param   AbstractMenu             $menu         The menu object to work with
+	 *
+	 * @return  RouterInterface
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function createRouter(CMSApplicationInterface $application, AbstractMenu $menu): RouterInterface
+	{
+		if (!$application instanceof SiteApplication)
+		{
+			throw new \RuntimeException('No router available for this application.');
+		}
+
+		return new ContentRouter($application, $menu, $this->category, $this->db);
+	}
+}

libraries/src/Component/Router/RouterFactoryInterface.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\CMS\Component\Router;
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Application\CMSApplicationInterface;
+use Joomla\CMS\Menu\AbstractMenu;
+
+/**
+ * Router factory interface
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+interface RouterFactoryInterface
+{
+	/**
+	 * Creates a router.
+	 *
+	 * @param   CMSApplicationInterface  $application  The application
+	 * @param   AbstractMenu             $menu         The menu object to work with
+	 *
+	 * @return  RouterInterface
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function createRouter(CMSApplicationInterface $application, AbstractMenu $menu): RouterInterface;
+}

libraries/src/Component/Router/RouterServiceInterface.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\CMS\Component\Router;
+
+defined('JPATH_PLATFORM') or die;
+
+use Joomla\CMS\Application\CMSApplicationInterface;
+use Joomla\CMS\Menu\AbstractMenu;
+
+/**
+ * The component router service.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+interface RouterServiceInterface
+{
+	/**
+	 * Returns the router.
+	 *
+	 * @param   CMSApplicationInterface  $application  The application object
+	 * @param   AbstractMenu             $menu         The menu object to work with
+	 *
+	 * @return  RouterInterface
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public function createRouter(CMSApplicationInterface $application, AbstractMenu $menu): RouterInterface;
+}