<html>
<head>
<title>Reference</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">PHPonTrax</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_PHPonTrax.html" class="menu">class tree: PHPonTrax</a> ]
[ <a href="../elementindex_PHPonTrax.html" class="menu">index: PHPonTrax</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_PHPonTrax.html">PHPonTrax</a><br />
<a href="../li_PHPonTraxTest.html">PHPonTraxTest</a><br />
<br /><br />
<b>Tutorials/Manuals:</b><br />
<strong>Package-level:</strong>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_PHPonTrax.pkg.html">PHP On Trax</a>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_rails_examples.pkg.html">Examples From The Rails Book</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_simpleapp.pkg.html">Build A Simple Trax Application</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_database.pkg.html">Create A Database and User</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_advbuild.pkg.html">Advanced Application Build Topics</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_naming.pkg.html">The Trax Naming Convention</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_troubleshoot.pkg.html">Troubleshooting</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_reference.pkg.html">Reference</a>
</ul>
</li></ul>
<strong>Class-level:</strong>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ActiveRecordHelper.cls.html">ActiveRecordHelper</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_FormTagHelper.cls.html">FormTagHelper</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_Helpers.cls.html">Helpers</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_UrlHelper.cls.html">UrlHelper</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_FormHelper.cls.html">FormHelper</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_InputFilter.cls.html">InputFilter</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ActionMailer.cls.html">ActionMailer</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ApplicationController.cls.html">ApplicationController</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ActionController.cls.html">ActionController</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ActiveRecord.cls.html">ActiveRecord</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_DateHelper.cls.html">DateHelper</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_Router.cls.html">Router</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_FormOptionsHelper.cls.html">FormOptionsHelper</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_TraxGenerator.cls.html">TraxGenerator</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_Session.cls.html">Session</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_Inflector.cls.html">Inflector</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ActiveRecordError.cls.html">ActiveRecordError</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ActionControllerError.cls.html">ActionControllerError</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ScaffoldController.cls.html">ScaffoldController</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_Dispatcher.cls.html">Dispatcher</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_TraxError.cls.html">TraxError</a>
</ul>
<ul>
<li type="square"><a href="../PHPonTrax/tutorial_ApplicationMailer.cls.html">ApplicationMailer</a>
</ul>
<b>Files:</b><br />
<div class="package">
<a href="../PHPonTrax/_vendor_trax_action_controller_php.html"> action_controller.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_mailer_php.html"> action_mailer.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_php.html"> action_view.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_active_record_php.html"> active_record.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_active_record_helper_php.html"> active_record_helper.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_add_phtml.html"> add.phtml
</a><br>
<a href="../PHPonTrax/_data_app_controllers_application_php.html"> application.php
</a><br>
<a href="../PHPonTrax/_data_app_views_layouts_application_phtml.html"> application.phtml
</a><br>
<a href="../PHPonTrax/_data_app_helpers_application_helper_php.html"> application_helper.php
</a><br>
<a href="../PHPonTrax/_data_app_application_mailer_php.html"> application_mailer.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_asset_tag_helper_php.html"> asset_tag_helper.php
</a><br>
<a href="../PHPonTrax/_test_layouts_catalog_phtml.html"> catalog.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_controller_php.html"> controller.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_controller_php.html"> controller.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_date_helper_php.html"> date_helper.php
</a><br>
<a href="../PHPonTrax/_data_config_environments_development_php.html"> development.php
</a><br>
<a href="../PHPonTrax/_data_public_dispatch_php.html"> dispatch.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_dispatcher_php.html"> dispatcher.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_edit_phtml.html"> edit.phtml
</a><br>
<a href="../PHPonTrax/_data_config_environment_php.html"> environment.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_error_phtml.html"> error.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_helper_php.html"> form_helper.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_options_helper_php.html"> form_options_helper.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_form_scaffolding_phtml.html"> form_scaffolding.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_tag_helper_php.html"> form_tag_helper.php
</a><br>
<a href="../PHPonTrax/_data_script_generate_php.html"> generate.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_helper_php.html"> helper.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_php.html"> helpers.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_index_phtml.html"> index.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_inflector_php.html"> inflector.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_input_filter_php.html"> input_filter.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_javascript_helper_php.html"> javascript_helper.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_layout_phtml.html"> layout.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_layout_phtml.html"> layout.phtml
</a><br>
<a href="../PHPonTrax/_makepkg_php.html"> makepkg.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_model_php.html"> model.php
</a><br>
<a href="../PHPonTrax/_data_config_environments_production_php.html"> production.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_router_php.html"> router.php
</a><br>
<a href="../PHPonTrax/_data_config_routes_php.html"> routes.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_scaffold_controller_php.html"> scaffold_controller.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_session_php.html"> session.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_show_phtml.html"> show.phtml
</a><br>
<a href="../PHPonTrax/_data_config_environments_test_php.html"> test.php
</a><br>
<a href="../PHPonTrax/_trax_php.html"> trax.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_trax_exceptions_php.html"> trax_exceptions.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_trax_generator_php.html"> trax_generator.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_action_view_helpers_url_helper_php.html"> url_helper.php
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_view_phtml.html"> view.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_add_phtml.html"> view_add.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_edit_phtml.html"> view_edit.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_index_phtml.html"> view_index.phtml
</a><br>
<a href="../PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_show_phtml.html"> view_show.phtml
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../PHPonTrax/.html"></a><br />
<a href="../PHPonTrax/ActionController.html">ActionController</a><br />
<a href="../PHPonTrax/ActionControllerError.html">ActionControllerError</a><br />
<a href="../PHPonTrax/ActionMailer.html">ActionMailer</a><br />
<a href="../PHPonTrax/ActiveRecord.html">ActiveRecord</a><br />
<a href="../PHPonTrax/ActiveRecordError.html">ActiveRecordError</a><br />
<a href="../PHPonTrax/ActiveRecordHelper.html">ActiveRecordHelper</a><br />
<a href="../PHPonTrax/ApplicationController.html">ApplicationController</a><br />
<a href="../PHPonTrax/ApplicationMailer.html">ApplicationMailer</a><br />
<a href="../PHPonTrax/AssetTagHelper.html">AssetTagHelper</a><br />
<a href="../PHPonTrax/DateHelper.html">DateHelper</a><br />
<a href="../PHPonTrax/Dispatcher.html">Dispatcher</a><br />
<a href="../PHPonTrax/FormHelper.html">FormHelper</a><br />
<a href="../PHPonTrax/FormOptionsHelper.html">FormOptionsHelper</a><br />
<a href="../PHPonTrax/FormTagHelper.html">FormTagHelper</a><br />
<a href="../PHPonTrax/Helpers.html">Helpers</a><br />
<a href="../PHPonTrax/Inflector.html">Inflector</a><br />
<a href="../PHPonTrax/InputFilter.html">InputFilter</a><br />
<a href="../PHPonTrax/JavaScriptHelper.html">JavaScriptHelper</a><br />
<a href="../PHPonTrax/Router.html">Router</a><br />
<a href="../PHPonTrax/ScaffoldController.html">ScaffoldController</a><br />
<a href="../PHPonTrax/Session.html">Session</a><br />
<a href="../PHPonTrax/TraxError.html">TraxError</a><br />
<a href="../PHPonTrax/TraxGenerator.html">TraxGenerator</a><br />
<a href="../PHPonTrax/UrlHelper.html">UrlHelper</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="10%" align="left" valign="bottom"><a href=
"../PHPonTrax/tutorial_troubleshoot.pkg.html">Prev</a></td>
<td width="80%" align="center" valign="bottom"></td>
<td width="10%" align="right" valign="bottom"><a href=
"../PHPonTrax/tutorial_ActiveRecordHelper.cls.html">Next</a></td>
</tr>
</table>
<span id = "simpleapp.reference"><h2 class="title">Reference</h2><a name="reference.ref_defines"></a><h3 class="title">Defines</h3>All the definitions below are set in file
<a href="../PHPonTrax/_data_config_environment_php.html">config/environment.php</a>
<ul><li><span class="cmd-title">DEBUG</span>
<div class="cmd-synopsis">boolean set to true if TRAX_MODE is 'development',
false otherwise. Determines whether PHP error messages should be
sent to the browser; true means show error messages on the
browser as well as the error log, false means send error messages
to only the error log. Implemented by calling
<a href="http://www.php.net/ini_set">ini_set()</a>
at the time DEBUG is defined.</div></li>
<li><span class="cmd-title">PHP_LIB_ROOT</span>
<div class="cmd-synopsis">Directory containing PHP libraries. This directory
will be added to the PHP
<a href="http://www.php.net/manual/en/ini.core.php#ini.include-path">include path</a>.</div></li>
<li><span class="cmd-title">TRAX_LIB_ROOT</span>
<div class="cmd-synopsis">Directory containing Trax libraries. Set to a
subdirectory of TRAX_ROOT or PHP_LIB_ROOT and added to the PHP
<a href="http://www.php.net/manual/en/ini.core.php#ini.include-path">include path</a>.</div></li>
<li><span class="cmd-title">TRAX_MODE</span>
<div class="cmd-synopsis">Contains one of 'test', 'development' or 'production'.
Determines which database to use.
Get it from $_SERVER['TRAX_MODE'] if that exists</div></li>
<li><span class="cmd-title">TRAX_PUBLIC</span>
<div class="cmd-synopsis">Subdirectory of the user's home directory referenced
by the Apache configuration variable <code>UserDir</code>.</div></li>
<li><span class="cmd-title">TRAX_ROOT</span>
<div class="cmd-synopsis">Filesystem path to the top of the Trax file tree.</div></li>
<li><span class="cmd-title">TRAX_URL_PREFIX</span>
<div class="cmd-synopsis">That part of a URL which refers to a Trax
application that comes after the domain name and before the
controller. Usually empty. In the case of a Trax application in
the home directory of user <code>username</code>,
<span class="cmd-title">TRAX_URL_PREFIX</span> would be set to
'<code>~username</code>'.</div></li>
<li><span class="cmd-title">TRAX_VIEWS_EXTENTION</span>
<div class="cmd-synopsis">File extension for views, default
'phtml'.</div></li></ul><hr />
<a name="reference.ref_globals"></a><h3 class="title">Globals</h3><ul><li><span class="cmd-title">$GLOBALS['ACTIVE_RECORD_DB']</span>
<div class="cmd-synopsis">Database connection resource for the currently open
database connection, or <a href="http://pear.php.net">PEAR</a> or
<a href="http://pear.php.net/package/DB">DB</a> error if
the connection attempt failed. Set in
<a href="../PHPonTrax/ActiveRecord.html#methodestablish_connection">ActiveRecord::establish_connection()</a>.</div></li>
<li><span class="cmd-title">$GLOBALS['ACTIVE_RECORD_SQL_LOG']</span>
<div class="cmd-synopsis">An array which contains a log of SQL queries sent to
the DBMS, one query per element. Created only when TRAX_MODE is
'development'. Written in <a href="../PHPonTrax/ActiveRecord.html#methodlog_query">ActiveRecord::log_query()</a>.</div></li>
<li><span class="cmd-title">$GLOBALS['COUNTRIES']</span>
<div class="cmd-synopsis">List of countries. Set in <a href="../PHPonTrax/_vendor_trax_action_view_helpers_form_options_helper_php.html">form_options_helper.php</a>.</div></li>
<li><span class="cmd-title">$GLOBALS['current_action_name']</span>
<div class="cmd-synopsis">Name of action parsed from the URL.
Set in <a href="../PHPonTrax/ActionController.html#methodprocess_route">ActionController::process_route()</a>
Value stored before knowing whether the method for this action
actually exists in the relevant controller.</div></li>
<li><span class="cmd-title">$GLOBALS['current_controller_name']</span>
<div class="cmd-synopsis">Name of the controller as parsed from the URL. The name is in
lower case without the "_controller" suffix.
Set in <a href="../PHPonTrax/ActionController.html#methodprocess_route">ActionController::process_route()</a>. Not set until
the controller PHP file has been opened and the controller object
created successfully.</div></li>
<li><span class="cmd-title">$GLOBALS['current_controller_object']</span>
<div class="cmd-synopsis">Successfully created controller object.
Set in <a href="../PHPonTrax/ActionController.html#methodprocess_route">ActionController::process_route()</a></div></li>
<li><span class="cmd-title">$GLOBALS['current_controller_path']</span>
<div class="cmd-synopsis">Controller URL path below <span class="cmd-title">TRAX_URL_PREFIX</span>.
Set in <a href="../PHPonTrax/ActionController.html#methodprocess_route">ActionController::process_route()</a>. Not set until
the controller PHP file has been opened and the controller object
created successfully.</div></li>
<li><span class="cmd-title">$GLOBALS['DEFAULT_DATE_OPTIONS']</span>
<div class="cmd-synopsis">Referenced in <a href="../PHPonTrax/FormHelper.html">FormHelper</a></div></li>
<li><span class="cmd-title">$GLOBALS['DEFAULT_FIELD_OPTIONS']</span>
<div class="cmd-synopsis">Referenced in <a href="../PHPonTrax/FormHelper.html">FormHelper</a></div></li>
<li><span class="cmd-title">$GLOBALS['DEFAULT_RADIO_OPTIONS']</span>
<div class="cmd-synopsis">Referenced in <a href="../PHPonTrax/FormHelper.html">FormHelper</a></div></li>
<li><span class="cmd-title">$GLOBALS['DEFAULT_TEXT_AREA_OPTIONS']</span>
<div class="cmd-synopsis">Referenced in <a href="../PHPonTrax/FormHelper.html">FormHelper</a></div></li>
<li><span class="cmd-title">$GLOBALS['JAVASCRIPT_DEFAULT_SOURCES']</span>
<div class="cmd-synopsis">Referenced in <a href="../PHPonTrax/AssetTagHelper.html">AssetTagHelper</a> constructor</div></li>
<li><span class="cmd-title">$GLOBALS['TRAX_DB_SETTINGS']</span>
<div class="cmd-synopsis">Array with keys 'test', 'development' and 'production' specifying
the database connection parameters for each of the three modes of
operation.
Set in file <a href="../PHPonTrax/_data_config_environment_php.html">config/environment.php</a>
from values parsed from file database.ini.
Used when opening a connection to the database.</div></li>
<li><span class="cmd-title">$GLOBALS['TRAX_INCLUDES']</span>
<div class="cmd-synopsis">Array with keys "models", "views", "controllers",
"helpers", "layouts", "config", "environments", "lib", "app",
"log" and "vendor". Values are the subdirectories of
<span class="cmd-title">TRAX_ROOT</span> where Trax files of the
corresponding category are stored. Used to create filesystem
paths to access Trax files.
Set in file <a href="../PHPonTrax/_data_config_environment_php.html">config/environment.php</a></div></li></ul><hr /></span>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="33%" align="left" valign="top"><a href="../PHPonTrax/tutorial_troubleshoot.pkg.html">Prev</a></td>
<td width="34%" align="center" valign="top"><a href=
"../PHPonTrax/tutorial_PHPonTrax.pkg.html">Up</a></td>
<td width="33%" align="right" valign="top"><a href=
"../PHPonTrax/tutorial_ActiveRecordHelper.cls.html">Next</a></td>
</tr>
<tr>
<td width="33%" align="left" valign="top">Troubleshooting</td>
<td width="34%" align="center" valign="top">PHP On Trax</td>
<td width="33%" align="right" valign="top">ActiveRecordHelper</td>
</tr>
</table>
<div class="credit">
<hr />
Documentation generated on Thu, 04 May 2006 19:46:54 -0600 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC4</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>