RssFeedGenerator
extends BaseXmlGenerator
in package
Defines the public API for XML generators and provides a shared codebase for common helpers.
Tags
Table of Contents
Properties
- $xmlElement : SimpleXMLElement
Methods
- __construct() : mixed
- Create a new XML generator instance.
- generate() : $this
- Generate the XML document.
- getDescription() : string
- getFilename() : string
- getXml() : string
- Get the XML document as a string.
- getXmlElement() : SimpleXMLElement
- Get the XML document as a SimpleXMLElement object.
- make() : string
- Generate a new XML document and get the contents as a string.
- addAtomLinkItem() : void
- addBaseChannelItems() : void
- addChild() : SimpleXMLElement
- addDynamicItemData() : void
- addItem() : void
- constructBaseElement() : void
- escape() : string
- getChannel() : SimpleXMLElement
- getImageLength() : numeric-string
- getImageType() : string
Properties
$xmlElement
protected
SimpleXMLElement
$xmlElement
Methods
__construct()
Create a new XML generator instance.
public
__construct() : mixed
generate()
Generate the XML document.
public
generate() : $this
Return values
$thisgetDescription()
public
static getDescription() : string
Return values
stringgetFilename()
public
static getFilename() : string
Return values
stringgetXml()
Get the XML document as a string.
public
getXml() : string
Return values
stringgetXmlElement()
Get the XML document as a SimpleXMLElement object.
public
getXmlElement() : SimpleXMLElement
Return values
SimpleXMLElementmake()
Generate a new XML document and get the contents as a string.
public
static make() : string
Return values
stringaddAtomLinkItem()
protected
addAtomLinkItem() : void
addBaseChannelItems()
protected
addBaseChannelItems() : void
addChild()
protected
addChild(SimpleXMLElement $element, string $name, string $value) : SimpleXMLElement
Parameters
- $element : SimpleXMLElement
- $name : string
- $value : string
Return values
SimpleXMLElementaddDynamicItemData()
protected
addDynamicItemData(SimpleXMLElement $item, MarkdownPost $post) : void
Parameters
- $item : SimpleXMLElement
- $post : MarkdownPost
addItem()
protected
addItem(MarkdownPost $post) : void
Parameters
- $post : MarkdownPost
constructBaseElement()
protected
constructBaseElement() : void
escape()
protected
escape(string $string) : string
Parameters
- $string : string
Return values
stringgetChannel()
protected
getChannel() : SimpleXMLElement
Return values
SimpleXMLElementgetImageLength()
protected
getImageLength(FeaturedImage $image) : numeric-string
Parameters
- $image : FeaturedImage
Return values
numeric-stringgetImageType()
protected
getImageType(FeaturedImage $image) : string
Parameters
- $image : FeaturedImage