API Docs for: 0.8.0
Show:

BaseAdminController Class

Extends BaseController
Defined in: controllers/admin/base_admin_controller.js:24
Module: dao

This class serves as a base class for all the controllers used in the admin control panel

Constructor

BaseAdminController

()

Defined in controllers/admin/base_admin_controller.js:24

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

extendedInit

(
  • cb
)

Defined in controllers/admin/base_admin_controller.js:46

Initializes the admin controller with instance variables

Parameters:

  • 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

getAdminPills

(
  • navKey
  • localizationService
  • activePill
  • [data]
)
Object

Defined in controllers/admin/base_admin_controller.js:57

Centralized place to obtain the pills to be displayed on top of the admin controller

Parameters:

  • navKey String
  • localizationService Localization
  • activePill
  • [data] Object optional

Returns:

Object:

pill objects for admin console with site pill at the beginning

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 but overwritten in controllers/admin/base_admin_controller.js:33

Initializes the admin controller with site-related info

Parameters:

  • props Object
  • cb Function

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

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

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

Properties

activeTheme

String

Inherited from BaseController: controllers/base_controller.js:203

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