abstract class AbstractRenderer in Zircon Profile 8

Hierarchy

• class \Zend\Feed\Writer\Extension\AbstractRenderer implements RendererInterface

File

vendor/zendframework/zend-feed/src/Writer/Extension/AbstractRenderer.php, line 17

Namespace

Zend\Feed\Writer\Extension

abstract class AbstractRenderer implements RendererInterface {

  /**
   * @var DOMDocument
   */
  protected $dom = null;

  /**
   * @var mixed
   */
  protected $entry = null;

  /**
   * @var DOMElement
   */
  protected $base = null;

  /**
   * @var mixed
   */
  protected $container = null;

  /**
   * @var string
   */
  protected $type = null;

  /**
   * @var DOMElement
   */
  protected $rootElement = null;

  /**
   * Encoding of all text values
   *
   * @var string
   */
  protected $encoding = 'UTF-8';

  /**
   * Set the data container
   *
   * @param  mixed $container
   * @return AbstractRenderer
   */
  public function setDataContainer($container) {
    $this->container = $container;
    return $this;
  }

  /**
   * Set feed encoding
   *
   * @param  string $enc
   * @return AbstractRenderer
   */
  public function setEncoding($enc) {
    $this->encoding = $enc;
    return $this;
  }

  /**
   * Get feed encoding
   *
   * @return string
   */
  public function getEncoding() {
    return $this->encoding;
  }

  /**
   * Set DOMDocument and DOMElement on which to operate
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $base
   * @return AbstractRenderer
   */
  public function setDomDocument(DOMDocument $dom, DOMElement $base) {
    $this->dom = $dom;
    $this->base = $base;
    return $this;
  }

  /**
   * Get data container being rendered
   *
   * @return mixed
   */
  public function getDataContainer() {
    return $this->container;
  }

  /**
   * Set feed type
   *
   * @param  string $type
   * @return AbstractRenderer
   */
  public function setType($type) {
    $this->type = $type;
    return $this;
  }

  /**
   * Get feedtype
   *
   * @return string
   */
  public function getType() {
    return $this->type;
  }

  /**
   * Set root element of document
   *
   * @param  DOMElement $root
   * @return AbstractRenderer
   */
  public function setRootElement(DOMElement $root) {
    $this->rootElement = $root;
    return $this;
  }

  /**
   * Get root element
   *
   * @return DOMElement
   */
  public function getRootElement() {
    return $this->rootElement;
  }

  /**
   * Append namespaces to feed
   *
   * @return void
   */
  protected abstract function _appendNamespaces();

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractRenderer::$base	protected	property
AbstractRenderer::$container	protected	property
AbstractRenderer::$dom	protected	property
AbstractRenderer::$encoding	protected	property	Encoding of all text values
AbstractRenderer::$entry	protected	property
AbstractRenderer::$rootElement	protected	property
AbstractRenderer::$type	protected	property
AbstractRenderer::getDataContainer	public	function	Get data container being rendered Overrides RendererInterface::getDataContainer
AbstractRenderer::getEncoding	public	function	Get feed encoding
AbstractRenderer::getRootElement	public	function	Get root element
AbstractRenderer::getType	public	function	Get feedtype
AbstractRenderer::setDataContainer	public	function	Set the data container Overrides RendererInterface::setDataContainer
AbstractRenderer::setDomDocument	public	function	Set DOMDocument and DOMElement on which to operate Overrides RendererInterface::setDomDocument
AbstractRenderer::setEncoding	public	function	Set feed encoding
AbstractRenderer::setRootElement	public	function	Set root element of document
AbstractRenderer::setType	public	function	Set feed type
AbstractRenderer::_appendNamespaces	abstract protected	function	Append namespaces to feed
RendererInterface::render	public	function	Render