You are here

interface RendererInterface in Zircon Profile 8

Same name in this branch
  1. 8 core/lib/Drupal/Core/Render/RendererInterface.php \Drupal\Core\Render\RendererInterface
  2. 8 vendor/zendframework/zend-feed/src/Writer/Extension/RendererInterface.php \Zend\Feed\Writer\Extension\RendererInterface
  3. 8 vendor/zendframework/zend-feed/src/Writer/Renderer/RendererInterface.php \Zend\Feed\Writer\Renderer\RendererInterface
Same name and namespace in other branches
  1. 8.0 vendor/zendframework/zend-feed/src/Writer/Renderer/RendererInterface.php \Zend\Feed\Writer\Renderer\RendererInterface

Hierarchy

Expanded class hierarchy of RendererInterface

All classes that implement RendererInterface

File

vendor/zendframework/zend-feed/src/Writer/Renderer/RendererInterface.php, line 17

Namespace

Zend\Feed\Writer\Renderer
View source
interface RendererInterface {

  /**
   * Render feed/entry
   *
   * @return void
   */
  public function render();

  /**
   * Save feed and/or entry to XML and return string
   *
   * @return string
   */
  public function saveXml();

  /**
   * Get DOM document
   *
   * @return DOMDocument
   */
  public function getDomDocument();

  /**
   * Get document element from DOM
   *
   * @return DOMElement
   */
  public function getElement();

  /**
   * Get data container containing feed items
   *
   * @return mixed
   */
  public function getDataContainer();

  /**
   * Should exceptions be ignored?
   *
   * @return mixed
   */
  public function ignoreExceptions();

  /**
   * Get list of thrown exceptions
   *
   * @return array
   */
  public function getExceptions();

  /**
   * Set the current feed type being exported to "rss" or "atom". This allows
   * other objects to gracefully choose whether to execute or not, depending
   * on their appropriateness for the current type, e.g. renderers.
   *
   * @param string $type
   */
  public function setType($type);

  /**
   * Retrieve the current or last feed type exported.
   *
   * @return string Value will be "rss" or "atom"
   */
  public function getType();

  /**
   * Sets the absolute root element for the XML feed being generated. This
   * helps simplify the appending of namespace declarations, but also ensures
   * namespaces are added to the root element - not scattered across the entire
   * XML file - may assist namespace unsafe parsers and looks pretty ;).
   *
   * @param DOMElement $root
   */
  public function setRootElement(DOMElement $root);

  /**
   * Retrieve the absolute root element for the XML feed being generated.
   *
   * @return DOMElement
   */
  public function getRootElement();

}

Members

Namesort descending Modifiers Type Description Overrides
RendererInterface::getDataContainer public function Get data container containing feed items
RendererInterface::getDomDocument public function Get DOM document
RendererInterface::getElement public function Get document element from DOM
RendererInterface::getExceptions public function Get list of thrown exceptions
RendererInterface::getRootElement public function Retrieve the absolute root element for the XML feed being generated.
RendererInterface::getType public function Retrieve the current or last feed type exported.
RendererInterface::ignoreExceptions public function Should exceptions be ignored?
RendererInterface::render public function Render feed/entry
RendererInterface::saveXml public function Save feed and/or entry to XML and return string
RendererInterface::setRootElement public function Sets the absolute root element for the XML feed being generated. This helps simplify the appending of namespace declarations, but also ensures namespaces are added to the root element - not scattered across the entire XML file - may assist namespace…
RendererInterface::setType public function Set the current feed type being exported to "rss" or "atom". This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.