root/trunk/trax/doc/li_PHPonTrax.html

Revision 199, 18.8 KB (checked in by haas, 6 years ago)

many fixes, documentation improvements
Line 
1<html>
2<head>
3<title>PHP On Trax</title>
4<link rel="stylesheet" type="text/css" href="media/style.css">
5</head>
6<body>
7
8<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
9  <tr>
10    <td class="header_top">PHPonTrax</td>
11  </tr>
12  <tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
13  <tr>
14    <td class="header_menu">
15          [ <a href="classtrees_PHPonTrax.html" class="menu">class tree: PHPonTrax</a> ]
16          [ <a href="elementindex_PHPonTrax.html" class="menu">index: PHPonTrax</a> ]
17          [ <a href="elementindex.html" class="menu">all elements</a> ]
18    </td>
19  </tr>
20  <tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
21</table>
22
23<table width="100%" border="0" cellpadding="0" cellspacing="0">
24  <tr valign="top">
25    <td width="200" class="menu">
26    <div id="todolist">
27            <p><a href="todolist.html">Todo List</a></p>
28    </div>
29      <b>Packages:</b><br />
30              <a href="li_PHPonTrax.html">PHPonTrax</a><br />
31              <a href="li_PHPonTraxTest.html">PHPonTraxTest</a><br />
32            <br /><br />
33        <b>Tutorials/Manuals:</b><br />
34                    <strong>Package-level:</strong>
35                            <ul>
36    <li type="square"><a href="PHPonTrax/tutorial_PHPonTrax.pkg.html">PHP On Trax</a>
37<ul>
38    <li type="square"><a href="PHPonTrax/tutorial_rails_examples.pkg.html">Examples From The Rails Book</a>
39</ul>
40
41<ul>
42    <li type="square"><a href="PHPonTrax/tutorial_simpleapp.pkg.html">Build A Simple Trax Application</a>
43</ul>
44
45<ul>
46    <li type="square"><a href="PHPonTrax/tutorial_database.pkg.html">Create A Database and User</a>
47</ul>
48
49<ul>
50    <li type="square"><a href="PHPonTrax/tutorial_advbuild.pkg.html">Advanced Application Build Topics</a>
51</ul>
52
53<ul>
54    <li type="square"><a href="PHPonTrax/tutorial_naming.pkg.html">The Trax Naming Convention</a>
55</ul>
56
57<ul>
58    <li type="square"><a href="PHPonTrax/tutorial_troubleshoot.pkg.html">Troubleshooting</a>
59</ul>
60
61<ul>
62    <li type="square"><a href="PHPonTrax/tutorial_reference.pkg.html">Reference</a>
63</ul>
64
65</li></ul>
66
67
68                                        <strong>Class-level:</strong>
69                            <ul>
70    <li type="square"><a href="PHPonTrax/tutorial_ActiveRecordHelper.cls.html">ActiveRecordHelper</a>
71</ul>
72
73
74                            <ul>
75    <li type="square"><a href="PHPonTrax/tutorial_FormTagHelper.cls.html">FormTagHelper</a>
76</ul>
77
78
79                            <ul>
80    <li type="square"><a href="PHPonTrax/tutorial_Helpers.cls.html">Helpers</a>
81</ul>
82
83
84                            <ul>
85    <li type="square"><a href="PHPonTrax/tutorial_UrlHelper.cls.html">UrlHelper</a>
86</ul>
87
88
89                            <ul>
90    <li type="square"><a href="PHPonTrax/tutorial_FormHelper.cls.html">FormHelper</a>
91</ul>
92
93
94                            <ul>
95    <li type="square"><a href="PHPonTrax/tutorial_InputFilter.cls.html">InputFilter</a>
96</ul>
97
98
99                            <ul>
100    <li type="square"><a href="PHPonTrax/tutorial_ActionMailer.cls.html">ActionMailer</a>
101</ul>
102
103
104                            <ul>
105    <li type="square"><a href="PHPonTrax/tutorial_ApplicationController.cls.html">ApplicationController</a>
106</ul>
107
108
109                            <ul>
110    <li type="square"><a href="PHPonTrax/tutorial_ActionController.cls.html">ActionController</a>
111</ul>
112
113
114                            <ul>
115    <li type="square"><a href="PHPonTrax/tutorial_ActiveRecord.cls.html">ActiveRecord</a>
116</ul>
117
118
119                            <ul>
120    <li type="square"><a href="PHPonTrax/tutorial_DateHelper.cls.html">DateHelper</a>
121</ul>
122
123
124                            <ul>
125    <li type="square"><a href="PHPonTrax/tutorial_Router.cls.html">Router</a>
126</ul>
127
128
129                            <ul>
130    <li type="square"><a href="PHPonTrax/tutorial_FormOptionsHelper.cls.html">FormOptionsHelper</a>
131</ul>
132
133
134                            <ul>
135    <li type="square"><a href="PHPonTrax/tutorial_TraxGenerator.cls.html">TraxGenerator</a>
136</ul>
137
138
139                            <ul>
140    <li type="square"><a href="PHPonTrax/tutorial_Session.cls.html">Session</a>
141</ul>
142
143
144                            <ul>
145    <li type="square"><a href="PHPonTrax/tutorial_Inflector.cls.html">Inflector</a>
146</ul>
147
148
149                            <ul>
150    <li type="square"><a href="PHPonTrax/tutorial_ActiveRecordError.cls.html">ActiveRecordError</a>
151</ul>
152
153
154                            <ul>
155    <li type="square"><a href="PHPonTrax/tutorial_ActionControllerError.cls.html">ActionControllerError</a>
156</ul>
157
158
159                            <ul>
160    <li type="square"><a href="PHPonTrax/tutorial_ScaffoldController.cls.html">ScaffoldController</a>
161</ul>
162
163
164                            <ul>
165    <li type="square"><a href="PHPonTrax/tutorial_Dispatcher.cls.html">Dispatcher</a>
166</ul>
167
168
169                            <ul>
170    <li type="square"><a href="PHPonTrax/tutorial_TraxError.cls.html">TraxError</a>
171</ul>
172
173
174                            <ul>
175    <li type="square"><a href="PHPonTrax/tutorial_ApplicationMailer.cls.html">ApplicationMailer</a>
176</ul>
177
178
179                                                    <b>Files:</b><br />
180          <div class="package">
181            <a href="PHPonTrax/_vendor_trax_action_controller_php.html">        action_controller.php
182        </a><br>
183            <a href="PHPonTrax/_vendor_trax_action_mailer_php.html">        action_mailer.php
184        </a><br>
185            <a href="PHPonTrax/_vendor_trax_action_view_php.html">      action_view.php
186        </a><br>
187            <a href="PHPonTrax/_vendor_trax_active_record_php.html">        active_record.php
188        </a><br>
189            <a href="PHPonTrax/_vendor_trax_action_view_helpers_active_record_helper_php.html">     active_record_helper.php
190        </a><br>
191            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_add_phtml.html">        add.phtml
192        </a><br>
193            <a href="PHPonTrax/_data_app_controllers_application_php.html">     application.php
194        </a><br>
195            <a href="PHPonTrax/_data_app_views_layouts_application_phtml.html">     application.phtml
196        </a><br>
197            <a href="PHPonTrax/_data_app_helpers_application_helper_php.html">      application_helper.php
198        </a><br>
199            <a href="PHPonTrax/_data_app_application_mailer_php.html">      application_mailer.php
200        </a><br>
201            <a href="PHPonTrax/_vendor_trax_action_view_helpers_asset_tag_helper_php.html">     asset_tag_helper.php
202        </a><br>
203            <a href="PHPonTrax/_test_layouts_catalog_phtml.html">       catalog.phtml
204        </a><br>
205            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_controller_php.html">       controller.php
206        </a><br>
207            <a href="PHPonTrax/_vendor_trax_templates_controller_php.html">     controller.php
208        </a><br>
209            <a href="PHPonTrax/_vendor_trax_action_view_helpers_date_helper_php.html">      date_helper.php
210        </a><br>
211            <a href="PHPonTrax/_data_config_environments_development_php.html">     development.php
212        </a><br>
213            <a href="PHPonTrax/_data_public_dispatch_php.html">     dispatch.php
214        </a><br>
215            <a href="PHPonTrax/_vendor_trax_dispatcher_php.html">       dispatcher.php
216        </a><br>
217            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_edit_phtml.html">       edit.phtml
218        </a><br>
219            <a href="PHPonTrax/_data_config_environment_php.html">      environment.php
220        </a><br>
221            <a href="PHPonTrax/_vendor_trax_templates_error_phtml.html">        error.phtml
222        </a><br>
223            <a href="PHPonTrax/_vendor_trax_action_view_helpers_form_helper_php.html">      form_helper.php
224        </a><br>
225            <a href="PHPonTrax/_vendor_trax_action_view_helpers_form_options_helper_php.html">      form_options_helper.php
226        </a><br>
227            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_form_scaffolding_phtml.html">       form_scaffolding.phtml
228        </a><br>
229            <a href="PHPonTrax/_vendor_trax_action_view_helpers_form_tag_helper_php.html">      form_tag_helper.php
230        </a><br>
231            <a href="PHPonTrax/_data_script_generate_php.html">     generate.php
232        </a><br>
233            <a href="PHPonTrax/_vendor_trax_templates_helper_php.html">     helper.php
234        </a><br>
235            <a href="PHPonTrax/_vendor_trax_action_view_helpers_php.html">      helpers.php
236        </a><br>
237            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_index_phtml.html">      index.phtml
238        </a><br>
239            <a href="PHPonTrax/_vendor_trax_inflector_php.html">        inflector.php
240        </a><br>
241            <a href="PHPonTrax/_vendor_trax_input_filter_php.html">     input_filter.php
242        </a><br>
243            <a href="PHPonTrax/_vendor_trax_action_view_helpers_javascript_helper_php.html">        javascript_helper.php
244        </a><br>
245            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_layout_phtml.html">     layout.phtml
246        </a><br>
247            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_layout_phtml.html">     layout.phtml
248        </a><br>
249            <a href="PHPonTrax/_makepkg_php.html">      makepkg.php
250        </a><br>
251            <a href="PHPonTrax/_vendor_trax_templates_model_php.html">      model.php
252        </a><br>
253            <a href="PHPonTrax/_data_config_environments_production_php.html">      production.php
254        </a><br>
255            <a href="PHPonTrax/_vendor_trax_router_php.html">       router.php
256        </a><br>
257            <a href="PHPonTrax/_data_config_routes_php.html">       routes.php
258        </a><br>
259            <a href="PHPonTrax/_vendor_trax_scaffold_controller_php.html">      scaffold_controller.php
260        </a><br>
261            <a href="PHPonTrax/_vendor_trax_session_php.html">      session.php
262        </a><br>
263            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_show_phtml.html">       show.phtml
264        </a><br>
265            <a href="PHPonTrax/_data_config_environments_test_php.html">        test.php
266        </a><br>
267            <a href="PHPonTrax/_trax_php.html">     trax.php
268        </a><br>
269            <a href="PHPonTrax/_vendor_trax_trax_exceptions_php.html">      trax_exceptions.php
270        </a><br>
271            <a href="PHPonTrax/_vendor_trax_trax_generator_php.html">       trax_generator.php
272        </a><br>
273            <a href="PHPonTrax/_vendor_trax_action_view_helpers_url_helper_php.html">       url_helper.php
274        </a><br>
275            <a href="PHPonTrax/_vendor_trax_templates_view_phtml.html">     view.phtml
276        </a><br>
277            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_add_phtml.html">       view_add.phtml
278        </a><br>
279            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_edit_phtml.html">      view_edit.phtml
280        </a><br>
281            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_index_phtml.html">     view_index.phtml
282        </a><br>
283            <a href="PHPonTrax/_vendor_trax_templates_scaffolds_generator_templates_view_show_phtml.html">      view_show.phtml
284        </a><br>
285      </div><br />
286
287     
288            <b>Classes:</b><br />
289        <div class="package">
290                    <a href="PHPonTrax/.html"></a><br />
291                <a href="PHPonTrax/ActionController.html">ActionController</a><br />
292                <a href="PHPonTrax/ActionControllerError.html">ActionControllerError</a><br />
293                <a href="PHPonTrax/ActionMailer.html">ActionMailer</a><br />
294                <a href="PHPonTrax/ActiveRecord.html">ActiveRecord</a><br />
295                <a href="PHPonTrax/ActiveRecordError.html">ActiveRecordError</a><br />
296                <a href="PHPonTrax/ActiveRecordHelper.html">ActiveRecordHelper</a><br />
297                <a href="PHPonTrax/ApplicationController.html">ApplicationController</a><br />
298                <a href="PHPonTrax/ApplicationMailer.html">ApplicationMailer</a><br />
299                <a href="PHPonTrax/AssetTagHelper.html">AssetTagHelper</a><br />
300                <a href="PHPonTrax/DateHelper.html">DateHelper</a><br />
301                <a href="PHPonTrax/Dispatcher.html">Dispatcher</a><br />
302                <a href="PHPonTrax/FormHelper.html">FormHelper</a><br />
303                <a href="PHPonTrax/FormOptionsHelper.html">FormOptionsHelper</a><br />
304                <a href="PHPonTrax/FormTagHelper.html">FormTagHelper</a><br />
305                <a href="PHPonTrax/Helpers.html">Helpers</a><br />
306                <a href="PHPonTrax/Inflector.html">Inflector</a><br />
307                <a href="PHPonTrax/InputFilter.html">InputFilter</a><br />
308                <a href="PHPonTrax/JavaScriptHelper.html">JavaScriptHelper</a><br />
309                <a href="PHPonTrax/Router.html">Router</a><br />
310                <a href="PHPonTrax/ScaffoldController.html">ScaffoldController</a><br />
311                <a href="PHPonTrax/Session.html">Session</a><br />
312                <a href="PHPonTrax/TraxError.html">TraxError</a><br />
313                <a href="PHPonTrax/TraxGenerator.html">TraxGenerator</a><br />
314                <a href="PHPonTrax/UrlHelper.html">UrlHelper</a><br />
315      </div>
316
317                </td>
318    <td>
319      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
320
321<table width="100%" border="0" cellpadding="0" cellspacing="0">
322<tr>
323<td width="10%" align="left" valign="bottom">Prev</td>
324<td width="80%" align="center" valign="bottom"></td>
325<td width="10%" align="right" valign="bottom"><a href=
326"PHPonTrax/tutorial_rails_examples.pkg.html">Next</a></td>
327</tr>
328</table>
329<div><a name=""></a><div class="ref-title-box">PHP On Trax<h1 class="ref-title">PHP On Trax</h1>
330  <h2 class="ref-purpose">Rapid Application Development Made Easy</h2></div>
331 <div class="ref-synopsis"><span class="author">Walt Haas
332   <div class="author-blurb"><a href="mailto:haas@xmission.com">haas@xmission.com</a></div></span></div>
333 <h1 align="center">Table of Contents</h1>
334<ul>
335
336<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome">Welcome To Trax!</a><br />
337
338&nbsp;&nbsp;&nbsp;<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-what">What Is Trax?</a><br />
339
340&nbsp;&nbsp;&nbsp;<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-who">Who Is Trax For?</a><br />
341
342&nbsp;&nbsp;&nbsp;<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-platform">What Do I Need To Run Trax?</a><br />
343
344&nbsp;&nbsp;&nbsp;<a href="PHPonTrax/tutorial_PHPonTrax.pkg.html#welcome.welcome-how">How Do I Install Trax?</a><br />
345</ul>
346
347 <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
348    development of the type of web site that is built around a
349    database.  Trax is a <a href="http://www.php.net">PHP</a> and
350    <a href="http://httpd.apache.org">Apache</a> port of
351    <a href="http://www.rubyonrails.org">Ruby on Rails</a>,
352    which is well described in the book
353    <a href="http://www.pragmaticprogrammer.com/title/rails">Agile Web Development with Rails</a>.</p>
354   <p>Trax uses the popular
355    <a href="http://en.wikipedia.org/wiki/Model-View-Controller">Model-View-Controller</a>
356    design pattern.  It helps you develop web sites faster by
357    automating the common development steps, and by using naming
358    conventions instead of explicit configuration.  This is done in a
359    way that permits you to do further customization by hand where the
360    standard Trax methods don't meet your needs.</p><hr />
361  <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
362     working knowledge of
363     <a href="http://en.wikipedia.org/wiki/Object-oriented_programming">object-oriented programming</a>
364     in general and
365     <a href="http://www.php.net/manual/en/language.oop5.php">PHP 5</a>
366     in particular; of
367     <a href="http://en.wikipedia.org/wiki/Relational_database_management_systems">relational database management systems</a>
368     and <a href="http://en.wikipedia.org/wiki/SQL">SQL</a>; and of
369     <a href="http://httpd.apache.org">Apache server</a> configuration.
370     Trax does not attempt to address the needs of unskilled users.</p><hr />
371  <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
372    <a href="http://httpd.apache.org/">Apache web server</a> and a relational
373    DBMS such as <a href="http://www.mysql.com/">MySQL</a> or another DBMS
374    supported by the
375    <a href="http://pear.php.net/package/DB">PEAR DB class</a>.  Apache must
376    be configured to allow Trax to use
377    <a href="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html">mod_rewrite</a>
378    and to support PHP 5 with
379    <a href="http://www.php.net/manual/en/security.apache.php">mod_php</a>.
380    PHP 5 must also be available from the command line.</p>
381
382    <p>To verify that PHP 5 is available from the command
383     line, type:
384     <pre class="example">$ <strong>php --version</strong>
385PHP 5.0.4 (cli) (built: Nov  8 2005 08:27:12)
386...</pre>
387    The version must be at least 5.0.3</p>
388
389    <p>To verify that PHP 5 is available as an Apache module,
390     create the one-line program below and install it somewhere in the
391     Apache document root:
392     <pre class="example">&lt;?php phpinfo() ?&gt;</pre>
393     When you browse to this program, you will see a page that
394     describes the Apache PHP installation (if any).</p><hr />
395  <a name="welcome.welcome-how"></a><h3 class="title">How Do I Install Trax?</h3><p>Download the Trax
396    <a href="http://www.phpontrax.com/downloads/PHPonTrax-199svn.tgz">PEAR-installable package</a>
397    into a convenient working directory, then install it with the
398    command:
399     <pre class="example">$ <strong>pear install -o PHPonTrax-</strong><span class = "tute-comment">release</span><strong>.tgz</strong></pre>
400    You will probably need to run this command as the superuser.  The
401    <strong>-o</strong> switch tells PEAR to also load any
402    required PEAR modules that are not already installed.  The
403    <span class="cmd-title">pear config-show</span> command will show you where
404    your PEAR library is installed:
405     <pre class="example">$ <strong>pear config-show</strong>
406CONFIGURATION:
407==============
408PEAR executables directory     bin_dir   ...
409PEAR documentation directory   doc_dir   ...
410PEAR directory                 php_dir   ...
411PEAR data directory            data_dir  ...
412PEAR test directory            test_dir  ...
413...</pre></p>
414    <p>Trax stores its documentation in
415     <span class = "tute-comment">doc_dir</span>/PHPonTrax/doc/ in HTML.
416     To read the documentation, browse to
417     file://<span class = "tute-comment">doc_dir</span>/PHPonTrax/doc/index.html</p>
418
419   <p>You should verify correct installation by changing to directory
420    <span class = "tute-comment">test_dir</span>/PHPonTrax/test/ and
421    running the command <span class="cmd-title">php runtests.php</span>.  All
422    tests should complete without failure.  Also verify that the
423    <span class="cmd-title">trax</span> command is available from the command line.</p>
424
425   <p>If PHP was installed on your system without PEAR,
426    <a href="http://pear.php.net/manual/en/installation.getting.php">install it</a>.</p>
427
428   <p>If you are installing Trax on a shared host where you do not
429    have authorization to install in the system PEAR module library,
430    the best approach is to build a
431    <a href="http://pear.php.net/manual/en/installation.shared.php">local PEAR copy</a>
432    and install Trax there.</p><hr /></span></div>
433<table width="100%" border="0" cellpadding="0" cellspacing="0">
434<tr>
435<td width="33%" align="left" valign="top">Prev</td>
436<td width="34%" align="center" valign="top">&nbsp;</td>
437<td width="33%" align="right" valign="top"><a href=
438"PHPonTrax/tutorial_rails_examples.pkg.html">Next</a></td>
439</tr>
440
441<tr>
442<td width="33%" align="left" valign="top"></td>
443<td width="34%" align="center" valign="top"></td>
444<td width="33%" align="right" valign="top">Examples From The Rails Book</td>
445</tr>
446</table>
447        <div class="credit">
448            <hr />
449            Documentation generated on Thu, 04 May 2006 19:46:54 -0600 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC4</a>
450          </div>
451      </td></tr></table>
452    </td>
453  </tr>
454</table>
455
456</body>
457</html>
Note: See TracBrowser for help on using the browser.