[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2017 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Toolbar;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('_JEXEC') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Interface for creating toolbar objects
  18   *
  19   * @since  4.0.0
  20   */
  21  interface ToolbarFactoryInterface
  22  {
  23      /**
  24       * Creates a new toolbar button.
  25       *
  26       * @param   Toolbar  $toolbar  The Toolbar instance to attach to the button
  27       * @param   string   $type     Button Type
  28       *
  29       * @return  ToolbarButton
  30       *
  31       * @since   4.0.0
  32       * @throws  \InvalidArgumentException
  33       */
  34      public function createButton(Toolbar $toolbar, string $type): ToolbarButton;
  35  
  36      /**
  37       * Creates a new Toolbar object.
  38       *
  39       * @param   string  $name  The toolbar name.
  40       *
  41       * @return  Toolbar
  42       *
  43       * @since   4.0.0
  44       */
  45      public function createToolbar(string $name = 'toolbar'): Toolbar;
  46  }