Alpha Framework 4.0.0 API Documentation

RSS extends Feed

in package

• Application

RSS 1.0 class for synication.

Tags

since

1.0

author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2021, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Table of Contents

Properties

$docElement  : DOMElement

The DOMElement object used to hold the item or entry elements.

$fieldNameMappings  : array<string|int, mixed>

An array containing Record field names -> RSS field name mappings.

$hasChannel  : bool

If the feed format has a channel or not.

$items  : array<string|int, mixed>

An array of feed items.

$nameSpace  : string

The XML namespace.

$root  : DOMElement

Holds the DOMElement to which metadata is added for the feed.

$rootTag  : string

The actual root tag used in each feed type.

$rssDoc  : DOMDocument

The DOMDocument object used to create the feed.

$tagMap  : array<string|int, mixed>

Maps the tags to the feed-specific tags.

$logger  : Logger

Trace logger.

$rdfns  : string

The RDF namespace.

$record  : ActiveRecord

The Record which we will serve up in this feed.

Methods

__construct()  : mixed

The constructor.

addRecord()  : void

Method for adding a Record to the current feed.

loadRecords()  : void

Method to load all of the Record items to the feed from the database, from the newest to the $limit provided.

render()  : string

Returns the formatted XML for the feed as a string.

setFieldMappings()  : void

Method for mapping Record fieldnames to feed field names.

addItem()  : void

Method for adding an item to a feed.

createFeedElement()  : DOMElement

Method for creating a new feed element.

createLink()  : void

Method for creating link elements (note that Atom has a different format).

createRSSNode()  : void

Method for creating an RSS node with a title, url and description.

addToItems()  : void

Add a URL to feed item.