[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  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * The category interface.
  18   *
  19   * @since  3.10.0
  20   */
  21  interface CategoryInterface
  22  {
  23      /**
  24       * Loads a specific category and all its children in a CategoryNode object.
  25       *
  26       * @param   mixed    $id         an optional id integer or equal to 'root'
  27       * @param   boolean  $forceload  True to force  the _load method to execute
  28       *
  29       * @return  CategoryNode|null  CategoryNode object or null if $id is not valid
  30       *
  31       * @since   3.10.0
  32       */
  33      public function get($id = 'root', $forceload = false);
  34  }