[5.0][RFC] Move Toolbar singleton to HtmlDocument

administrator/components/com_finder/src/View/Indexer/HtmlView.php

@@ -10,7 +10,6 @@
 
 namespace Joomla\Component\Finder\Administrator\View\Indexer;
 
-use Joomla\CMS\Factory;
 use Joomla\CMS\Form\Form;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
@@ -64,17 +63,14 @@ public function display($tpl = null)
      */
     protected function addToolbar()
     {
-        $toolbar = Toolbar::getInstance('toolbar');
+        /** @var Toolbar $toolbar */
+        $toolbar = $this->getDocument()->getToolbar();
 
         ToolbarHelper::title(Text::_('COM_FINDER_INDEXER_TOOLBAR_TITLE'), 'search-plus finder');
 
-        $arrow  = Factory::getLanguage()->isRtl() ? 'arrow-right' : 'arrow-left';
-
-        ToolbarHelper::link(
-            Route::_('index.php?option=com_finder&view=index'),
-            'JTOOLBAR_BACK',
-            $arrow
-        );
+        $toolbar->linkButton('back', 'JTOOLBAR_BACK')
+            ->icon('icon-arrow-' . ($this->getLanguage()->isRtl() ? 'right' : 'left'))
+            ->url(Route::_('index.php?option=com_finder&view=index'));
 
         $toolbar->standardButton('index', 'COM_FINDER_INDEX')
             ->icon('icon-play')

administrator/components/com_finder/src/View/Item/HtmlView.php

@@ -12,6 +12,7 @@
 
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
+use Joomla\CMS\Toolbar\Toolbar;
 use Joomla\CMS\Toolbar\ToolbarHelper;
 
 /**
@@ -78,7 +79,13 @@ public function display($tpl = null)
      */
     protected function addToolbar()
     {
+        /** @var Toolbar $toolbar */
+        $toolbar = $this->getDocument()->getToolbar();
+
         ToolbarHelper::title(Text::_('COM_FINDER_INDEX_TOOLBAR_TITLE'), 'search-plus finder');
-        ToolbarHelper::back('JTOOLBAR_BACK', 'index.php?option=com_finder&view=index');
+
+        $toolbar->linkButton('back', 'JTOOLBAR_BACK')
+            ->icon('icon-arrow-' . ($this->getLanguage()->isRtl() ? 'right' : 'left'))
+            ->url(Route::_('index.php?option=com_finder&view=index'));
     }
 }

libraries/src/Document/HtmlDocument.php

@@ -16,6 +16,8 @@
 use Joomla\CMS\Filter\InputFilter;
 use Joomla\CMS\Helper\ModuleHelper;
 use Joomla\CMS\Language\Text;
+use Joomla\CMS\Toolbar\Toolbar;
+use Joomla\CMS\Toolbar\ToolbarFactoryInterface;
 use Joomla\CMS\Uri\Uri;
 use Joomla\CMS\Utility\Utility;
 use Joomla\Registry\Registry;
@@ -121,6 +123,14 @@ class HtmlDocument extends Document implements CacheControllerFactoryAwareInterf
      */
     private $html5 = true;
 
+    /**
+     * List of type \Joomla\CMS\Toolbar\Toolbar
+     *
+     * @var    Toolbar[]
+     * @since  __DEPLOY_VERSION__
+     */
+    private $toolbars = [];
+
     /**
      * Class constructor
      *
@@ -778,6 +788,58 @@ protected function _fetchTemplate($params = [])
         return $this;
     }
 
+    /**
+     * Returns a toolbar object or null
+     *
+     * @param   string   $toolbar
+     * @param   boolean  $create
+     *
+     * @return  ?Toolbar
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getToolbar(string $toolbar = 'toolbar', bool $create = true): ?Toolbar
+    {
+        if (empty($this->toolbars[$toolbar])) {
+            if (!$create) {
+                return null;
+            }
+
+            $this->toolbars[$toolbar] = CmsFactory::getContainer()->get(ToolbarFactoryInterface::class)->createToolbar($toolbar);
+        }
+
+        return $this->toolbars[$toolbar];
+    }
+
+    /**
+     * Returns the toolbar array
+     *
+     * @return  array
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function getToolbars(): array
+    {
+        return $this->toolbars;
+    }
+
+    /**
+     * Adds a new or replace an existing toolbar object
+     *
+     * @param   string   $name
+     * @param   Toolbar  $toolbar
+     *
+     * @return  $this
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function setToolbar(string $name, Toolbar $toolbar): self
+    {
+        $this->toolbars[$name] = $toolbar;
+
+        return $this;
+    }
+
     /**
      * Parse a document template
      *

libraries/src/Toolbar/Toolbar.php

@@ -77,6 +77,10 @@ class Toolbar
      *
      * @var    Toolbar[]
      * @since  2.5
+     *
+     * @deprecated  5.0 will be removed in 7.0
+     *              Toolbars instances will be stored in the \Joomla\CMS\Document\HTMLDocument object
+     *              Request the instance from Factory::getApplication()->getDocument()->getToolbar('name');
      */
     protected static $instances = [];
 
@@ -141,11 +145,14 @@ public function __construct($name = 'toolbar', ToolbarFactoryInterface $factory
      */
     public static function getInstance($name = 'toolbar')
     {
+        $toolbar = Factory::getApplication()->getDocument()->getToolbar($name);
+
+        // TODO b/c remove with Joomla 7.0 or removed in 6.0 with this function
         if (empty(self::$instances[$name])) {
-            self::$instances[$name] = Factory::getContainer()->get(ToolbarFactoryInterface::class)->createToolbar($name);
+            self::$instances[$name] = $toolbar;
         }
 
-        return self::$instances[$name];
+        return $toolbar;
     }
 
     /**

libraries/src/Toolbar/ToolbarHelper.php

@@ -52,7 +52,7 @@ public static function title($title, $icon = 'generic.png')
             $title .= ' - ' . Text::_('JADMINISTRATION');
         }
 
-        Factory::getDocument()->setTitle($title);
+        $app->getDocument()->setTitle($title);
     }
 
     /**