Gurú Sistemas Ltd.

Facility	Speed	Support
Even a novice programmer can generate a php DataGrid complete with a professional finish in a few minutes applying a few lines of code.	With just a few lines of code, obtain a complete and professional DataGrid for your site.	Receive quick answers to your questions about phpMyDataGrid, receive customized examples and support 24 hours a day.

Interactive Documentation

Installation

Properties

Methods

You can modify the value of the parameters input boxes, see the generated code in the Example of use Box and copy the code into your own scripts

Methods

Define the name of form:

Function name:

Form ('formName',doForm);

Parameters:

formName	:	Name of the form
doForm	:

Example of use:

$objGrid -> Form ('employees',true);

<<• >>

Define the method of the form:

Function name:

methodForm ('strMethod');

Parameters:

strMethod

You can use either of the methods available form, GET or POST

Example of use:

$objGrid -> methodForm ('post');

Atention: If you are making the call to phpMyDataGrid from a form defined by you, you must use the same method used in form.

<<• >>

If you want to propagate your own GET or POST parameters, pass the data to the script, so it continue transferring the parameters in the dataGrid, for this, use:

Function name:

linkparam("parameters");

Parameters:

parameters

You must set the parameter list in the same way that parameters of the type GET

Example of use:

$objGrid -> linkparam("&session={$session}&userid={$userid}&option=4");

Atention:

The variables to be included in the list of parameters must have been previously caught, for instance, to capture the variable session:

If method = GET:
$session = $_GET['session'];

If method = POST:
$session = $_POST['session'];

If you do not know the request method or it can be mixed (GET and/or POST):
$session = (isset($_GET['session'])?$_GET['session']:(isset($_POST['session'])?$_POST['session']:''));

Note that the list of parameters are delimited by double quotes and the name of the variables enclosed between brackets {}, so, the variables are replaced by its record value.

<<• >>

If you want to have a context menu with options for maintenance, use the following line:

Function name:

useRightClickMenu();

Example of use:

$objGrid -> useRightClickMenu();

<<• >>

To define the way it generates the HTML:

Function name:

friendlyHTML(bolStat);

Parameters:

bolStat

true = for readable friendly HTML output
false = For obfuscated code

Example of use:

$objGrid -> friendlyHTML(true);

<<• >>

For compatibility with XHTML use this feature:

Function name:

closeTags(bolStat);

Parameters:

bolStat

true = XHTML compatible code
false = HTML only code

Example of use:

$objGrid -> closeTags(false);

<<• >>

To set the path where images are located:

Function name:

pathtoimages('strPath');

Parameters:

strPath

Path to images

Example of use:

$objGrid -> pathtoimages('/images/');

<<• >>

It is necessary to establish a connection to the database server to do that use the following function:

Function name:

conectadb('strServer', 'strUsername', 'strPassword', 'strDatabase', 'useADOdb', 'strType', intPort);

Parameters:

strServer	:	Server Name or Server IP
strUsername	:	DataBase Username
strPassword	:	Password
strDatabase	:	Database Name
useADOdb	:	true = Will use ADOdb library for connection false = Will use MySQL native drivers on php
strType	:	For connetions made with ADOdb, you can define the database Type to use
intPort	:	DataBase port

Example of use:

$objGrid -> conectadb('localhost', 'root', '%my12PaSS%', 'testdb', 'false', 'mysql', 3306);

Atention: If you choose to use ADOdb library to make the connection, you must download it from ADOdb website, and must include the necesary files at the beginning of the script

<<• >>

The default language for messages phpMyDataGrid is English, if you want to change the language, use this function:

Function name:

language('strLang');

Parameters:

strLang

Enter the two-character ISO code language

Example of use:

$objGrid -> language('es');

Atention: Available languages on phpMyDataGrid Professional are Spanish and English, if you want to add another language, you can just create the file in the languages folder.

<<• >>

To enable or disable maintenance icons, use:

Function name:

buttons(bolAdd, bolUpd, bolDel, bolChk, intColumn, 'strColumnName');

Parameters:

bolAdd	:	true = Enable the option to add false = Disable the option to add option
bolUpd	:	true = Enable the option to Edit false = Disable the option to Edit Option
bolDel	:	true = Enable the option to Delete false = Disable the option to Delete Option
bolChk	:	true = Enable the option to View false = Disable the option to View option
intColumn	:	Define the column in which you want to display the maintenance icons (-1 indicates at the right side of the grid)
strColumnName	:	Complete this field, whether to show a title in the column of icons

Example of use:

$objGrid -> buttons(true, true, true, true, -1, 'Column Title');

<<• >>

To enable or disable the options for export, use the following function:

