This plug-in enables the MergeBlock() method to display only a part of the records, instead of all records. Displayed records are those corresponding to a page number, like if the record set was split by pages having the same size.

Note: when you call the plug-in command, it activates the ByPage mode only for one MergeBlock() call. Other MergBlock() calls won't have the ByPage mode until you call the plug-in just before them.

Important remark: In most of cases, the ByPage mode costs as much process time as for the normal mode with the same query. This is explained in the chapter "how the ByPage plug-in works?" above.

Requirement: include the file 'tbs_plugin_bypage.php'. This can be after the TBS object variable is created.

Installation mode: automatic when the plug-in command is called for the first time.

Command syntax: $TBS->PlugIn(TBS_BYPAGE, int PageSize, int PageNum {, int RecCount})

Example:

include_once('tbs_plugin_bypage.php');
$TBS->PlugIn(TBS_BYPAGE, 20, 3);
$TBS->MergeBlock('b1','mysql','SELECT * FROM t_mytable ORDER BY id');

How the ByPage plug-in works ?

It's important to notice that this plug-in won't makes the query to run faster. Because all database systems don't have a LIMIT clause for SELECT queries, and because all queries are not SELECT queries then the plug-in must let the query as is without inserting any LIMIT clause by itself. Thus, the ByPage plug-in just sends the query, reads all records in order, starts to display records when the beginning of the page is reached, and stops to read and display when the end of the page is reached.

That's why the ByPage plug-in is not convenient to display a page among a large number of records. It's better to use the LIMIT clause of your database system instead (or other native clause for limiting data).

How to use argument RecCount ?

You should use RecCount if you need the MergeBlock() method to return the real total number of record (this can be useful when you need to display the page of data noticing the total number of records). In the normal mode, the MergeBlock() method return the total number of records, but in the ByPage mode, it return the number of the last read record, this can be different. But RecCount enables MergBlock() to whether makes a real count or to trust your value.

Value of argument RecCount:

Example :

