[4.0] Introduce category factory

administrator/components/com_banners/services/provider.php

@@ -9,15 +9,15 @@
 
 defined('_JEXEC') or die;
 
-use Joomla\CMS\Categories\Categories;
+use Joomla\CMS\Categories\CategoriesFactoryInterface;
 use Joomla\CMS\Dispatcher\DispatcherFactoryInterface;
 use Joomla\CMS\Extension\ComponentInterface;
+use Joomla\CMS\Extension\Service\Provider\CategoriesFactory;
 use Joomla\CMS\Extension\Service\Provider\DispatcherFactory;
 use Joomla\CMS\Extension\Service\Provider\MVCFactoryFactory;
 use Joomla\CMS\HTML\Registry;
 use Joomla\CMS\MVC\Factory\MVCFactoryFactoryInterface;
 use Joomla\Component\Banners\Administrator\Extension\BannersComponent;
-use Joomla\Component\Banners\Site\Service\Category;
 use Joomla\DI\Container;
 use Joomla\DI\ServiceProviderInterface;
 
@@ -39,8 +39,7 @@
 	 */
 	public function register(Container $container)
 	{
-		$container->set(Categories::class, ['' => new Category]);
-
+		$container->registerServiceProvider(new CategoriesFactory(['table' => '#__banners', 'extension' => 'com_banners']));
 		$container->registerServiceProvider(new MVCFactoryFactory('\\Joomla\\Component\\Banners'));
 		$container->registerServiceProvider(new DispatcherFactory('\\Joomla\\Component\\Banners'));
 
@@ -52,7 +51,7 @@ function (Container $container)
 
 				$component->setRegistry($container->get(Registry::class));
 				$component->setMvcFactoryFactory($container->get(MVCFactoryFactoryInterface::class));
-				$component->setCategories($container->get(Categories::class));
+				$component->setCategoriesFactory($container->get(CategoriesFactoryInterface::class));
 
 				return $component;
 			}

administrator/components/com_content/services/provider.php

@@ -10,16 +10,16 @@
 defined('_JEXEC') or die;
 
 use Joomla\CMS\Association\AssociationExtensionInterface;
-use Joomla\CMS\Categories\Categories;
+use Joomla\CMS\Categories\CategoriesFactoryInterface;
 use Joomla\CMS\Dispatcher\DispatcherFactoryInterface;
 use Joomla\CMS\Extension\ComponentInterface;
+use Joomla\CMS\Extension\Service\Provider\CategoriesFactory;
 use Joomla\CMS\Extension\Service\Provider\DispatcherFactory;
 use Joomla\CMS\Extension\Service\Provider\MVCFactoryFactory;
 use Joomla\CMS\HTML\Registry;
 use Joomla\CMS\MVC\Factory\MVCFactoryFactoryInterface;
 use Joomla\Component\Content\Administrator\Extension\ContentComponent;
 use Joomla\Component\Content\Administrator\Helper\AssociationsHelper;
-use Joomla\Component\Content\Site\Service\Category;
 use Joomla\DI\Container;
 use Joomla\DI\ServiceProviderInterface;
 
@@ -41,9 +41,9 @@
 	 */
 	public function register(Container $container)
 	{
-		$container->set(Categories::class, ['' => new Category]);
 		$container->set(AssociationExtensionInterface::class, new AssociationsHelper);
 
+		$container->registerServiceProvider(new CategoriesFactory(['table' => '#__content', 'extension' => 'com_content']));
 		$container->registerServiceProvider(new MVCFactoryFactory('\\Joomla\\Component\\Content'));
 		$container->registerServiceProvider(new DispatcherFactory('\\Joomla\\Component\\Content'));
 
@@ -55,7 +55,7 @@ function (Container $container)
 
 				$component->setRegistry($container->get(Registry::class));
 				$component->setMvcFactoryFactory($container->get(MVCFactoryFactoryInterface::class));
-				$component->setCategories($container->get(Categories::class));
+				$component->setCategoriesFactory($container->get(CategoriesFactoryInterface::class));
 				$component->setAssociationExtension($container->get(AssociationExtensionInterface::class));
 
 				return $component;

administrator/components/com_fields/Model/FieldModel.php

@@ -983,7 +983,7 @@ protected function preprocessForm(\JForm $form, $data, $group = 'content')
 				throw new SectionNotFoundException;
 			}
 