Function name:

export(bolExportsheet, bolExportCSV, bolExportXML, bolPrinter, bolExportPDF, 'pdfOrientation');

Parameters:

bolExportsheet	:	true = Enable the option to export to worksheet (XLS) false = Disable the option to export to worksheet (XLS)
bolExportCSV	:	true = Enable the option to export to CSV false = Disable the option to export to CSV
bolExportXML	:	true = Enable the option to export to XML false = Disable the option to export to XML
bolPrinter	:	true = Enable the option to print false = Disable the option to print
bolExportPDF	:	true = Enable the option to export to PDF false = Disable the option to export to PDF
pdfOrientation	:	Select the page orientation to export to PDF (P) = Portrait (L) = Landscape

Example of use:

$objGrid -> export(true, true, true, true, true, 'P');

<<• >>

If you want to have a column with checkboxes for multiple-choice, use the following function:

Function name:

checkable(status);

Parameters:

status

true = Enable checkboxes column
false = Disable checkboxes column

Example of use:

$objGrid -> checkable(false);

<<• >>

To define a title in the grid, use:

Function name:

TituloGrid('strTitle');

Parameters:

strTitle

Example of use:

$objGrid -> TituloGrid('Grid Title');

<<• >>

To define a footnote in the grid, use:

Function name:

FooterGrid('strFooter');

Parameters:

strFooter

Example of use:

$objGrid -> FooterGrid('Grid footnote, © 2012 Gurú Sistemas');

<<• >>

To control the number of rows to display on each page:

Function name:

datarows(intLines);

Parameters:

intLines

Number of entries per page

Example of use:

$objGrid -> datarows(15);

<<• >>

If you want to set the number of pages that appear before summarize with ... change the amount with this function:

Function name:

linksperpage('amount');

Parameters:

amount

Enter the number of links that you want to display

Example of use:

$objGrid -> linksperpage('4');

Atention: Do not define very large quantities because they can distort the structure of the Grid
By setting linksperpage = 5, you'll look something like this: 1 2 3 4 5 ... 15 16 17 18 19 20 21 22 23 24 25 ... 45 46 47 48 49

<<• >>

To change the pagination format, use:

Function name:

paginationmode('pgm',inTable);

Parameters:

pgm	:	Define the type of paging, there are 3 available values: links = Generates a list page numbers indicating the page number to which the user want to go (Recommended tables with no more than 20 pages) select = Generates a menu that lets you choose the number of page you want to go mixed = Generates a list combining the above methods (default)
inTable	:	true = Page numbers will be formated inside a table false = Standar page style

Example of use:

$objGrid -> paginationmode('mixed',false);

<<• >>

You can define a security code (Magic word) which will help to phpMyDataGrid to be safer:

Function name:

salt('code');

Parameters:

code

Example of use:

$objGrid -> salt('salt&pepper');

<<• >>

Set the number of decimal digits to be displayed in numeric fields:

Function name:

decimalDigits('amount');

Parameters:

amount

Example of use:

$objGrid -> decimalDigits('2');

<<• >>

You can define the character you want to use as a decimal point:

Function name:

decimalPoint('char');

Parameters:

char

Example of use:

$objGrid -> decimalPoint('.');

<<• >>

The online edition can be: off, activated with a single click and save when leave the field, or ask for confirmation to save. To define this, use:

Function name:

ajax('style');

Parameters:

style

none = Disable online edition
default = Enables online edition with confirmation recording
silent = Enables online edition with automatic recording

Example of use:

$objGrid -> ajax('none');

<<• >>

If you want to differentiate on the screen the values that have been modified via AJAX, you can use this function:

Function name:

AjaxChanged('strColor');

Parameters:

strColor

It must be a valid hex color

Example of use:

$objGrid -> AjaxChanged('#900');

<<• >>

If for some reason needed to check whether a call is being made to AJAX page can use this function:

Function name:

isAjaxRequest();

Example of use:

$objGrid -> isAjaxRequest();

Atention:

if ($objGrid -> isAjaxRequest()){
echo 'This is an AJAX request';
} else {
echo 'This is a direct request';
}

<<• >>

You can customize the actions to do when a maintenance button is clicked:

Function name:

setAction('button', 'event');

Parameters:

button	:
event	:

Example of use:

$objGrid -> setAction('add', 'javascript_function()');

Atention: Considerations to have in mind to set new processes buttons:

Add button = None
Sample: $objGrid -> setAction('add','new_adicionar()');

