docs/developer/globals.php

<?php
// $Id: globals.php,v 1.7 2008/09/15 21:57:07 davereid Exp $

/**
 * @file
 * These are the global variables that Drupal uses.
 */

/**
 * Stores timers that have been created by timer_start().
 *
 * @see timer_start()
 * @see timer_read()
 * @see timer_stop()
 */
global $timers;

/**
 * The base URL of the drupal installation.
 *
 * @see conf_init()
 */
global $base_url;

/**
 * The base path of the drupal installation. At least will default to /.
 *
 * @see conf_init()
 */
global $base_path;

/**
 * The root URL of the host excludes the path.
 *
 * @see conf_init()
 */
global $base_root;

/**
 * The url of the database. Thorough documentation provided in default.settings.php.
 */
global $db_url;

/**
 * The prefix to be placed on all database tables.
 */
global $db_prefix;

/**
 * The domain to be used form session cookies.
 *
 * Cookie domains must contain at least one dot other than the first (RFC 2109).
 * For hosts such as 'localhost' or an IP Addresses the cookie domain will not be set.
 */
global $cookie_domain;

/**
 * Array of persistent variables stored in 'variables' table.
 * 
 * @see variable_get()
 * @see variable_set()
 * @see variable_del()
 */
global $conf;

/**
 * The name of the profile that has just been installed.
 */
global $installed_profile;

/**
 * Access control for update.php script. Allows the update.php script to be run when
 * not logged in as and administrator.
 */
global $update_free_access;

/**
 * Representation of the current user. Stores preferences and other user information.
 */
global $user;

/**
 * An object containing the information for the active language.
 *
 * Example values:
 *  - 'language' => 'en',
 *  - 'name' => 'English',
 *  - 'native' => 'English',
 *  - 'direction' => 0,
 *  - 'enabled' => 1,
 *  - 'plurals' => 0,
 *  - 'formula' => '',
 *  - 'domain' => '',
 *  - 'prefix' => '',
 *  - 'weight' => 0,
 *  - 'javascript' => ''
 */
global $language;

/**
 * Disabled caling hook_boot() and hook_exit() during the update process (update.php) since
 * the database is in a largely unknown state.
 *
 * @see drupal_goto()
 */
global $update_mode;

/**
 * The name of the currently installed profile.
 */
global $profile;

/**
 * The type of database being used.
 *
 * Example: mysql.
 */
global $db_type;

/**
 * Active database connection.
 *
 * @see db_set_active()
 */
global $active_db;

/**
 * Array of queries that have been executed.
 */
global $queries;

/**
 * Resource of the query executed.
 */
global $last_result;

/**
 * The locale to use during installation
 *
 * @see st()
 */
global $install_locale;

/**
 * Result of pager_query() that is utilized by other functions.
 */
global $pager_page_array;

/**
 * Array of the total number of pages per pager. The key is will be 0 by defualt, but
 * can be specified via the $element parameter of pager_query().
 */
global $pager_total;

/**
 * Array of the total number of items per pager. The key is will be 0 by defualt, but
 * can be specified via the $element parameter of pager_query().
 */
global $pager_total_items;

/**
 * Name of the active theme.
 */
global $theme;

/**
 * Name of custom theme to override default theme.
 *
 * @see init_theme()
 */
global $custom_theme;

/**
 * Name of the active theme.
 *
 * @see init_theme()
 */
global $theme_key;

/**
 * Active theme object. For documentation of the theme object see _init_theme().
 *
 * @see _init_theme()
 */
global $theme_info;

/**
 * An array of objects that reperesent the base theme. For documentation of the
 * theme object see _init_theme().
 *
 * @see _init_theme()
 */
global $base_theme_info;

/**
 * The active theme engine related to the active theme.
 */
global $theme_engine;

/**
 * Path to the active theme.
 */
global $theme_path;

/**
 * The current multibyte mode.
 * Possible values: UNICODE_ERROR, UNICODE_SINGLEBYTE, UNICODE_MULTIBYTE.
 */
