[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2018 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\Categories;
  11  
  12  use Joomla\CMS\Form\Form;
  13  
  14  // phpcs:disable PSR1.Files.SideEffects
  15  \defined('JPATH_PLATFORM') or die;
  16  // phpcs:enable PSR1.Files.SideEffects
  17  
  18  /**
  19   * Access to component specific categories.
  20   *
  21   * @since  4.0.0
  22   */
  23  interface CategoryServiceInterface
  24  {
  25      /**
  26       * Returns the category service.
  27       *
  28       * @param   array   $options  The options
  29       * @param   string  $section  The section
  30       *
  31       * @return  CategoryInterface
  32       *
  33       * @since   4.0.0
  34       * @throws  SectionNotFoundException
  35       */
  36      public function getCategory(array $options = [], $section = ''): CategoryInterface;
  37  
  38      /**
  39       * Adds Count Items for Category Manager.
  40       *
  41       * @param   \stdClass[]  $items    The category objects
  42       * @param   string       $section  The section
  43       *
  44       * @return  void
  45       *
  46       * @since   4.0.0
  47       * @throws  \Exception
  48       */
  49      public function countItems(array $items, string $section);
  50  
  51      /**
  52       * Prepares the category form
  53       *
  54       * @param   Form          $form  The form to change
  55       * @param   array|object  $data  The form data
  56       *
  57       * @return   void
  58       */
  59      public function prepareForm(Form $form, $data);
  60  }