Getting Started with ApPHP DataGrid Wizard (v2.0.0 or above)

Common Notices

• Please, use a $debug = true; in datagrid_wizard.php before you say "Why Nothing Works ?!"

1. General and Site Settings.

This section describes how to manage a general settings of DataGrid Wizard.

1.1 DataGrid Component.

ApPHP DataGrid Wizard is utility script for ApPHP DataGrid component, so you need it uploaded and placed in directory modules/ to make the Wizard works as expected.

ApPHP DataGrid Wizard standard installation package includes ApPHP DataGrid Free version, so you may install it and test. This configuration allows you to create and run DataGrid pages, with many features of DataGrid. Of course, some of them will be not accessible due using of Free version. We strongly recommend to purchase ApPHP DataGrid Pro and use it for your projects. In section 1.2 it's described how to replace(update) ApPHP DataGrid component.

1.2 Updating of DataGrid component.

Updating of DataGrid component is a very straight forward process: remove all files from modules/datagrid/ directory and re-upload there all files from the new version of DataGrid. DataGrid Wizard will recognize the version of installed DataGrid component and will use an appropriate code template.

1.3 DataGrid Wizard Settings.

There are a lot of settings available in DataGrid Wizard to help you configure it according to your needs. You may change these stiings before instalaltion or even after it was complete. The configuration file is found in install/config.tpl. After installation complete the configuration file will be created in include/ directory.

Below the main configuration settings:
  • _DATAGRID_DIR - specifies default path to datagrid directory (relatively to datagrid_wizard.php)
  • _PAGES_DIR - specifies default path to generated pages directory (relatively to datagrid_wizard.php)
  • _BACK_BUT_PATH - specifies default path for Back button
  • _CANCEL_BUT_PATH - specifies default path for Cancel button
  • _USE_CODE_EDITOR - specifies whether to use rich text code editor
  • _ENTER_DB_CONNECTION - specifies whether to force entering db connection params
  • _ENCODE_DB_USER_PASSWORD - specifies whether to encode db user password, that stored in database
  • _DEFAULT_EXTENSION - specifies default PHP database extension: PEAR or PDO
  • _DEFAULT_DB_TYPE - specifies default PHP db type - look in
  • _DEFAULT_DB_NAME - specifies default database name
  • _DEFAULT_DB_USER - specifies default database user
  • _DEFAULT_DB_PASSWORD - specifies default database password
  • _USE_TABLE_PREFIXES - specifies whether to require using of prefixes for tables
  • _DROP_NON_VISIBLE_FIELDS - specifies whether to drop from the list of fields non-visible fields
  • _GENERATE_CODE_WO_COMMENTS - specifies whether to generate code without comments
  • _ALLOW_TRANSACTION_MODE - specifies whether to allow transaction mode
  • _ALLOW_DB_SCHEMA - specifies whether to allow db schema
  • _DEFAULT_DB_SCHEMA - specifies default schema
  • _MENU_POSITION - specifies menu position: 'side' or 'top'
  • _HIDE_NON_ACTIVE_FIELDSETS - specifies whether to show/hode non-active fieldsets
  • _ALLOW_DATAGRIDS_CLONING - specifies whether to allow cloning of datagrids

2. Working with DataGrid pages.

This section describes how to work with DataGrid pages.

2.1 Creating DataGrid page.

Editing DataGrid Page
To create DataGrid pages do to DataGrid Pages Manager and click on "+ Add New" link. Enter a page name and a name of the file (it will create the .php file with this name), and then click on "Create" button to finish the process. DataGrid Wizard will create an empty PHP page, that will appear on DataGrid Pages Manager page.

2.1.1 Creating & Calling Section.

This section is entended for setting up the major parameters, like: database connection parameters, PHP extention (PEAR or PDO), database type, unique prefix, debug mode etc. Without these parameters DataGrid Wizard will not work.

2.1.2 Master/Details Section.

Master Details Section
To create Master/Detail Section you have to create a Detail Grid page before. After the Detail Grid is created, create a new page with Wizard and goto the Master/Details Keys Section. To make this feature works you have to define following fields:

- Details Key Field - the field in Master table that relates to the Details table
- Details DataGrid page name (previously created DataGrid page)
- Datails table (select from dropdown box)
- Field Name - the field in Datails table that relates to the Master table

2.2 Editing page with Code Editor.

Editing DataGrid Page with Code Editor
To edit existing DataGrid page with Code Editor click on "Code" link in the column, called "Wizard Actions ". On the page that will be opened, you could edit a DataGrid page code directly with a simple text editor. Just enter all needed changes and click on "Save Code" button to save the changes.

Important: the changes that made via Code Editor is not saved in database and the code will be re-written if you will make changes in DataGrid Wizard again.

The result of these changes may be immediately reviewed via DataGrid Pages Manager.

2.3 Editing page with Wizard.

Editing DataGrid Page with Wizard - General View Editing DataGrid Page with Wizard
To edit existing DataGrid page with a Wizard Editor click on "Wizard" link in the column, called "Wizard Actions". On the page that will be opened, you could edit DataGrid page with a DataGrid Wizard, which help you to create Datagrid page "on fly" in easiest way.

The result of these changes may be immediately reviewed via DataGrid Pages Manager.

2.4 Deleting pages.

Deleting DataGrid Page
To delete existing DataGrid page go to DataGrid Pages Manager, click on "Delete" icon on DataGrid Pages Manager. The file and all related data from your database will be removed.

Create Your Free Account
Please remember that this information is essential to use our services correctly.
After creating the account you will be able to download all of our FREE products.
Fields marked with * are mandatory

Please send me information about updates, new products, specials and discounts from ApPHP!
We recommend that your password should be at least 6 characters long and should be different from your username/email. Please use only letters of the English alphabet to enter your name.

Your e-mail address must be valid. We use e-mail for communication purposes (order notifications, etc). Therefore, it is essential to provide a valid e-mail address to be able to use our services correctly.

All your private data is confidential. We will never sell, exchange or market it in any way. Please refer to Privacy Policy.

By clicking "Create Account", you are indicating that you have read and agree to the ApPHP Terms & Conditions.