<HTML ><HEAD ><TITLE >Configuration Variables</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.52"><LINK REL="HOME" TITLE="phpGroupWare Docs V0.05" HREF="book1.html"><LINK REL="UP" TITLE="Developers Documentation" HREF="p261.html"><LINK REL="PREVIOUS" TITLE="Email/NNTP Functions" HREF="x471.html"><LINK REL="NEXT" TITLE="Using Language Support" HREF="devlangsup.html"></HEAD ><BODY CLASS="CHAPTER" ><DIV CLASS="NAVHEADER" ><TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >phpGroupWare Docs V0.05</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="x471.html" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="devlangsup.html" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="CHAPTER" ><H1 ><A NAME="DEVCONFVAR" >Chapter 26. Configuration Variables</A ></H1 ><DIV CLASS="TOC" ><DL ><DT ><B >Table of Contents</B ></DT ><DT ><A HREF="devconfvar.html#AEN482" >Introduction</A ></DT ><DT ><A HREF="devconfvar.html#AEN488" >User information</A ></DT ><DT ><A HREF="devconfvar.html#AEN526" >Group information</A ></DT ><DT ><A HREF="devconfvar.html#AEN530" >Server information</A ></DT ><DT ><A HREF="devconfvar.html#AEN562" >Database information</A ></DT ><DT ><A HREF="devconfvar.html#AEN577" >Mail information</A ></DT ><DT ><A HREF="devconfvar.html#AEN598" >NNTP information</A ></DT ><DT ><A HREF="devconfvar.html#AEN612" >Application information</A ></DT ></DL ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN482" >Introduction</A ></H4 ><P > 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 <TT CLASS="CLASSNAME" >$phpgw_info[]</TT >, which includes all the information about your environment.Due to the multi-dimensional array approach. getting these values is easy. </P ><P > Here are some examples: <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" ><TR ><TD ><PRE CLASS="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' ?></PRE ></TD ></TR ></TABLE > </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN488" >User information</A ></H4 ><P > <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["userid"] = </TT >The user ID</TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["sessionid"] = </TT >The session ID</TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["theme"] = </TT >Selected theme</TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["private_dir"] = </TT >Users private dir. Use phpGroupWare core functions for access to the files.</TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["firstname"] = </TT >Users first name</TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["lastname"] = </TT >Users last name </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["fullname"] = </TT >Users Full Name </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["groups"] = </TT >Groups the user is a member of </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["app_perms"] = </TT >If the user has access to the current application </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["lastlogin"] = </TT >Last time the user logged in. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["lastloginfrom"] = </TT >Where they logged in from the last time. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["lastpasswd_change"] = </TT >Last time they changed their password. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["passwd"] = </TT >Hashed password. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["status"] = </TT >If the user is enabled. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["logintime"] = </TT >Time they logged into their current session. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["session_dla"] = </TT >Last time they did anything in their current session </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["user"]["session_ip"] = </TT >Current IP address </TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN526" >Group information</A ></H4 ><P > <TT CLASS="CLASSNAME" >$phpgw_info["group"]["group_names"] = </TT >List of groups. </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN530" >Server information</A ></H4 ><P > <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["server_root"] = </TT >Main installation directory </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["include_root"] = </TT >Location of the '<TT CLASS="CLASSNAME" >inc</TT >' directory. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["temp_dir"] = </TT >Directory that can be used for temporarily storing files </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["files_dir"] = </TT >Directory er and group files are stored </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["common_include_dir"] = </TT >Location of the core/shared include files. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["template_dir"] = </TT >Active template files directory. This is defaulted by the server, and changeable by the user. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["dir_separator"] = </TT >Allows compatibility with WindowsNT directory format, </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["encrpytkey"] = </TT >Key used for encryption functions </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["site_title"] = </TT >Site Title will show in the title bar of each webpage. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["webserver_url"] = </TT >URL to phpGroupWare installation. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["hostname"] = </TT >Name of the server phpGroupWare is installed upon. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["charset"] = </TT >default charset, default:<TT CLASS="CLASSNAME" >iso-8859-1</TT > </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["version"] = </TT >phpGroupWare version. </TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN562" >Database information</A ></H4 ><P > It is unlikely you will need these, because <TT CLASS="CLASSNAME" >$phpgw_info_db</TT > will already be loaded as a database for you to use. <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["db_host"] = </TT >Address of the database server. Usually this is set to localhost. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["db_name"] = </TT >Database name. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["db_user"] = </TT >User name. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["db_pass"] = </TT >Password </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["db_type"] = </TT >Type of database. Currently MySQL and PostgreSQL are supported. </TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN577" >Mail information</A ></H4 ><P > It is unlikely you will need these, because most email needs are services thru core phpGroupWare functions. <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["mail_server"] = </TT >Address of the IMAP server. Usually this is set to localhost. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["mail_server_type"] = </TT >IMAP or POP3 </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["imap_server_type"] = </TT >Cyrus or Uwash </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["imap_port"] = </TT >This is usually 143, and should only be changed if there is a good reason. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["mail_suffix] = </TT >This is the domain name, used to add to email address </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["mail_login_type"] = </TT >This adds support for VMailMgr. Generally this should be set to '<TT CLASS="CLASSNAME" >standard</TT >'. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["smtp_server"] = </TT >Address of the SMTP server. Usually this is set to localhost. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["smtp_port"] = </TT >This is usually 25, and should only be changed if there is a good reason. </TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN598" >NNTP information</A ></H4 ><P > <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["nntp_server"] = </TT >Address of the NNTP server. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["nntp_port"] = </TT >This is usually XX, and should only be changed if there is a good reason. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["nntp_sender"] = </TT >Unknown </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["nntp_organization"] = </TT >Unknown </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["nntp_admin"] = </TT >Unknown </TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ><DIV CLASS="SIMPLESECT" ><H4 CLASS="SIMPLESECT" ><A NAME="AEN612" >Application information</A ></H4 ><P > Each application has the following information available. <P ></P ><TABLE BORDER="0" ><TBODY ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["apps"]["appname"]["title"] = </TT >The title of the application. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["apps"]["appname"]["enabled"] = </TT >If the application is enabled. True or False. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["app_include_dir"] = </TT >Location of the current application include files. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["app_template_dir"] = </TT >Location of the current application tpl files. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["app_lang_dir"] = </TT >Location of the current lang directory. </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["app_auth"] = </TT >If the server and current user have access to current application </TD ></TR ><TR ><TD ><TT CLASS="CLASSNAME" >$phpgw_info["server"]["app_current"] = </TT >name of the current application. </TD ></TR ></TBODY ></TABLE ><P ></P > </P ></DIV ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="x471.html" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="book1.html" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="devlangsup.html" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Email/NNTP Functions</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="p261.html" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >Using Language Support</TD ></TR ></TABLE ></DIV ></BODY ></HTML >