Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Namespaces | Variables
config.php File Reference

Go to the source code of this file.

Namespaces

 Elgg\Core
 Activate a plugin or plugins.
 

Variables

$CONFIG path
 The full path where Elgg is installed. More...
 
$CONFIG pluginspath
 The full path where plugins are stored. More...
 
$CONFIG wwwroot
 The full URL where Elgg is installed. More...
 
$CONFIG url
 The full URL where Elgg is installed. More...
 
$CONFIG sitename
 The name of the site as defined in the config table. More...
 
$CONFIG language
 The current language for either the site or the user. More...
 
$CONFIG installed
 Is the site fully installed. More...
 
$CONFIG site_guid
 The guid of the current site object. More...
 
$CONFIG site_id
 Copy of $CONFIG->site_guid. More...
 
$CONFIG site
 The current site object. More...
 
$CONFIG dataroot
 The full path to the data directory. More...
 
$CONFIG simplecache_enabled
 Is simplecache enabled? More...
 
$CONFIG system_cache_enabled
 Is the system cache enabled. More...
 
$CONFIG auto_disable_plugins
 Are unbootable plugins automatically disabled. More...
 
$CONFIG sitedescription
 The site description from the current site object. More...
 
$CONFIG siteemail
 The site email from the current site object. More...
 
$CONFIG default_limit
 The default "limit" used in site queries. More...
 
$CONFIG view
 The current view type. More...
 
$CONFIG default_access
 Default access as defined in the config table for the current site. More...
 
$CONFIG allow_registration
 Is registration enabled? More...
 
$CONFIG walled_garden
 Is current site in walled garden mode? More...
 
$CONFIG allow_user_default_access
 Are users allow to enter their own default access levels. More...
 
$CONFIG menu_items_featured_urls
 A list of feature URLs for the main site menu. More...
 
$CONFIG menu_items_custom_items
 The custom menu items entered in the administration. More...
 
$CONFIG pluginlistcache
 A list of plugins and their load order. More...
 
$CONFIG registered_entities
 A list of registered entities and subtypes. More...
 
$CONFIG independents
 A list of entity types and subtypes that have metadata whose access permission can be changed independently of the main object. More...
 
$CONFIG submenu_items
 Holds items for all submenus. More...
 
$CONFIG servicehandler
 Holds the service handlers as registered by {()}. More...
 
$CONFIG menucontexts
 A list of menu contexts for menus registered with add_menu(). More...
 
$CONFIG registers
 A list of registers and their children added via {()}. More...
 
$CONFIG register_objects
 A list of objects that can emit notifications. More...
 
$CONFIG group_tool_options
 Holds available group tools options. More...
 
$CONFIG lastcache
 The last cache time for the current viewtype. More...
 
$CONFIG exception_include = ''
 This is an optional script used to override Elgg's default handling of uncaught exceptions. More...
 
$_ELGG language_paths
 Paths to scan for autoloading languages. More...
 
$_ELGG translations
 String translations for the current language. More...
 
$_ELGG registered_tag_metadata_names
 An array of metadata names to be used as tags. More...
 
$_ELGG view_path
 The full path for core views. More...
 
$_ELGG view_types
 A list of valid view types as discovered. More...
 

Variable Documentation

$CONFIG allow_registration

Is registration enabled?

bool $CONFIG->allow_registration

Definition at line 163 of file config.php.

$CONFIG allow_user_default_access

Are users allow to enter their own default access levels.

bool $CONFIG->allow_user_default_access

Definition at line 177 of file config.php.

$CONFIG auto_disable_plugins

Are unbootable plugins automatically disabled.

See Also
->load

string $CONFIG->auto_disable_plugins

Definition at line 113 of file config.php.

$CONFIG dataroot

The full path to the data directory.

string $CONFIG->dataroot

Definition at line 86 of file config.php.

$CONFIG default_access

Default access as defined in the config table for the current site.

string $CONFIG->default_access

Definition at line 156 of file config.php.

$CONFIG default_limit

The default "limit" used in site queries.

int $CONFIG->default_limit

Definition at line 135 of file config.php.

$CONFIG exception_include = ''

This is an optional script used to override Elgg's default handling of uncaught exceptions.

This should be an absolute file path to a php script that will be called any time an uncaught exception is thrown.

The script will have access to the following variables as part of the scope global $CONFIG $exception - the unhandled exception

Warning
- the database may not be available

string $CONFIG->exception_include

Definition at line 281 of file config.php.

$CONFIG group_tool_options

Holds available group tools options.

Added with add_group_tool_option()

array $CONFIG->group_tool_options

Definition at line 257 of file config.php.

$CONFIG independents

A list of entity types and subtypes that have metadata whose access permission can be changed independently of the main object.

register_metadata_as_indepenent()

string $CONFIG->independents

Definition at line 215 of file config.php.

$CONFIG installed

Is the site fully installed.

bool $CONFIG->installed

Definition at line 58 of file config.php.

$CONFIG language

The current language for either the site or the user.

$CONFIG->language

Definition at line 51 of file config.php.

$_ELGG language_paths

Paths to scan for autoloading languages.

