-
-
Notifications
You must be signed in to change notification settings - Fork 2
Items as an Array
Jorge Reyes edited this page Jun 3, 2015
·
2 revisions
The following structure keys contain item data. Each item is stored as a query or by default as an array. Query results don't return anywhere near the same amount of information as the array. The following is the item structure returned as an array, all values are strings unless otherwise noted.
Items [array]::
Attachment* [array]::
See below
Author Author of the item or file attachment::
Body Text describing this feed, the attachment or a text summary of a longer article::
Category* [array]::
Domain URL to or name of the convention used by this category
Tag Category item
Comments [structure]::
Count Number of comments for this item
Hit_parade A history list of the comment count
Url A URL to a webpage where you can leave comments in regards to this item
Datepublished When item was first published::
Dateupdated When item was last updated::
Id (Should be) a unique Id for this item::
Keywords A list of classifications used to reference the item, these are sourced from the category array::
Rights Copyright notice for this item::
Title Title for this item::
Url URL to the HTML or complete edition of this item::
The Attachment array can have three different structures dependent on the source. You can use the type value to detect what kind of array structure will be returned.
Attachment* [array]::
Type "enclosure" A standard feed file attachment
Duration Running duration or length
Filesize File size (usually in bytes)
Mimetype MIME type
Url URL of where the file is located so it can be directly downloaded
Attachment* [array]::
Type "media" A Media RSS attachment
Duration Play time in seconds
Filesize File size in bytes
Height Media height
!IsDefault When the value is true then this is the default attachment for use
Medium Type of media, value will be either image, audio, video, document, executable
Mimetype MIME type
Url URL of where the media is located so it can be directly downloaded or streamed
Width Media width
Attachment* [array]::
Type "thumbnail" A Media RSS thumbnail preview
Height Thumbnail height
Medium Will always be image
Url URL of where the thumbnail is located so it can be directly downloaded or viewed
Width Thumbnail width
The Specs structure contains technical information related to the feed, it can usually be ignored.
Specs [structure]::
Extensions List of recognised extensions contained within this feed
Generator Name (and maybe version, URL) of the program used to create this feed
Namespace [structure]
Namespace structure contains a collection of URLs returned by the feed's namespace tag
Type Type of feed, either RSS, RDF, Atom
Url Self URL for this feed (this is supplied by the feed and is not generated by ColdBox)
Version Numeric revision value for the feed, best used in combination with Type
- Feed Reader * [RSS Syndication Format](https://github.com/ColdBox/cbox-feeds/wiki/RSS Syndication Format) * RDF Syndication Format * Atom Syndication Format * Supported Syntax and Formats
- Feed Generator
- Feed Generator Elements