Table Setup

Note For simplicity, we use "table" in the following description to refer to any of database object in the project. A database object can be either a table, a view, a Custom View, a report or a Linked Table.

After loading the database, the tables will be shown in the database pane on the left pane. To access ALL setting for a table (including Multi-page, Table-specific Options and Master/Detail), click the table node of any table in the database pane and then click the [Table] tab to go to the Table Setup page. This is the setup page for a single table.

screen shot

You can also click on the [Tables] or [Views] or [Custom Views] or [Reports] or [Linked Tables] node in the database pane to go to the Tables Setup page which is a grid showing the most frequently used settings for all tables. If you need to set these settings for multiple tables, this page allow you to view and set them quickly. Note that this page does not include Multi-page, Table-specific Options and Master/Detail.

screen shot

Notes

For all checkbox or combobox columns, if you want to apply the setting to ALL tables or views, you can choose your setting at the [Tables] or [Views] or [Custom Views] or [Reports] or [Linked Tables] row.
View/Edit/Search functionality works at field level and can be setup for each field in the Field Level Setup page. Please refer to the Field Setup for details. If all fields are not selected for View/Edit/Search, the function will not be generated.

If you prefer to view the tables in alphabetical order, click [Tools]->[Sort Tables Alphabetically] (see Tools).

You can still change the display order of the menu item by drag-and-drop. Select a table by clicking the first column - [Table/View Name] column, then drag and drop to where you want. Note that a table cannot be moved out of its parent node.

Note that changing the display order of table in this Table Setup page does not change the display order of the tables in the menu. To change the display order of the menu item, click [Tools]->[Menu Editor] (see Tools).

Important

It is assumed that all tables have primary key. (Composite key is supported) If there is no primary key specified, View/Add/Copy/Delete/Edit/Update settings have no effect and will be reset to disabled when the [Generate] button is pressed. Only the List page can be generated. If you add back a primary key later, you'll need to come back to this page and re-enable them. Since reports are read-only, View/Add/Copy/Delete/Edit/Update settings are not applicable to reports.
Views or Custom Views involving more than one table are usually NOT updatable. Although you can force PHPMaker to enable the Add/Copy/Delete/Edit/Update pages by specifying a primary key, the generated pages will not work if these views or Custom Views cannot be updated like regular tables.

The available table level settings are as follows:

General

Generate	Select/unselect a particular table for generation
Caption	To change the caption of a table, click on [Caption] box to make the necessary change. Note If you use Multi-Language (see PHP Settings), use Multi-Language Property Editor, see Tools for details.
Filter	Specify a filter (WHERE clause) for the table. Click the [...] button in [Filter] column, the Filter Editor will popup. Enter your filter, you can drag the field names from the left pane to the editor, the SQL identifier quote characters will also be added for you automatically. Note The filter must be a valid PHP expression and it will be concatenated to the SQL. If it is a string, it should be double quoted.
Sort	Specify the sort fields (ORDER BY clause) for the table. Click the [...] button in [Sort] column, the following dialog box will popup. You can choose up to 6 fields, in either ascending or descending order.
Output folder	For use with Custom File only. The output folder is relative to application root.
Include custom files	For use with Custom File and for PHP file only. Include common files such as header and footer so the custom file will have the same layout .
Default	Set a Table as the Default Table. The Default table is the first table the user see when visiting your site. Select the table you want in the [Default] column.

List

