modules/handler/handler.environment.inc

<?php
// $Id: $

/**
 * @file
 * The Drupal environment uber variable.
 * 
 * Handlers by design should be totally insulated from the context in which
 * they run.  All communication eith their environment is through a provided
 * environment object, which manages communication with the rest of the system.
 * That makes it very easy to "mock" the environment in order to unit test
 * a handler object in a vaccuum.
 */

/**
 * The basic Drupal environment object interface.
 *
 */
interface DrupalEnvironmentInterface {
  
  public function variableGet($var, $default);
  public function variableSet($var, $default);
  
  public function httpGet($key = NULL, $default = NULL);
  public function httpPost($key = NULL, $default = NULL);
  public function httpCookie($key = NULL, $default = NULL);
  public function requestArgument($arg);
  public function requestPath();
  
  public function serverInfo($key = NULL, $default = NULL);
  public function envInfo($key = NULL, $default = NULL);
  
  public function invokeHooks($hook);
  public function handler($target, $options = array());
  
}

class EnvironmentDefault implements DrupalEnvironmentInterface {
  
  protected $requestPath;
  protected $getArray;
  protected $postArray;
  protected $cookieArray;
  protected $serverArray;
  protected $envArray;
  
  public function __construct() {
    $this->requestPath = drupal_get_normal_path($_GET['q']);
    
    $this->getArray = $_GET;
    $this->postArray = $_POST;
    $this->cookieArray = $_COOKIE;
    $this->serverArray = $_SERVER;
    $this->envArray = $_ENV;
    unset($this->getArray['q']);
    
    $this->requestArguments = explode('/', $this->requestPath);
    
  }
  
  public function variableGet($var, $default) {
    return variable_get($var, $default);
  }
  
  public function variableSet($var, $default) {
    return variable_set($var, $default);
  }
  
  public function requestPath() {
    return $this->requestPath;
  }
  
  protected function arrayIndexLookup($array, $key = NULL, $default = NULL) {
    if (isset($key)) {
      return isset($this->$array[$key]) ? $this->$array[$key] : $default;
    }
    else {
      return $this->$array;
    }
  }
  
  public function httpGet($key = NULL, $default = NULL) {
    return $this->arrayIndexLookup('getArray', $key, $default);
  }
  
  public function httpPost($key = NULL, $default = NULL) {
    return $this->arrayIndexLookup('postArray', $key, $default);
  }
  
  public function httpCookie($key = NULL, $default = NULL) {
    return $this->arrayIndexLookup('cookieArray', $key, $default);
  }
  
  public function serverInfo($key = NULL, $default = NULL) {
    return $this->arrayIndexLookup('serverArray', $key, $default);
  }
  
  public function envInfo($key = NULL, $default = NULL) {
    return $this->arrayIndexLookup('envArray', $key, $default);
  }
  
  public function requestArgument($arg) {
    return isset($this->requestArguments[$arg]) ? $this->requestArguments[$arg] : NULL;
  }
  
  public function invokeHooks($hook) {
    return call_user_func_array('module_invoke_all', func_get_args());
  }
  
  public function handler($target, $options = array()) {
    return handler($target, $options);
  }
}

1	<?php
2	// $Id: $
3
4	/**
5	* @file
6	* The Drupal environment uber variable.
7	*
8	* Handlers by design should be totally insulated from the context in which
9	* they run. All communication eith their environment is through a provided
10	* environment object, which manages communication with the rest of the system.
11	* That makes it very easy to "mock" the environment in order to unit test
12	* a handler object in a vaccuum.
13	*/
14
15	/**
16	* The basic Drupal environment object interface.
17	*
18	*/
19	interface DrupalEnvironmentInterface {
20
21	public function variableGet($var, $default);
22	public function variableSet($var, $default);
23
24	public function httpGet($key = NULL, $default = NULL);
25	public function httpPost($key = NULL, $default = NULL);
26	public function httpCookie($key = NULL, $default = NULL);
27	public function requestArgument($arg);
28	public function requestPath();
29
30	public function serverInfo($key = NULL, $default = NULL);
31	public function envInfo($key = NULL, $default = NULL);
32
33	public function invokeHooks($hook);
34	public function handler($target, $options = array());
35
36	}
37
38	class EnvironmentDefault implements DrupalEnvironmentInterface {
39
40	protected $requestPath;
41	protected $getArray;
42	protected $postArray;
43	protected $cookieArray;
44	protected $serverArray;
45	protected $envArray;
46
47	public function __construct() {
48	$this->requestPath = drupal_get_normal_path($_GET['q']);
49
50	$this->getArray = $_GET;
51	$this->postArray = $_POST;
52	$this->cookieArray = $_COOKIE;
53	$this->serverArray = $_SERVER;
54	$this->envArray = $_ENV;
55	unset($this->getArray['q']);
56
57	$this->requestArguments = explode('/', $this->requestPath);
58
59	}
60
61	public function variableGet($var, $default) {
62	return variable_get($var, $default);
63	}
64
65	public function variableSet($var, $default) {
66	return variable_set($var, $default);
67	}
68
69	public function requestPath() {
70	return $this->requestPath;
71	}
72
73	protected function arrayIndexLookup($array, $key = NULL, $default = NULL) {
74	if (isset($key)) {
75	return isset($this->$array[$key]) ? $this->$array[$key] : $default;
76	}
77	else {
78	return $this->$array;
79	}
80	}
81
82	public function httpGet($key = NULL, $default = NULL) {
83	return $this->arrayIndexLookup('getArray', $key, $default);
84	}
85
86	public function httpPost($key = NULL, $default = NULL) {
87	return $this->arrayIndexLookup('postArray', $key, $default);
88	}
89
90	public function httpCookie($key = NULL, $default = NULL) {
91	return $this->arrayIndexLookup('cookieArray', $key, $default);
92	}
93
94	public function serverInfo($key = NULL, $default = NULL) {
95	return $this->arrayIndexLookup('serverArray', $key, $default);
96	}
97
98	public function envInfo($key = NULL, $default = NULL) {
99	return $this->arrayIndexLookup('envArray', $key, $default);
100	}
101
102	public function requestArgument($arg) {
103	return isset($this->requestArguments[$arg]) ? $this->requestArguments[$arg] : NULL;
104	}
105
106	public function invokeHooks($hook) {
107	return call_user_func_array('module_invoke_all', func_get_args());
108	}
109
110	public function handler($target, $options = array()) {
111	return handler($target, $options);
112	}
113	}
114