Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 430 lines (379 sloc) 9.769 kB
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
1 <?php
2 /**
3 * Stub info for $CONFIG global options.
4 *
5 * @tip Plugins should never use the $CONFIG array directly.
6 *
7 * @package Elgg.Core
8 * @subpackage Configuration
9 */
10
11 /**
12 * Event information for the events subsystem.
13 *
c8f6c3c @ewinslow Fixes #2367: With fear and trepidation, converting events/plugin hook…
ewinslow authored
14 * Events are added with {@link elgg_register_event_handler()} and
15 * can be removed in >= 1.8 with {@link elgg_unregister_event_handler()}.
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
16 *
17 * Events are stored as a multidimensional array in the format:
18 * <code>
19 * $CONFIG->events[str $event_name][str $event_type][int priority] = str callback_function
20 * </code>
21 *
22 * @global array $CONFIG->events
23 * @name $CONFIG->events
24 * @see events()
c8f6c3c @ewinslow Fixes #2367: With fear and trepidation, converting events/plugin hook…
ewinslow authored
25 * @see elgg_register_event_handler()
26 * @see elgg_unregister_event_handler()
27 * @see elgg_trigger_event()
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
28 */
29 $CONFIG->events;
30
31 /**
32 * Plugin Hook information for the plugin hooks subsystem.
33 *
c8f6c3c @ewinslow Fixes #2367: With fear and trepidation, converting events/plugin hook…
ewinslow authored
34 * Hooks are added with {@link elgg_register_plugin_hook_handler()} and
35 * can be removed in >= 1.8 with {@link elgg_unregister_plugin_hook_handler()}.
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
36 *
37 * Hooks are stored as a multidimensional array in the format:
38 * <code>
39 * $CONFIG->hooks[str $hook_name][str $hook_type][int priority] = str callback_function
40 * </code>
41 *
42 * @global array $CONFIG->hooks
c8f6c3c @ewinslow Fixes #2367: With fear and trepidation, converting events/plugin hook…
ewinslow authored
43 * @see elgg_register_plugin_hook_handler()
44 * @see elgg_unregister_plugin_hook_handler()
45 * @see elgg_trigger_plugin_hook()
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
46 */
47 $CONFIG->hooks;
48
49 /**
50 * Paths to scan for autoloading languages.
51 *
52 * Languages are automatically loaded for the site or
53 * user's default language. Plugins can extend or override strings.
54 * language_paths is an array of paths to scan for PHP files matching
55 * the default language. The order of paths is determined by the plugin load order,
56 * with later entries overriding earlier. Language files within these paths are
57 * named as the two-letter ISO 639-1 country codes for the language they represent.
58 *
59 * Language paths are stored as array keys in the format:
60 * <code>
61 * $CONFIG->language_paths[str $language_path] = true
62 * </code>
63 *
64 * @link http://en.wikipedia.org/wiki/ISO_639-1
65 * @see register_language()
66 * @global array $CONFIG->language_paths
67 */
68 $CONFIG->language_paths;
69
70
71 /**
72 * String translations for the current language.
73 *
74 * Elgg uses a key-based system for string internationalization, which
75 * is accessed with {@link elgg_echo()}.
76 *
77 * Translations are stored as an array in the following format:
78 * <code>
79 * $CONFIG->translations[str $language_code][str $string_key] = str 'Translated Language String';
80 * </code>
81 *
82 * @see register_translation()
83 * @see elgg_echo()
84 * @global array $CONFIG->translations
85 */
86 $CONFIG->translations;
87
88 /**
89 * Stores input used by {@link set_input()} and {@link get_input()}.
90 *
91 * @global array $CONFIG->input
92 */
93 $CONFIG->input;
94
95 /**
96 * An array of metadata names to be used as tags.
97 *
98 * Because tags are simply names of meatdata, This is used
99 * in search to prevent data exposure by searching on
100 * arbitrary metadata.
101 *
102 * @global array $CONFIG->registered_tag_metadata_names
103 */
104 $CONFIG->registered_tag_metadata_names;
105
106 /**
107 * An associative array of page handlers and their function names.
108 *
782fd90 @ewinslow Replaced all occurrences of register_page_handler in core with elgg_r…
ewinslow authored
109 * Page handlers must be registered by {@link elgg_register_page_handler()} and
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
110 * will be dispatched by {@link engine/handlers/pagehandler.php} to the
111 * proper function.
112 *
113 * @global array $CONFIG->pagehandler
114 */
115 $CONFIG->pagehandler;
116
117 /**
118 * An object holding valid widgets and their configurations.
119 *
120 * This object stores the valid context for widgets, and the handlers
121 * registered, as well as a description of the widget.
122 *
123 * Widgets are added with {@link add_widget_type()}.
124 *
125 * @global stdClass $CONFIG->widgets
126 */
127 $CONFIG->widgets;
128
129 /**
130 * The full path where Elgg is installed.
131 *
132 * @global string $CONFIG->path;
133 */
134 $CONFIG->path;
135
136 /**
137 * The full path for core views.
138 *
139 * @global string $CONFIG->viewpath
140 */
141 $CONFIG->viewpath;
142
143 /**
144 * The full path where plugins are stored.
145 *
146 * @global string $CONFIG->pluginspath
147 */
148 $CONFIG->pluginspath;
149
150 /**
151 * The full URL where Elgg is installed
152 *
153 * @global string $CONFIG->wwwroot
154 */
155 $CONFIG->wwwroot;
156
157 /**
158 * The full URL where Elgg is installed
159 *
160 * @global string $CONFIG->wwwroot
161 */
162 $CONFIG->url;
163
164 /**
165 * The name of the site as defined in the config table.
166 *
167 * @global string $CONFIG->sitename
168 */
169 $CONFIG->sitename;
170
171 /**
172 * The current language for either the site or the user.
173 *
174 * @global $CONFIG->language
175 */
176 $CONFIG->language;
177
178 /**
9795d6a @cash ripped out last remaining tentacles of old installer from core - just…
cash authored
179 * Is the site fully installed
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
180 *
9795d6a @cash ripped out last remaining tentacles of old installer from core - just…
cash authored
181 * @global bool $CONFIG->installed
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
182 */
9795d6a @cash ripped out last remaining tentacles of old installer from core - just…
cash authored
183 $CONFIG->installed;
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
184
185 /**
186 * The guid of the current site object.
187 *
188 * @global int $CONFIG->site_id
189 */
190 $CONFIG->site_id;
191
192 /**
193 * The guid of the current site object.
194 *
195 * @global int $CONFIG->site_id
196 */
197 $CONFIG->site_guid;
198
199 /**
200 * The current site object.
201 *
202 * @global ElggSite $CONFIG->site
203 */
204 $CONFIG->site;
205
206 /**
207 * The full path to the data directory.
208 *
209 * @global string $CONFIG->dataroot
210 */
211 $CONFIG->dataroot;
212
213 /**
214 * Is simplecache enabled?
215 *
216 * @global string $CONFIG->simplecache_enabled
217 */
218 $CONFIG->simplecache_enabled;
219
220 /**
221 * Is view paths cache enabled
222 *
223 * @global string $CONFIG->viewpath_cache_enabled
224 */
225 $CONFIG->viewpath_cache_enabled;
226
227 /**
228 * The site description from the current site object.
229 *
230 * @global string $CONFIG->sitedescription
231 */
232 $CONFIG->sitedescription;
233
234 /**
235 * The site email from the current site object.
236 *
237 * @global string $CONFIG->siteemail
238 */
239 $CONFIG->siteemail;
240
241 /**
242 * The current view type
243 *
daa94f8 @brettp Refs @2450: Better documentation for $CONFIG->view.
brettp authored
244 * View types determin the location of view files that are used to draw pages.
245 * They are set system-wide by the $_REQUEST['view']. If a view type is manually
246 * set in settings.php or through a function hooking to the {@elgg_hook
247 *
92c1586 @brettp Refs #2450: Added config.php stub to document many of the $CONFIG vars.
brettp authored
248 * @warning This is the current view type used to determine where to load views.
249 * Don't confuse this with the current view.
250 *
251 * @global string $CONFIG->view
252 */
253 $CONFIG->view;
254
255 /**
256 * Default access as defined in the config table for the current site.
257 *
258 * @global string $CONFIG->default_access
259 */
260 $CONFIG->default_access;
261
262 /**
263 * Is registration enabled?
264 *
265 * @global bool $CONFIG->allow_registration
266 */
267 $CONFIG->allow_registration;
268
269 /**
270 * Is current site in walled garden mode?
271 *
272 * @global bool $CONFIG->walled_garden
273 */
274 $CONFIG->walled_garden;
275
276 /**
277 * Are users allow to enter their own default access levels
278 *
279 * @global bool $CONFIG->allow_user_default_access
280 */
281 $CONFIG->allow_user_default_access;
282
283 /**
284 * A list of feature URLs for the main site menu.
285 *
286 * These links are added via the admin interface.
287 *
288 * @global string $CONFIG->menu_items_featured_urls
289 */
290 $CONFIG->menu_items_featured_urls;
291
292 /**
293 * The custom menu items entered in the administration.
294 *
295 * @global string $CONFIG->menu_items_custom_items
296 */
297 $CONFIG->menu_items_custom_items;
298
299 /**
300 * A list of registered actions, their file locations, and access permissions.
301 *
302 * @global array $CONFIG->actions
303 */
304 $CONFIG->actions;
305
306 /**
307 * Holds information about views.
308 *
309 * @global object $CONFIG->views
310 */
311 $CONFIG->views;
312
313 /**
314 * A list of views to cache in the simple cache.
315 *
316 * @global object $CONFIG->views->simplecache
317 */
318 $CONFIG->views->simplecache;
319
320 /**
321 * A list of views and the top level views directory to search for the view in.
322 *
323 * @note Views are stored as the key and the top level view location is stored as the value.
324 * The current viewtype {@link $CONFIG->view} is used to determin which directory under the entry
325 * in $CONFIG->views->location to search. View names are automatically appened a '.php' extension.
326 *
327 * @global object $CONFIG->views->locations
328 */
329 $CONFIG->views->locations;
330
331
332 /**
333 * A list of valid view types as discovered.
334 *
335 * @global array $CONFIG->view_types
336 */
337 $CONFIG->view_types;
338
339 /**
340 * A list of plugins and their load order
341 *
342 * @global string $CONFIG->pluginlistcache
343 */
344 $CONFIG->pluginlistcache;
345
346 /**
347 * Holds URL handler information for ElggExtender objects.
348 *
349 * @global array $CONFIG->extender_url_handler
350 */
351 $CONFIG->extender_url_handler;
352
353 /**
354 * A list of registered entities and subtypes. Used in search.
355 *
356 * @global array $CONFIG->registered_entities
357 */
358 $CONFIG->registered_entities;
359
360 /**
361 * A list of URL handlers for {@link ElggEntity::getURL()}
362 *
363 * @global array $CONFIG->entity_url_handler
364 */
365 $CONFIG->entity_url_handler;
366
367 /**
368 * A list of entity types and subtypes that have metadata whose access permission
369 * can be changed independently of the main object. {@link register_metadata_as_indepenent()}
370 *
371 * @global string $CONFIG->independents
372 */
373 $CONFIG->independents;
374
375 /**
376 * Holds items for all submenus.
377 *
378 * @global string $CONFIG->submenu_items
379 */
380 $CONFIG->submenu_items;
381
382 /**
383 * Holds the service handlers as registered by {@register_service_handler()}
384 *
385 * @global array $CONFIG->servicehandler
386 */
387 $CONFIG->servicehandler;
388
389 /**
390 * A list of stop works for search. Not currently used.
391 *
392 * @global array $CONFIG->wordblacklist
393 * @todo currently unused.
394 */
395 $CONFIG->wordblacklist;
396
397 /**
398 * A list of menu contexts for menus registered with {@link add_menu()}. Not currently used.
399 *
400 * @global array $CONFIG->menucontexts
401 */
402 $CONFIG->menucontexts;
403
404 /**
405 * A list of registers and their children added via {@add_to_register()}. Used only for menus.
406 *
407 * @global string $CONFIG->registers
408 */
409 $CONFIG->registers;
410
411 /**
412 * A list of objects that can emit notifications. {@link register_notification_object()}
413 *
414 * @global array $CONFIG->register_objects
415 */
416 $CONFIG->register_objects;
417
418 /**
419 * Holds available group tools options. Added with {@link add_group_tool_option()}
420 *
421 * @global array $CONFIG->group_tool_options
422 */
423 $CONFIG->group_tool_options;
424
425 /**
426 * The last cache time for the current viewtype. Used in the generation of CSS and JS links.
427 *
428 * @global string $CONFIG->lastcache
429 */
430 $CONFIG->lastcache;
Something went wrong with that request. Please try again.