Edit button = Function must have 2 parameters, delimited in the following way: (\"%s\",\"%s\");
Sample: $objGrid -> setAction('edit','new_editrow(\"%s\",\"%s\")');

Delete Button = Function must have 2 parameters, delimited in the following way: (\"%s\",\"%s\");
Sample: $objGrid -> setAction('delete','new_deleterow(\"%s\",\"%s\")');

Search Button = None
Sample: $objGrid -> setAction('search','new_search()');

View Button = Function must have 2 parameters, delimited in the following way: (\"%s\",\"%s\");
Sample: $objGrid -> setAction('view','new_viewrow(\"%s\",\"%s\")');

<<• >>

It is necessary to define the table on which the grid will work:

Function name:

tabla('strTable');

Parameters:

strTable

Example of use:

$objGrid -> tabla('employees');

<<• >>

You can define a WHERE condition to filter and display only the records that meet the condition:

Function name:

where('strWhere');

Parameters:

strWhere

Example of use:

$objGrid -> where('active = 1');

<<• >>

If you need to group records by some fields, or fields, you can use this function:

Function name:

groupby('strGroup');

Parameters:

strGroup

Example of use:

$objGrid -> groupby('status');

Atention: Note that when grouping data, the functionality of maintenance (Add, Edit, Delete, online edition), not function properly, therefore it is recommended to disable, or if necessary, implement your own maintenance processes.

<<• >>

Define the fields for which you want to sort the records:

Function name:

orderby('fields','style');

Parameters:

fields	:	List of fields to which you want to sort the output, separated by commas
style	:	Define the type ordering type for each field ASC or DESC, if blank, ASC will be used automatically

Example of use:

$objGrid -> orderby('name,lastname','asc,desc');

<<• >>

The professional version has a feature which will allow you to order manually a set of records, which is useful for example to define the order in which products will appear on a page:

Function name:

setorderarrows('field');

Parameters:

field

The consecutive field should not be the table ID

Example of use:

$objGrid -> setorderarrows('consecutivo');

Atention: The ordering field should be consecutive and not be autoincrementable, for the examples that we have developed, its value is always the same as the autoincrementable ID value

<<• >>

By default, phpMyDataGrid enables the ordering arrows in the titles of all the columns, if you want to disable this feature use the following function:

Function name:

noorderarrows();

Example of use:

$objGrid -> noorderarrows();

Atention: If you want to disable the ordering of a few columns only, DO NOT use this function, instead use chField specifying the necessary parameters.

<<• >>

phpMyDataGrid automatically generates SQL queries based on the information provided, but sometimes it is necessary to generate advanced queries that require the programmer defined them manually, to do this, use:

Function name:

sqlstatement('strSQL','strCount');

Parameters:

strSQL	:
strCount	:

Example of use:

$objGrid -> sqlstatement('SELECT *, now() as fecha from employees','select count(*) from employees');

Atention: User defined SQL queries should not include sentences WHERE, GROUP or ORDER, these must be defined directly from the class functions.
You should have in mind that it is very important that all the names of fields used in the grid must be defined in the SQL query

<<• >>

For the developer it is essential to track the performance of the scripts, this feature allows to the programmer to receive emails with 'any' SQL errors that may be generated:

Function name:

reportSQLErrorsTo('strMail', 'bolShow');

Parameters:

strMail	:	Developer e-mail
bolShow	:	true = Display SQL errors on the screen to end user (Recommended while developing)) false = Hides any generated SQL errors (Recommended for production environments)

Example of use:

$objGrid -> reportSQLErrorsTo('developer@thecompanymail.com', 'false');

Atention: This function uses the mail() php function, therefore to work properly, it must be configured and working

<<• >>

For maintenance options it is necesary to define a key fields, to do this, use:

Function name:

keyfield('strField');

Parameters:

strField

Example of use:

$objGrid -> keyfield('id');

<<• >>

To allow search data in phpMyDataGrid, simply define the fields which will be allowed to search for:

Function name:

searchby('listoffields');

Parameters:

listoffields

You can add the instruction :SELECT to field name to display a drop-down menu with the resume of all possible values to search.

Example of use:

$objGrid -> searchby('firstname,lastname,date:select');

<<• >>

If you like to set the 'Reset Search' button outside the grid, use this function:

Function name:

getResetSearch();

Example of use:

$objGrid -> getResetSearch();

<<• >>

One of the main functions is FormatColumn, with this function you define the characteristics of each one of the fields displayed on grid:

Function name:

FormatColumn('strfieldName','strHeader','fieldWidth','maxlength','inputtype','columnwidth','align','Mask','default','cutChar');

Parameters:

strfieldName	:	Field name
strHeader	:	Column Title
fieldWidth	:	Used only in textarea fields, it is used to set the textarea rows
maxlength	:	Max length allowed to be typed by user
inputtype	:	Field type 0 = Normal Field 1 = Read only field 2 = Hidden field 3 = Image, calc, link or imagelink without relation to a field 4 = Image, calc or link related with a field
columnwidth	:	Column width (in pixels)
align	:	Column Text align center = (default) left right
Mask	:	Masking to field text = Normal field text textarea = Region for text editing (may have a larger area that the fields type text) image = Display an image, may be field related or static. (view samples) imagelink = Display a clickable image, may be field related or static. (view samples) number = Numeric field money = Numeric money sign field, format: money:sign, sample money:$ money:£ date = Date type field, format: date:format:separator, sample date:dmy:/ date:ymd:- link = Link field. view samples password = Password type field calc = Calculated field. view samples scalc = Calculated field which stores the result in a field, view samples bool = Boolean field, create a checkbox and store 0 when unchecked and 1 when checked check = same as bool type field select = Field with a dropdown menu, the options can be manually defined or dynamically loaded from another table in the database. 0 = Integer, no decimals 1 = Float 1 decimal 2 = Float 2 decimals 3 = Float 3 decimals 4 = float 4 decimals integer = Integer, no decimals
default	:	Default value for field (Used in add option)
cutChar	:	Used generally in textarea fields which are too long, by using this parameter the grid will only display the amount of X characters

Example of use:

$objGrid -> FormatColumn('lastname','Lastname','0','20','0','80','center','text','','');

<<• >>

You can define aditional atributes for each column:

Function name:

chField('strfieldName', 'permissions')

Parameters:

strfieldName	:	Field Name
permissions	:	N+ = Display field while adding N- = Hide field while adding E+ = Display field while editing E- = Hide field while editing V+ = Display field while viewing records V- = Hide field while viewing R = Remove order arrows for field U = (only for imagetype fields) allow new images to be uploaded to the field M = (only for imagetype fields) Allow images to be uploaded, no matter if field already has an image on it

Example of use:

$objGrid -> chField('nombrecampo', 'N+')

Atention: You would combine several atributes in the same request, sample:
$objGrid -> chField('firstname','N-E+V+R');

<<• >>

If you want to validate user input data via Javascript use:

Function name:

jsValidate('strField', 'strValidation', 'strErrorMessage', 'strDisplayMessage');

Parameters:

strField	:	Field Name
strValidation	:	JavaScript code to validate, (You can call a JS function as well)
strErrorMessage	:	Error Message
strDisplayMessage	:	Input instructions message

Example of use:

$objGrid -> jsValidate('firstname', 'this.value.length>=8', 'Name must have at least 7 chars long', 'Write customer name');

Atention: Javascript validations will be executed on New and Edit options, as well in online edition, please keep in mind you can validate only the actual field (this.) validations can not be done combined with other fields

<<• >>

To Just display an instructions message to user, use:

Function name:

fldComment('strField', 'strDisplayMessage');

Parameters:

strField	:	Field name
strDisplayMessage	:	Input instructions message

Example of use:

$objGrid -> fldComment('lastname', 'Write customer lastname');

Atention: Those messages will be available in Add and Edit options only.

<<• >>

If you like to use a datepicker, you should use this function:

Function name:

useCalendar(bolCalendar);

Parameters:

bolCalendar

Example of use:

$objGrid -> useCalendar(true);

<<• >>

To totalize columns, use:

Function name:

total('fields');

Parameters:

fields

List of fields to totalize, comma separated

Example of use:

$objGrid -> total('salary,days,total');

Atention: Remember, now you can totalize calculated colums as well

<<• >>

This function is available for backward compatibility, it is not recommended to be used, instead you would insert the JS and CSS files by yourself:

Function name:

setHeader('phpScriptFile', 'jsFile', 'cssFile', 'jsCalFile', 'cssCalFile', 'jsmmenu');

Parameters:

phpScriptFile	:	php script name
jsFile	:	path and name to datagrid JS file
cssFile	:	path and name to datagrid CSS file
jsCalFile	:	path and name to calendar JS file
cssCalFile	:	path and name to calendar CSS file
jsmmenu	:	path and name to right click menu

Example of use:

$objGrid -> setHeader('sample.php', 'js/dgscripts.js', 'css/dgstyle.css', 'js/dgcalendar.js', 'css/dgcalendar.css',  'mmscripts.js');

<<• >>

Finally, call this function which will render the grid based on all settings previously provided:

Function name:

grid();

Example of use:

$objGrid -> grid();

<<• >>

Home ¦ News ¦ Documentation ¦ Samples ¦ Downloads ¦ Buy ¦ Support ¦ Terms of Use