Languages are automatically loaded for the site or user's default language. Plugins can extend or override strings. language_paths is an array of paths to scan for PHP files matching the default language. The order of paths is determined by the plugin load order, with later entries overriding earlier. Language files within these paths are named as the two-letter ISO 639-1 country codes for the language they represent.

Language paths are stored as array keys in the format: $_ELGG->language_paths[str $language_path] = true

register_language() array $_ELGG->language_paths private

Definition at line 303 of file config.php.

$CONFIG lastcache

The last cache time for the current viewtype.

Used in the generation of CSS and JS links.

string $CONFIG->lastcache

Definition at line 264 of file config.php.

$CONFIG menu_items_custom_items

The custom menu items entered in the administration.

string $CONFIG->menu_items_custom_items

Definition at line 193 of file config.php.

$CONFIG menu_items_featured_urls

A list of feature URLs for the main site menu.

These links are added via the admin interface.

string $CONFIG->menu_items_featured_urls

Definition at line 186 of file config.php.

$CONFIG menucontexts

A list of menu contexts for menus registered with add_menu().

Not currently used.

array $CONFIG->menucontexts

Definition at line 236 of file config.php.

$CONFIG path

The full path where Elgg is installed.

string $CONFIG->path;

Definition at line 16 of file config.php.

$CONFIG pluginlistcache

A list of plugins and their load order.

string $CONFIG->pluginlistcache

Definition at line 200 of file config.php.

$CONFIG pluginspath

The full path where plugins are stored.

string $CONFIG->pluginspath

Definition at line 23 of file config.php.

$CONFIG register_objects

A list of objects that can emit notifications.

register_notification_object()

array $CONFIG->register_objects

Definition at line 250 of file config.php.

$CONFIG registered_entities

A list of registered entities and subtypes.

Used in search.

array $CONFIG->registered_entities

Definition at line 207 of file config.php.

$_ELGG registered_tag_metadata_names

An array of metadata names to be used as tags.

Because tags are simply names of meatdata, This is used in search to prevent data exposure by searching on arbitrary metadata.

array $_ELGG->registered_tag_metadata_names private

Definition at line 333 of file config.php.

$CONFIG registers

A list of registers and their children added via {()}.

Used only for menus.

string $CONFIG->registers

Definition at line 243 of file config.php.

$CONFIG servicehandler

Holds the service handlers as registered by {()}.

array $CONFIG->servicehandler

Definition at line 229 of file config.php.

$CONFIG simplecache_enabled

Is simplecache enabled?

See Also
elgg_is_simplecache_enabled() Use this instead of reading the value.

string $CONFIG->simplecache_enabled

Definition at line 95 of file config.php.

string $type object user group or site

The current site object.

ElggSite $CONFIG->site

Definition at line 79 of file config.php.

$CONFIG site_guid

The guid of the current site object.

int $CONFIG->site_guid

Definition at line 65 of file config.php.

$CONFIG site_id

Copy of $CONFIG->site_guid.

int $CONFIG->site_id

Definition at line 72 of file config.php.

$CONFIG sitedescription

The site description from the current site object.

string $CONFIG->sitedescription

Definition at line 120 of file config.php.

$CONFIG siteemail

The site email from the current site object.

string $CONFIG->siteemail

Definition at line 128 of file config.php.

$CONFIG sitename

The name of the site as defined in the config table.

string $CONFIG->sitename

Definition at line 44 of file config.php.

$CONFIG submenu_items

Holds items for all submenus.

string $CONFIG->submenu_items

Definition at line 222 of file config.php.

$CONFIG system_cache_enabled

Is the system cache enabled.

See Also
elgg_is_system_cache_enabled() Use this instead of reading the value.

string $CONFIG->system_cache_enabled

Definition at line 104 of file config.php.

$_ELGG translations

String translations for the current language.

Elgg uses a key-based system for string internationalization, which is accessed with elgg_echo().

Translations are stored as an array in the following format: $_ELGG->translations[str $language_code][str $string_key] = str 'Translated Language String';

See Also
register_translation()
elgg_echo() array $_ELGG->translations private

Definition at line 321 of file config.php.

$CONFIG url

The full URL where Elgg is installed.

string $CONFIG->wwwroot

Definition at line 37 of file config.php.

$CONFIG view

The current view type.

View types determin the location of view files that are used to draw pages. They are set system-wide by the $_REQUEST['view']. If a view type is manually set in settings.php or through a function hooking to the {

Warning
This is the current view type used to determine where to load views. Don't confuse this with the current view.

string $CONFIG->view

Definition at line 149 of file config.php.

$_ELGG view_path

The full path for core views.

string $_ELGG->view_path private

Definition at line 341 of file config.php.

$_ELGG view_types

A list of valid view types as discovered.

array $_ELGG->view_types private

Definition at line 349 of file config.php.

$CONFIG walled_garden

Is current site in walled garden mode?

bool $CONFIG->walled_garden

Definition at line 170 of file config.php.

$CONFIG wwwroot

The full URL where Elgg is installed.

string $CONFIG->wwwroot

Definition at line 30 of file config.php.