Inline Add	Enable/disable Inline Add function for the table. Inline Add allows users to add a record within the List page. Default is disabled.
Inline Copy	Enable/disable Inline Copy function for the table. Inline Copy allows users to copy a record within the List page. Default is disabled.
Inline Edit	Enable/disable Inline Edit function for the table. Inline Edit allows users to edit a record within the List page. Default is disabled.
Grid Add	Enable/disable Grid-Add function for table. Allows users to add multiple records to the table. Default is disabled.
Grid Edit	Enable/disable Grid-Edit function for table. Grid-Edit allows users to edit multiple records within the List page. Default is disabled.
Import	Enable/disable Import function for table. The Import feature enables you to import records from an external Excel/CSV file to database table. Default is disabled. Read Import Data for more information.
Requires Search Criteria	Specifies if the List page requires search criteria. Default is disabled. Notes If enabled, the List page always requires search criteria. When the page is initially loaded, no records will be displayed until searching is done. (Remember to enable Quick Search, including Extended Quick Search, or Advanced Search or both. See below.) If a record is added but the new record does not meet the search criteria (or there is no search criteria yet), the record will not appear in the List page. So this option is best for tables which are for browsing only.
Sequence number	Add a column to show the sequence number (record index) of the record in the recordset.
Detail Add	Enable/disable Master/Detail-Add function for table (as detail table). Allows users to add multiple records to the detail table in the Add page of the master table. Default is disabled.
Detail Edit	Enable/disable Master/Detail-Edit function for table (as detail table). Allows users to edit multiple records of the detail table in the Edit page of the master table. Default is disabled.
Detail View	Enable/disable Master/Detail-View function for table (as detail table). Allows users to view multiple detail records in the View page of the master table. Default is disabled.
Multiple Detail Tables	Enable/disable multiple Detail Add/Edit/View. By default each pair of Master/Detail tables are handled separately, meaning that in a page, there are one master table (the current table) and one of its detail tables only. If this option is enabled, all detail tables will be displayed together in the same page. Enabling this option will hide separate Master/Detail table pairs.
Detail Record Count	Specifies if the number of detail records for the master record should be displayed. Default is disabled. Note Applicable to master tables with master/detail relationships defined in PHPMaker only, see below. If the detail table is a report, this feature is NOT applicable, there will be NO detail record counts for the detail report. The counts are retrieved by using a subquery for each detail table. The more detail tables, the more performance penalty. You should enable this feature discreetly.

Quick	If enabled, Quick Search panel (including Extended Quick Search) will be generated with the List page. Default is enabled. Quick Search searches text fields and optionally numeric fields only. These fields are selectable in Field Setup page. You may want to hide the Quick Search form for tables that do not have searchable fields.
Default value (Quick)	Default value for Quick Search. If no user input for Quick Search, this default value will be used. After users entering their search criteria, the default value will not be used.
Default search type (Quick)	Default search type for Quick Search. Possible values are: Any words All words Exact match
Extended	If enabled, Extended Quick Search inputs will be generated in the List page. Default is enabled.
Fields per row (Extended)	For use with Extended Quick Search. Specifies the number of fields per row in the Quick Search panel. Default is 0 (unspecifed), which means one field per row.
Advanced	If enabled, an Advanced Search Page will be generated and linked to the List page. Default is disabled.
Modal dialog (Advanced)	For use with Advanced Search. Use modal dialog to show the Advanced Search page.
Highlight	If this setting is checked, the search criteria in the search result (List page) will be highlighted. Default is disabled.

View

View	If enabled, a View page for the table will be generated (for displaying a record). Default is enabled. Note The table must have primary key or this setting will be unchecked during generation.
Modal dialog	Use modal dialog to show the Multi-Update page.

Add

Add	If enabled, an Add page for the table will be generated (for adding/copying a record). Default is enabled. Note The table must have primary key or this setting will be unchecked during generation.
Copy	If enabled, Add page will be generated and "Copy" links will be generated for record(s) in List/View page (for copying). Default is enabled. (If this setting is enabled, the "Add" setting is also enabled by default as copying requires the Add page.) Note The table must have primary key or this setting will be unchecked during generation.
CAPTCHA	Enable/disable CAPTCHA function for the Add page. Default is disabled. (CAPTCHA requires that the user type the letters or digits of a distorted image before submitting a form to prevent automated software from posting spam to your web application.) Notes Requires CAPTCHA extension, click Tools -> Extensions from the main menu to enable. Also see Third-party Tools. Not applicable to Inline/Grid-Add/Copy.
Confirm	Enable/disable confirmation function for the Add page. Default is disabled. If enabled, there will be a confirmation step in the Add page, users will be able check their input before actually inserting the record. Note Not applicable to Inline/Grid-Add/Copy.
Modal dialog	Use modal dialog to show the Add page.

Edit

Edit	If enabled, an Edit page for the table will be generated (for updating a record). Default is enabled. Note The table must have primary key or this setting will be unchecked during generation.
CAPTCHA	Enable/disable CAPTCHA function for the Edit page. Default is disabled. (CAPTCHA requires that the user type the letters or digits of a distorted image before submitting a form to prevent automated software from posting spam to your web application.) Notes Requires CAPTCHA extension, click Tools -> Extensions from the main menu to enable. Also see Third-party Tools. Not applicable to Inline/Grid-Edit.
Confirm	Enable/disable confirmation function for the Edit page. Default is disabled. If enabled, there will be a confirmation step in the Edit page, users will be able check their input before actually updating the record. Note Not applicable to Inline/Grid-Edit.
Check Conflicts	Check if the record is changed by other user before updating the record. Notes Since processing of current data for later comparison is required, using this feature will increase the time required to load the page. For better performance only the first hundreds of bytes of the BLOB fields are processed by default, but there are chances that change of BLOB data is not detected (if the first nth bytes are not changed). You can increase the number of bytes in Advanced Setting, if you want to process all bytes, enter 0. You can use the Row_UpdateConflict server event (see Server Events and Client Scripts) to resolve the conflicts according to your business logic by code. Not applicable to Inline/Grid-Edit.
Modal dialog	Use modal dialog to show the Edit page.

