Class
baseHandler
lucee.Component
coldbox.system.FrameworkSupertype
coldbox.system.EventHandler
coldbox.system.RestHandler
contentbox.modules.contentbox-admin.handlers.baseHandler
Direct Known Subclasses:
about
,
authors
,
baseContentHandler
,
categories
,
ckfilebrowser
,
comments
,
content
,
contentTemplates
,
dashboard
,
emailTemplates
,
globalHTML
,
mediamanager
,
menus
,
modules
,
permissionGroups
,
permissions
,
roles
,
securityRules
,
settings
,
sites
,
subscribers
,
themes
,
tools
,
versions
,
widgets
Copyright 2005-2007 ColdBox Framework by Luis Majano and Ortus Solutions, Corp
www.ortussolutions.com
The Base handler for ALL ContentBox admin handlers.
Class Attributes:
synchronized
: false
accessors
: false
persistent
: false
Property Summary
type
property
default
serializable
required
any
CBHelper
access = public
returntype = any
inject = CBHelper@contentbox
true
false
any
paginator
access = public
returntype = any
inject = Paging@contentbox
true
false
any
settingService
access = public
returntype = any
inject = settingService@contentbox
true
false
any
siteService
--------------------------------------------------------------------------.
access = public
returntype = any
inject = siteService@contentbox
true
false
Method Summary
private numeric
getMaxRows ([any maxRows])
Get the max number of rows to retrieve according to contentbox settings.
private numeric
getPageOffset ([any page='1'], [any maxRows])
Calculate the starting record offset for the incoming page and maxrows per page.
Methods inherited from class coldbox.system.RestHandler
aroundHandler , onAnyOtherException , onAuthenticationFailure , onAuthorizationFailure , onEntityNotFoundException , onError , onExpectationFailed , onInvalidHTTPMethod , onInvalidRoute , onMissingAction , onValidationException
Methods inherited from class coldbox.system.FrameworkSupertype
announce , announceInterception , async , back , externalView , forAttribute , getCache , getCachebox , getColdBoxSetting , getController , getDateTimeHelper , getEnv , getFlash , getFlow , getInstance , getIsoTime , getJsonUtil , getLog , getLogBox , getModuleConfig , getModuleSettings , getRenderer , getRequestCollection , getRequestContext , getRootWireBox , getSetting , getSystemProperty , getSystemSetting , getUserSessionIdentifier , getWirebox , ifNull , ifPresent , inDebugMode , includeUDF , isDevelopment , isProduction , isTesting , layout , listen , loadApplicationHelpers , locateDirectoryPath , locateFilePath , persistVariables , populate , populateModel , relocate , renderExternalView , renderLayout , renderview , runEvent , runRoute , setCachebox , setController , setEnv , setFlash , setFlow , setJsonUtil , setLog , setLogBox , setSetting , setWirebox , settingExists , throwIf , throwUnless , toJson , unless , view , when
Methods inherited from class lucee.Component
None
CBHelper
property any
CBHelper
Attributes:
access
- public
required
- false
returntype
- any
inject
- CBHelper@contentbox
serializable
- true
paginator
property any
paginator
Attributes:
access
- public
required
- false
returntype
- any
inject
- Paging@contentbox
serializable
- true
settingService
property any
settingService
Attributes:
access
- public
required
- false
returntype
- any
inject
- settingService@contentbox
serializable
- true
siteService
property any
siteService
--------------------------------------------------------------------------
Global Dependencies
--------------------------------------------------------------------------
Attributes:
access
- public
required
- false
returntype
- any
inject
- siteService@contentbox
serializable
- true
getMaxRows
private numeric getMaxRows ([any maxRows])
Get the max number of rows to retrieve according to contentbox settings
or an override argument
Parameters:
maxRows
Returns:
The max rows to return for pagination
getPageOffset
private numeric getPageOffset ([any page='1'], [any maxRows])
Calculate the starting record offset for the incoming page and maxrows per page
Parameters:
page
- The page to pagination on
maxRows
- Max rows per page override or use global setting
Returns:
The page start offset