My favorites | Sign in
Project Home Downloads Wiki Issues
READ-ONLY: This project has been archived. For more information see this post.
Search
for
PluginAPI  
API for Plugin Developers
Updated Nov 4, 2009 by damian.d...@gmail.com

See the Plugins page for details in creating plugins

Objects

The $feedInfo & $feedItem objects are available to plugin developers.


$feedInfo

The $feedInfo object contains the feed's information, such as url's, title, and the last time it was updated.

$feedInfo->id

Provides the ID of the feed

$feedInfo->url

Provides the full url of the feed

$feedInfo->title

Provides the title of the feed

$feedInfo->description

Provides the description of the feed

$feedInfo->owner

Provides the ID of the feeds owner

$feedInfo->xml_type

Provides the type of feed (e.g RSSv2)

$feedInfo->xlmns

Provides the xml namespaces in comma delimited format

$feedInfo->site_url

Provides the url of the parent of the feed (e.g http://www.twitter.com/yourname)

$feedInfo->base_url

Provides the url of the parent site (e.g. http://www.twitter.com)

$feedInfo->site_name

Provides the name of the site (e.g. Twitter)

$feedInfo->site_favicon

Provides the name of the feed's favicon. Favicons associated with feeds are stored locally at images/icons.

$feedInfo->last_modified

Provides the unix timestamp of the last time the feed was updated in HulloHallo.


$feedItem

The $feedItem object holds all data passed from the feed one item at a time. Due to the differences between RSS & ATOM feeds, what is available to this object will depend on the type of feed and what that feed contains.

RSS & ATOM Feeds

The following are available to all feeds

$feedItem->title

Provides the title of the item

$feedItem->rssTitle

Provides the title of the item. Used for outgoing RSS Feeds. Useful if you want the title on your rss feed to be different from what is in your life stream. Generally this object should be clean of any HTML in order to properly generate titles in RSS.

$feedItem->link

Provides the link to the item

$feedItem->description

Provides the body of the item

$feedItem->date

Provides the date of the item

$feedItem->guid

Provides the guid of the item

$feedItem->status

Provides the status of an item. This defaults to keep. Change this to delete if you do not want the item to be displayed.

RSS Only

Note: The following are not available to every feed.

$feedItem->contentUrl

Provides the full url to the content contained in the item

$feedItem->contentTitle

Provides the title of the item's content. In most cases this is the same as $feedItem->title

$feedItem->thumbnailUrl

Provides the full url item's related thumbnail

$feedItem->playerUrl

Provides the full url to the item's related player (e.g video url)

$feedItem->credit

Provides the name of the person/group/company that is responsible for the creation of the content contained in the item

$feedItem->role

Provides the role of the content's creator

$feedItem->author

Provides the name of the item's author

ATOM Only

Note: The following are not available to every feed.

$feedItem->author

Provides the name of the item's author

$feedItem->authorUri

Provides the url to the author's site

$feedItem->id

Provides the id of the item

$feedItem->altLink

Provides the item's alternate link

$feedItem->relLink

Provides the item's related link

$feedItem->selfLink

Provides the item's self link

$feedItem->viaLink

Provides the item's via link

$feedItem->encLink

Provides the item's enclosure link

Powered by Google Project Hosting