API Docs for: 0.8.0
Show:

ApiActionController Class

Extends BaseController
Defined in: controllers/api/api_action_controller.js:27
Module: dao

Deprecated: Since 0.4.1

Controller interface used to map simple actions to handlers and provide a flow for validation and error handling.

Constructor

ApiActionController

() deprecated

Defined in controllers/api/api_action_controller.js:27

Deprecated: Since 0.4.1

Methods

checkForFormRefill

(
  • result
  • cb
)

Inherited from BaseController: controllers/base_controller.js:555

Parameters:

  • result String
  • cb Function

displayErrorOrSuccessCallback

(
  • flag
  • cb
)

Inherited from BaseController: controllers/base_controller.js:388

Parameters:

  • flag String
  • cb Function

formError

(
  • message
  • redirectLocation
  • cb
)

Inherited from BaseController: controllers/base_controller.js:374

Parameters:

  • message String
    The error message to be displayed
  • redirectLocation String
  • cb Function

getActions

() Object

Defined in controllers/api/api_action_controller.js:72

Provides the hash of all actions supported by this controller

Returns:

Object:

An empty hash of actions since this is meant to be overriden.

getAutoSanitize

()

Defined in controllers/api/api_action_controller.js:136

Returns:

{Boolean

getJSONPostParams

(
  • cb
)
deprecated

Inherited from BaseController: controllers/base_controller.js:460

Deprecated: Since 0.8.0. Will be removed in v1.0

Parses the incoming payload of a request as JSON formatted data.

Parameters:

  • cb Function

getPageName

() String

Inherited from BaseController: controllers/base_controller.js:410

Provides a page title. This is picked up by the template engine when the ^page_name^ key is found in a template.

Returns:

String: The page title

getPostData

(
  • cb
)

Inherited from BaseController: controllers/base_controller.js:492

Parameters:

  • cb Function

getPostParams

(
  • cb
)

Inherited from BaseController: controllers/base_controller.js:429

Parameters:

  • cb Function

getSanitizationRules

() Object

Inherited from BaseController: controllers/base_controller.js:598

Returns:

Object:

getServiceContext

() Object

Inherited from BaseController: controllers/base_controller.js:341

Retrieves a context object that contains the necessary information for service prototypes

Returns:

Object:

getTemplateServiceInstance

(
  • props
)
TemplateService

Inherited from BaseController: controllers/base_controller.js:241

Creates a TemplateService instance

Parameters:

  • props Object

Returns:

TemplateService:

hasRequiredParams

(
  • queryObject
  • requiredParameters
)

Inherited from BaseController: controllers/base_controller.js:521

Parameters:

  • queryObject Object
  • requiredParameters Array

init

(
  • props
  • cb
)

Inherited from BaseController: controllers/base_controller.js:90

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:

  • props Object

    The properties needed to initialize the controller

    • request_handler RequestHandler
    • request Request

      The incoming request

    • response Response

      The outgoing response

    • session Object

      The session object

    • localization_service Localization

      The localization service instance for the request

    • path_vars Object

      The path variables associated with the URL for the request

    • query Object

      The query string variables associated with the URL for the request

  • cb Function

    A callback that takes a single optional argument: cb(Error)

initSync

(
  • context
)

Inherited from BaseController: controllers/base_controller.js:233

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:

  • context Object
    See "init" for more details on properties

onLocalizedAlternateFlagFound

(
  • routeLocalized
  • cb
)

Inherited from BaseController: controllers/base_controller.js:301

Parameters:

  • routeLocalized Boolean
  • cb Function

redirect

(
  • location
  • cb
)

Inherited from BaseController: controllers/base_controller.js:638

Redirects a request to a different location

Parameters:

  • location String
  • cb Function

render

(
  • cb
)

Defined in controllers/api/api_action_controller.js:47

The entry point called by the RequestHandler. Executes the calls to the validation framework then, if passes, executes the action handler.

Parameters:

  • cb Function

requiresClientLocalization

() Boolean

Inherited from BaseController: controllers/base_controller.js:351

Returns:

Boolean:

requiresClientLocalizationCallback

(
  • flag
  • cb
)

Inherited from BaseController: controllers/base_controller.js:360

Parameters:

  • flag String
  • cb Function

sanitizeObject

(
  • obj
)

Inherited from BaseController: controllers/base_controller.js:573

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:

  • obj Object

setAutoSanitize

(
  • val
)

Defined in controllers/api/api_action_controller.js:144

Parameters:

  • val Boolean

setFormFieldValues

(
  • post
)

Inherited from BaseController: controllers/base_controller.js:545

Parameters:

  • post Object

setPageName

(
  • pageName
)

Inherited from BaseController: controllers/base_controller.js:420

Sets the page title

Parameters:

  • pageName String
    The desired page title

validateParameters

(
  • action
  • cb
)

Defined in controllers/api/api_action_controller.js:82

Validates the query, path, and post parameters in parallel and calls back with any validation errors.

Parameters:

  • action String
  • cb Function

validatePathParameters

(
  • action
  • cb
)

Defined in controllers/api/api_action_controller.js:152

Validates any path parameters for the specified action. The callback will provide an array of validation errors. When the array is empty it is safe to assume that validation succeeded. The default implementation examines the value for the action in the value returned by ApiActionController#getActions. If the value evaluates to true then the implementation will validate that an "id" path parameter was passed.

Parameters:

  • action String
  • cb Function

validatePostParameters

(
  • action
  • post
  • cb
)

Defined in controllers/api/api_action_controller.js:186

Validates any post parameters for the specified action. The callback will provide an array of validation errors. When the array is empty it is safe to assume that validation succeeded. The default implementation passes an empty error array.

Parameters:

  • action String
  • post Object
  • cb Function

validateQueryParameters

(
  • action
  • cb
)

Defined in controllers/api/api_action_controller.js:173

Validates any query parameters for the specified action. The callback will provide an array of validation errors. When the array is empty it is safe to assume that validation succeeded. The default implementation passes an empty error array.

Parameters:

  • action String
  • cb Function

Properties

activeTheme

String

Inherited from BaseController: controllers/base_controller.js:203

autoSanitize

Boolean

Defined in controllers/api/api_action_controller.js:38

Flag to indicate if the form should automatically sanitize the incoming values. In this case sanitize means it will attempt to strip away any HTML tags to prevent HTML injection and XSS.

body

Object | Null

Inherited from BaseController: controllers/base_controller.js:143

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

Inherited from BaseController: controllers/base_controller.js:211

localizationService

Localization deprecated

Inherited from BaseController: controllers/base_controller.js:151

Deprecated: Use this.ls

pageName

String

Inherited from BaseController: controllers/base_controller.js:178

The title of the view to be rendered, if there is a view

pathVars

Object

Inherited from BaseController: controllers/base_controller.js:164

The hash of key/value pairs that represent the variables passed in the route path

query

Object

Inherited from BaseController: controllers/base_controller.js:171

The hash of key/value pairs that represent the variables passed as query string parameters

referer

String deprecated

Inherited from BaseController: controllers/base_controller.js:189

The referring URL

req

Request

Inherited from BaseController: controllers/base_controller.js:122

The current request object

reqHandler

RequestHandler

Inherited from BaseController: controllers/base_controller.js:115

The instance of the request handler that processed the request

res

Response

Inherited from BaseController: controllers/base_controller.js:129

The current response object

session

Object

Inherited from BaseController: controllers/base_controller.js:136

The session object that represents the calling entity