BaseController Class
The base controller provides functions for the majority of the heavy lifing for a controller. It accepts and provides access to extending controllers for items such as the request, response, session, etc.
Constructor
BaseController
()
Item Index
Methods
- apiResponse static
- checkForFormRefill
- displayErrorOrSuccessCallback
- formError
- getContentSanitizationRules static deprecated
- getDefaultSanitizationRules static deprecated
- getJSONPostParams deprecated
- getPageName
- getPostData
- getPostParams
- getSanitizationRules
- getServiceContext
- getTemplateServiceInstance
- hasRequiredParams
- init
- initSync
- onLocalizedAlternateFlagFound
- redirect
- requiresClientLocalization
- requiresClientLocalizationCallback
- sanitize static deprecated
- sanitizeObject
- setFormFieldValues
- setPageName
Properties
- activeTheme
- ALERT_PATTERN static
- API_FAILURE static
- API_SUCCESS static
- body
- context
- ENCODING_MAPPING static
- FORM_REFILL_PATTERN static
- localizationService deprecated
- ls
- pageName
- pathVars
- query
- referer deprecated
- req
- reqHandler
- res
- session
- ts
Methods
apiResponse
()
String
static
Generates an generic API response object
Returns:
JSON
checkForFormRefill
-
result -
cb
Parameters:
-
resultString -
cbFunction
displayErrorOrSuccessCallback
-
flag -
cb
Parameters:
-
flagString -
cbFunction
formError
-
message -
redirectLocation -
cb
Parameters:
-
messageStringThe error message to be displayed
-
redirectLocationString -
cbFunction
getContentSanitizationRules
()
deprecated
static
The sanitization rules that apply to Pages and Articles
getDefaultSanitizationRules
()
deprecated
static
getJSONPostParams
-
cb
Parses the incoming payload of a request as JSON formatted data.
Parameters:
-
cbFunction
getPageName
()
String
Provides a page title. This is picked up by the template engine when the ^page_name^ key is found in a template.
Returns:
The page title
getPostData
-
cb
Parameters:
-
cbFunction
getPostParams
-
cb
Parameters:
-
cbFunction
getSanitizationRules
()
Object
Returns:
getServiceContext
()
Object
Retrieves a context object that contains the necessary information for service prototypes
Returns:
getTemplateServiceInstance
-
props
Creates a TemplateService instance
Parameters:
-
propsObject
Returns:
hasRequiredParams
-
queryObject -
requiredParameters
Parameters:
-
queryObjectObject -
requiredParametersArray
init
-
props -
cb
Responsible for initializing a controller. Properties from the RequestHandler are passed down so that the controller has complete access to a variety of request specified properties. By default the function transfers the options over to instance variables that can be access during rendering. In addition, the function sets up the template service along with a set of local flags:
- locale - The selected locale for the request (NOTE: this may not match the requested language if not supported)
- error_success - An alert box if one was registered by the controller
- page_name - The title of the page
- localization_script - Includes the localization script so that it can be used client side
- analytics - Inserts the necessary javascript for analytics providers
Parameters:
-
propsObjectThe properties needed to initialize the controller
-
request_handlerRequestHandler -
requestRequestThe incoming request
-
responseResponseThe outgoing response
-
sessionObjectThe session object
-
localization_serviceLocalizationThe localization service instance for the request
-
path_varsObjectThe path variables associated with the URL for the request
-
queryObjectThe query string variables associated with the URL for the request
-
-
cbFunctionA callback that takes a single optional argument: cb(Error)
initSync
-
context
Provides a synchronous function means to initialize a controller. It is meant to be called from the "init" function called by the request handler.
Parameters:
-
contextObjectSee "init" for more details on properties
onLocalizedAlternateFlagFound
-
routeLocalized -
cb
Parameters:
-
routeLocalizedBoolean -
cbFunction
redirect
-
location -
cb
Redirects a request to a different location
Parameters:
-
locationString -
cbFunction
requiresClientLocalization
()
Boolean
Returns:
requiresClientLocalizationCallback
-
flag -
cb
Parameters:
-
flagString -
cbFunction
sanitize
-
value -
[config]
Parameters:
-
valueString -
[config]Object optional
sanitizeObject
-
obj
Sanitizes an object. This function is handy for incoming post objects. It iterates over each field. If the field is a string value it will be sanitized based on the default sanitization rules (BaseController.getDefaultSanitizationRules) or those provided by the call to BaseController.getSanitizationRules.
Parameters:
-
objObject
setFormFieldValues
-
post
Parameters:
-
postObject
setPageName
-
pageName
Sets the page title
Parameters:
-
pageNameStringThe desired page title
Properties
activeTheme
String
ALERT_PATTERN
String
private
static
The snippet of HTML that will display an alert box
API_FAILURE
Integer
static
The code for a failed API call
API_SUCCESS
Integer
static
The code for a successful API call
body
Object | Null
The deserialized body of the request. This field is only ever populted if the executing route specifies the "request_body" attribute and provides valid MIME types that map to a registered body parser
context
Req: Request, session: object, ls: Localization, ts: TemplateService, site: string, hostname: string, activeTheme: string, onlyThisSite: boolean, siteObj: object
ENCODING_MAPPING
Object
private
static
A mapping that converts the HTTP standard for content-type encoding and what the Buffer prototype expects
FORM_REFILL_PATTERN
String
private
static
The snippet of JS code that will ensure that a form is refilled with values from the post
pageName
String
The title of the view to be rendered, if there is a view
pathVars
Object
The hash of key/value pairs that represent the variables passed in the route path
query
Object
The hash of key/value pairs that represent the variables passed as query string parameters
referer
String
deprecated
The referring URL
req
Request
The current request object
res
Response
The current response object
session
Object
The session object that represents the calling entity