• Product Information
  • About
  • News
  • Screenshots
  • Video tutorials
  • Changelog
• Support Information
  • Documentation
  • Resources
  • FAQ
  • Samples
  • Support
  • Upgrade policy
  • Feature matrix
• Download
• Purchase

Download Buy

DB2 PHP Generator online Help

OnGetCustomTemplate

This event allows you to customize almost any part of the generated application using an own template instead of the default one.

Signature:

function OnGetCustomTemplate ($part, $mode, &$result, &$params)

Parameters:

PHP Generator uses Smarty 2.0 as template language. If you are not familiar with web template engines, you might want to start here.

Our Feature Demo provides a number of live examples of customized templates. We would recommend you to study them carefully before trying to customize your application.

To customize a webpage, you need to:

The simplest way to create a new template is to modify an existing one (it is much easier than create a new template "from scratch"). Use the table below to select the template corresponding to the necessary state of page and page part. Custom template files must be uploaded to the 'components/templates/custom_templates' directory. This folder should be created by the user of PHP Generator and its content is not changing during the PHP Generator sessions.

To instruct PHP Generator to use a customized template file for a certain webpage, specify the following code in the page's OnGetCustomTemplate event handler (of course you should replace YourPart and YourMode to the appropriate values from the table below).

if ($part == YourPart && $mode == YourMode) {

  $result = 'your_template_file.tpl';

}

The following table shows how to customize various pages used in the generated applications.

The following table shows how to customize user registration and password recovering pages. These parameters can be used only for the project-level version of this event.

The following table shows how to customize emails sent to users on registration and password recovering. These parameters can be used only for the project-level version of this event.

Example 1:

Suppose we need to use components/templates/custom_templates/staff_edit.tpl file as a template for the edit form of a webpage.

if ($part == PagePart::VerticalGrid && $mode == PageMode::Edit) {

  $result = 'staff_edit.tpl';

}

Now we can compare the result webpages without using this event and with the enabled one:

Example 2:

A single event handler can be used to customize multiple templates:

if ($part == PagePart::Grid && $mode == PageMode::ViewAll)

   $result = 'games_grid.tpl';

if ($part == PagePart::VerticalGrid && $mode == PageMode::Edit)

   $result = 'games_edit.tpl';  

if ($part == PagePart::RecordCard && $mode == PageMode::View)

   $result = 'games_view.tpl';

Example 3

This example shows how to fill a SELECT input with names of all MySQL databases available at the server.

1. Specify the OnGetCustomTemplate event handler as follows:

// set the template file

if ($part == PagePart::Grid && $mode == PageMode::ViewAll) {

    $result = 'custom_grid.tpl';

//  get the list of available databases

    $queryResult = array();

    $this->GetConnection()->ExecQueryToArray('SHOW DATABASES', $queryResult);

//  fill a one-dimensional array with database names

    $databaseNames = array();

    foreach($queryResult as $row)

        $databaseNames[] = $row[0];

//  assign the parameter in the template

    $params['databaseNames'] = $databaseNames;

}

2. Add the following code to the template file:

<select name="database">

    {foreach from=$databaseNames item=database}

        <option value="{$database}">{$database}</option>

    {/foreach}

</select>

The screen below demonstrates the result output.

Example 4

This example shows the use of the superglobal $_GET array values in a custom template.

1. Specify the OnGetCustomTemplate event handler as follows:

if ($part == PagePart::Grid && $mode == PageMode::ViewAll) {

    $result = 'custom_grid.tpl';

    // check if the parameter custom_var available

    if (GetApplication()->IsGETValueSet('custom_var'))

      // found

      $params['custom_var'] = GetApplication()->GetGETValue('custom_var');

    else

      // not found. Assign a default value.   

      $params['custom_var'] = '5 (default)';

}

2. Add the following code to the template file:

<div>

<h4>I am a custom template with a custom variable $custom_var. Its value

  {if !isset($custom_var)}

    still undefined

  {else}

    = {$custom_var}

  {/if}.

</h4>

</div>

Example 4

Let's see the login form customization used in our NBA online demo.

1. Specify the OnGetCustomTemplate event handler as follows:

if ($part == PagePart::LoginPage) {

    $result = 'login_page.tpl';

}

2. Add the following code to the template file:

<h2>Logins</h2>

<table class="table table-bordered">

  <thead>

    <tr>

         <th>Username</th>

         <th>Password</th>

         <th>Description</th>

    </tr>

  </thead>

  <tbody>

    <tr>

         <td>admin</td>

         <td>admin</td>

         <td>Can modify any record at any page and manage other users.</td>

    </tr>

    <tr>

         <td>lakers</td>

         <td>lakers</td>

         <td>Can modify team info, home games and players for LA Lakers.</td>

    </tr>

    <tr>

         <td>boston</td>

         <td>boston</td>

         <td>The same for the Boston Celtics team.</td>

    </tr>

    <tr>

         <td>game_manager</td>

         <td>game</td>

         <td>Can access only game list. Can modify any game.</td>

    </tr>

  </tbody>

</table>

Example 5

The example below is used in our NBA demo application to customize the template used to export a single record to PDF.

if ($part == PagePart::RecordCard && $mode == PageMode::ExportPdf) {

    $result = 'game_pdf.tpl';

}

Live example can be found here.