[4.0] Move component categories helper to services

administrator/components/com_content/services/services.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  com_content
+ *
+ * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+$container->share(
+	'ContentComponentContainer',
+	function (\Joomla\DI\Container $parent)
+	{
+		$container = new \Joomla\CMS\Extension\ComponentContainer($parent);
+		$container->set('categories', new \Joomla\Component\Content\Site\Service\Category);
+
+		return $container;
+	},
+	true
+);

administrator/components/com_fields/Model/FieldModel.php

@@ -967,7 +967,7 @@ protected function preprocessForm(\JForm $form, $data, $group = 'content')
 		}
 
 		// Setting the context for the category field
-		$cat = \JCategories::getInstance(str_replace('com_', '', $component));
+		$cat = $this->bootComponent($component)->getCategories();
 
 		if ($cat && $cat->get('root')->hasChildren())
 		{

components/com_content/helpers/category.php → components/com_content/Service/Category.php

@@ -6,15 +6,18 @@
  * @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\Site\Service;
 
 defined('_JEXEC') or die;
 
+use Joomla\CMS\Categories\Categories;
+
 /**
  * Content Component Category Tree
  *
  * @since  1.6
  */
-class ContentCategories extends JCategories
+class Category extends Categories
 {
 	/**
 	 * Class constructor
@@ -25,7 +28,7 @@ class ContentCategories extends JCategories
 	 */
 	public function __construct($options = array())
 	{
-		$options['table'] = '#__content';
+		$options['table']     = '#__content';
 		$options['extension'] = 'com_content';
 
 		parent::__construct($options);

libraries/src/Application/CMSApplication.php

@@ -14,6 +14,7 @@
 use Joomla\CMS\Authentication\Authentication;
 use Joomla\CMS\Event\AbstractEvent;
 use Joomla\CMS\Event\BeforeExecuteEvent;
+use Joomla\CMS\Extension\ExtensionLoader;
 use Joomla\CMS\Input\Input;
 use Joomla\CMS\Language\Language;
 use Joomla\CMS\Menu\AbstractMenu;
@@ -35,7 +36,7 @@
  */
 abstract class CMSApplication extends WebApplication implements ContainerAwareInterface, CMSApplicationInterface
 {
-	use ContainerAwareTrait, ExtensionNamespaceMapper;
+	use ContainerAwareTrait, ExtensionLoader, ExtensionNamespaceMapper;
 
 	/**
 	 * Array of options for the \JDocument object

libraries/src/Application/CMSApplicationInterface.php

@@ -8,6 +8,7 @@
 
 namespace Joomla\CMS\Application;
 
+use Joomla\CMS\Extension\ExtensionLoaderInterface;
 use Joomla\CMS\User\User;
 use Joomla\Session\SessionInterface;
 
@@ -16,7 +17,7 @@
  *
  * @since  4.0.0
  */
-interface CMSApplicationInterface
+interface CMSApplicationInterface extends ExtensionLoaderInterface
 {
 	/**
 	 * Constant defining an enqueued emergency message

libraries/src/Application/CliApplication.php

@@ -14,6 +14,7 @@
 use Joomla\CMS\Application\CLI\CliInput;
 use Joomla\CMS\Application\CLI\CliOutput;
 use Joomla\CMS\Application\CLI\Output\Stdout;
+use Joomla\CMS\Extension\ExtensionLoader;
 use Joomla\Input\Cli;
 use Joomla\Input\Input;
 use Joomla\DI\Container;
@@ -32,7 +33,7 @@
  */
 abstract class CliApplication extends AbstractApplication implements DispatcherAwareInterface, CMSApplicationInterface
 {
-	use DispatcherAwareTrait, EventAware, IdentityAware, ContainerAwareTrait;
+	use DispatcherAwareTrait, EventAware, IdentityAware, ContainerAwareTrait, ExtensionLoader;
 
 	/**
 	 * Output object

libraries/src/Application/ConsoleApplication.php

@@ -11,6 +11,7 @@
 defined('JPATH_PLATFORM') or die;
 
 use Joomla\CMS\Console;
+use Joomla\CMS\Extension\ExtensionLoader;
 use Joomla\CMS\Input\Cli;
 use Joomla\CMS\Plugin\PluginHelper;
 use Joomla\Console\Application;
@@ -30,7 +31,7 @@
  */
 class ConsoleApplication extends Application implements DispatcherAwareInterface, CMSApplicationInterface
 {
-	use DispatcherAwareTrait, EventAware, IdentityAware, ContainerAwareTrait;
+	use DispatcherAwareTrait, EventAware, IdentityAware, ContainerAwareTrait, ExtensionLoader;
 
 	/**
 	 * The application message queue.

libraries/src/Categories/Categories.php

@@ -90,7 +90,7 @@ class Categories
 	 * @var    array
 	 * @since  1.6
 	 */
-	protected $_options = null;
+	protected $_options = [];
 
 	/**
 	 * Class constructor
@@ -101,20 +101,20 @@ class Categories
 	 */
 	public function __construct($options)
 	{
+		// Required options
 		$this->_extension  = $options['extension'];
 		$this->_table      = $options['table'];
 		$this->_field      = isset($options['field']) && $options['field'] ? $options['field'] : 'catid';
 		$this->_key        = isset($options['key']) && $options['key'] ? $options['key'] : 'id';
 		$this->_statefield = $options['statefield'] ?? 'state';
 
-		$options['access']      = $options['access'] ?? 'true';
-		$options['published']   = $options['published'] ?? 1;
-		$options['countItems']  = $options['countItems'] ?? 0;
-		$options['currentlang'] = Multilanguage::isEnabled() ? Factory::getLanguage()->getTag() : 0;
+		// Default some optional options
+		$this->_options['access']      = 'true';
+		$this->_options['published']   = 1;
+		$this->_options['countItems']  = 0;
+		$this->_options['currentlang'] = Multilanguage::isEnabled() ? Factory::getLanguage()->getTag() : 0;
 
-		$this->_options = $options;
-
-		return true;
+		$this->setOptions($options);
 	}
 
 	/**
@@ -125,7 +125,8 @@ public function __construct($options)
 	 *
 	 * @return  Categories|boolean  Categories object on success, boolean false if an object does not exist
 	 *
-	 * @since   1.6
+	 * @since       1.6
+	 * @deprecated  5.0 Use the ComponentContainerInterface to get the categories
 	 */
 	public static function getInstance($extension, $options = array())
 	{
@@ -136,32 +137,11 @@ public static function getInstance($extension, $options = array())
 			return self::$instances[$hash];
 		}
 
-		$parts = explode('.', $extension);
-		$component = 'com_' . strtolower($parts[0]);
-		$section = count($parts) > 1 ? $parts[1] : '';
-		$classname = ucfirst(substr($component, 4)) . ucfirst($section) . 'Categories';
-
-		if (!class_exists($classname))
-		{
-			$path = JPATH_SITE . '/components/' . $component . '/helpers/category.php';
-
-			if (!is_file($path))
-			{
-				return false;
-			}
+		$parts = explode('.', $extension, 2);
 
-			include_once $path;
-		}
+		$categories = Factory::getApplication()->bootComponent($parts[0])->getCategories($options, count($parts) > 1 ? $parts[1] : '');
 
-		// Check for a possible service from the container otherwise manually instantiate the class
-		if (\JFactory::getContainer()->exists($classname))
-		{
-			self::$instances[$hash] = \JFactory::getContainer()->get($classname);
-		}
-		else
-		{
-			self::$instances[$hash] = new $classname($options);
-		}
+		self::$instances[$hash] = $categories;
 
 		return self::$instances[$hash];
 	}
@@ -389,4 +369,36 @@ protected function _load($id)
 			$this->_nodes[$id] = null;
 		}
 	}
+
+	/**
+	 * Allows to set some optional options, eg. if the access level should be considered.
+	 * Also clears the internal children cache.
+	 *
+	 * @param   array  $options  The new options
+	 *
+	 * @return  void
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public function setOptions(array $options)
+	{
+		if (isset($options['access']))
+		{
+			$this->_options['access'] = $options['access'];
+		}
+
+		if (isset($options['published']))
+		{
+			$this->_options['published'] = $options['published'];
+		}
+
+		if (isset($options['countItems']))
+		{
+			$this->_options['countItems'] = $options['countItems'];
+		}
+
+		// Reset the cache
+		$this->_nodes             = [];
+		$this->_checkedCategories = [];
+	}
 }

libraries/src/Extension/ComponentContainer.php

@@ -0,0 +1,56 @@
+<?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\Extension;
+
+defined('JPATH_PLATFORM') or die;
+
+use Joomla\CMS\Categories\Categories;
+use Joomla\DI\Container;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Access to component specific services.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class ComponentContainer extends Container implements ComponentContainerInterface
+{
+	/**
+	 * Returns the category service. If the service is not available
+	 * null is returned.
+	 *
+	 * @param   array   $options  The options
+	 * @param   string  $section  The section
+	 *
+	 * @return  Categories|null
+	 *
+	 * @see Categories::setOptions()
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public function getCategories(array $options = [], $section = '')
+	{
+		$serviceName = 'categories';
+
+		if ($section)
+		{
+			$serviceName .= '.' . strtolower($section);
+		}
+
+		if (!$this->has($serviceName))
+		{
+			return null;
+		}
+
+		$categories = $this->get($serviceName);
+		$categories->setOptions($options);
+
+		return $categories;
+	}
+}

libraries/src/Extension/ComponentContainerInterface.php

@@ -0,0 +1,36 @@
+<?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\Extension;
+
+defined('JPATH_PLATFORM') or die;
+
+use Joomla\CMS\Categories\Categories;
+
+/**
+ * Access to component specific services.
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+interface ComponentContainerInterface
+{
+	/**
+	 * Returns the category service. If the service is not available
+	 * null is returned.
+	 *
+	 * @param   array   $options  The options
+	 * @param   string  $section  The section
+	 *
+	 * @return  Categories|null
+	 *
+	 * @see Categories::setOptions()
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	public function getCategories(array $options = [], $section = '');
+}