<html>
<head>
<title>PHP On Trax</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">Prev</td>
<td width="80%" align="center" valign="bottom"></td>
<td width="10%" align="right" valign="bottom"><a href=
"PHPonTrax/tutorial_rails_examples.pkg.html">Next</a></td>
</tr>
</table>
<div><a name=""></a><div class="ref-title-box">PHP On Trax<h1 class="ref-title">PHP On Trax</h1>
<h2 class="ref-purpose">Rapid Application Development Made Easy</h2></div>
<div class="ref-synopsis"><span class="author">Walt Haas
<div class="author-blurb"><a href="mailto:hide@address.com">hide@address.com</a></div></span></div>
<h1 align="center">Table of Contents</h1>
<ul>
<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome">Welcome To Trax!</a><br />
<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-what">What Is Trax?</a><br />
<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-who">Who Is Trax For?</a><br />
<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-platform">What Do I Need To Run Trax?</a><br />
<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-how">How Do I Install Trax?</a><br />
</ul>
<span><a name="welcome"></a><h2 class="title">Welcome To Trax!</h2><a name="welcome.welcome-what"></a><h3 class="title">What Is Trax?</h3><p>Trax is an open source software package designed to speed the
development of the type of web site that is built around a
database. Trax is a <a href="http://www.php.net">PHP</a> and
<a href="http://httpd.apache.org">Apache</a> port of
<a href="http://www.rubyonrails.org">Ruby on Rails</a>,
which is well described in the book
<a href="http://www.pragmaticprogrammer.com/title/rails">Agile Web Development with Rails</a>.</p>
<p>Trax uses the popular
<a href="http://en.wikipedia.org/wiki/Model-View-Controller">Model-View-Controller</a>
design pattern. It helps you develop web sites faster by
automating the common development steps, and by using naming
conventions instead of explicit configuration. This is done in a
way that permits you to do further customization by hand where the
standard Trax methods don't meet your needs.</p><hr />
<a name="welcome.welcome-who"></a><h3 class="title">Who Is Trax For?</h3><p>Trax is designed to be used by programmers who have a good
working knowledge of
<a href="http://en.wikipedia.org/wiki/Object-oriented_programming">object-oriented programming</a>
in general and
<a href="http://www.php.net/manual/en/language.oop5.php">PHP 5</a>
in particular; of
<a href="http://en.wikipedia.org/wiki/Relational_database_management_systems">relational database management systems</a>
and <a href="http://en.wikipedia.org/wiki/SQL">SQL</a>; and of
<a href="http://httpd.apache.org">Apache server</a> configuration.
Trax does not attempt to address the needs of unskilled users.</p><hr />
<a name="welcome.welcome-platform"></a><h3 class="title">What Do I Need To Run Trax?</h3><p>Trax requires <a href="http://www.php.net">PHP</a> 5, the
<a href="http://httpd.apache.org/">Apache web server</a> and a relational
DBMS such as <a href="http://www.mysql.com/">MySQL</a> or another DBMS
supported by the
<a href="http://pear.php.net/package/DB">PEAR DB class</a>. Apache must
be configured to allow Trax to use
<a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html">mod_rewrite</a>
and to support PHP 5 with
<a href="http://www.php.net/manual/en/security.apache.php">mod_php</a>.
PHP 5 must also be available from the command line.</p>
<p>To verify that PHP 5 is available from the command
line, type:
<pre class="example">$ <strong>php --version</strong>
PHP 5.0.4 (cli) (built: Nov 8 2005 08:27:12)
...</pre>
The version must be at least 5.0.3</p>
<p>To verify that PHP 5 is available as an Apache module,
create the one-line program below and install it somewhere in the
Apache document root:
<pre class="example"><?php phpinfo() ?></pre>
When you browse to this program, you will see a page that
describes the Apache PHP installation (if any).</p><hr />
<a name="welcome.welcome-how"></a><h3 class="title">How Do I Install Trax?</h3><p>Download the Trax
<a href="http://www.phpontrax.com/downloads/PHPonTrax-199svn.tgz">PEAR-installable package</a>
into a convenient working directory, then install it with the
command:
<pre class="example">$ <strong>pear install -o PHPonTrax-</strong><span class = "tute-comment">release</span><strong>.tgz</strong></pre>
You will probably need to run this command as the superuser. The
<strong>-o</strong> switch tells PEAR to also load any
required PEAR modules that are not already installed. The
<span class="cmd-title">pear config-show</span> command will show you where
your PEAR library is installed:
<pre class="example">$ <strong>pear config-show</strong>
CONFIGURATION:
==============
PEAR executables directory bin_dir ...
PEAR documentation directory doc_dir ...
PEAR directory php_dir ...
PEAR data directory data_dir ...
PEAR test directory test_dir ...
...</pre></p>
<p>Trax stores its documentation in
<span class = "tute-comment">doc_dir</span>/PHPonTrax/doc/ in HTML.
To read the documentation, browse to
file://<span class = "tute-comment">doc_dir</span>/PHPonTrax/doc/index.html</p>
<p>You should verify correct installation by changing to directory
<span class = "tute-comment">test_dir</span>/PHPonTrax/test/ and
running the command <span class="cmd-title">php runtests.php</span>. All
tests should complete without failure. Also verify that the
<span class="cmd-title">trax</span> command is available from the command line.</p>
<p>If PHP was installed on your system without PEAR,
<a href="http://pear.php.net/manual/en/installation.getting.php">install it</a>.</p>
<p>If you are installing Trax on a shared host where you do not
have authorization to install in the system PEAR module library,
the best approach is to build a
<a href="http://pear.php.net/manual/en/installation.shared.php">local PEAR copy</a>
and install Trax there.</p><hr /></span></div>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="33%" align="left" valign="top">Prev</td>
<td width="34%" align="center" valign="top"> </td>
<td width="33%" align="right" valign="top"><a href=
"PHPonTrax/tutorial_rails_examples.pkg.html">Next</a></td>
</tr>
<tr>
<td width="33%" align="left" valign="top"></td>
<td width="34%" align="center" valign="top"></td>
<td width="33%" align="right" valign="top">Examples From The Rails Book</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>