Can I use the console to view API documentation?
From PHP on Trax
Yes you sure can!
First start your console
[root@bsd1 /home/phpontrax/dev/trax/script]# ./console.php
Loading Trax development environment.
>> use '?' to open the inline help
>>
Then you can use the "?" and after it (ClassName|ClassName::function_name()|ClassName::var_name)
So Say I want to see the phpDocumentor API docs for ActiveRecord's find_all function
[root@bsd1 /home/phpontrax/dev/trax/script]# ./console.php
Loading Trax development environment.
>> use '?' to open the inline help
>> ? ActiveRecord::find_all()
'/**
* Return rows selected by $conditions
*
* If no rows match, an empty array is returned.
* @param string SQL to use in the query. If
* $conditions contains "SELECT", then $order, $limit and
* $joins are ignored and the query is completely specified by
* $conditions. If $conditions is omitted or does not contain
* "SELECT", "SELECT * FROM" will be used. If $conditions is
* specified and does not contain "SELECT", the query will
* include "WHERE $conditions". If $conditions is null, the
* entire table is returned.
* @param string Argument to "ORDER BY" in query.
* If specified, the query will include
* "ORDER BY $order". If omitted, no ordering will be
* applied.
* @param integer[] Page, rows per page???
* @param string ???
* @todo Document the $limit and $joins parameters
* @uses $rows_per_page_default
* @uses $rows_per_page
* @uses $offset
* @uses $page
* @uses is_error()
* @uses $new_record
* @uses query()
* @return object[] Array of objects of the same class as this
* object, one object for each row returned by the query.
* If the column \'id\' was in the results, it is used as the key
* for that object in the array.
* @throws {@link ActiveRecordError}
*/'
>>
or what the Active Record variable $table_name is
>> ? ActiveRecord::table_name
'/**
* Table name
*
* Name of the table in the database associated with the subclass.
* Normally set to the pluralized lower case underscore form of
* the class name by the constructor. May be overridden.
* @var string
*/'
>>
or maybe I just want to see what the Main docs for ActiveRecord are
>> ? ActiveRecord
'/**
* Base class for the ActiveRecord design pattern
*
* <p>Each subclass of this class is associated with a database table
* in the Model section of the Model-View-Controller architecture.
* By convention, the name of each subclass is the CamelCase singular
* form of the table name, which is in the lower_case_underscore
* plural notation. For example,
* a table named "order_details" would be associated with a subclass
* of ActiveRecord named "OrderDetail", and a table named "people"
* would be associated with subclass "Person". See the tutorial
* {@tutorial PHPonTrax/naming.pkg}</p>
*
* <p>For a discussion of the ActiveRecord design pattern, see
* "Patterns of Enterprise
* Application Architecture" by Martin Fowler, pp. 160-164.</p>
*
* <p>Unit tester: {@link ActiveRecordTest}</p>
*
* @tutorial PHPonTrax/ActiveRecord.cls
*/'
>>