-			$cat = $componentObject->getCategories();
+			$cat = $componentObject->getCategory();
 
 			if ($cat->get('root')->hasChildren())
 			{

libraries/src/Categories/Categories.php

@@ -18,7 +18,7 @@
  *
  * @since  1.6
  */
-class Categories
+class Categories implements CategoryInterface
 {
 	/**
 	 * Array to hold the object instances
@@ -146,7 +146,7 @@ public static function getInstance($extension, $options = array())
 
 			if ($component instanceof CategoriesServiceInterface)
 			{
-				$categories = $component->getCategories($options, count($parts) > 1 ? $parts[1] : '');
+				$categories = $component->getCategory($options, count($parts) > 1 ? $parts[1] : '');
 			}
 		}
 		catch (SectionNotFoundException $e)
@@ -160,16 +160,18 @@ public static function getInstance($extension, $options = array())
 	}
 
 	/**
-	 * Loads a specific category and all its children in a CategoryNode object
+	 * Loads a specific category and all its children in a CategoryNode object.
 	 *
 	 * @param   mixed    $id         an optional id integer or equal to 'root'
 	 * @param   boolean  $forceload  True to force  the _load method to execute
 	 *
-	 * @return  CategoryNode|null|boolean  CategoryNode object or null if $id is not valid
+	 * @return  CategoryNode  CategoryNode object
 	 *
 	 * @since   1.6
+	 *
+	 * @throws  CategoryNotFoundException
 	 */
-	public function get($id = 'root', $forceload = false)
+	public function get($id = 'root', $forceload = false): CategoryNode
 	{
 		if ($id !== 'root')
 		{
@@ -192,13 +194,8 @@ public function get($id = 'root', $forceload = false)
 		{
 			return $this->_nodes[$id];
 		}
-		// If we processed this $id already and it was not valid, then return null.
-		elseif (isset($this->_checkedCategories[$id]))
-		{
-			return;
-		}
 
-		return false;
+		throw new CategoryNotFoundException;
 	}
 
 	/**

libraries/src/Categories/CategoriesFactory.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+namespace Joomla\CMS\Categories;
+
+defined('_JEXEC') or die;
+
+/**
+ * Option based categories factory.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class CategoriesFactory implements CategoriesFactoryInterface
+{
+	/**
+	 * The options
+	 *
+	 * @var  array
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	private $options;
+
+	/**
+	 * CategoriesFactory constructor.
+	 *
+	 * @param   array  $options  The options
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function __construct(array $options)
+	{
+		$this->options = $options;
+	}
+
+	/**
+	 * Creates a category.
+	 *
+	 * @param   string  $section  The section
+	 *
+	 * @return  CategoryInterface
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 *
+	 * @throws  SectionNotFoundException
+	 */
+	public function createCategory(string $section): CategoryInterface
+	{
+		if (!array_key_exists($section, $this->options))
+		{
+			throw new SectionNotFoundException;
+		}
+
+		return new Categories($this->options[$section]);
+	}
+}

libraries/src/Categories/CategoriesFactoryInterface.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\CMS\Categories;
+
+defined('_JEXEC') or die;
+
+/**
+ * Categories factory interface
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+interface CategoriesFactoryInterface
+{
+	/**
+	 * Creates a category.
+	 *
+	 * @param   string  $section  The section
+	 *
+	 * @return  CategoryInterface
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 *
+	 * @throws  SectionNotFoundException
+	 */
+	public function createCategory(string $section): CategoryInterface;
+}

libraries/src/Categories/CategoriesServiceInterface.php

@@ -25,14 +25,14 @@ interface CategoriesServiceInterface
 	 * @param   array   $options  The options
 	 * @param   string  $section  The section
 	 *
-	 * @return  Categories
+	 * @return  CategoryInterface
 	 *
-	 * @see Categories::setOptions()
+	 * @see     CategoryInterface::setOptions()
 	 *
 	 * @since   4.0.0
 	 * @throws  SectionNotFoundException
 	 */
-	public function getCategories(array $options = [], $section = ''): Categories;
+	public function getCategory(array $options = [], $section = ''): CategoryInterface;
 
 	/**
 	 * Adds Count Items for Category Manager.

libraries/src/Categories/CategoriesServiceTrait.php

@@ -21,54 +21,47 @@
 trait CategoriesServiceTrait
 {
 	/**
-	 * An array of categories.
+	 * The categories factory
 	 *
-	 * @var  Categories[]
+	 * @var  CategoriesFactoryInterface
 	 *
 	 * @since  4.0.0
 	 */
-	private $categories;
+	private $categoriesFactory;
 
 	/**
 	 * Returns the category service.
 	 *
 	 * @param   array   $options  The options
 	 * @param   string  $section  The section
 	 *
-	 * @return  Categories
+	 * @return  CategoryInterface
 	 *
-	 * @see Categories::setOptions()
+	 * @see     CategoryInterface::setOptions()
 	 *
 	 * @since   4.0.0
 	 * @throws  SectionNotFoundException
 	 */
-	public function getCategories(array $options = [], $section = ''): Categories
+	public function getCategory(array $options = [], $section = ''): CategoryInterface
 	{
-		if (!array_key_exists($section, $this->categories))
-		{
-			throw new SectionNotFoundException;
-		}
-
-		$categories = clone $this->categories[$section];
-		$categories->setOptions($options);
+		$category = $this->categoriesFactory->createCategory($section);
+		$category->setOptions($options);
 
-		return $categories;
+		return $category;
 	}
 
 	/**
-	 * An array of categories where the key is the name of the section.
-	 * If the component has no sections then the array must have at least
-	 * an empty key.
+	 * Sets the internal categories factory.
 	 *
-	 * @param   array  $categories  The categories
+	 * @param   CategoriesFactoryInterface  $categoriesFactory  The categories factory
 	 *
 	 * @return  void
 	 *
 	 * @since  4.0.0
 	 */
-	public function setCategories(array $categories)
+	public function setCategoriesFactory(CategoriesFactoryInterface $categoriesFactory)
 	{
-		$this->categories = $categories;
+		$this->categoriesFactory = $categoriesFactory;
 	}
 
 	/**