Define the name of form: Function name:Form ('formName',doForm);Parameters:
formName : Name of the form
doForm :
Example of use: Copy
TOP
« • »
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: Copy
Atention: If you are making the call to phpMyDataGrid from a form defined by you, you must use the same method used in form.
TOP
« • »
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: Copy
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.

TOP
« • »
If you want to have a context menu with options for maintenance, use the following line: Function name:useRightClickMenu('classpath');Parameters:
classpath : write the full path including filename for phpMyMenu class
Example of use: Copy
TOP
« • »
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: Copy
TOP
« • »
For compatibility with XHTML use this feature: Function name:closeTags(bolStat);Parameters:
bolStat : true = XHTML compatible code
false = HTML only code
Example of use: Copy
TOP
« • »
To set the path where images are located: Function name:pathtoimages('strPath');Parameters:
strPath : Path to images
Example of use: Copy
TOP
« • »
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: Copy
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
TOP
« • »
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: Copy
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.
TOP
« • »
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: Copy
TOP
« • »
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: Copy
TOP
« • »
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: Copy
TOP
« • »
To define a title in the grid, use: Function name:TituloGrid('strTitle');Parameters:
strTitle :
Example of use: Copy
TOP
« • »
To define a footnote in the grid, use: Function name:FooterGrid('strFooter');Parameters:
strFooter :
Example of use: Copy
TOP
« • »
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: Copy
TOP
« • »
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: Copy
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

TOP
« • »
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)
input = Set a input for the user type the page numbers
inTable : This parameter is not used anymore, left for backward compatibility
Example of use: Copy
TOP
« • »
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: Copy
TOP
« • »
Set the number of decimal digits to be displayed in numeric fields: Function name:decimalDigits('amount');Parameters:
amount :
Example of use: Copy
TOP
« • »
You can define the character you want to use as a decimal point: Function name:decimalPoint('char');Parameters:
char :
Example of use: Copy
TOP
« • »
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',clicks);Parameters:
style : none = Disable online edition
default = Enables online edition with confirmation recording
silent = Enables online edition with automatic recording
clicks : Define the amount of clicks needed to activate the data for online edition.
1 - Single click
2 - Double click
Example of use: Copy
TOP
« • »
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: Copy
TOP
« • »
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: Copy
Atention: 

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

TOP
« • »
You can customize the actions to do when a maintenance button is clicked: Function name:setAction('button', 'event');Parameters:
button :
event :
Example of use: Copy
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\")');

