ColdBox Platform Version 2.6.3

coldbox.system.plugins
Class feedGenerator

WEB-INF.cftags.component
        extended by coldbox.system.frameworkSupertype
            extended by coldbox.system.plugin
                extended by coldbox.system.plugins.feedGenerator

public class feedGenerator
extends plugin

A feed generator plugin. This plugin only generates RSS 2.0 feeds.


Constructor Summary
init(any controller)
          Plugin Constructor.
 
Method Summary
 xml createFeed(struct feedStruct, [struct ColumnMap], [string OutputFile])
          Create an RSS 2.0 feed.
 string generateItems(struct feedStruct, [struct ColumnMap])
          Generate the items XML
private string generateRFC822Date(string targetDate)
          Generate an RFC8222 Date from a date object. Conformed to GMT
 struct getDefaultPropertyMap()
          Get the default property map
 struct parseColumnMap(struct columnMap)
          Parse and validate a column mapper
 void verifyFeed(struct feedStruct)
          Verify the feed structure and append auto-generated properties.
 
Methods inherited from class coldbox.system.plugin
getPluginDescription, getPluginName, getPluginVersion, getpluginPath, setPluginDescription, setPluginName, setPluginVersion
 
Methods inherited from class coldbox.system.frameworkSupertype
abort, announceInterception, dump, getColdboxOCM, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getcontroller, getfwLocale, htmlhead, include, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, rethrowit, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setcontroller, settingExists, throw
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)

Method Detail

createFeed

public xml createFeed(struct feedStruct, [struct ColumnMap], [string OutputFile])
Create an RSS 2.0 feed.

Parameters:
feedStruct - The structure used to build a feed. Look at docs for more info.
ColumnMap - The column mapper to use for the items query.
OutputFile - The file destination of where to store the generated XML

generateItems

public string generateItems(struct feedStruct, [struct ColumnMap])
Generate the items XML

Parameters:
feedStruct - The structure used to build a feed. Look at docs for more info.
ColumnMap - The column mapper to use for the items query.

generateRFC822Date

private string generateRFC822Date(string targetDate)
Generate an RFC8222 Date from a date object. Conformed to GMT

Parameters:
targetDate - The target Date. Must be a valid date.

getDefaultPropertyMap

public struct getDefaultPropertyMap()
Get the default property map


parseColumnMap

public struct parseColumnMap(struct columnMap)
Parse and validate a column mapper

Parameters:
columnMap - The column map to parse

verifyFeed

public void verifyFeed(struct feedStruct)
Verify the feed structure and append auto-generated properties.

Parameters:
feedStruct - The feed structure

ColdBox Platform Version 2.6.3