| $APPENDCOMPILEDFILETYPETOFILEPATH |
| function $appendCompiledFileTypeToFilePath |
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $ARRAYMERGE |
| function $arrayMerge |
Arguments:
| Name |
Required |
Type |
Default |
| arr1 |
Required |
array |
|
| arr2 |
Required |
array |
|
|
| ReturnType: |
array
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I add all the elemnts of one array to another, returning the result |
| Description: |
|
|
|
| $CALCULATERELATIVEPATH |
| function $calculateRelativePath |
Arguments:
| Name |
Required |
Type |
Default |
| basePath |
Required |
string |
|
| relativePath |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $CREATETEMPORARYFILENAME |
| function $createTemporaryFilename |
Arguments:
| Name |
Required |
Type |
Default |
| extension |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $DIRECTORYCLEAN |
| function $directoryClean |
Arguments:
| Name |
Required |
Type |
Default |
| directory |
Required |
string |
|
| excludeFiles |
Optional |
string |
[empty string] |
| fileTypes |
Optional |
string |
[empty string] |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I delete all the files in a directory |
| Description: |
|
|
|
| $DIRECTORYCREATE |
| function $directoryCreate |
Arguments:
| Name |
Required |
Type |
Default |
| directory |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $DIRECTORYLIST |
| function $directoryList |
Arguments:
| Name |
Required |
Type |
Default |
| directory |
Required |
string |
|
| filter |
Optional |
string |
*.* |
| recurse |
Optional |
boolean |
true |
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return a query of files and subdirectories for a given directory |
| Description: |
|
|
|
| $ENSUREFULLDIRECTORYPATH |
| function $ensureFullDirectoryPath |
Arguments:
| Name |
Required |
Type |
Default |
| dir |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $ENSUREFULLFILEPATH |
| function $ensureFullFilePath |
Arguments:
| Name |
Required |
Type |
Default |
| file |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $EXTRACTURLFROMRENDEREDINCLUDE |
| function $extractUrlFromRenderedInclude |
Arguments:
| Name |
Required |
Type |
Default |
| renderedInclude |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $FILEDELETE |
| function $fileDelete |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $FILELASTMODIFIED |
| function $fileLastModified |
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
string |
|
|
| ReturnType: |
date
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the last modified date of the given file (path) |
| Description: |
|
|
|
| $FILEREAD |
| function $fileRead |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the content of the given file (path) |
| Description: |
|
|
|
| $FILEREADBINARY |
| function $fileReadBinary |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
| convertToBase64 |
Optional |
boolean |
false |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the content of the given file (path) |
| Description: |
|
|
|
| $FILEWRITE |
| function $fileWrite |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
| content |
Required |
string |
|
| charset |
Optional |
string |
utf-8 |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I write the passed content to the given file (path) |
| Description: |
|
|
|
| $GENERATECACHEBUSTER |
| function $generateCacheBuster |
Arguments:
| Name |
Required |
Type |
Default |
| dateLastModified |
Optional |
date |
[runtime expression] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return a cachebuster string for a given date |
| Description: |
|
|
|
| $GETSTRINGBUFFER |
| function $getStringBuffer |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $HTTPGET |
| function $httpGet |
Arguments:
| Name |
Required |
Type |
Default |
| urlToGet |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I attempt to get and return the content of the passed url over http. |
| Description: |
|
|
|
| $ISTEMPORARYFILENAME |
| function $isTemporaryFileName |
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $ISURL |
| function $isUrl |
Arguments:
| Name |
Required |
Type |
Default |
| stringToCheck |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return whether or not the passed string is a url (based on a very crude regex, do not use for any stringent url checking) |
| Description: |
|
|
|
| $LISTAPPEND |
| function $listAppend |
Arguments:
| Name |
Required |
Type |
Default |
| list |
Required |
string |
|
| value |
Required |
string |
|
| delimiter |
Optional |
string |
, |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I override listAppend, ensuring that, when a list already contains its delimiter at the end, a duplicate delimiter is not appended |
| Description: |
|
|
|
| $LISTDELETELAST |
| function $listDeleteLast |
Arguments:
| Name |
Required |
Type |
Default |
| list |
Required |
string |
|
| delimiter |
Optional |
string |
, |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I delete the last member of the passed string, returning the result of the deletion. |
| Description: |
|
|
|
| $LOADJAVACLASS |
| function $loadJavaClass |
Arguments:
| Name |
Required |
Type |
Default |
| className |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I isntanciate and return a java object |
| Description: |
|
|
|
| $NEWLINE |
| function $newline |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $NORMALIZEUNIXANDWINDOWSPATHS |
| function $normalizeUnixAndWindowsPaths |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $RENDERCSSINCLUDE |
| function $renderCssInclude |
Arguments:
| Name |
Required |
Type |
Default |
| src |
Required |
string |
|
| media |
Required |
string |
|
| ieConditional |
Optional |
string |
[empty string] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the html necessary to include the given css file |
| Description: |
|
|
|
| $RENDERIECONDITIONAL |
| function $renderIeConditional |
Arguments:
| Name |
Required |
Type |
Default |
| include |
Required |
string |
|
| ieConditional |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I wrap an html include string with IE conditional statements when necessary, returning the result |
| Description: |
|
|
|
| $RENDERJSINCLUDE |
| function $renderJsInclude |
Arguments:
| Name |
Required |
Type |
Default |
| src |
Required |
string |
|
| ieConditional |
Optional |
string |
[empty string] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the html nevessary to include the given javascript file |
| Description: |
|
|
|
| $RESEARCH |
| function $reSearch |
Arguments:
| Name |
Required |
Type |
Default |
| regex |
Required |
string |
|
| text |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I perform a Regex search and return a struct of arrays containing pattern match information. Each key represents the position of a match, i.e. $1, $2, etc. Each key contains an array of matches. |
| Description: |
|
|
|
| $SHOULDFILEBEINCLUDED |
| function $shouldFileBeIncluded |
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
string |
|
| includePattern |
Required |
string |
|
| excludePattern |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| $THROW |
| function $throw |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Optional |
string |
CfMinify.error |
| message |
Optional |
string |
|
| detail |
Optional |
string |
|
| errorCode |
Optional |
string |
|
| extendedInfo |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I throw an error |
| Description: |
|
|
|
| $UNIQUELIST |
| function $uniqueList |
Arguments:
| Name |
Required |
Type |
Default |
| list |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _ADDRENDEREDINCLUDETOCACHE |
| function _addRenderedIncludeToCache |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| path |
Required |
string |
|
| rendered |
Required |
string |
|
| debug |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _ANYTHINGTORENDER |
| function _anythingToRender |
Arguments:
| Name |
Required |
Type |
Default |
| filters |
Required |
array |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _APPENDFILETYPESTOSPECIALINCLUDES |
| function _appendFileTypesToSpecialIncludes |
Arguments:
| Name |
Required |
Type |
Default |
| includedFile |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CACHEINCLUDEMAPPINGS |
| function _cacheIncludeMappings |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I calculate the include mappings. The mappings are a quick referenced storage of a given 'include' string that a coder might use to include a package or file that is mapped to the resultant set of packages and files that it might need to include given its dependencies. These mappings then negate the need to calculate dependencies on every request (making cfstatic super fast). |
| Description: |
|
|
|
| _CACHERENDEREDINCLUDES |
| function _cacheRenderedIncludes |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CACHERENDEREDINCLUDESFORALLMODE |
| function _cacheRenderedIncludesForAllMode |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CACHERENDEREDINCLUDESFORFILEMODE |
| function _cacheRenderedIncludesForFileMode |
Arguments:
| Name |
Required |
Type |
Default |
| debug |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CACHERENDEREDINCLUDESFORPACKAGEMODE |
| function _cacheRenderedIncludesForPackageMode |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CHAINABLE |
| function _chainable |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CLEAROUTTEMPORARYLESSFILES |
| function _clearoutTemporaryLessFiles |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CLEARPACKAGEOBJECTS |
| function _clearPackageObjects |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _CLEARREQUESTDATA |
| function _clearRequestData |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _COMPILATIONNECESSARY |
| function _compilationNecessary |
Arguments:
| Name |
Required |
Type |
Default |
| collectionPackageOrFile |
Required |
any |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I calculate whether or not compilation is neccessary for the given file, package or packageCollection object. The desicion is based on the presence of a compiled file and the last modified dates of the compiled file and source files. Compilation can also be forced with the forceCompilation config option. |
| Description: |
|
|
|
| _COMPILEALL |
| function _compileAll |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I compile all the js files into a single minified js file and all the css files into a single css file. |
| Description: |
|
|
|
| _COMPILECOFFEESCRIPT |
| function _compileCoffeeScript |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _COMPILECSSANDJAVASCRIPT |
| function _compileCssAndJavascript |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I instantiate the compiling of static files, using different methods depending on the value of the 'minifyMode' config option (passed to the constructor) |
| Description: |
|
|
|
| _COMPILECSSFILE |
| function _compileCssFile |
Arguments:
| Name |
Required |
Type |
Default |
| file |
Required |
org.cfstatic.core.StaticFile |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I compile a single css file, returning the compiled string |
| Description: |
|
|
|
| _COMPILEFILES |
| function _compileFiles |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I compile all the js and css files, compiling each single source file as a single compiled file. |
| Description: |
|
|
|
| _COMPILEJSFILE |
| function _compileJsFile |
Arguments:
| Name |
Required |
Type |
Default |
| file |
Required |
org.cfstatic.core.StaticFile |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I compile a single js file, returning the compiled string |
| Description: |
|
|
|
| _COMPILELESS |
| function _compileLess |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _COMPILEPACKAGES |
| function _compilePackages |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I compile all the js and css files into a single file per package (directory containing files) |
| Description: |
|
|
|
| _FILESHAVECHANGED |
| function _filesHaveChanged |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETADDCACHEBUSTERS |
| function _getAddCacheBusters |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETADDIMAGECACHEBUSTERS |
| function _getAddImageCacheBusters |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCHECKFORUPDATES |
| function _getCheckForUpdates |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCOFFEESCRIPTCOMPILER |
| function _getCoffeeScriptCompiler |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCSSDEPENDENCYFILE |
| function _getCssDependencyFile |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCSSDIRECTORY |
| function _getCssDirectory |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCSSIMAGEPARSER |
| function _getCssImageParser |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCSSPACKAGES |
| function _getCssPackages |
| Arguments: | none |
| ReturnType: |
org.cfstatic.core.PackageCollection
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETCSSURL |
| function _getCssUrl |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETDEBUG |
| function _getDebug |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETDEBUGALLOWED |
| function _getDebugAllowed |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETDEBUGKEY |
| function _getDebugKey |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETDEBUGPASSWORD |
| function _getDebugPassword |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETDEPENDENCIESFROMFILE |
| function _getDependenciesFromFile |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETDOWNLOADEXTERNALS |
| function _getDownloadExternals |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETEMBEDCSSIMAGES |
| function _getEmbedCssImages |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETEXCLUDEPATTERN |
| function _getExcludePattern |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETFILESTATE |
| function _getFileState |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETFILESTATECACHE |
| function _getFileStateCache |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETFORCECOMPILATION |
| function _getForceCompilation |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETINCLUDEALLBYDEFAULT |
| function _getIncludeAllByDefault |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETINCLUDEMAPPINGS |
| function _getIncludeMappings |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETINCLUDEMAPPINGSFORFILE |
| function _getIncludeMappingsForFile |
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
string |
|
| file |
Required |
any |
|
| pkgInclude |
Required |
string |
|
| mappings |
Required |
struct |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETINCLUDEMAPPINGSFORPACKAGE |
| function _getIncludeMappingsForPackage |
Arguments:
| Name |
Required |
Type |
Default |
| packageName |
Required |
string |
|
| packageType |
Required |
string |
|
| mappings |
Required |
struct |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETINCLUDEPATTERN |
| function _getIncludePattern |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETJAVALOADER |
| function _getJavaLoader |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETJSDATAVARIABLE |
| function _getJsDataVariable |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETJSDEPENDENCYFILE |
| function _getJsDependencyFile |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETJSDIRECTORY |
| function _getJsDirectory |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETJSPACKAGES |
| function _getJsPackages |
| Arguments: | none |
| ReturnType: |
org.cfstatic.core.PackageCollection
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETJSURL |
| function _getJsUrl |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETLESSCOMPILER |
| function _getLessCompiler |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETLESSGLOBALS |
| function _getLessGlobals |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETLESSGLOBALSLASTMODIFIED |
| function _getLessGlobalsLastModified |
| Arguments: | none |
| ReturnType: |
date
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETMINIFIEDURL |
| function _getMinifiedUrl |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETMINIFYMODE |
| function _getMinifyMode |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETOUTPUTCHARSET |
| function _getOutputCharset |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETOUTPUTDIRECTORY |
| function _getOutputDirectory |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETPACKAGE |
| function _getPackage |
Arguments:
| Name |
Required |
Type |
Default |
| packageName |
Required |
string |
|
| packageType |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETRENDEREDINCLUDECACHE |
| function _getRenderedIncludeCache |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| debug |
Optional |
boolean |
false |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETREQUESTDATA |
| function _getRequestData |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I get the structure of data to be rendered as javascript variables for this request |
| Description: |
|
|
|
| _GETREQUESTINCLUDEFILTERS |
| function _getRequestIncludeFilters |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| debugMode |
Optional |
boolean |
false |
|
| ReturnType: |
array
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETREQUESTINCLUDES |
| function _getRequestIncludes |
| Arguments: | none |
| ReturnType: |
array
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I get the array of includes for this request |
| Description: |
|
|
|
| _GETROOTDIRECTORY |
| function _getRootDirectory |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETTHROWONMISSINGINCLUDE |
| function _getThrowOnMissingInclude |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _GETYUICOMPRESSOR |
| function _getYuiCompressor |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _ISDEBUGONFORREQUEST |
| function _isDebugOnForRequest |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _LOADCOMPILERS |
| function _loadCompilers |
Arguments:
| Name |
Required |
Type |
Default |
| javaLoaderScope |
Optional |
string |
server |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I instantiate all the compilers used by cfstatic |
| Description: |
|
|
|
| _LOADJAVALOADERS |
| function _loadJavaLoaders |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _PACKAGEDIRECTORY |
| function _packageDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| rootDirectory |
Required |
string |
|
| rootUrl |
Required |
string |
|
| minifiedUrl |
Required |
string |
|
| fileType |
Required |
string |
|
| dependencies |
Optional |
struct |
[runtime expression] |
|
| ReturnType: |
org.cfstatic.core.PackageCollection
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I take a directory and return a processed PackageCollection object (with stored metadata about the packages and files within it) |
| Description: |
|
|
|
| _PROCESSSTATICFILES |
| function _processStaticFiles |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I call all the methods that do the grunt work of cfstatic (processing all the file metadata, caching relationships and compiling files) |
| Description: |
|
|
|
| _READLESSIMPORTS |
| function _readLessImports |
Arguments:
| Name |
Required |
Type |
Default |
| filePath |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _RENDERREQUESTDATA |
| function _renderRequestData |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I render any data set for the request as a javascript variable |
| Description: |
|
|
|
| _RESOURCEEXISTS |
| function _resourceExists |
Arguments:
| Name |
Required |
Type |
Default |
| resource |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SCANFORIMPORTEDLESSFILES |
| function _scanForImportedLessFiles |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETADDCACHEBUSTERS |
| function _setAddCacheBusters |
Arguments:
| Name |
Required |
Type |
Default |
| addCacheBusters |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETADDIMAGECACHEBUSTERS |
| function _setAddImageCacheBusters |
Arguments:
| Name |
Required |
Type |
Default |
| addImageCacheBusters |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCHECKFORUPDATES |
| function _setCheckForUpdates |
Arguments:
| Name |
Required |
Type |
Default |
| checkForUpdates |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCOFFEESCRIPTCOMPILER |
| function _setCoffeeScriptCompiler |
Arguments:
| Name |
Required |
Type |
Default |
| CoffeeScriptCompiler |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCSSDEPENDENCYFILE |
| function _setCssDependencyFile |
Arguments:
| Name |
Required |
Type |
Default |
| cssDependencyFile |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCSSDIRECTORY |
| function _setCssDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| cssDirectory |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCSSIMAGEPARSER |
| function _setCssImageParser |
Arguments:
| Name |
Required |
Type |
Default |
| cssImageParser |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCSSPACKAGES |
| function _setCssPackages |
Arguments:
| Name |
Required |
Type |
Default |
| cssPackages |
Required |
org.cfstatic.core.PackageCollection |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETCSSURL |
| function _setCssUrl |
Arguments:
| Name |
Required |
Type |
Default |
| cssUrl |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETDEBUG |
| function _setDebug |
Arguments:
| Name |
Required |
Type |
Default |
| debug |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETDEBUGALLOWED |
| function _setDebugAllowed |
Arguments:
| Name |
Required |
Type |
Default |
| debugAllowed |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETDEBUGKEY |
| function _setDebugKey |
Arguments:
| Name |
Required |
Type |
Default |
| debugKey |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETDEBUGPASSWORD |
| function _setDebugPassword |
Arguments:
| Name |
Required |
Type |
Default |
| debugPassword |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETDOWNLOADEXTERNALS |
| function _setDownloadExternals |
Arguments:
| Name |
Required |
Type |
Default |
| downloadExternals |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETEMBEDCSSIMAGES |
| function _setEmbedCssImages |
Arguments:
| Name |
Required |
Type |
Default |
| embedCssImages |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETEXCLUDEPATTERN |
| function _setExcludePattern |
Arguments:
| Name |
Required |
Type |
Default |
| excludePattern |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETFILESTATECACHE |
| function _setFileStateCache |
Arguments:
| Name |
Required |
Type |
Default |
| fileStateCache |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETFORCECOMPILATION |
| function _setForceCompilation |
Arguments:
| Name |
Required |
Type |
Default |
| forceCompilation |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETINCLUDEALLBYDEFAULT |
| function _setIncludeAllByDefault |
Arguments:
| Name |
Required |
Type |
Default |
| includeAllByDefault |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETINCLUDEMAPPINGS |
| function _setIncludeMappings |
Arguments:
| Name |
Required |
Type |
Default |
| includeMappings |
Required |
struct |
|
| type |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETINCLUDEPATTERN |
| function _setIncludePattern |
Arguments:
| Name |
Required |
Type |
Default |
| includePattern |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETJAVALOADER |
| function _setJavaLoader |
Arguments:
| Name |
Required |
Type |
Default |
| javaLoader |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETJSDATAVARIABLE |
| function _setJsDataVariable |
Arguments:
| Name |
Required |
Type |
Default |
| JsDataVariable |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETJSDEPENDENCYFILE |
| function _setJsDependencyFile |
Arguments:
| Name |
Required |
Type |
Default |
| JsDependencyFile |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETJSDIRECTORY |
| function _setJsDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| jsDirectory |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETJSPACKAGES |
| function _setJsPackages |
Arguments:
| Name |
Required |
Type |
Default |
| jsPackages |
Required |
org.cfstatic.core.PackageCollection |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETJSURL |
| function _setJsUrl |
Arguments:
| Name |
Required |
Type |
Default |
| jsUrl |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETLESSCOMPILER |
| function _setLessCompiler |
Arguments:
| Name |
Required |
Type |
Default |
| lessCompiler |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETLESSGLOBALS |
| function _setLessGlobals |
Arguments:
| Name |
Required |
Type |
Default |
| lessGlobals |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETMINIFIEDURL |
| function _setMinifiedUrl |
Arguments:
| Name |
Required |
Type |
Default |
| minifiedUrl |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETMINIFYMODE |
| function _setMinifyMode |
Arguments:
| Name |
Required |
Type |
Default |
| minifyMode |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETOUTPUTCHARSET |
| function _setOutputCharset |
Arguments:
| Name |
Required |
Type |
Default |
| outputCharset |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETOUTPUTDIRECTORY |
| function _setOutputDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| outputDirectory |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETPROPERTIES |
| function _setProperties |
Arguments:
| Name |
Required |
Type |
Default |
| staticDirectory |
Required |
string |
|
| staticUrl |
Required |
string |
|
| jsDirectory |
Optional |
string |
js |
| cssDirectory |
Optional |
string |
css |
| outputDirectory |
Optional |
string |
min |
| minifyMode |
Optional |
string |
package |
| downloadExternals |
Optional |
boolean |
false |
| addCacheBusters |
Optional |
boolean |
true |
| addImageCacheBusters |
Optional |
boolean |
true |
| debugAllowed |
Optional |
boolean |
true |
| debugKey |
Optional |
string |
debug |
| debugPassword |
Optional |
string |
true |
| debug |
Optional |
boolean |
false |
| forceCompilation |
Optional |
boolean |
false |
| checkForUpdates |
Optional |
boolean |
false |
| includeAllByDefault |
Optional |
boolean |
true |
| embedCssImages |
Optional |
string |
none |
| includePattern |
Optional |
string |
.* |
| excludePattern |
Optional |
string |
[empty string] |
| outputCharset |
Optional |
string |
utf-8 |
| lessGlobals |
Optional |
string |
[empty string] |
| jsDataVariable |
Optional |
string |
cfrequest |
| jsDependencyFile |
Optional |
string |
[empty string] |
| cssDependencyFile |
Optional |
string |
[empty string] |
| throwOnMissingInclude |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETREQUESTDATA |
| function _setRequestData |
Arguments:
| Name |
Required |
Type |
Default |
| requestData |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I set the structure of data to be rendered as javascript variables for this request |
| Description: |
|
|
|
| _SETREQUESTINCLUDES |
| function _setRequestIncludes |
Arguments:
| Name |
Required |
Type |
Default |
| requestIncludes |
Required |
array |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I set the array of includes for this request |
| Description: |
|
|
|
| _SETROOTDIRECTORY |
| function _setRootDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| rootDirectory |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETTHROWONMISSINGINCLUDE |
| function _setThrowOnMissingInclude |
Arguments:
| Name |
Required |
Type |
Default |
| throwOnMissingInclude |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETUPRENDEREDINCLUDECACHE |
| function _setupRenderedIncludeCache |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| _SETUPREQUEST |
| function _setupRequest |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I setup all the skeleton data for a new request. I also check to see whether or not we should attempt to recompile all the static files (dev mode) |
| Description: |
|
|
|
| _SETYUICOMPRESSOR |
| function _setYuiCompressor |
Arguments:
| Name |
Required |
Type |
Default |
| yuiCompressor |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETINCLUDEURL |
| function getIncludeUrl |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| resource |
Required |
string |
|
| throwOnMissing |
Optional |
boolean |
[runtime expression] |
| debugMode |
Optional |
boolean |
[runtime expression] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the getIncludeUrl() method. I return the URL of the compiled asset for the given path. |
| Description: |
|
|
|
| INCLUDE |
| function include |
Arguments:
| Name |
Required |
Type |
Default |
| resource |
Required |
string |
|
| throwOnMissing |
Optional |
boolean |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the include() method. Call me on each request to specify that a static resource should be included in the requested page. I return a reference to the cfstatic object and can therefore be chained. e.g. cfstatic.include('/css/core/').include('/css/homepage/homepage.css'); |
| Description: |
|
|
|
| INCLUDEDATA |
| function includeData |
Arguments:
| Name |
Required |
Type |
Default |
| data |
Required |
struct |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the includeData() method. Call me on each request to make ColdFusion data available to your javascript code. Data passed in to this method (as a struct) will be output as a global javascript variable named 'cfrequest'. So, if you pass in a structure like so: {siteroot='/mysite/', dataurl='/mysite/getdata'}, you will have 'cfrequest.siteroot' and cfrequest.dataurl as variables available to any javascript files included with cfstatic. |
| Description: |
|
|
|
| INIT |
| function init |
Arguments:
| Name |
Required |
Type |
Default |
| staticDirectory |
Required |
string |
|
| staticUrl |
Required |
string |
|
| jsDirectory |
Optional |
string |
js |
| cssDirectory |
Optional |
string |
css |
| outputDirectory |
Optional |
string |
min |
| minifyMode |
Optional |
string |
package |
| downloadExternals |
Optional |
boolean |
false |
| addCacheBusters |
Optional |
boolean |
true |
| addImageCacheBusters |
Optional |
boolean |
true |
| debugAllowed |
Optional |
boolean |
true |
| debugKey |
Optional |
string |
debug |
| debugPassword |
Optional |
string |
true |
| debug |
Optional |
boolean |
false |
| forceCompilation |
Optional |
boolean |
false |
| checkForUpdates |
Optional |
boolean |
false |
| includeAllByDefault |
Optional |
boolean |
true |
| embedCssImages |
Optional |
string |
none |
| includePattern |
Optional |
string |
.* |
| excludePattern |
Optional |
string |
[empty string] |
| outputCharset |
Optional |
string |
utf-8 |
| javaLoaderScope |
Optional |
string |
server |
| lessGlobals |
Optional |
string |
[empty string] |
| jsDataVariable |
Optional |
string |
cfrequest |
| jsDependencyFile |
Optional |
string |
[empty string] |
| cssDependencyFile |
Optional |
string |
[empty string] |
| throwOnMissingInclude |
Optional |
boolean |
false |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the constructor for CfStatic. Pass in your CfStatic configuration options to me. |
| Description: |
|
|
|
| RENDERINCLUDES |
| function renderIncludes |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Optional |
string |
|
| debugMode |
Optional |
boolean |
[runtime expression] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the renderIncludes() method. I return the html required for including all the static resources needed for the requested page. If no includes have been specified, I include *all* static resources. |
| Description: |
|
|
|