|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.frameworkSupertype
coldbox.system.plugin
coldbox.system.plugins.cfcViewer
public class cfcViewer
This components provides functionality to obtain information about cfcs via introspection.
Constructor Summary | |
---|---|
init(any controller)
|
Method Summary | |
---|---|
string |
buildLink(string package)
Build a link for a package name |
private array |
buildPackages(Array aPackages, string directory, string parentName)
Create an array of package names |
string |
buildRootLink()
Build a link for a root name |
private string |
getAbsolutePath(string targetPath)
Get an absolute path |
any |
getCFCMetaData(string cfcName)
returns a structure with information about the given component. This structure contains information about returntype, methods, parameters, etc. |
string |
getDirpath()
Get the dirpath of where the cfc's reside. This is expanded. |
string |
getLinkBaseURL()
|
string |
getRenderingTemplate()
Get rendering template to use |
string |
getStyleSheet()
Get the stylesheet to use when rendering the documentation. |
array |
getaCFC()
returns an array with the names of all components within the current directory |
array |
getaPacks()
Get aPacks |
string |
getlinkString()
Get linkString |
string |
getlinkType()
Get linkType |
string |
getlstAccessTypes()
Get lstAccessTypes |
string |
getrootPath()
Get rootPath |
private array |
inheritanceRecursion(array tree, struct md)
Inheritance Recursion |
any |
renderit()
Render the content |
void |
setLinkBaseURL(string LinkBaseURL)
|
void |
setRenderingTemplate(string RenderingTemplate)
Set the rendering template to use |
void |
setStyleSheet(string styleSheet)
Set the stylesheet to use when rendering the documentation |
void |
setaCFC(array aCFC)
Set CFCs |
void |
setaPacks(array aPacks)
Set aPacks |
void |
setdirpath(string dirpath)
Set the dirpath |
void |
setlinkString(string linkString)
Set linkString |
void |
setlinkType(string linkType)
Set linkType |
void |
setlstAccessTypes(string lstAccessTypes)
Set lstAccessTypes |
void |
setrootPath(string rootPath)
Set rootPath |
cfcViewer |
setup(string dirpath, [string accessTypesFilter=''], [string dirLink], [string jsLink], [string RenderingTemplate], [string LinkBaseURL])
Use this method to initialize for documentation. You must persist it in your request so you can do renderings and interact with the object. |
Methods inherited from class coldbox.system.plugin |
---|
getPluginDescription, getPluginName, getPluginVersion, getpluginPath, setPluginDescription, setPluginName, setPluginVersion
|
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any controller)
Method Detail |
---|
public string buildLink(string package)
package
- private array buildPackages(Array aPackages, string directory, string parentName)
aPackages
- The array to append todirectory
- The target directory to recurseparentName
- The parent packagepublic string buildRootLink()
private string getAbsolutePath(string targetPath)
targetPath
- public any getCFCMetaData(string cfcName)
cfcName
- The name of the cfcpublic string getDirpath()
public string getLinkBaseURL()
public string getRenderingTemplate()
public string getStyleSheet()
public array getaCFC()
public array getaPacks()
public string getlinkString()
public string getlinkType()
public string getlstAccessTypes()
public string getrootPath()
private array inheritanceRecursion(array tree, struct md)
tree
- The arraymd
- The extends mdpublic any renderit()
public void setLinkBaseURL(string LinkBaseURL)
LinkBaseURL
public void setRenderingTemplate(string RenderingTemplate)
RenderingTemplate
public void setStyleSheet(string styleSheet)
styleSheet
public void setaCFC(array aCFC)
aCFC
public void setaPacks(array aPacks)
aPacks
public void setdirpath(string dirpath)
dirpath
public void setlinkString(string linkString)
linkString
public void setlinkType(string linkType)
linkType
public void setlstAccessTypes(string lstAccessTypes)
lstAccessTypes
public void setrootPath(string rootPath)
rootPath
public cfcViewer setup(string dirpath, [string accessTypesFilter=''], [string dirLink], [string jsLink], [string RenderingTemplate], [string LinkBaseURL])
dirpath
- 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/systemaccessTypesFilter
- Use this argument to only display methods with the access types given. If empty, displays all methods (public, private, remote, package).dirLink
- 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
- 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 choosenRenderingTemplate
- Override the rendering template with yoursLinkBaseURL
- The base url to use for anchors
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |