Public Method Details |
module |
public string module(array $params)
|
|
Modules usually correspond to datatypes -- e.g. 'document' might be a module -- but modules can also be applications (like a calendar) that encompass more than one datatype. In order to be invoked by this method, the module must have been declared using the Modules::addModule() method. IMPORTANT CACHING NOTE: Because of the inability for output buffers (at this PHP version) to layer nicely, embedded modules may not be cached correctly. So, for the time being, avoid invoking this method in a module that was invoked via this method. (or disable caching.)
|
Parameter |
|
array |
$params |
|
|
A hash of paramters to the module. Must include
at minimum, the 'module' and 'action' params. |
|
Returns |
string result from module call (usu HTML) |
|
section |
public string section(array $params)
|
|
This is similar to the module() method, except that it allows you to load a section page within the current page ... Might currently produce unwanted results, but should also allow for future flexibility.
|
Parameter |
|
array |
$params |
|
|
A hash of paramters to the section. Must include
at minimum the 'request' (path) param. |
|
Returns |
string |
|
breadcrumb |
public string breadcrumb()
|
|
uses the breadcrumb.tpl template to handle the actual display of the breadcrumb trail. -- basic display logic is encapsulated in breadcrumb.tpl
|
Returns |
string The breadcrumb |
|
functionNav |
public string functionNav()
|
|
"Functions" are modules that have been tagged as "navigable". This is the driving reason behind the Modules::findModules() method.
|
Returns |
string navigation |
|
browseNav |
public string browseNav()
|
|
|
Returns |
string navigation |
|
buildBrowseArrays |
public string buildBrowseArrays(array $browseBy)
|
|
A sample browseBy specification is below. The key of the browseBy array is the pick table to use to get options. Note that you can ommit all the parameters and the function defaults to using the name field for name, value and weight for sorting, and the table name for the listName and first option in the list. $browseby = array( 'topics' => array ( 'nameField' => 'name', 'labelField'=> 'name', 'order' => 'weight', 'listName' => 'Topics', ), 'issues' => array (), ), );
|
Parameter |
|
array |
$browseBy |
|
|
, array of nested arrays specifying what lists to use and how. |
|
Returns |
string navigation |
|
buildBrowseArray |
public array buildBrowseArray(string $table, array $params)
|
|
|
Parameter |
|
string |
$table |
|
|
, table name |
|
|
array |
$params |
|
|
, brose by options (see above) |
|
Returns |
array |
|
pager |
public string pager(object pxdb_collection &$Records, integer $rows_per_page, integer $current_page, array $params)
|
|
|
Parameter |
|
object pxdb_collection |
&$Records |
|
|
pxdb_collection class or subclass |
|
|
|
|
|
|
array |
$params |
|
|
Hash of any additional params that should be passed in querystring. |
|
Returns |
string |
|
sidebar |
public string sidebar()
|
|
|
Returns |
string sidebar contents |
|
getContentUpdated |
public void getContentUpdated([ string $group ])
|
|
|
Parameter |
|
string |
$group |
= >>null<< |
|
The cache group to check. |
|
Returns |
void |
|
checkCache |
public void checkCache([ string $group ])
|
|
may correspond to datatype.
|
Parameter |
|
string |
$group |
= >>null<< |
|
The cache group to check. |
|
Returns |
void |
|
callModule |
public string callModule(string $module, string $action, [ array $params ])
|
|
more explicit, since every call to a module must include the module name and action name.
|
Parameter |
|
string |
$module |
|
|
The module you're calling |
|
|
string |
$action |
|
|
The action you want to call for the module |
|
|
array |
$params |
= >>null<< |
|
Associative array of arguments to pass to the module |
|
Returns |
string buffered output from the module |
|
getDetailUrl |
public void getDetailUrl(object Record $Record)
|
|
|
Parameter |
|
object Record |
$Record |
|
|
object |
|
Returns |
void |
|