|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.web.feeds.SharedGenerator
public class SharedGenerator
Methods belonging to the FeedGenerator plug-in that specifically relate to feed creation
Constructor Summary | |
---|---|
init()
|
Method Summary | |
---|---|
private string |
RSSFormat(string string)
A CFML XMLFormat() tag replacement that converts high characters to XML safe Unicode |
private string |
URLFormat(string string)
A CFML XMLFormat() tag replacement that converts URL strings into XML safe, escaped mark-up |
string |
XSLFormat()
An Extensible Stylesheet (XSL) used to cleanup whitespace within our generated XML code |
string |
cclicenseGenChannel(struct fs)
Generate Creative Commons extension channel XML |
string |
cclicenseGenItem(query items, struct map, numeric currentrow)
Generate Creative Commons extension item XML |
string |
cclicenseValChannel(struct fs)
Validate Creative Commons extension channel element |
string |
cclicenseValItem(query fi, struct map, numeric currentrow)
Validate Creative Commons extension item element |
struct |
createInstances(struct instance)
Variables used for the validation and creation of feed data |
string |
dcmtGenChannel(struct fs)
Generate DCMI Metadata terms extension channel XML |
string |
dcmtGenItem(query items, struct map, numeric currentrow)
Generate DCMI Metadata terms extension item XML |
private string |
generateExtensionNameSpace(string keys)
Generates the XML namespaces for feed extensions depending on the tags in use |
struct |
generateExtensionPropertyMap()
Generates the extensions default property map |
private string |
generateNum1kSeparator(numeric number, [string seperator=','])
Inserts thousand-seperators into a number |
private string |
generateNumSuffix(numeric number, [string seperator=','])
Attaches an English oral suffix (st,nd,rd,th) to a number |
private string |
generateRFC822Date(string targetDate)
Generate an RFC8222 Date from a date object that conforms to GMT |
string |
itunesGenChannel(struct fs)
Generate Apple iTunes extension channel XML |
string |
itunesGenItem(query items, struct map, numeric currentrow)
Generate Apple iTunes extension item XML |
string |
itunesValChannel(struct fs)
Validate Apple iTunes extension channel element |
string |
ituneseValItem(query fi, struct map, numeric currentrow)
Validate Apple iTunes extension item element |
string |
opensearchGenChannel(struct fs)
Generate OpenSearch extension channel XML |
string |
opensearchValChannel(struct fs)
Validate OpenSearch extension channel elements |
struct |
parseColumnMap(struct columnMap)
Parse and validate a column mapper |
string |
slashGenItem(query items, struct map, numeric currentrow)
Generate Slash extension channel XML |
string |
slashValItem(query fi, struct map, numeric currentrow)
Validate Slash extension item element |
private struct |
validateDaysList(string targetList)
Validate list object against the RSS skipDays element requirements |
private struct |
validateHoursList(string targetList)
Validate list object against the RSS skipHours element requirements |
private boolean |
validateItunesDuration(string targetTime)
Force iTunes duration formatting |
private boolean |
validateNNInteger(string targetInt)
Validate number object as a non-negative integer (0,1,2,3 |
private boolean |
validatePerson(string targetString)
Validate string object against the RSS person scheme containing an e-mail and an optional name |
private boolean |
validateRFC1766(string targetString)
Validate string object against RFC1766 'Tags for the Identification of Languages' |
private boolean |
validateRFC3066(string targetString)
RFC3066 'Tags for the Identification of Languages' |
private boolean |
validateRFC822Date(string targetDate)
Validate date object against RFC822 'Date and Time Specification' |
private boolean |
validateURI(string targetString)
Validate string object against a HTTP or HTTPS, FTP, news, mailto URI |
private boolean |
validateURL(string targetString)
Validate string object against a URL |
private boolean |
validatecommonslicense(string targetString)
Validate targetString object as a URL pointing to the Creative Commons website |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Method Detail |
---|
private string RSSFormat(string string)
string
- The target stringprivate string URLFormat(string string)
string
- The target stringpublic string XSLFormat()
public string cclicenseGenChannel(struct fs)
fs
- The structure used to build a feedpublic string cclicenseGenItem(query items, struct map, numeric currentrow)
items
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberpublic string cclicenseValChannel(struct fs)
fs
- The structure used to build a feedpublic string cclicenseValItem(query fi, struct map, numeric currentrow)
fi
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberpublic struct createInstances(struct instance)
instance
- public string dcmtGenChannel(struct fs)
fs
- The structure used to build a feedpublic string dcmtGenItem(query items, struct map, numeric currentrow)
items
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberprivate string generateExtensionNameSpace(string keys)
keys
- A list of distinct column and structures keyspublic struct generateExtensionPropertyMap()
private string generateNum1kSeparator(numeric number, [string seperator=','])
number
- Integerseperator
- Seperator characterprivate string generateNumSuffix(numeric number, [string seperator=','])
number
- Integerseperator
- Seperator characterprivate string generateRFC822Date(string targetDate)
targetDate
- The target date which must be a valid datepublic string itunesGenChannel(struct fs)
fs
- The structure used to build a feedpublic string itunesGenItem(query items, struct map, numeric currentrow)
items
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberpublic string itunesValChannel(struct fs)
fs
- The structure used to build a feedpublic string ituneseValItem(query fi, struct map, numeric currentrow)
fi
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberpublic string opensearchGenChannel(struct fs)
fs
- The structure used to build a feedpublic string opensearchValChannel(struct fs)
fs
- The structure used to build a feedpublic struct parseColumnMap(struct columnMap)
columnMap
- The column map to parsepublic string slashGenItem(query items, struct map, numeric currentrow)
items
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberpublic string slashValItem(query fi, struct map, numeric currentrow)
fi
- The feed itemsmap
- The column mapper to map items to queriescurrentrow
- Current item numberprivate struct validateDaysList(string targetList)
targetList
- The target listprivate struct validateHoursList(string targetList)
targetList
- The target listprivate boolean validateItunesDuration(string targetTime)
targetTime
- The target duration timeprivate boolean validateNNInteger(string targetInt)
targetInt
- The target integerprivate boolean validatePerson(string targetString)
targetString
- The target stringprivate boolean validateRFC1766(string targetString)
targetString
- The target string.private boolean validateRFC3066(string targetString)
targetString
- The target stringprivate boolean validateRFC822Date(string targetDate)
targetDate
- The target date.private boolean validateURI(string targetString)
targetString
- The target stringprivate boolean validateURL(string targetString)
targetString
- The target stringprivate boolean validatecommonslicense(string targetString)
targetString
- The target string
|
ColdBox Platform v3.8.0 | ||||
FRAMES |