forked from extern/egroupware
137 lines
8.9 KiB
Plaintext
137 lines
8.9 KiB
Plaintext
<chapter id="devconfvar">
|
|
<title>Configuration Variables</title>
|
|
|
|
<simplesect>
|
|
<title>Introduction</title>
|
|
<para>
|
|
phpGroupWare attempt to provide developers with as much information about the user, group,
|
|
server, and application configuration as possible. To do this we provide a multi-dimensional
|
|
array called <classname>$phpgw_info[]</classname>, which includes all the information about
|
|
your environment.Due to the multi-dimensional array approach. getting these values is easy.
|
|
</para>
|
|
<para>
|
|
Here are some examples:
|
|
|
|
<programlisting>
|
|
<?php
|
|
// To do a hello username
|
|
echo "Hello " . $phpgw_info["user"]["fullname"];
|
|
//If username first name is John and last name is Doe, prints: 'Hello John Doe'
|
|
?>
|
|
<?php
|
|
// To find out the location of the imap server
|
|
echo "IMAP Server is named: " . $phpgw_info["server"]["imap_server"];
|
|
//If imap is running on localhost, prints: 'IMAP Server is named: localhost'
|
|
?>
|
|
</programlisting>
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>User information</title>
|
|
<para>
|
|
<simplelist type=vert columns=1>
|
|
<member><classname>$phpgw_info["user"]["userid"] = </classname>The user ID</member>
|
|
<member><classname>$phpgw_info["user"]["sessionid"] = </classname>The session ID</member>
|
|
<member><classname>$phpgw_info["user"]["theme"] = </classname>Selected theme</member>
|
|
<member><classname>$phpgw_info["user"]["private_dir"] = </classname>Users private dir. Use phpGroupWare core functions for access to the files.</member>
|
|
<member><classname>$phpgw_info["user"]["firstname"] = </classname>Users first name</member>
|
|
<member><classname>$phpgw_info["user"]["lastname"] = </classname>Users last name </member>
|
|
<member><classname>$phpgw_info["user"]["fullname"] = </classname>Users Full Name </member>
|
|
<member><classname>$phpgw_info["user"]["groups"] = </classname>Groups the user is a member of </member>
|
|
<member><classname>$phpgw_info["user"]["app_perms"] = </classname>If the user has access to the current application </member>
|
|
<member><classname>$phpgw_info["user"]["lastlogin"] = </classname>Last time the user logged in. </member>
|
|
<member><classname>$phpgw_info["user"]["lastloginfrom"] = </classname>Where they logged in from the last time. </member>
|
|
<member><classname>$phpgw_info["user"]["lastpasswd_change"] = </classname>Last time they changed their password. </member>
|
|
<member><classname>$phpgw_info["user"]["passwd"] = </classname>Hashed password. </member>
|
|
<member><classname>$phpgw_info["user"]["status"] = </classname>If the user is enabled. </member>
|
|
<member><classname>$phpgw_info["user"]["logintime"] = </classname>Time they logged into their current session. </member>
|
|
<member><classname>$phpgw_info["user"]["session_dla"] = </classname>Last time they did anything in their current session </member>
|
|
<member><classname>$phpgw_info["user"]["session_ip"] = </classname>Current IP address </member>
|
|
</simplelist>
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Group information</title>
|
|
<para>
|
|
<classname>$phpgw_info["group"]["group_names"] = </classname>List of groups.
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Server information</title>
|
|
<para>
|
|
<simplelist type=vert columns=1>
|
|
<member><classname>$phpgw_info["server"]["server_root"] = </classname>Main installation directory </member>
|
|
<member><classname>$phpgw_info["server"]["include_root"] = </classname>Location of the '<classname>inc</classname>' directory. </member>
|
|
<member><classname>$phpgw_info["server"]["temp_dir"] = </classname>Directory that can be used for temporarily storing files </member>
|
|
<member><classname>$phpgw_info["server"]["files_dir"] = </classname>Directory er and group files are stored </member>
|
|
<member><classname>$phpgw_info["server"]["common_include_dir"] = </classname>Location of the core/shared include files. </member>
|
|
<member><classname>$phpgw_info["server"]["template_dir"] = </classname>Active template files directory. This is defaulted by the server, and changeable by the user. </member>
|
|
<member><classname>$phpgw_info["server"]["dir_separator"] = </classname>Allows compatibility with WindowsNT directory format, </member>
|
|
<member><classname>$phpgw_info["server"]["encrpytkey"] = </classname>Key used for encryption functions </member>
|
|
<member><classname>$phpgw_info["server"]["site_title"] = </classname>Site Title will show in the title bar of each webpage. </member>
|
|
<member><classname>$phpgw_info["server"]["webserver_url"] = </classname>URL to phpGroupWare installation. </member>
|
|
<member><classname>$phpgw_info["server"]["hostname"] = </classname>Name of the server phpGroupWare is installed upon. </member>
|
|
<member><classname>$phpgw_info["server"]["charset"] = </classname>default charset, default:<classname>iso-8859-1</classname> </member>
|
|
<member><classname>$phpgw_info["server"]["version"] = </classname>phpGroupWare version. </member>
|
|
</simplelist>
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Database information</title>
|
|
<para>
|
|
It is unlikely you will need these, because <classname>$phpgw_info_db</classname> will already be loaded as a database for you to use.
|
|
<simplelist type=vert columns=1>
|
|
<member><classname>$phpgw_info["server"]["db_host"] = </classname>Address of the database server. Usually this is set to localhost. </member>
|
|
<member><classname>$phpgw_info["server"]["db_name"] = </classname>Database name. </member>
|
|
<member><classname>$phpgw_info["server"]["db_user"] = </classname>User name. </member>
|
|
<member><classname>$phpgw_info["server"]["db_pass"] = </classname>Password </member>
|
|
<member><classname>$phpgw_info["server"]["db_type"] = </classname>Type of database. Currently MySQL and PostgreSQL are supported. </member>
|
|
</simplelist>
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Mail information</title>
|
|
<para>
|
|
It is unlikely you will need these, because most email needs are services thru core phpGroupWare functions.
|
|
<simplelist type=vert columns=1>
|
|
<member><classname>$phpgw_info["server"]["mail_server"] = </classname>Address of the IMAP server. Usually this is set to localhost. </member>
|
|
<member><classname>$phpgw_info["server"]["mail_server_type"] = </classname>IMAP or POP3 </member>
|
|
<member><classname>$phpgw_info["server"]["imap_server_type"] = </classname>Cyrus or Uwash </member>
|
|
<member><classname>$phpgw_info["server"]["imap_port"] = </classname>This is usually 143, and should only be changed if there is a good reason. </member>
|
|
<member><classname>$phpgw_info["server"]["mail_suffix] = </classname>This is the domain name, used to add to email address </member>
|
|
<member><classname>$phpgw_info["server"]["mail_login_type"] = </classname>This adds support for VMailMgr. Generally this should be set to '<classname>standard</classname>'. </member>
|
|
<member><classname>$phpgw_info["server"]["smtp_server"] = </classname>Address of the SMTP server. Usually this is set to localhost. </member>
|
|
<member><classname>$phpgw_info["server"]["smtp_port"] = </classname>This is usually 25, and should only be changed if there is a good reason. </member>
|
|
</simplelist>
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>NNTP information</title>
|
|
<para>
|
|
<simplelist type=vert columns=1>
|
|
<member><classname>$phpgw_info["server"]["nntp_server"] = </classname>Address of the NNTP server. </member>
|
|
<member><classname>$phpgw_info["server"]["nntp_port"] = </classname>This is usually XX, and should only be changed if there is a good reason. </member>
|
|
<member><classname>$phpgw_info["server"]["nntp_sender"] = </classname>Unknown </member>
|
|
<member><classname>$phpgw_info["server"]["nntp_organization"] = </classname>Unknown </member>
|
|
<member><classname>$phpgw_info["server"]["nntp_admin"] = </classname>Unknown </member>
|
|
</simplelist>
|
|
</para>
|
|
</simplesect>
|
|
<simplesect>
|
|
<title>Application information</title>
|
|
<para>
|
|
Each application has the following information available.
|
|
<simplelist type=vert columns=1>
|
|
<member><classname>$phpgw_info["apps"]["appname"]["title"] = </classname>The title of the application. </member>
|
|
<member><classname>$phpgw_info["apps"]["appname"]["enabled"] = </classname>If the application is enabled. True or False. </member>
|
|
<member><classname>$phpgw_info["server"]["app_include_dir"] = </classname>Location of the current application include files. </member>
|
|
<member><classname>$phpgw_info["server"]["app_template_dir"] = </classname>Location of the current application tpl files. </member>
|
|
<member><classname>$phpgw_info["server"]["app_lang_dir"] = </classname>Location of the current lang directory. </member>
|
|
<member><classname>$phpgw_info["server"]["app_auth"] = </classname>If the server and current user have access to current application </member>
|
|
<member><classname>$phpgw_info["server"]["app_current"] = </classname>name of the current application. </member>
|
|
</simplelist>
|
|
</para>
|
|
</simplesect>
|
|
|
|
</chapter>
|
|
|