Feed/Writer/Renderer/RendererAbstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed_Writer
version: $Id: RendererAbstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Feed_Writer_Renderer_RendererAbstract

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Feed_Writer_Renderer_RendererAbstract
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed_Writer
Properties: $_extensions; $_container; $_dom; $_ignoreExceptions; $_exceptions; $_encoding; $_type; $_rootElement
Methods: __construct; saveXml; getDomDocument; getElement; getDataContainer; setEncoding; getEncoding; ignoreExceptions; getExceptions; setType; getType; setRootElement; getRootElement; _loadExtensions

Description

Properties

$_container
jump to class

mixed $_container = 'null'

Details

$_container: mixed
visibility: protected
default: null
final: false
static: false

$_dom
jump to class

DOMDocument $_dom = 'null'

Details

$_dom: DOMDocument
visibility: protected
default: null
final: false
static: false

$_encoding
jump to class

string $_encoding = 'UTF-8'

Encoding of all text values

Details

$_encoding: string
visibility: protected
default: UTF-8
final: false
static: false

$_exceptions
jump to class

array $_exceptions = 'array'

Details

$_exceptions: array
visibility: protected
default: array
final: false
static: false

$_extensions
jump to class

array $_extensions = 'array'

Extensions

Details

$_extensions: array
visibility: protected
default: array
final: false
static: false

$_ignoreExceptions
jump to class

bool $_ignoreExceptions = 'false'

Details

$_ignoreExceptions: bool
visibility: protected
default: false
final: false
static: false

$_rootElement
jump to class

DOMElement $_rootElement = 'null'

Details

$_rootElement: DOMElement
visibility: protected
default: null
final: false
static: false

$_type
jump to class

string $_type = 'null'

Holds the value "atom" or "rss" depending on the feed type set when when last exported.

Details

$_type: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          mixed $container
          )
        
        :
        void

Constructor

Arguments

$container: mixed

Details

visibility: public
final: false
static: false

_loadExtensions
jump to class

_loadExtensions(
          
          )
        
        :
        void

Load extensions from Zend_Feed_Writer

Details

visibility: protected
final: false
static: false

getDataContainer
jump to class

getDataContainer(
          
          )
        
        :
        mixed

Get data container of items being rendered

Output

mixed

Details

visibility: public
final: false
static: false

getDomDocument
jump to class

getDomDocument(
          
          )
        
        :
        DOMDocument

Get DOM document

Output

DOMDocument

Details

visibility: public
final: false
static: false

getElement
jump to class

getElement(
          
          )
        
        :
        DOMElement

Get document element from DOM

Output

DOMElement

Details

visibility: public
final: false
static: false

getEncoding
jump to class

getEncoding(
          
          )
        
        :
        string

Get feed encoding

Output

string

Details

visibility: public
final: false
static: false

getExceptions
jump to class

getExceptions(
          
          )
        
        :
        array

Get exception list

Output

array

Details

visibility: public
final: false
static: false

getRootElement
jump to class

getRootElement(
          
          )
        
        :
        DOMElement

Retrieve the absolute root element for the XML feed being generated.

Output

DOMElement

Details

visibility: public
final: false
static: false

getType
jump to class

getType(
          
          )
        
        :
        string

Retrieve the current or last feed type exported.

Output

string: Value will be "rss" or "atom"

Details

visibility: public
final: false
static: false

ignoreExceptions
jump to class

ignoreExceptions(
          bool $bool
              =
              true
          )
        
        :
        Zend_Feed_Writer_Renderer_RendererAbstract

Indicate whether or not to ignore exceptions

Arguments

$bool: bool

Output

Zend_Feed_Writer_Renderer_RendererAbstract

Details

visibility: public
final: false
static: false

saveXml
jump to class

saveXml(
          
          )
        
        :
        string

Save XML to string

Output

string

Details

visibility: public
final: false
static: false

setEncoding
jump to class

setEncoding(
          string $enc
          )
        
        :
        Zend_Feed_Writer_Renderer_RendererAbstract

Set feed encoding

Arguments

$enc: string

Output

Zend_Feed_Writer_Renderer_RendererAbstract

Details

visibility: public
final: false
static: false

setRootElement
jump to class

setRootElement(
          DOMElement $root
          )
        
        :

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 ;).

Arguments

$root: DOMElement

Details

visibility: public
final: false
static: false

setType
jump to class

setType(
          string $type
          )
        
        :

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.

Arguments

$type: string

Details

visibility: public
final: false
static: false

API Documentation

Feed/Writer/Renderer/RendererAbstract.php

Description

Zend_Feed_Writer_Renderer_RendererAbstractjump to top

Description

Properties

$_containerjump to class

Details

$_domjump to class

Details

$_encodingjump to class

Details

$_exceptionsjump to class

Details

$_extensionsjump to class

Details

$_ignoreExceptionsjump to class

Details

$_rootElementjump to class

Details

$_typejump to class

Details

Methods

__constructjump to class

Arguments

Details

_loadExtensionsjump to class

Details

getDataContainerjump to class

Output

Details

getDomDocumentjump to class

Output

Details

getElementjump to class

Output

Details

getEncodingjump to class

Output

Details

getExceptionsjump to class

Output

Details

getRootElementjump to class

Output

Details

getTypejump to class

Output

Details

ignoreExceptionsjump to class

Arguments

Output

Details

saveXmljump to class

Output

Details

setEncodingjump to class

Arguments

Output

Details

setRootElementjump to class

Arguments

Details

setTypejump to class

Arguments

Details

Zend_Feed_Writer_Renderer_RendererAbstract
jump to top

$_container
jump to class

$_dom
jump to class

$_encoding
jump to class

$_exceptions
jump to class

$_extensions
jump to class

$_ignoreExceptions
jump to class

$_rootElement
jump to class

$_type
jump to class

__construct
jump to class

_loadExtensions
jump to class

getDataContainer
jump to class

getDomDocument
jump to class

getElement
jump to class

getEncoding
jump to class

getExceptions
jump to class

getRootElement
jump to class

getType
jump to class

ignoreExceptions
jump to class

saveXml
jump to class

setEncoding
jump to class

setRootElement
jump to class

setType
jump to class