ATK Configuration

Below is a categorized list of configuration options. This page is far from complete. If you encounter a configuration value in ATK that is not listed here, please help us improve the documentation by adding it.

Within a category, the options are listed alphabetically.

$config_identifier = "atkapp";

Unique application identifier. Set this when using multiple applications within one website

Database Configuration

$config_db["default"]["driver"]

Which database driver to use

Possible values :

• mysql - All MySQL versions since 3.23
• mysqli - not supported?
• mysql41 - MySQL 4.1+. On top of the "mysql" driver, this one has transaction support. (requires PHP5, mysqli extension)
• mssql - not supported?
• oci805 - Oracle 8.0.5
• oci8 - All Oracle 8i versions
• oci9 - Oracle9i+ (also works for 10G)
• pgqsl - PostgreSQL 7.1+
• db2 - not supported?
• i5 - not supported?

Default : mysql

$config_db["default"]["host"] = "localhost";

Specify the hostname of the database server

$config_db["default"]["db"] = "genbydb";

$config_db["default"]["user"] = "admin";

$config_db["default"]["password"] = "";

$config_edit_fieldprefix

This configoption sets the default fieldprefix for all fields in all nodes to use in ATK. If you only want to use the fieldprefix for some of the nodes in your ATK application use the setEditFieldPrefix method of the atknode class instead.

Possible values : Text with the fieldprefix

Default : N/A

DEBUGGER CONFIGURATION

$config_debug = 0;

The debug level.

• 0 - No debug information
• 1 - Print some debug information at the bottom of each screen
• 2 - Print debug information, and pause before redirects
• 3 - Like 2, but also adds trace information to each statement

$config_mailreport = "";

The automatic error reporter. Error reports are sent to the given email address. If you set this to "", error reporting will be turned off. WARNING: DO NOT LEAVE THIS TO THE DEFAULT ADDRESS OR PREPARE TO BE SEVERELY FLAMED!

GUI Configuration

$config_defaulttheme

The theme defines the layout of your application. You can see which themes there are in the directory atk/themes.

$config_force_theme_recompile = true;

The themecompiler caches all theme settings for performance reasons. This means that when you make changes to a themedefinition, they won't actually be used unless the cache is removed and the themecompiler is forced to recompile. It is always advisable to turn on the $config_force_theme_recompile (ATK>=5.03)config option when working on themes, this will reduce performance but also ensure that the themecompiler will recompile the themecache for every reload, thus always giving you the current and correct themedefinitons. Or you could also just remove the themecache, just use 'rm -rf atktmp/themes' in your application root (with atktmp being the name of the temporary directory). You must have the rights to do this though (only root and the webserver user should have this right).

$config_fullscreen = false;

If the users are using IE, then the application can be run in fullscreen mode.

$config_language="en";

The language of the application. You can use any language for which a language file is present in the atk/languages directory.

$config_menu_align

how the menu aligns. This is not a standard config variable, so you can't find it in config.inc.php

Possible values : left, center, right

Default : center

$config_menu_delimiter = "
";

$config_menu_layout

A theme defines which menus it supports. (because the layout is very theme specific so it doesn't support all of them). If a theme supports multiple menu's, then you can choose one by defining $config_menu_layout. However, if a menu is selected that is not supported by the theme, the theme will fallback to the first menu it does support.

Possible values : Set by $theme['compatible_menus'] in themedef.inc

Default : first menu supported by the theme.

$config_menu_pos = "left";

$config_recordlist_icons = true;

$config_recordlistorientation

Place the recordlist action icons on the left or right of recordlists.

Possible values : right, left, both

Default : right

$config_recordlistvorientation

Place the column headers (fieldname, searchfields etc.) at the top or bottom of recordlists.

Possible values : top, bottom, both

Default : top

$config_recordsperpage

The number of records to display in a list of records. If there are more records than this number, previous/next links and page numbers will be added.

Possible values : positive number

Default : 25

$config_top_frame = 1;

If you have a menu at either left or right, you can add an extra topframe by setting the following option to 1. If you set it to 1, you must provide a "top.php" file in your application directory.

Relations

$config_manytoone_autocomplete_minchars

The number of characters a user must type before a manytoonerelation starts to do autocompletion

Possible values : Number higher than 0

Default : 2

Security Configuration

$config_auth_enablepasswordmailer = true;

This will put an extra button on the longin screen to have a password sent to the email address regered for the username entered. Of note, the following options must also be set for this to work:

• $config_auth_usernode = "module.nodename";
• $config_auth_usertable = "user_tablename";
• $config_auth_userfield = "username_fieldname";
• $config_auth_emailfield = "useremail_fieldname";
• $config_auth_passwordfield = "userpassword_fieldname";

Possible values : True

Default : N/A

$config_auth_loginpage = 'http://myurl';

For applications that do not want to use the atk login form or the htaccess box this config variable can contain an url to redirect to instead of displaying the login form of ATK.

Possible values : Text with the url

Default : N/A