PHP on T R A X
Rapid Application Development Made Easy

root/trunk/trax/doc/li_PHPonTrax.html

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