static array $store = array() (line 291)

Global store

This property is used to stored all data accessed using get(), set()...

• access: public

static add (line 1333)

Adds a value to the array pointed by the key

If the first argument is an array, values are merged recursively. The array is first dimensionized You can add values to sub arrays by using a path-like key. For example, to add a value to the array $array[key1][key2] use the key 'key1/key2' If the value pointed by the key is not an array, it will be transformed to one. Can be used on any array by specifying the third argument

• see: Atomik::_dimensionizeArray()
• access: public

• array|string $key: Can be an array to add many key/value
• mixed $value
• bool $dimensionize: Whether to use Atomik::_dimensionizeArray()
• array $array: The array on which the operation is applied
• &$array

static appRedirect (line 2674)

Same as Atomik::redirect() but for urls relative to the root application

• see: Atomik::redirect()
• access: public

• string $url: The url to redirect to
• bool $useUrl: Use Atomik::url() on $url before redirecting
• int $httpCode: The redirection HTTP code

static asset (line 2334)

Returns the url of an asset file (ie. an url without index.php) relative to the current application scope

• see: Atomik::url()
• access: public

• string $filename
• array $params

static autoload (line 2413)

Class autoloader

• see: spl_autoload_register()
• access: public

• string $className

static debug (line 2774)

Equivalent to var_dump() but can be disabled using the configuration

• return: The result or null if $echo is set to true
• see: var_dump()
• access: public

• mixed $data: The data which value should be dumped
• bool $force: Always display the dump even if debug from the config is set to false
• bool $echo: Whether to echo or return the result

static disableLayout (line 1211)

Disables the layout

• access: public

• bool $disable: Whether to disable the layout

static dispatchPluggableApplication (line 1827)

Dispatches a pluggable application

• return: Dispatch success
• see: Atomik::registerPluggableApplication()
• access: public

• string $plugin: Plugin's name
• string $uri: Uri
• array $config: Configuration

static escape (line 2432)

Escapes text so it can be outputted safely

Uses escape profiles defined in the escaping configuration key

• return: The escaped string
• access: public

• string $text: The text to escape
• mixed $profile: A profile name, a function name, or an array of function

static executeFile (line 959)

Executes the action file inside a clean scope and returns defined variables

• see: Atomik::_execute()
• access: public

• string $actionFilename
• array $vars: Variables that will be available in the scope
• string $className: If a class name is specified, it will try to execute its execute() static method

static fireEvent (line 2020)

Fires an event

• return: An array containing results of each executed listeners
• access: public

• string $event: The event name
• array $args: Arguments for listeners
• bool $resultAsString: Whether to return all listener results as a string

static friendlify (line 2624)

Makes a string friendly to urls

• access: public

• string $string

static getLoadedPlugins (line 1775)

Returns all loaded plugins

• access: public

• bool $withDir: Whether to only returns plugin names or the name (as array key) and the directory

static has (line 1470)

Checks if a key is defined in the store

Can check through sub array using a path-like key Can be used on any array by specifying the second argument

• see: Atomik::get()
• access: public

• string $key: The key which should be deleted
• array $array: The array on which the operation is applied

static isPluginAvailable (line 1761)

Checks if a plugin is available

• access: public

• string $plugin

static listenEvent (line 1995)

Registers a callback to an event

• access: public

• string $event: Event name
• callback $callback: The callback to call when the event is fired
• int $priority: Listener priority
• bool $important: If true and a listener of the same priority already exists, registers the new listener before the existing one.

static loadCustomPluginIfAvailable (line 1737)

Loads a custom plugin only if it's available

• see: Atomik::loadPlugin()
• access: public

• $plugin
• $config
• $options

static loadPlugin (line 1607)

Loads a plugin using the configuration specified under plugins

• access: public

• string $name

static log (line 2732)

Fire an Atomik::Log event to which logger can listen

• access: public

• string $message
• int $level

static needed (line 2384)

• access: public

• $include
• $className
• $dirs

static path (line 2083)

Builds a path.

Multiple cases possible:

1) path($setOfPaths, $asArray = false) Returns a path from a set of paths (the set can be a string or an array). If the second argument is true, it returns all paths from the set as an array

2) path($file, $setOfPaths, $check = true) Searches for a file in the set of paths and returns the first one it finds. If $check is set to false, it returns the filename as if it was in the first path from the set of paths. Returns false when $check is true and no file where found.