global $multibyte;

/**
 * General string or array.
 *
 * @see aggregator_element_start()
 */
global $item;

/**
 * Structured array describing the data to be rendered.
 *
 * @see aggregator_element_start()
 */
global $element;

/**
 * Active tag name.
 *
 * @see aggregator_element_start()
 */
global $tag;

/**
 * Array of items used by aggregator.
 *
 * @see aggregator_element_start()
 */
global $items;

/**
 * An associative array containing title, link, description and other keys.
 * The link should be an absolute URL.
 *
 * @see aggregator_element_start()
 */
global $channel;

/**
 * Current image tag used by aggregator.
 */
global $image;

/**
 * Active blog node id.
 */
global $nid;

/**
 * An array of topic header information.
 */
global $forum_topic_list_header;

/**
 * Boolean indicating that a menu administrator is running the menu access check.
 */
global $menu_admin;

/**
 * Array used by XRDS XML parser for OpenID to track parsing state.
 */
global $xrds_services;

/**
 * Array used by XRDS XML parser for OpenID to track parsing state.
 */
global $xrds_open_elements;

/**
 * Array used by XRDS XML parser for OpenID to track parsing state.
 */
global $xrds_current_service;

/**
 * Recent activity statistics generated by statistics_exit().
 */
global $recent_activity;

/**
 * Active statistics record id.
 */
