extensions extension cfc matrix - getrailo/railo GitHub Wiki

Table of Contents Extension CFCs matrix ExtensionConfig.cfc ExtensionStep.cfc ExtensionGroup.cfc ExtensionItem.cfc ExtensionOption.cfc Extension documentation:

The methods marked red are system methods and should therefore not be called in the installation application. The hierarchy looks like follows: ExtensionConfig.cfc ? ExtensionStep.cfc ? ExtensionGroup.cfc ? ExtensionItem.cfc ? ExtensionOption.cfc

Method	Description
createStep(string: label, string: decription): ExtensionStep	Creates and links a new step.
getSteps(): ExtensionStep[]	Returns all ExtensionSteps of the ExtesnionConfig.

Method	Description
init(string: label, string: description): ExtensionStep	Initalizes the ExtensionStep CFC. Is called on creation.
createGroup(string: label, string: decription): ExtensionStep	Creates and links a new group.
getGroups(): ExtensionGroup[]	Returns all ExtensionGroups of the ExtesnionStep.
getLabel(): string	Returns the label of the step .
getDescription(): string	Returns the description of the step.
setLabel(string: label): void	Sets the label
setDescription(string: label): void	Sets the description

Method	Description
init(string: label, string: description): ExtensionGroup	Initalizes the ExtensionGroup CFC. Is called on creation.
createItem(string: type, string: name, string: value, boolean: selected, string: label, string: decription): ExtensionItem	Creates and links a new item.
getItems(): ExtensionItem[]	Returns all ExtensionItems of the ExtesnionGroup.
getLabel(): string	Returns the label of the group.
getDescription(): string	Returns the description of the group.
setLabel(string: label): void	Sets the label
setDescription(string: label): void	Sets the description

Method	Description
init(string: type, string: name, string: value, boolean: selected, string: label, string: decription): ExtensionItem	Initalizes the ExtensionItem CFC. Is called on creation.
createOption(string: value, boolean: selected, string: label, string: decription): ExtensionOption	Creates and links a new option.
getOptions(): ExtensionOption[]	Returns all ExtensionOptions of the ExtesnionItem.
getType(): string	Returns the type of the Item. Valid values are:          text          radio          checkbox          select          hidden          password
getName(): string	Returns the name of the item
getValue(): string	Returns the value of the item
getSelected(): boolean	Returns whether the item is selected or not. Can be used when type is: select,radio,checkbox
getLabel(): string	Returns the label of the item
getDescription(): string	Returns the description of the item
setType(string: type): void	Sets the type of the item. Valid values are:          text          radio          checkbox          select          hidden          password
setName(string: name): void	Sets the name
setValue(string: value): void	Sets the value
setSelected(boolean: selected): void	Sets whether a certain option should be selected or not.
setLabel(string: label): void	Sets the label
setDescription(string: label): void	Sets the description

Method	Description
init(string: value, boolean: selected, string: label, string: decription): ExtensionOption	Initalizes the ExtensionOption CFC. Is called on creation.
getValue(): string	Returns the value of the item
getSelected(): boolean	Returns whether the item is selected or not.
getLabel(): string	Returns the label of the item
getDescription(): string	Returns the description of the item
setValue(string: value): void	Sets the value of the option
setSelected(boolean: selected): void	Sets whether the item is selected or not.
setLabel(string: label): void	Sets the label
setDescription(string: label): void	Sets the description

Next step - Support components

• Overview
• The extension provider
• The extension consumer
• The extension structure
• Adding dynamic content to the config.xml
• The config.xml matrix
• The extension.cfc matrix
• Support components