function drush_get_context

8.0.x context.inc &drush_get_context($context = NULL, $default = NULL)
6.x context.inc &drush_get_context($context = NULL, $default = NULL)
7.x context.inc &drush_get_context($context = NULL, $default = NULL)
3.x context.inc &drush_get_context($context = null, $default = null)
4.x context.inc &drush_get_context($context = NULL, $default = NULL)
5.x context.inc &drush_get_context($context = NULL, $default = NULL)
master context.inc &drush_get_context($context = NULL, $default = NULL)

Return a specific context, or the whole context cache

This function provides a storage mechanism for any information the currently running process might need to communicate.

This avoids the use of globals, and constants.

Functions that operate on the context cache, can retrieve a reference to the context cache using : $cache = &drush_get_context($context);

This is a private function, because it is meant as an internal generalized API for writing static cache functions, not as a general purpose function to be used inside commands.

Code that modifies the reference directly might have unexpected consequences, such as modifying the arguments after they have already been parsed and dispatched to the callbacks.

Parameters

context: Optional. Any of the default defined contexts.

Return value

If context is not supplied, the entire context cache will be returned. Otherwise only the requested context will be returned. If the context does not exist yet, it will be initialized to an empty array.

99 calls to drush_get_context()
drush_backend_get_result in includes/backend.inc
drush_backend_output in includes/backend.inc
drush_backend_set_result in includes/backend.inc
drush_bootstrap in includes/environment.inc
Bootstrap Drush to the desired phase.
drush_bootstrap_error in includes/environment.inc
Helper function to collect any errors that occur during the bootstrap process. Always returns FALSE, for convenience.

... See full list

File

includes/context.inc, line 285
The Drush context API implementation.

Code

function &drush_get_context($context = null, $default = null) {
  static $cache = array();
  if (!is_null($context)) {
    if (!isset($cache[$context])) {
      $default = !is_null($default) ? $default : array();
      $cache[$context] = $default;
    }
    return $cache[$context];
  }
  return $cache;
}