Documentation

RSSWriter
in package

Tags
copyright

Cloudrexx AG

author

Cloudrexx AG info@cloudrexx.com

subpackage

lib_framework

Table of Contents

Properties

$_arrItems  : mixed
$_currentItem  : mixed
$_rssVersion  : mixed
$_xmlElementLevel  : mixed
$_xmlVersion  : mixed
$arrErrorMsg  : mixed
$arrWarningMsg  : mixed
$channelCategory  : mixed
$channelCloud  : mixed
$channelCopyright  : mixed
$channelDescription  : mixed
$channelDocs  : mixed
$channelGenerator  : mixed
$channelImageDescription  : mixed
$channelImageHeight  : mixed
$channelImageLink  : mixed
$channelImageTitle  : mixed
$channelImageUrl  : mixed
$channelImageWidth  : mixed
$channelLanguage  : mixed
$channelLastBuildDate  : mixed
$channelLink  : mixed
$channelManagingEditor  : mixed
$channelPubDate  : mixed
$channelRating  : mixed
$channelSkipDays  : mixed
$channelSkipHours  : mixed
$channelTextInputDescription  : mixed
$channelTextInputLink  : mixed
$channelTextInputName  : mixed
$channelTextInputTitle  : mixed
$channelTitle  : mixed
$channelTtl  : mixed
$channelWebMaster  : mixed
$characterEncoding  : mixed
$feedType  : mixed
$xmlDocument  : mixed
$xmlDocumentPath  : mixed
$xmlItems  : mixed

Methods

__construct()  : mixed
PHP5 contructor
_addChannelDescription()  : bool
Add channel description
_addChannelLink()  : bool
Add channel link
_addChannelTitle()  : bool
Add channel title
_addCustomChannelElements()  : bool
Add custom channel elements
_addOptionalChannelElements()  : bool
Add optional channel elements
_create()  : bool
Create feed
_createJS()  : mixed
_createXML()  : mixed
_parseItems()  : mixed
Parse items
_visualElementLevel()  : string
Visual element level
addItem()  : bool
Add item
removeItems()  : mixed
Remove items
write()  : bool
Write feed
_js_umlauts()  : mixed
Takes a string and replaces all umlauts and special chars with their unicode escape sequence. This is needed so UTF8 Javascript news gets displayed correctly in Latin1 pages.
_ordUTF8()  : mixed
returns the ord() of an UTF8 character.
_uni_escape()  : mixed
Helper function for converting an special character into it's proper \uXXXX notation.

Properties

$channelTextInputDescription

public mixed $channelTextInputDescription = ''

Methods

_addChannelDescription()

Add channel description

public _addChannelDescription() : bool

Adds the channel description to the feed.

Return values
bool

_addChannelLink()

Add channel link

public _addChannelLink() : bool

Adds the link title to the feed.

Return values
bool

_addChannelTitle()

Add channel title

public _addChannelTitle() : bool

Adds the channel title to the feed.

Return values
bool

_addCustomChannelElements()

Add custom channel elements

public _addCustomChannelElements([mixed $array = array() ]) : bool

Adds all the custom channel elements to the feed.

Parameters
$array : mixed = array()
Return values
bool

_addOptionalChannelElements()

Add optional channel elements

public _addOptionalChannelElements() : bool

Adds all the optional channel elements to the feed.

Return values
bool

_create()

Create feed

public _create() : bool

Create the content of the RSS feed.

Return values
bool

_parseItems()

Parse items

public _parseItems() : mixed

Parse the items of the feed and adds them to it.

_visualElementLevel()

Visual element level

public _visualElementLevel() : string

Return a number of tabs to visual the locial structure of the RSS feed.

Return values
string

addItem()

Add item

public addItem([stirng $title = '' ][, string $link = '' ][, stirng $description = '' ][, string $author = '' ][, array<string|int, mixed> $arrCategory = array() ][, string $comments = '' ][, array<string|int, mixed> $arrEnclosure = array() ][, array<string|int, mixed> $arrGuid = array() ][, string $pubDate = '' ][, array<string|int, mixed> $arrSource = array() ]) : bool

Add an item to the RSS feed

Parameters
$title : stirng = ''
$link : string = ''
$description : stirng = ''
$author : string = ''
$arrCategory : array<string|int, mixed> = array()
$comments : string = ''
$arrEnclosure : array<string|int, mixed> = array()
$arrGuid : array<string|int, mixed> = array()
$pubDate : string = ''
$arrSource : array<string|int, mixed> = array()
Return values
bool

removeItems()

Remove items

public removeItems() : mixed

Removes the items from the rss writer object.

write()

Write feed

public write() : bool

Writes the rss feed.

Return values
bool

_js_umlauts()

Takes a string and replaces all umlauts and special chars with their unicode escape sequence. This is needed so UTF8 Javascript news gets displayed correctly in Latin1 pages.

private _js_umlauts(mixed $str) : mixed
Parameters
$str : mixed

_ordUTF8()

returns the ord() of an UTF8 character.

private _ordUTF8(mixed $c[, mixed $index = 0 ][, mixed &$bytes = null ]) : mixed
Parameters
$c : mixed
$index : mixed = 0
$bytes : mixed = null

_uni_escape()

Helper function for converting an special character into it's proper \uXXXX notation.

private _uni_escape(mixed $chr) : mixed
Parameters
$chr : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results