Delete

Delete	If enabled, a Delete page for the table will be generated (for deleting record or multiple records). Default is enabled. Note The table must have primary key or this setting will be unchecked during generation.
Inline Delete (Modal dialog)	Use modal dialog to show the deletion confirmation page.

Multi-Update

Multi-Update	If enabled, a Multi-Update page for the table will be generated (for updating multiple records). Default is disabled. With this feature you can select multiple records in the List page and update all records at the same time. You can select fields (see Field Setup page) to be included in the Multi-Update page. Note The table must have primary key or this setting will be unchecked during generation.
Confirm	Enable/disable confirmation function for the Multi-Update page. Default is disabled. If enabled, there will be a confirmation step in the Multi-Update page, users will be able check their input before actually updating the selected records.
Modal dialog	Use modal dialog to show the Multi-Update page.

Audit Trail
To use this feature, you must also specify the [Audit Trail folder] or database table and field under [PHP]->[General Options] tab. See PHP Settings for details.

Audit Trail

If audit trail for a table is enabled, when an user add(copy)/edit/delete a record or login/logout, the related information will be logged in a log file or into the specified database table.

Note By default all add(copy)/edit/delete info will be logged, if you want to select what to log, or want to log search/view activities also, use the Audit Trail Extension, also see [Tools]->[Extensions].

Email Notification
To use this feature, you must also specify the [Email Settings] under [PHP]->[Email Settings] tab. See PHP Setup for details.

On Add	If enabled, when an user add a record, an email will be send to pre-set recipient email address(es). Default is disabled.
On Edit	If enabled, when an user edit a record, an email will be send to pre-set recipient email address(es). Default is disabled.
On Delete	If enabled, when an user delete a record, an email will be send to pre-set recipient email address(es). Default is disabled.

Other than above Tables Setup page, you can also click on a particular table node (under [Tables] or [Views] or [Custom Views] or [Reports] or [Linked Tables] node) in the database pane to go to the Table Setup page for that table. The Table Setup page includes the following tabs: Table, Fields, and Server Events/Client Scripts. Click on the Table tab you'll see settings for the selected table only. The right side includes two panel - the [Table-specific Options] panel and the [Master/Detail] panel (see below), the left side contains settings same as above (but for the selected table only) and other settings:

Multi-Page

Normally each field is displayed as a table row in the View/Add/Edit page, this Multi-Page features allow you to display divide the fields into pages and display only one page at a time. To enable, at least one field with page number larger than 1 must be set up in Field Setup page. This feature is presented as tabs.

Multi-Page type	Specifies how to display the pages. Possible values are: Tabs - use Bootstrap basic tabs (default) Pills - use Bootstrap basic pills Accordion - use Bootstrap Collapse
Page Labels	Specifies the page captions of each page in the Multi-Page. Click the [...] button and enter the page captions and click [OK] to save. If page captions are not specified, "Page n" will be used by default. To add a page, go to Field Setup page, specify the page number for the fields in the page first. Note If you use Multi-Language (see PHP Settings), use Multi-Language Property Editor, see Tools for details.
Add page	Specifies if Multi-Page is enabled for Add page.
Edit page	Specifies if Multi-Page is enabled for Edit page.
View page	Specifies if Multi-Page is enabled for View page.
Search page	Specifies if Multi-Page is enabled for Advanced Search page.
Registration page	Specifies if Multi-Page is enabled for registration page. This setting is only available for the user table specified in Security Settings.

Return Pages

After Add	Specifies the return URL after a new record is added. Predefined settings are: Add Page - returns to the Add page of the current table Edit Page - returns to the Edit page of the current table List Page - returns to the List page of the current table (default if the Add page is opened from the List page) View Page - returns to the View page of the current table (default if the Add page is opened from the View page) You can also enter your own URL. Notes The URL must be a valid PHP expression. If it is a string, it should be double quoted. For predefined settings, if the Add page and the return page (Add/Edit/View Page) uses modal dialog, the return page will be opened in the same modal dialog. However, modal dialog is not supported if the return page is not one of the predefined settings. Example 1 If you want to redirect user to a custom page, enter: (with quotes) "MyPage.php" Example 2 If you want to pass field values, enter: (with quotes) "MyPage.php?xxx=" . urlencode($this-><Field>->CurrentValue) e.g. "MyPage.php?ID=" . urlencode($this->ID->CurrentValue) Example 3 If you have just added a master record and want to go to Grid-Add page of the detail table, enter: (with quotes) "<DetailTable>list.php?a=gridadd&showmaster=<Table>&fk_<KeyField>=" . urlencode($this-><Field>->CurrentValue) e.g. "OrderDetailslist.php?a=gridadd&showmaster=Orders&fk_OrderID=" . urlencode($this->OrderID->CurrentValue) Example 4 If you have just added a master record and want to go to Add page of the detail table, enter: (with quotes) "<DetailTable>add.php?showmaster=<Table>&fk_<KeyField>=" . urlencode($this-><Field>->CurrentValue) e.g. "OrderDetailsadd.php?showmaster=Orders&fk_OrderID=" . urlencode($this->OrderID->CurrentValue)
After Edit	Specifies the return URL after a record is edited. Notes The URL must be a valid PHP expression. If it is a string, it should be double quoted. For predefined settings, if the Edit page and the return page (Add/Edit/View Page) uses modal dialog, the return page will be opened in the same modal dialog. However, modal dialog is not supported if the return page is not one of the predefined settings.
After Grid-Add	Specifies the return URL after Grid-Add is done. Predefined settings are: List Page - returns to the List page of the current table (default) Grid-Add Page - returns to the Grid-Add page of the current table Grid-Edit Page - returns to the Grid-Edit page of the current table You can also enter your own URL. The URL must be a valid PHP expression. If it is a string, it should be double quoted.
After Grid-Edit	Specifies the return URL after Grid-Edit is done. Predefined settings are: List Page - returns to the List page of the current table (default) Grid-Add Page - returns to the Grid-Add page of the current table Grid-Edit Page - returns to the Grid-Edit page of the current table You can also enter your own URL. The URL must be a valid PHP expression. If it is a string, it should be double quoted.
After Register	Specifies the return URL after an user is registered. This setting is only available for the user table specified in Security Settings. Notes The URL must be a valid PHP expression. If it is a string, it should be double quoted. For predefined settings, if the Add page and the return page (Add/Edit/View Page) uses modal dialog, the return page will be opened in the same modal dialog. However, modal dialog is not supported if the return page is not one of the predefined settings.

Table-specific Options
These options are same as the List page options as described in PHP Settings except that the options are table-specific, meaning that you can have different List page options for different tables. To use table-specific options, select a table in the grid, uncheck [Use global settings] in the [Table-specific Options] panel, the panel will be enabled for you to setup.

Master/Detail
When you set up a master/detail relationship, you link two tables so that all the records of one table (the detail table) always correspond to the single current record in the other table (the master table). Each table can have multiple master tables and details tables.

You can establish master/detail (one-to-many) relationship between two tables as follows

Select a table in the table grid,
Then in [Master/Detail] panel at the bottom right corner of the page, click [Modify...] to bring up the visual master/detail relationship editor.
Click [Add table] to add the master and detail table to the diagram.
Create a relationship between them by dragging from the master field (key field in master table) to the detail field (foreign key field in the detail table). If there are more linked field, repeat the step until all the relationships are setup.

If you want to remove a relationship, select the link in the diagram and click [Delete]. After setup, click [OK] to confirm.

Note The diagram only shows master/detail relationships of the selected table. Although you can setup relationships for other tables in the diagram and view them in the [Master/Detail] panel immediately after clicking [OK], the relationships for other tables will not be loaded again if you go to other table and then come back to this table. Instead, the relationships will only be displayed when you change to the related tables.

In most cases, master and detail tables are joined by one field, you have one link between the master/detail table and you have one row in the Master/Detail panel only.

Referential Integrity	Specifies that user may not add/update a record in the detail table unless the foreign key points to a valid record in the master table.
Cascade Delete	Specifies that if a record in the master table is deleted, all corresponding records in the detail table will be deleted. Note If you have used ON DELETE CASCADE for the table in the database, no need to enable this setting.
Cascade Update	Specifies that if the primary key for a record in the master table changes, all corresponding records in the detail table will be updated. Note If you have used ON UPDATE CASCADE for the table in the database, no need to enable this setting.

Also See:

Tutorial - Master/Detail