Example:

DataFormat Tag

The dataformat tag is used to specify how the output of a column should look like. DataFormat tags can only be used within column tags.

The dataformat has a very simply syntax, and needs only two attributes: function and arg1, however you may use additional arg attributes (arg2, arg3, arg4, etc). The function attribute must contain the function that should be used to format the data. This can be either a static reference (class::method), an object reference (obj->method) or a simple function. In the arguments you can use the {item:*} variables (see the variables section).

Example:

Link/Button Tag

The link or button tag is used to display a column with a link or button. These are used to execute certain actions or callbacks. Each tag is exactly the same in attributes, and usage, except the link tag creates a link, and the button tag a button. They must have a name attribute. If you do not set a name, they won't be displayed.

Other attributes that this tag can use are callback, action, value, confirm, onclick, text, updatetext, and canceltext (plus the regular column attributes. See full attribute list above). The callback attribute is used to set a function that needs to be executed on the server side. This can only be a static reference (class::method) or a simple function. Object references do NOT work.

The action attribute isn't really used for anything, except for in-built commands. Of course, you can set the action attribute yourself, and then in your PHP script check for that action (using the DG_ACTION constant, see the constants below). The value attribute is used to pass an additional value.

The confirm and onclick attributes are used for the client-side. If you want to display a confirmation message, when the button or link is clicked, then set the confirm to your message, and it will be displayed on the client-side (using JavaScript). The onclick attribute can be used to set a JavaScript OnClick handler. Works just like the regular HTML OnClick attribute.

Finally, the text, updatetext and canceltext attributes is used to set the text of the link or button. The updatetext and canceltext are used to set the text of the update and cancel button/link (when using inline editing, see the inline editing section).

Example:

Or:

Row Tag

The row tag is used to add something before or after the data. This can be especially useful when you want to add some text above or below. The row tag must have a name set, or it won't be displayed.

The row tag has column tags to display data for each column. For example, if you want to display something for the first column, then you have to use a column tag, with a for attribute set to 0.

The column tags accept style attributes and tags. The row also accepts style attributes and tags (only the Style style applies to the row, none of the other styles work with rows).

See demo 7 in the demos folder for a working demonstration of adding custom rows.

A Simple DataGrid Layout

Below is a simple layout of a PHP:DataGrid. To see its result, check out demo 1 (in the demos folder).

As you can see, the syntax of PHP:DataGrid is extremely easy and straight-forward. It's almost just like English, and it requires very little knowledge to create something good-looking and powerful at the same time.

The above example can also be created like this:

The output will be exactly the same, but this time we used Style tags instead of Style attributes.

PHP Code

To display a DataGrid, you must bind the data (that you got from your SQL query) to the DataGrid. To do this, you can use the bind() method.

Now the data ($data) has been binded to a datagrid called 'demo'. If you do not do this, an error will be displayed.

Constants

To help you create your PHP scripts, and interact with datagrids, PHP:DataGrid will automatically set 9 constants:

Variables

To help you create a dynamic DataGrid, you can use certain variables in your templates. Below is a table of all the available variables.

Styles

Styles can be used to give your DataGrid a different look. There are 5 types of styles:

You can use style tags (e.g. <HeaderStyle bold="true" />) or style attributes (e.g <php:datagrid HeaderStyle-bold="true" />);

Styles can be used on the php:datagrid, column and row tags. Each tag accepts style attributes, and style tags. See the sample layout for an example of styles.

Templates

Template tags can be used to give your datagrid a completely different look. There are 4 different kinds of templates.

To set a template, use the template tags, e.g. <HeaderTemplate>Your new HTML goes here</HeaderTemplate>, and the same goes for the other templates.

Various

Inline Editing

PHP:DataGrid supports a feature called 'Inline Editing', that is also present in the ASP.NET DataGrid control. It allows you to directly edit an item from the datagrid.

To enable editing mode, all you have to do is add a link or button, and set its action attribute to 'edit'. When that button or link is clicked, edit mode will be enabled, and for each column a text box will appear where the value can be edited. If you want certain columns to be read-only, just set their readonly attributes to true, and they won't be editable.

When the update button is clicked, the updated information will be made available in $_DATAGRID->update, which you can use in your PHP script.

See demo 6 in the demos folder for an example of inline editing.

Sorting

PHP:DataGrid also supports column sorting. To enable column support, set the AllowSorting attribute of the php:datagrid tag to true, and sorting will be enabled for all the columns. Or, set the AllowSorting attribute on an individual column to true, and only that column is sortable. You can then use the constants to use the sorting in your PHP script.

Sorting goes in both directions, ascending and descending. PHP:DataGrid will automatically take care of that for you.

See demo 4 in the demos folder for an example of column sorting.

Inbuilt Commands

PHP:DataGrid has a few inbuilt commands that can be used with links and buttons. At the moment there is only one called 'redirect', which will redirect the user to a URL. Below is an example of this command.

Notes & Warnings

• You must use valid XHTML in the DataGrid control. Any invalid XHTML, and your DataGrid will not show properly.
• PHP:DataGrid works on the basis of output buffering. If you do any advanced things with output buffering, then you might prevent PHP:DataGrid from working properly. If you end the output buffer with ob_end_* then PHP:DataGrid will most likely not work.
• The links and buttons depend on JavaScript being enabled. If JavaScript is enabled, these will not work. This also means that they cannot be followed by bots and search spiders.

Support

For any questions, problems, comments or anything else, please visit our Community Support Forums or send us an e-mail at support@pallettgroup.com