Docs
- Home
-
Quick Index
- Introduction
- ColdBox Overview
- Directory Layout & Conventions
- Request Life Cycles
- Application Bootstrapper
- Configuring
- Application Configuration
- Using configuration settings
- Fun Logging with LogBox
- Models
- ColdBox Models
- Dependency Injection via WireBox
- Active Entity
- Built-in ORM Services
- Hibernate Criteria Builder
- ORM Event Handling
- Views
- Layouts and Rendering in ColdBox
- Controllers
- Event Handlers
- ColdBox SES URL Mappings
- Object and Form Validation
- Request Context
- Request Context
- Extending the Request Context
- Tumble Down The Rabbit Hole...
- Flash RAM & Webflows
- Ajax Integration
- Powering Flex/Air/SOAP/REST Apps
- Caching with CacheBox
- Localization & i18n
- ColdBox Security
- Aspect Oriented Programming
- ColdBox Recipes
- Extending ColdBox
- ColdBox Modules & Architecture
- ColdBox Plugins
- Core Plugins Browser
- ColdBox Interceptors
- Core Interceptors Browser
- Testing
- Testing ColdBox Applications
- Mocking-Stubbing with MockBox
- Tools, IDE Extras
- ColdBox Platform Utilities
- IDE Syntax Dictionaries
- Standalone Projects
- ColdBox Cheatsheet
- API Docs
- Directory
SideBar
User Login 
Plugins:XMLConverter
last edited by
lmajano
on 11-Apr-2010
lmajano
on 11-Apr-2010
|
Exploring the XMLConverter Plugin
Overview
A utility tool that can marshall data to XML
arrayToXML
Converts an array into XML with no headers.
Returns
- This function returns string
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| data | array | Yes | --- | The array to convert |
| useCDATA | boolean | No | false | Use CDATA content for ALL values. False by default |
| rootName | string | Yes | The name of the root element, else it defaults to the internal defaults. |
Examples
toXML
Convert any type of data to XML. This method will auto-discover the type. Valid types are array,query,struct
Returns
- This function returns string
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| data | any | Yes | --- | The data to convert to xml |
| columnlist | string | No | --- | Choose which columns to inspect, by default it uses all the columns in the query, if using a query |
| useCDATA | boolean | No | false | Use CDATA content for ALL values. The default is false |
| addHeader | boolean | No | true | Add an xml header to the packet returned. |
| encoding | string | Yes | UTF-8 | The character encoding of the header. UTF-8 is the default |
| delimiter | string | No | , | The delimiter in the list. Comma by default |
| rootName | string | Yes | The name of the root element, else it defaults to the internal defaults. |
Examples
structToXML
Converts a struct into XML with no headers.
Returns
- This function returns string
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| data | any | Yes | --- | The structure, object, any to convert. |
| useCDATA | boolean | No | false | Use CDATA content for ALL values |
| rootName | string | Yes | The name of the root element, else it defaults to the internal defaults. |
Examples
queryToXML
Converts a query to XML with no headers.
Returns
- This function returns string
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| data | query | Yes | --- | The query to convert |
| CDATAColumns | string | No | Which columns to wrap in cdata tags | |
| columnlist | string | No | [runtime expression] | Choose which columns to include in the translation, by default it uses all the columns in the query |
| useCDATA | boolean | No | false | Use CDATA content for ALL values |
| rootName | string | Yes | The name of the root element, else it defaults to the internal defaults. |
Comments (