Docs
- Home
-
Quick Index
- Introduction
- ColdBox Overview
- My First Application
- Directory Layout & Conventions
- Request Life Cycles
- ColdBox Major Classes
- Configuring
- Application Configuration
- Using configuration settings
- Fun Logging with LogBox
- Models
- ColdBox Models
- Built-in ORM Services
- ORM Event Handling
- Dependency Injection via WireBox
- Views
- Layouts and Rendering in ColdBox
- Controllers
- Event Handlers
- ColdBox SES URL Mappings
- ColdBox Modules & Architecture
- Request Context
- Request Context
- Extending the Request Context
- Tumble Down The Rabbit Hole...
- Flash RAM & Webflows
- ColdBox URL Actions
- Integrating with Ajax
- Powering Flex/Air/Remote Apps
- Application.cfc Bootstrapper
- Caching with CacheBox
- ColdBox Recipes
- Localization & i18n
- Securing your apps
- Aspect Oriented Programming
- Extending ColdBox
- 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:CFCViewer
last edited by
lmajano
on 16-Apr-2010
lmajano
on 16-Apr-2010
|
Exploring the CFCViewer Plugin
Overview
This plugin provides functionality to obtain information about CFCs via introspection and generate cool documentation about them.
setRenderingTemplate
Set the rendering template to use instead of the default ColdBox one.
Returns
- This function returns void
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| RenderingTemplate | string | Yes | --- |
Examples
getPlugin("CFCViewer").setRenderingTemplate("/includes/MyDocs.cfm");
renderit
Render the content
Returns
- This function returns any
Examples
// Choose where you want the docs to be rendered: <div id="content"> #getPlugin("CFCViewer").renderit()# </div>
getDirpath
Get the dirpath of where the cfc's reside. This is expanded.
Returns
- This function returns string
getaCFC
returns an array with the names of all components within the current directory
Returns
- This function returns array
Examples
// mostly used when building your own rendering templates <cfloop array="#getPlugin("CFCViewer").getaCFC()#"> </cfloop>
setup
Use this method to initialize for documentation. You must persist it in your request so you can do renderings and interact with the object.
Returns
- This function returns CFCViewer
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| dirpath | string | Yes | --- | The directory path to which is the root of what you want the cfcviewer to report on. This must be a valid instantiation path: ex: /coldbox/system |
| accessTypesFilter | string | No | Use this argument to only display methods with the access types given. If empty, displays all methods (public, private, remote, package). | |
| dirLink | string | No | --- | If you pass this. it will create a linkable directory or package structure according to the link provided and append an internal package variable. |
| jsLink | string | No | --- | If you pass this, it will create a linkable package according to the js provided. Also, place a @package@ on your link, so it can correctly identify where to place the url parameter for the package choosen |
| RenderingTemplate | string | No | --- | Override the rendering template with yours |
| LinkBaseURL | string | No | --- | The base url to use for anchors |
Examples
// setup the documentation viewer = getPlugin("CFCViewer").setup(dirPath="/coldbox/system/plugins",linkBaseURL=getSetting('sesBaseURL')); // setup the documentation viewer = getPlugin("CFCViewer").setup(dirPath="/coldbox/system/plugins",accessTypeFilter="public,remote"); // setup the documentation via JS links viewer = getPlugin("CFCViewer").setup(dirPath="/coldbox/system/plugins",jsLink="changeDocs('@package@')");
setStyleSheet
Set the stylesheet to use when rendering the documentation
Returns
- This function returns void
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| styleSheet | string | Yes | --- |
Examples
viewer.setStyleSheet('includes/docs/mydocs.css');
getaPacks
Get aPacks
Returns
- This function returns array
Examples
// get the packages array that is found in the current documentation directory
packages = viewer.getaPacks();
Comments (