global $id;
1	<?php
2	// $Id: globals.php,v 1.7 2008/09/15 21:57:07 davereid Exp $
3
4	/**
5	* @file
6	* These are the global variables that Drupal uses.
7	*/
8
9	/**
10	* Stores timers that have been created by timer_start().
11	*
12	* @see timer_start()
13	* @see timer_read()
14	* @see timer_stop()
15	*/
16	global $timers;
17
18	/**
19	* The base URL of the drupal installation.
20	*
21	* @see conf_init()
22	*/
23	global $base_url;
24
25	/**
26	* The base path of the drupal installation. At least will default to /.
27	*
28	* @see conf_init()
29	*/
30	global $base_path;
31
32	/**
33	* The root URL of the host excludes the path.
34	*
35	* @see conf_init()
36	*/
37	global $base_root;
38
39	/**
40	* The url of the database. Thorough documentation provided in default.settings.php.
41	*/
42	global $db_url;
43
44	/**
45	* The prefix to be placed on all database tables.
46	*/
47	global $db_prefix;
48
49	/**
50	* The domain to be used form session cookies.
51	*
52	* Cookie domains must contain at least one dot other than the first (RFC 2109).
53	* For hosts such as 'localhost' or an IP Addresses the cookie domain will not be set.
54	*/
55	global $cookie_domain;
56
57	/**
58	* Array of persistent variables stored in 'variables' table.
59	*
60	* @see variable_get()
61	* @see variable_set()
62	* @see variable_del()
63	*/
64	global $conf;
65
66	/**
67	* The name of the profile that has just been installed.
68	*/
69	global $installed_profile;
70
71	/**
72	* Access control for update.php script. Allows the update.php script to be run when
73	* not logged in as and administrator.
74	*/
75	global $update_free_access;
76
77	/**
78	* Representation of the current user. Stores preferences and other user information.
79	*/
80	global $user;
81
82	/**
83	* An object containing the information for the active language.
84	*
85	* Example values:
86	* - 'language' => 'en',
87	* - 'name' => 'English',
88	* - 'native' => 'English',
89	* - 'direction' => 0,
90	* - 'enabled' => 1,
91	* - 'plurals' => 0,
92	* - 'formula' => '',
93	* - 'domain' => '',
94	* - 'prefix' => '',
95	* - 'weight' => 0,
96	* - 'javascript' => ''
97	*/
98	global $language;
99
100	/**
101	* Disabled caling hook_boot() and hook_exit() during the update process (update.php) since
102	* the database is in a largely unknown state.
103	*
104	* @see drupal_goto()
105	*/
106	global $update_mode;
107
108	/**
109	* The name of the currently installed profile.
110	*/
111	global $profile;
112
113	/**
114	* The type of database being used.
115	*
116	* Example: mysql.
117	*/
118	global $db_type;
119
120	/**
121	* Active database connection.
122	*
123	* @see db_set_active()
124	*/
125	global $active_db;
126
127	/**
128	* Array of queries that have been executed.
129	*/
130	global $queries;
131
132	/**
133	* Resource of the query executed.
134	*/
135	global $last_result;
136
137	/**
138	* The locale to use during installation
139	*
140	* @see st()
141	*/
142	global $install_locale;
143
144	/**
145	* Result of pager_query() that is utilized by other functions.
146	*/
147	global $pager_page_array;
148
149	/**
150	* Array of the total number of pages per pager. The key is will be 0 by defualt, but
151	* can be specified via the $element parameter of pager_query().
152	*/
153	global $pager_total;
154
155	/**
156	* Array of the total number of items per pager. The key is will be 0 by defualt, but
157	* can be specified via the $element parameter of pager_query().
158	*/
159	global $pager_total_items;
160
161	/**
162	* Name of the active theme.
163	*/
164	global $theme;
165
166	/**
167	* Name of custom theme to override default theme.
168	*
169	* @see init_theme()
170	*/
171	global $custom_theme;
172
173	/**
174	* Name of the active theme.
175	*
176	* @see init_theme()
177	*/
178	global $theme_key;
179
180	/**
181	* Active theme object. For documentation of the theme object see _init_theme().
182	*
183	* @see _init_theme()
184	*/
185	global $theme_info;
186
187	/**
188	* An array of objects that reperesent the base theme. For documentation of the
189	* theme object see _init_theme().
190	*
191	* @see _init_theme()
192	*/
193	global $base_theme_info;
194
195	/**
196	* The active theme engine related to the active theme.
197	*/
198	global $theme_engine;
199
200	/**
201	* Path to the active theme.
202	*/
203	global $theme_path;
204
205	/**
206	* The current multibyte mode.
207	* Possible values: UNICODE_ERROR, UNICODE_SINGLEBYTE, UNICODE_MULTIBYTE.
208	*/
209	global $multibyte;
210
211	/**
212	* General string or array.
213	*
214	* @see aggregator_element_start()
215	*/
216	global $item;
217
218	/**
219	* Structured array describing the data to be rendered.
220	*
221	* @see aggregator_element_start()
222	*/
223	global $element;
224
225	/**
226	* Active tag name.
227	*
228	* @see aggregator_element_start()
229	*/
230	global $tag;
231
232	/**
233	* Array of items used by aggregator.
234	*
235	* @see aggregator_element_start()
236	*/
237	global $items;
238
239	/**
240	* An associative array containing title, link, description and other keys.
241	* The link should be an absolute URL.
242	*
243	* @see aggregator_element_start()
244	*/
245	global $channel;
246
247	/**
248	* Current image tag used by aggregator.
249	*/
250	global $image;
251
252	/**
253	* Active blog node id.
254	*/
255	global $nid;
256
257	/**
258	* An array of topic header information.
259	*/
260	global $forum_topic_list_header;
261
262	/**
263	* Boolean indicating that a menu administrator is running the menu access check.
264	*/
265	global $menu_admin;
266
267	/**
268	* Array used by XRDS XML parser for OpenID to track parsing state.
269	*/
270	global $xrds_services;
271
272	/**
273	* Array used by XRDS XML parser for OpenID to track parsing state.
274	*/
275	global $xrds_open_elements;
276
277	/**
278	* Array used by XRDS XML parser for OpenID to track parsing state.
279	*/
280	global $xrds_current_service;
281
282	/**
283	* Recent activity statistics generated by statistics_exit().
284	*/
285	global $recent_activity;
286
287	/**
288	* Active statistics record id.
289	*/
290	global $id;