Aspen Framework

From Aspen Documentation

The following is a list of all available configuration parameters that you may use in your application or user configuration files. The configuration settings on this page are used by the framework and should not be removed.

In the list below, we list config key Default Value and a description.

application_name Aspen Framework

Defines the name of your website or application. This is currently used in error reporting and default templates.

application_guid 8266f8e0-204d-11dd-bd0b-0800200c9a66

A unique identification key for your application. Provided by default is the aspen application key, but we strongly recommend generating your own.

application_version 1.0.0 Beta 2

The version you want to assign to your website or application.

application_url '

The web address to your root installation. This is auto-detected if this setting is left false.

db_username root

Database access username.

db_password '

Database access password.

db_database aspen_framework

Database name.

db_hostname localhost

Database access hostname. Usually, this will be "localhost".

db_extension mysql

Database type. Currently, Aspen only supports MySQL.

enable_languages 1

Enables the support for language files.

language en_US

The default language file to be loaded.

enable_mod_rewrite 1

Enables clean urls using mod_rewrite within your application.

default_module Index_Admin

The name of the default module to load if none provided in the URL.

default_module_no_config Install_Admin

The name of the default module to load if the system has not been installed. Installed will return false if user config is missing, database connection fails, or tables are not present.

default_method view

Default class method "page" to load if none provided in URL.

force_https '

Force redirection to HTTPS if connection is at HTTP. Requires ports to be standard 80/443.

post_login_redirect 1

Redirect user to originally requested URL after they login.

static_content_path '

Web address to static content like css, images, javascript. Useful if your content is being served from another server like Lighttpd or similar.

email_sender noreply@yourdomain.com

Default address on outgoing email (you must use this config manually if adding new email functions).

email_sender_name noreply@yourdomain.com

Default name on outgoing email (you must use this config manually if adding new email functions).

minimum_displayable_error 1

PHP error level that must be encountered before displaying to user. Set to zero for none.

save_error_to_db 1

Toggles saving php/system error messages to database.

send_error_emails '

Toggles sending error log to an email account.

error_email_recipient webmaster@yourdomain.com

Error email recipient address.

error_email_sender errors@yourdomain.com

Error email sender address.

error_email_sender_name errors@yourdomain.com

Error email sender name.

minimum_version_php 5.1.0

Minimum version of PHP that is required. This version is merely informational. For version checks, update the value in the index.php file you're using for your application interface or system/loader.inc.php.

timezone America/Los_Angeles

Default timezone.

currency_format %n

Default currency format. More information.

currency_locale en_US

Default currency locale. More information.

custom_classes_directory custom

Directory that custom classes may be found in. Directory is relative to root installation path.

require_form_token_auth '

Toggle requiring a form authentication token. This stores a token in the session which must be matched to a form on submit.

sml_message_html <p class="notice">%s</p>

The wrapping html for any messages displaying from the SML class.

form_error_wrapping_html <ul class="error">%s</ul>

Default wrapping html for any form errors displayed using the printErrors method.

form_error_line_html <li&gt%s</li&gt

Default per-error wrapping html for any form errors displayed using the printErrors method.

html_purifier_settings Array

An array of settings that are passed to the HTMLPurifier class.

watch_pending_db_upgrade '

If true, the system will watch the modules/Install/sql/upgrade.sql file for any new sql queries with a build number greater than that in the upgrade_history table.

mysql_field_group_int array('tinyint', 'int', 'smallint', 'mediumint', 'bigint', 'float', 'double', 'decimal')

List of mysql field types that are grouped as integers. Used in the [[Aspen:Scaffold|Scaffold] class.

mysql_field_group_text array('char', 'varchar', 'text', 'tinytext', 'mediumtext', 'longtext', 'tinyblob', 'blob', 'mediumblob', 'longblob')

List of mysql field types that are grouped as text. Used in the [[Aspen:Scaffold|Scaffold] class.

mysql_field_group_date array('date', 'datetime', 'timestamp', 'time', 'year')

List of mysql field types that are grouped as date fields. Used in the [[Aspen:Scaffold|Scaffold] class.

allowed_file_extensions array('jpg', 'jpeg', 'png', 'gif')

File extensions that are allowed during upload.

enable_uploads false

Toggle to allow files to be uploaded.

upload_server_path uploads

Server path to an uploads folder.

upload_browser_path false

Web address to upload folder. Automatically detected if set to false.

upload_max_file_size 2000000

Maximum upload file size, in bytes.

enable_logging '

Enables system logging. Requires logging folder with proper permissions.

timestamp_log_file '

Whether or not log files are timestamped, so that each request is logged separately.

log_verbosity 1

Level of data to log. If less than 1, no core system information is logged. Only system startup messages, and any user level messages.

log_dir logs

Path to log directory.

enable_cache '

Enables cache class.

cache_template_output '

Toggles template output caching.

cache_dir cache

Cache file directory.

load_add_core_class Array

System classes that are to be loaded at startup. Only the core framework are listed here. To load additional or to load custom classes, set those settings in your config.