if (isset($_GET['nbrtot']) {
  $RecCount = $_GET['nbrtot'];  // MergeBlock() will trus this value.
} else {
  $RecCount = -1; // Will Force MergeBlock() to count all records.
}
include_once('tbs_plugin_bypage.php');
$TBS->PlugIn(TBS_BYPAGE, 20, 3, $RecCount);
$nbrtot = $TBS->MergeBlock('b1', 'mysql', 'SELECT * FROM t_mytable ORDER BY id');

This plug-in provides several actions for a Cache System. The Cache System enables you to manage manually or automatically the backup of the merge result into a temporary file called "cache" file.

Requirement: include the file 'tbs_plugin_cache.php'. This can be after the TBS object variable is created.

Installation mode: automatic when the plug-in command is called for the first time.

You can aslo install the plug-in manually in order to specify the default directory and the cache mask. See Setting Cache System parameters for more details.

Command syntax: bool $TBS->PlugIn(TBS_CACHE, string CacheId {, int Action/MaxAge}{, string Dir})

The function returns true or false depending to the success or failure of the action.

Example :

include_once('tbs_plugin_cache.php');
$TBS->PlugIn(TBS_CACHE, 'mainpage', 3600);  

Manage a cache file:

The Cache System enables you to create, load, update or delete a cache file identified by CacheId. There is also an Automatic Mode that let the System manage those actions depending to a max-age of the cache file.

Cache on Show:

If you start the "Cache on Show", then the result of the merge will be automatically saved in the cache file at the first use of the TBS Show() method. The recording takes place after the display of the result.

Please note that by default the Show() method causes the end of the script. If you want to continue some treatments after the "Cache on Show", then you have to set the TBS Render property in order to avoid the end of the script.

Here is the list of possible actions for the Action/MaxAge argument, it can be a constant of the plug-in or a positive numerical value.

$TBS->PlugIn(TBS_CACHE,$CacheId,TBS_CACHEDELETE);
$TBS->PlugIn(TBS_CACHE,'*',TBS_CACHEDELETE);

Setting Cache Sytem parameters:

By installing the plug-in manually, you can set the default directory and the names of cache files. Take care that you must install the plug-in before to use its command. Installing the plug-in after having called the command will produce an error.

Install syntax: $TBS->PlugIn(TBS_INSTALL, TBS_CACHE {, string Dir}{, string Mask})

Example :

include_once('tbs_plugin_cache.php');
$TBS->PlugIn(TBS_INSTALL, TBS_CACHE, './cache', 'cache_*.tmp');
$TBS->PlugIn(TBS_CACHE, 'mainpage', 3600);

This plug-in enables you to displays a navigation bar based on specific TBS block and TBS fields.The design of the navigation bar must be prepared in the HTML side using TBS block havins some specifications. See HTML side for more details.

Requirement: include the file 'tbs_plugin_navbar.php'. This can be after the TBS object variable is created.

Installation mode: automatic when the plug-in command is called for the first time.

Command syntax: $TBS->PlugIn(TBS_NAVBAR,string NavName, mix Options, int PageNum [, int RecCount, int PageSize])

Example:

$TBS->PlugIn(TBS_NAVBAR,'nav','',$page,$rec_nbr,$page_size);

HTML side

Use a normal TBS block to display the page numbers.

This block will be merged with a virtual data source having as much records as pages to display, and with the following columns:

page is the only value that changes and its linked field must be placed inside the block. Others columns have always the same value and can be placed inside the block as well as outside the block.

Those fields support the parameter endpoint. It will replace the value of the field with an empty string ('') when the active page is equal to first page or last page. This enables you to manage display exceptions with parameter magnet for example.

The block can contain a special section to display the active page differently.

This section is defined using parameter currpage on the block definition.

You can use parameter bmagnet (which is a block's parameter supported by TBS) to delete the navigation bar when there is only one page to display.

Options

The block definition can contain parameters that are specific to the navigation bar.

Those options can also be defined as a parameter of the plug-in's command.

This plug-in provides several features to manage HTML templates:

• Select HTML items (lists, checkboxes and radio buttons).

• Looks if contents is HTML before to convert.

Those features can be called from any TBS field using parameter "ope=html". See below for more details.

The plug-in must be installed, otherwise you'll have a TBS error: "parameter ope doesn't support value 'html'".

Requirement: include the file 'tbs_plugin_html.php'.

Installation mode: automatic when included before the creation of the TBS variable.

If you include it after the creation of the TBS varibale, you should force the installation by using the command :

Command syntax:  (no command).

Select HTML items:

Create a new item anywhere in the list. Inside this item, place a TBS field which would display the value of the item to select (you can place it anywhere inside the option tags). Then add parameters ope=html and select (without value) to the TBS field and it will select the corresponding item. This new item won't be displayed, il will only make other be selected.

If the value of the field is a PHP array, then several items can be selected.

If the value of the field is not found in the list, then no item is selected. But if you add parameter addmising then not found values will be added at the end of the list. Parameter addmissing is supported since version 1.0.3 of this plug-in.

Place a TBS field which would display the value of the item to select (you can place it anywhere in the area containing items to select, see optimization below for more details about this area). Then add parameters ope=html and select=tagname to the TBS field and it will select the corresponding item. Only radio buttons and checkboxes named tagname will be browsed. The TBS field won't be displayed, il will only make items be selected.

If the value of the field is a PHP array, then several items can be selected.

Optimization:

By default the bounds for searching items to select are html tags <select> for lists , and <form> for radio buttons and checkboxes. But you can change those bounds using parameter selbounds. It enables you to change the search zone for items to select by indicating an HTML tag type.

Example:

Look if contents is HTML :

Use a TBS field with parameter ope=html and parameter look in order to check the value to merge and to convert it into HTML only if is not yet HTML.

Example:

This plug-in enables the MergeBlock() method to display data on fly. This means that the result of the merge will be displayed progressively during the execution of MergeBlock(). At the end of the MergeBlock(), only the part of the template after the block will remain. You steel have to use the Show() method for this ending part.

Notice: when you call the plug-in command, it activates the OnFly mode only for one MergeBlock() call. Other MergBlock() calls won't have the OnFly mode until you call the plug-in just before them.

You have to take care that the OnFly mode will cost much more time execution, because several small echo() commands always cost more time than a single big one. Despite this loss of execution time, the OnFly mode can be a smart issue when you have a very large number of records to display because the user can start the read the data before it ends.

Requirement: include the file 'tbs_plugin_mergeonfly.php'. This can be after the TBS object variable is created.

Installation mode: automatic when the plug-in command is called for the first time.

Command syntax: $TBS->PlugIn(TBS_ONFLY, int PackSize [, boolean CountSubRecord=false])

Example :

include_once('tbs_plugin_mergeonfly.php');
$TBS->PlugIn(TBS_ONFLY, 100);
$TBS->MergeBlock('b1','mysql','SELECT * FROM t_table1');