Root Namespace

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

Classes

Config

constructor

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

Signature

constructor(Object options) : Object

Parameters

  • options
    • Options of the config
    • Type: Object

Returns

  • Object
    • Options of the config

load

Load a configuration from a given path.

Signature

load([String path]) : void

Parameters

  • [path]
    • Path to the config to load
    • Type: String

get

Get config|config-key.

Signature

get([String key]) : void

Parameters

  • [key]
    • Key to get or without an key get the whole config
    • Type: String

set

Set config|config-key by given value.

Signature

set([String key], Mixed value) : void

Parameters

  • [key]
    • Key to set or without an key overwrite the whole config
    • Type: String
  • value
    • Value to set
    • Type: Mixed

setDefault

Set the default configuration.

Signature

setDefault(Object config) : void

Parameters

  • config
    • Config to set as default
    • Type: Object

getDefault

Get the predefined default configuration.

Signature

getDefault(void) : Object

Returns

  • Object
    • The return value is not further described

merge

Merge in a new config over the predefined default config.

Signature

merge(Object config, [Boolean deep]) : void

Parameters

  • config
    • Config to merge in
    • Type: Object
  • [deep]
    • Perform a deep merge
    • Type: Boolean

Greppy

constructor

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

Signature

constructor(void) : Object|Greppy

Returns

  • Object, Greppy
    • A new instance of Greppy

initDefaultLogger

Setup an default logger. This is adds the ability to easily use the Greppy Framework parts without an Greppy application.

Signature

initDefaultLogger(void) : void

get

Return a class definition.

Signature

get(String classPath) : Function

Parameters

  • classPath
    • Dot seperated class path
    • Type: String

Returns

  • Function
    • The return value is not further described

Store

constructor

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

Signature

constructor(Array namespaces) : Array

Parameters

  • namespaces
    • Namespaces to register
    • Type: Array

Returns

  • Array
    • Namespaces to register

get

Return the value of a given key and its given namespace.

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

set

Set the value of a given key and its given namespace.

Signature

set([String namespace], String key, String value) : Mixed

Parameters

  • [namespace]
    • Namespace or the default-namespace
    • Type: String
  • key
    • Key to write to
    • Type: String
  • value
    • Value to set upon the key
    • Type: String

Returns

  • Mixed
    • The return value is not further described

list

List all keys in a given namespace.

Signature

list([String namespace]) : Array

Parameters

  • [namespace]
    • Namespace or the default-namespace
    • Type: String

Returns

  • Array
    • The return value is not further described