|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.web.feeds.FeedReader
public class FeedReader
Feed reader plug-in additional methods
Constructor Summary | |
---|---|
init([any controller])
|
Method Summary | |
---|---|
array |
arrayOfStructsSort(array aOfS, string key, [string sortOrder='desc'], [string sortType='textnocase'])
Sorts a structured array by a selected value |
string |
findAuthor(xml itemRoot)
Parse an item and find an author |
array |
findCategory(xml itemRoot, array categorynode)
Parse an item and find a categories |
struct |
findComments(xml itemRoot, struct commentsnode)
Parse an item and find comments |
string |
findCreatedDate(xml xmlRoot)
Parse the document to find a created date |
string |
findKeywords(array categoryRoot)
Parse an item's category array and find keywords |
array |
findMediaContent(xml itemRoot, array attachmentnode)
Parse an item and find media content |
array |
findThumbnails(xml itemRoot, array attachmentnode)
Parse an item and find thumbnails |
string |
findUpdatedDate(xml xmlRoot)
Parse the document and find a updated date |
boolean |
isDateISO8601(string datetime)
Checks if a date is in ISO8601 format |
string |
normalizeAtomTextConstruct(any entity)
Send an element and it will return the appropriate text construct |
any |
parseAtomItems(any items, [string itemsType='array'], [numeric maxItems='0'])
Parse the items an return an array of structures |
any |
parseRSSItems(any items, [string itemsType='array'], [numeric maxItems='0'])
Parse the items an return an array of structures |
struct |
parseVariablesSet(struct feed)
Set empty structure variables that will be used by parseFeed |
query |
querySortandTrim(query query, numeric maxRecords, string sort, string direction)
Sorts a structured array by a selected value |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init([any controller])
controller
Method Detail |
---|
public array arrayOfStructsSort(array aOfS, string key, [string sortOrder='desc'], [string sortType='textnocase'])
aOfS
- The array to sortkey
- Structure Key to sort bysortOrder
- Order to sort by, asc or descsortType
- Text, textnocase, or numericpublic string findAuthor(xml itemRoot)
itemRoot
- The item to look inpublic array findCategory(xml itemRoot, array categorynode)
itemRoot
- The item to look incategorynode
- Existing category to merge with categoriespublic struct findComments(xml itemRoot, struct commentsnode)
itemRoot
- The item to look incommentsnode
- Existing comments structure to be updatedpublic string findCreatedDate(xml xmlRoot)
xmlRoot
- The XML root to look inpublic string findKeywords(array categoryRoot)
categoryRoot
- The category root to look inpublic array findMediaContent(xml itemRoot, array attachmentnode)
itemRoot
- The item to look inattachmentnode
- Existing attachments to merge with media contentpublic array findThumbnails(xml itemRoot, array attachmentnode)
itemRoot
- The item to look inattachmentnode
- Existing attachments to merge with thumbnailspublic string findUpdatedDate(xml xmlRoot)
xmlRoot
- The XML root to look inpublic boolean isDateISO8601(string datetime)
datetime
- The datetime string to checkpublic string normalizeAtomTextConstruct(any entity)
entity
- The XML constructpublic any parseAtomItems(any items, [string itemsType='array'], [numeric maxItems='0'])
items
- The xml of itemsitemsType
- The type of the items either query or array, array is used by defaultmaxItems
- The maximum number of entries to retrieve, default is display allpublic any parseRSSItems(any items, [string itemsType='array'], [numeric maxItems='0'])
items
- The xml of itemsitemsType
- The type of the items either query or array, array is used by defaultmaxItems
- The maximum number of entries to retrieve, default is display allpublic struct parseVariablesSet(struct feed)
feed
- Structure of the current state of the parseFeed processpublic query querySortandTrim(query query, numeric maxRecords, string sort, string direction)
query
- The query to trimmaxRecords
- Trim to maximum recordssort
- Sort query by this columndirection
- Sort direction, either 'asc' or 'desc'
|
ColdBox Platform v3.8.0 | ||||
FRAMES |