Warning! This page has the following tags:

• This page needs to be merged with docbook documentation.

Agavi Configuration Directives

The following is a list of directives you can set via AgaviConfig:

Core Directives

Name	Description	Possible Values	Default Value
core.debug	Enables or disables debug mode	true, false	false
core.available	Whether or not this Application is available	true, false	false
core.minimum_php_version	The minimum version of PHP required
core.app_name	The name of the Application
core.environment	The name of the Environment to bootstrap in case you don't want to hand it to Agavi::bootstrap() as an argument.
core.default_context	The name of the Context that will be returned by AgaviContext::getInstance() if you don't supply a name as an argument.
core.use_database	Whether or not to use database functionalities	true, false	false
core.use_logging	Whether or not logging should be enabled	true, false	false
core.use_security	Whether or not to enable security features	true, false	true
core.use_translation	Whether or not to enable translation features	true, false	false
core.agavi_dir	The location of Agavi		The folder where agavi.php is located.
core.cache_dir	The location where Agavi will store cache files for configuration, output, compiled templates etc.		"core.app_dir/cache"
core.cldr_dir	The application's cldr data directory.		"core.agavi_dir/translation/data"
core.config_dir	The location where the application's config files are stored		"core.app_dir/config"
core.system_config_dir	The location where the Agavi's default config files (autoload.xml, compile.xml and config_handlers.xml) are stored. You usually shouldn't have to change this.		"core.app_dir/config/defaults"
core.lib_dir	The application's library directory.		"core.app_dir/lib"
core.model_dir	The application's global model directory.		"core.app_dir/models"
core.module_dir	The folder where an application's modules reside in		"core.app_dir/modules"
core.template_dir	The folder where an application's global templates are stored		"core.app_dir/templates"
core.app_dir	The location of your application's app dir. This value must be set before Agavi::bootstrap() is called.
core.skip_config_validation	Whether or not validation for config files should be skipped (good if you have an old, buggy libxml version)	true, false	false
core.skip_config_transformations	Whether or not transformations for config files should be skipped (this includes backwards-compatibility transformations and Schematron validation)	true, false	false

Default Action Directives

These are used to configure module and action names for the default Actions Agavi uses in special situations.

Name	Description	Possible Values	Default Value
actions.error_404_module	Agavi forwards to the 404 Action when a requested module or action could not be found.
actions.error_404_action	The action name of the 404 Action.
actions.default_module	The Default Action is executed when the request does not contain information about the module and action to run.
actions.default_action	The action name of the Default Action.
actions.login_module	Unauthenticated users are forwarded to the Login Action when a request is made for a secure action.
actions.login_action	The action name of the Login Action.
actions.module_disabled_module	The Module Disabled Action will be run if the request is made for a disabled module.
actions.module_disabled_action	The action name of the Module Disabled Action.
actions.secure_module	The Secure Action is run when a user does not have sufficient credentials to access an Action (basically a 403 Forbidden page).
actions.secure_action	The action name of the Secure Action.
actions.unavailable_module	The Unvailable Action is executed when the application is in unavailable state, i.e. core.available is set to false.
actions.unavailable_action	The action name of the Unavailable Action.

Agavi Information Directives

These settings are for informational purposes and usually shouldn't be changed at runtime (no idea why you would want to anyway).

Name	Description	Possible Values	Default Value
agavi.name	The name of the framework ;)		"Agavi"
agavi.major_version	The major framework version, e.g. "1"
agavi.minor_version	The minor framework version, e.g. "0"
agavi.micro_version	The micro framework version, e.g. "3"
agavi.branch	The framework version branch, usually "trunk"
agavi.status	The framework version status, such as "DEV" or "RC1" or "stable"
agavi.version	The entire version information string, e.g. "1.0.3-stable"		"agavi.major_version.agavi.minor_version.agavi.micro_version-agavi.status"
agavi.release	The entire release information string, e.g. "Agavi/1.0.3-stable"		"agavi.name/agavi.version"
agavi.url	The URL to the framework website		"http://www.agavi.org"
agavi.info	The complete information string, e.g. "Agavi/1.0.3-stable (http://www.agavi.org)"		"agavi.release (agavi.url)"