[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2019 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\Tree;
  11  
  12  // phpcs:disable PSR1.Files.SideEffects
  13  \defined('JPATH_PLATFORM') or die;
  14  // phpcs:enable PSR1.Files.SideEffects
  15  
  16  /**
  17   * Interface for a node class
  18   *
  19   * @since  4.0.0
  20   */
  21  interface NodeInterface extends ImmutableNodeInterface
  22  {
  23      /**
  24       * Set the parent of this node
  25       *
  26       * If the node already has a parent, the link is unset
  27       *
  28       * @param   NodeInterface|null  $parent  NodeInterface for the parent to be set or null
  29       *
  30       * @return  void
  31       *
  32       * @since   4.0.0
  33       */
  34      public function setParent(NodeInterface $parent);
  35  
  36      /**
  37       * Add child to this node
  38       *
  39       * If the child already has a parent, the link is unset
  40       *
  41       * @param   NodeInterface  $child  The child to be added.
  42       *
  43       * @return  void
  44       *
  45       * @since   4.0.0
  46       */
  47      public function addChild(NodeInterface $child);
  48  
  49      /**
  50       * Remove a specific child
  51       *
  52       * @param   NodeInterface  $child  Child to remove
  53       *
  54       * @return  void
  55       *
  56       * @since   4.0.0
  57       */
  58      public function removeChild(NodeInterface $child);
  59  
  60      /**
  61       * Function to set the left or right sibling of a node
  62       *
  63       * @param   NodeInterface  $sibling  NodeInterface object for the sibling
  64       * @param   boolean        $right    If set to false, the sibling is the left one
  65       *
  66       * @return  void
  67       *
  68       * @since   4.0.0
  69       */
  70      public function setSibling(NodeInterface $sibling, $right = true);
  71  }