Store Namespace

  1. Documentation
  2. Framework
  3. Reference
  4. Store

Classes

ConfigStore

constructor

With the help of this method you can create a new instance of ConfigStore.

Signature

constructor(void) : Object|ConfigStore

Returns

  • Object, ConfigStore
    • A new instance of ConfigStore

load

Load a configuration from a given path and push it into the store.

Signature

load(String path, String key, [Object options]) : void

Parameters

  • path
    • Path to the config to load
    • Type: String
  • key
    • Key to use for later addressing
    • Type: String
  • [options]
    • Options to pass to the config
    • Type: Object

new

Create a new configuration and push it into the store.

Signature

new(String key, [Object options]) : void

Parameters

  • key
    • Key to use for later addressing
    • Type: String
  • [options]
    • Options to pass to the config
    • Type: Object

DBStore

constructor

With the help of this method you can create a new instance of DBStore.

Signature

constructor(void) : Object|DBStore

Returns

  • Object, DBStore
    • A new instance of DBStore

configure

Configure all selected backends and/or connections.

Signature

configure(Object select, Function callback) : void

Parameters

  • select
    • Selection of backends and connections
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

close

Close all connections for this store.

Signature

close(Function callback) : void

Parameters

  • callback
    • Function to call on finish
    • Type: Function

get

Get a connection by namepath from the store.

Signature

get(String namepath) : Object

Parameters

  • namepath
    • The namepath to search the backend/connection for
    • Type: String

Returns

  • Object
    • The return value is not further described

HelperStore

constructor

With the help of this method you can create a new instance of HelperStore.

Signature

constructor(void) : Object|HelperStore

Returns

  • Object, HelperStore
    • A new instance of HelperStore

loadApplicationHelpers

Load all helpers of the application.

Signature

loadApplicationHelpers(void) : void

pathToName

Convert the path to the valid helper-keys format.

Signature

pathToName(String path, String helperPath, [String module]) : String

Parameters

  • path
    • Absolute path to the helper file
    • Type: String
  • helperPath
    • Cutting prefix on absolute paths
    • Type: String
  • [module]
    • Module name to prefix
    • Type: String

Returns

  • String
    • The return value is not further described

loadModule

Load all helpers for a given module.

Signature

loadModule(String module) : void

Parameters

  • module
    • Name of the module
    • Type: String

loadHelper

Load an helper as given key and load the file.

Signature

loadHelper(String key, String path) : void

Parameters

  • key
    • Helper name (namespace/key)
    • Type: String
  • path
    • Absolute path to the helper file
    • Type: String

get

Wrapper for the original store method.

Signature

get([String namespace], String key) : Mixed

Parameters

  • [namespace]
    • Namespace or the default-namespace
    • Type: String
  • key
    • Key to get
    • Type: String

Returns

  • Mixed
    • The return value is not further described