• access: public

• string|array $file
• string|array|bool $paths
• bool $check

static pluginRedirect (line 2691)

Same as Atomik::redirect() but redirects to a pluggable application

• see: Atomik::redirect()
• access: public

• string $url: The url to redirect to
• bool $useUrl: Use Atomik::url() on $url before redirecting
• int $httpCode: The redirection HTTP code
• $plugin

static prepend (line 1349)

Prependes a value to the array pointed by the key

Works the same as add()

• see: Atomik::add()
• access: public

• array|string $key: Can be an array to add many key/value
• mixed $value
• bool $dimensionize: Whether to use Atomik::_dimensionizeArray()
• array $array: The array on which the operation is applied
• &$array

static registerMethod (line 1945)

Registers a method that will be available on the Atomik class when using PHP5.3 or through Atomik::call() for previous versions.

• access: public

• string $method: The method name
• callback $callback: A callback to be called when the method is called

static registerSelector (line 1591)

Registers a new selector namespace

A namespace preceed a key. When used, $callback will be called instead of the normal logic. Applies only on get() calls.

• access: public

• string $namespace
• callback $callback

static renderException (line 2819)

Renders an exception

• access: public

• Exception $exception: The exception which sould ne rendered
• bool $return: Return the output instead of printing it

static renderLayout (line 1102)

Renders a layout

• access: public

• string $layout: Layout name
• string $content: The content that will be available in the layout in the $contentForLayout variable
• array $vars: An array containing key/value pairs that will be transformed to variables accessible inside the layout
• bool $triggerError: Whether to throw an exception if an error occurs
• array $dirs: Directories where to search for layouts

static route (line 711)

Parses an uri to extract parameters

Routes defines how to extract parameters from an uri. They can have additional default parameters. There are two kind of routes:

• segments: the uri is divided into path segments. Each segment can be either static or a parameter (indicated by :). eg: /archives/:year/:month

• regexp: uses a regexp against the uri. Must be enclosed using # instead of slashes parameters must be specified as named subpattern. eg: #^archives/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})$#

You can also name your routes using the @name parameter (which won't be included in the returned params). Named route can then be use with Atomik::url()

• return: Route parameters or false if it fails
• access: public

• string $uri
• array $params: Additional parameters which are not in the uri
• array $routes: Uses app/routes if null

static set (line 1256)

Sets a key/value pair in the store

If the first argument is an array, values are merged recursively. The array is first dimensionized You can set values from sub arrays by using a path-like key. For example, to set the value inside the array $array[key1][key2] use the key 'key1/key2' Can be used on any array by specifying the third argument

• see: Atomik::_dimensionizeArray()
• access: public

• array|string $key: Can be an array to set many key/value
• mixed $value
• bool $dimensionize: Whether to use Atomik::_dimensionizeArray() on $key
• array $array: The array on which the operation is applied
• array $add: Whether to add values or replace them
• &$array

static trigger404 (line 2703)

Triggers a 404 error

• access: public

static url (line 2190)

Returns an url for the action depending on whether url rewriting is used or not. Will return an url relative to the current application scope.

Ie. if a plugin uses this method, it will return an url for an action of itself

Can be used on links starting with a protocol but they will of course not be resolved like action names. Named routes can also be used (only specify the route name - with the @ - as the action)

The item "_merge_GET" can be use in $params to merge GET parameters with specified params.

• access: public

• string $action: The action name or an url. Can contain GET parameters (after ?)
• array $params: GET parameters to be added to the query string, if true will reuse current GET params
• bool $useIndex: Whether to use index.php in the url
• bool $useBaseAction: Whether to prepend the action with atomik/base_action

static _dimensionizeArray (line 1385)

Recursively checks array for path-like keys (ie. keys containing slashes) and transform them into multi dimensions array

• access: public

• array $array
• string $separator

static _getFlashMessages (line 2482)

Returns the flash messages saved in the session

• return: An array of messages if the label is specified or an array of array message
• access: public

• string $label: Whether to only retreives messages from this label. When null or 'all', returns all messages
• bool $delete: Whether to delete messages once retrieved

static __callStatic (line 1975)

PHP 5.3 magic method to handle calls to undefined method

• access: public

• $method
• $args