TOP
« • »
It is necessary to define the table on which the grid will work: Function name:tabla('strTable');Parameters:
strTable :
Example of use: Copy
TOP
« • »
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: Copy
TOP
« • »
You can define a HAVING condition to filter and display only the records that meet the condition: Function name:having('strHaving');Parameters:
strHaving :
Example of use: Copy
TOP
« • »
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: Copy
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.
TOP
« • »
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: Copy
TOP
« • »
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: Copy
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
TOP
« • »
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: Copy
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.
TOP
« • »
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: Copy
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
TOP
« • »
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: Copy
Atention: This function uses the mail() php function, therefore to work properly, it must be configured and working
TOP
« • »
For maintenance options it is necesary to define a key fields, to do this, use: Function name:keyfield('strField');Parameters:
strField :
Example of use: Copy
TOP
« • »
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: Copy
TOP
« • »
If you like to set the 'Reset Search' button outside the grid, use this function: Function name:getResetSearch(icon);Parameters:
icon : Defines if the return data is just text or a icon, default: false
Example of use: Copy
TOP
« • »
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. (see samples)
  imagelink = Display a clickable image, may be field related or static. (see 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:-
  datetime = Date and time type field, format: datetime:dateformat:separator:timeformat,separator, sampledatetime:datetime:mdy:/:His,: or datetime:mdy:/:hisa,:
  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
  related = Find a correspondence in other table based in the field value
  array() - conditional = Display a value based on a set of conditions that meet the field value. (see samples)
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: Copy
TOP
« • »
You can define aditional atributes for each column: Function name:chField('strfieldName', 'permissions', overwrite)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
X+ = To export hidden fields in grid
X- = To not export visible fields
overwrite : Define whether the definitions made earlier to the field must be erased or cumulative
Example of use: Copy
Atention: You would combine several atributes in the same request, sample:
$objGrid -> chField('firstname','N-E+V+R');
TOP
« • »
Define the size for the input boxes when editing/adding: Function name:setInputWidth('field','width');Parameters:
field :
width :
Example of use: Copy
TOP
« • »
If you want to validate user input data via Javascript use: Function name:jsValidate('strField', 'strValidation', 'strErrorMessage', 'strDisplayMessage');Parameters:
strField : FieldName
strValidation : JavaScript code to validate, (You can call a JS function as well)
strErrorMessage : Error Message
strDisplayMessage : Input instructions message
Example of use: Copy
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
TOP
« • »
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: Copy
Atention: Those messages will be available in Add and Edit options only.
TOP
« • »
If you like to use a datepicker, you should use this function: Function name:useCalendar(bolCalendar);Parameters:
bolCalendar :
Example of use: Copy
TOP
« • »
To totalize columns, use: Function name:total('fields');Parameters:
fields : List of fields to totalize, comma separated
Example of use: Copy
Atention: Remember, now you can totalize calculated colums as well
TOP
« • »
Define the size (width, height) to display the pictures in a field: Function name:setImageSize('field','width','height');Parameters:
field : Field Name
width : Width in px (just the integer value)
height : Height in px (just the integer value)
Example of use: Copy
Atention: This function do not resize the stored images, just resize the output image in browser.
TOP
« • »
Lets you set a conditional format to CELLS that meet a condition: Function name:addCellStyle('field','condition', 'style');Parameters:
field : Field Name
condition : String, condition.
style : Name of the CSS class to use
Example of use: Copy
Atention: It is possible to use any field used within the grid, simply type the field name between [' ... '].
TOP
« • »
Lets you set a conditional format to ROWS that meet a condition: Function name:addRowStyle('condition', 'style');Parameters:
condition : String, condition.
style : Name of the CSS class to use
Example of use: Copy
Atention: It is possible to use any field used within the grid, simply type the field name between [' ... '].
TOP
« • »
Define the path for skin related images: Function name:skinimages('skin', 'path');Parameters:
skin : Skin name
path : Path to images
Example of use: Copy
Atention: The %s in path will be replaced by skin name, if this %s does not exist, the path will be used as is.
TOP
« • »
Changes the value to store instead of the specified in the online edition: Function name:setNewInlineData('newData');Parameters:
newData : New data to store when editing online
Example of use: Copy
TOP
« • »
Define a JS function to run after updating online, may have the parameters (idkey,field,newtext,oldtext): Function name:onAjaxUpdate('js');Parameters:
js : JavaScript function name to call when the Online edition finishes
Example of use: Copy
TOP
« • »
Returns the value of the AJAX action being executed: Function name:getAjaxID();Example of use: Copy
TOP
« • »
Returns codes of the selected checkboxes: Function name:getCheckedBoxes();Example of use: Copy
TOP
« • »
Returns true if the AJAX action is Adding data: Function name:isadding();Example of use: Copy
TOP
« • »
Returns true if the request is an online edition: Function name:isOnlineEdition();Example of use: Copy
TOP
« • »
Returns the data is being edited online: Function name:getEditedData();Example of use: Copy
TOP
« • »
Set an image by aplying a new parameter: Function name:changeImage();Example of use: Copy
TOP
« • »
Add a separator in the toolbar: Function name:addSeparator();Example of use: Copy
Atention: This feature is only valid if property toolbar is true
TOP
« • »
Add Buttons to the toolbar: Function name:addButton('img', 'action', 'message');Parameters:
img : Path and image name of the icon to display
action : Javascript funcion to call when the button is selected
message : Message to display at side of the icon
Example of use: Copy
Atention: This feature is only valid if property toolbar is true
TOP
« • »
Add a select menu to toolbar: Function name:addSelect('arrData', 'action', 'message');Parameters:
arrData :'toDisplay1','key2'=>'toDisplay2','key3'=>'toDisplay3','keyN'=>'toDisplayN')' onblur='ut("$objGrid","58","addSelect(¬c¬arrData¬c¬, ¬c¬action¬c¬, ¬c¬message¬c¬);","ta58","arrData,action,message",false)' />
action : Name of the JavaScript function to execute
message : Message to display at side of the icon
Example of use: Copy
Atention: This feature is only valid if property toolbar is true
TOP
« • »
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 or use the function set_DG_Header: 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: Copy
TOP
« • »
Finally, call this function which will render the grid based on all settings previously provided: Function name:grid();Example of use: Copy
TOP
« • »
If you need to pass parameters to a query is recommended to use this function which will analyze the contents of the variable, and amended if necessary to prevent SQL injections.: Function name:magic_quote($variable);Example of use: Copy
Atention: Note that this function is not part of the DataGrid class, and therefore should not be called as an object but as independent function!
TOP
« • »
It is recommended to include JS and CSS files, by using this function, see examples for details: Function name:set_DG_Header('path/to/JS/', 'path/to/CSS/', 'closetagChar', 'skinName')Example of use: Copy
Atention: Note that this function is not part of the DataGrid class, and therefore should not be called as an object but as independent function!
TOP
« • »