NodeElementInterface.php in Extensible BBCode 4.0.x

Namespace

Drupal\xbbcode\Parser\Tree

File

src/Parser/Tree/NodeElementInterface.php

<?php

namespace Drupal\xbbcode\Parser\Tree;


/**
 * Interface for node elements.
 */
interface NodeElementInterface extends ElementInterface {

  /**
   * Append an element to the children of this element.
   *
   * @param \Drupal\xbbcode\Parser\Tree\ElementInterface $element
   *   The new element.
   */
  public function append(ElementInterface $element) : void;

  /**
   * Get all children of the element.
   *
   * @return \Drupal\xbbcode\Parser\Tree\ElementInterface[]
   *   The children.
   */
  public function getChildren() : array;

  /**
   * Retrieve the rendered content of the element.
   *
   * @return mixed
   *   The rendered content.
   */
  public function getContent();

  /**
   * Retrieve the rendered output of each child.
   *
   * @param bool $force_render
   *   (Optional) Set to FALSE to only return output that is already rendered.
   *   By default, this method renders it implicitly.
   *
   * @return \Drupal\xbbcode\Parser\Tree\OutputElementInterface[]
   *   The sequence of rendered outputs.
   */
  public function getRenderedChildren($force_render = TRUE) : array;

  /**
   * Retrieve the descendants of the node.
   *
   * @return \Drupal\xbbcode\Parser\Tree\ElementInterface[]|\iterable
   *   Every descendant of the node.
   */
  public function getDescendants();

}

Interfaces

Name	Description
NodeElementInterface	Interface for node elements.