Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES  

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 plug-in. Currently this plug-in only generates RSS 2.0 feeds.

Constructor Summary
init(any controller)
          Plug-in constructor
 
Method Summary
 any createFeed(struct feedStruct, [struct ColumnMap='[runtime expression]'], [string OutputFile], [boolean OutputXML])
          Create a web feed, by default it returns the xml string
 struct getDefaultPropertyMap()
          Get the default property map
 struct parseColumnMap(struct columnMap)
          Parse and validate a column mapper
 
Methods inherited from class coldbox.system.Plugin
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
 
Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)
Plug-in constructor.

Parameters:
controller
Method Detail

createFeed

public any createFeed(struct feedStruct, [struct ColumnMap='[runtime expression]'], [string OutputFile], [boolean OutputXML])
Create a web feed, by default it returns the xml string.

Parameters:
feedStruct - The structure used to build a feed
ColumnMap - The column mapper to wire items to queries
OutputFile - The file destination of where to store the generated XML (optional)
OutputXML - Toggle to display the XML output on-screen delivered by cfcontent (optional)

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
Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES