phpGrid

• System Environment: Web-based
• Intended Audience: Non-Technical Users, Web Developers,
• Language: Multilingual
• Operating System: OS Independent
• Programming Language: PHP, jQuery, jqGrid, XHTML, SQL
• Database: Any Modern Relational Database (thru ADOdb)

phpGrid version 4 represents a major shift in system architecture. The new version abandends the old programming model which heavily relies on server side scripting, both in rendering and data operations. Much of the datagrid rendering now resides on the client side browser using jQuery and jqGrid. The server side is soley responsible for data CRUD operations. The new version is much more scalable than the previous generation, It also offers more features, such as subgrid and theme roller.

PHP web-based editable datagrid now can be achieved in two lines of code rather than five lines in the previous version. It also use Cascading Style Sheets, or CSS, extensivley for display related tasks, a perfect balance between simplicity and featues.

phpGrid Supports all major web browsers:

phpGrid supports all major databases

Database Type

phpGrid supports wide range of database types. Simply define DB_TYPE parameter value to your own database type. It can be one of the following strings. The default database type for phpGrid is “mysql”. DB_TYPE string is case sensitive.

A full list of supported databases and naming convention are available in ADOdb website. Not required but we encourage users to visit ADOdb website. It helps you understand how phpGrid utilizes it under the hood.
phpGrid now supports local array data source without using a database.

Oracle only

When using Oracle database with TNS(Transparent Network Substrate), replace the database host name with the TNS Name in conf.php e.g. define(‘DB_HOSTNAME’,<YOUR ORACLE TNS NAME>);

After successful installation, call the constructor similar to the following:

The details of phpGrid constructor is explained below:

__constructor($sql, $sql_key=’id’, $sql_table=”, $db_connection=”)

• Parameter(s):
  • $sql: SQL SELECT statement. This is the only SQL statement users needs to implement. The SELECT statement must include the primary key as one of the columns if not using the wildcard start(*) in SELECT statement.
    
    This parameter can also be a local array (version 5.5+). See phpGrid local array data source usage example.
     
    
  • $sql_key: The name of the primary key of the database table. The default value is “id”.
  • $sql_table: Name of the database table used in the SQL statement. If not defined, the table name is automatically parsed from the SQL statementent.
  • $db_connection: Optional. Since version 4.3, the 4th parameter was introduced and used to overwrite connection parameters in conf.php. It allows datagrid to reference to a difference data source on the fly. See Reference to Multiple Databases example for more information on this parameter. If you have only one database, you can safely ignore this parameter.
• Description:
  • This is our datagrid object constructor. Use this method to create the phpGrid object. Usually this is the first line in your code.
• Remark:
  • Do not include WHERE clause in $sql. Instead, use set_query_filter method (version 4.2+) to set filter in your query.
  • If not using the wildcard star(*), the SELECT statement MUST include the primary key as one of the columns.
• Example:

• Parameters:
  • $WHERE: Sql WHERE statement to select data conditionally (DO NOT include WHERE keyword).
• Description:
  • The query filter is essentially the WHERE clause without the WHERE. The method adds WHERE condition to already existing Sql SELECT statement. Use this method if you have WHERE clause in your SQL statement. You should use the same SQL syntax, such as single quotes around non-numeric values, and even SQL functions.
• Remark:
  • DO NOT include keyword “WHERE” the filter. phpGrid automatically adds WHERE to the query.
  • Use only SINGLE QUOTE around the filtered value.
• Example:

* Please note this feature is only available in paid versions.

• Parameters:
  • $edit_mode: FORM, or INLINE. The default is FORM.
  • $operations: specify allowed datagrid edit operations.
    • C = Create
    • R = Review
    • U = Update
    • D = Delete
  • By default, all above operations are allowed.
• Description:
  • When Form edit mode is used, additional icons appear in the data grid footer used for editing. When set to inline mode, the cells in the selected row become editable when the row is clicked. Only a single row can be edited for either mode.
• Remark:
  • Multiple records can be deleted when multiple select is enabled. See has_multiselect() for more information on this method.
  • For inline edit, the user must press Enter key to save changes
• Example:

• Parameter(s):
  • $type: Export type is either EXCEL or HTML. The default is EXCEL
• Description:
  • When export is enabled, the export icon appears in the grid footer. The datagrid can be exported in either EXCEL or HTML format. The Excel is exported in native Excel XML format.  More formats will be supported in the future.
• Example:

• Parameter(s):
  • $is_resizable: boolean value indicating whether the phpGrid is resizable.
  • $min_w: minimum resizable width of the datagrid. The default is 350 pixel.
  • $min_h: minimum resizable height of the datagrid. The default is 80 pixel.
• Description:
  • When $is_resizable is set to true, the small triangle shaped icon is displayed at the right bottom corner of the php data grid. The grid can be resized by simply click and drag the icon using mouse. This is more convenient than setting the width and height by programming.
• Remark:
  • The method utilizes jQuery UI library. This is currently an experimental feature.
• Example:

• Parameter(s):
• $render_content: Optional. True or false. Render content to screen, default value is set to true.
• Description:
  • This is the method to call to display the datagrid. This is usually the last method to call. It automatically stores the output to output buffer first before rending the data grid.
• Remark:
• • Unless used together wtih get_display(), it’s not necessary to supply a parameter value.
• Example:

• Parameter(s):
  • $debug: boolean value indicating whether to display debug message
• Description:
  • Enable debug displays phpGrid object as well as the current PHP session information. In addition, XMLHttpRequest, or AJAX, response data is displayed that occurs during CRUD operations. This is helpful debugging information can be used during development.
• Remark:
  • Make sure this method is not called, or the $debug parameter is set to false, when deployed in production.
• Example:

• Parameter(s):
  • $can_search: boolean. When set to true, the search icon displays in the footer, and the integrated search is toggled when the icon is clicked.
• Description:
  • The integrated search provides an intuitive interface for searching data within the datagrid. The user can search one or multiple fields. No additional programming is required. The datagrid is automatically refreshed and repopulated with results returned from the query through AJAX.
• Remark:
  • The integrated search is toggle off by default. Click on the Search button in the footer to toggle on the integrated search.
• Example:

• Parameter(s):
  • $caption: the text for the grid caption
• Description:
  • When set, this method displays text above the column header as the datagrid caption. When this method is not called, phpGrid sets the table name as the default caption. For example, the caption will be displayed as “Orders” when the table name is “Orders”.
• Remark:
  • When caption is set to empty string, e.g. ”, the space used for displaying caption will be hidden, leaves only the column header, grid, and the footer. To display the caption without any text, uses “ ” without the quote.
• Example:

• Parameter(s):
  • $col_name: column name
  • $prefix: currency prefix. The default is USD symbol, $
  • $suffix: currency suffix. The default is blank.
  • $thousandsSeparator: The character as the thousands separator. The default is the comma character “,”.
  • $decimalSeparator: The character as the decimal separator. The default is the dot character.
  • $decimalPlaces: The number of digital is displayed after the decimal point. The default is two.
  • $defaultValue: The value display when the value return from database is null or empty string. The default is 0.00
• Description:
  • This is helper method to display currency value. It formats column as currency when displayed. The value is automatically unformatted during CRUD operations.
• Example:

• Parameter(s):
  • $col_name: Name of column to display dynamic URL
  • $baseLinkUrl: The base URL. e.g. “http://www.example.com”
  • $dynaParam: Name of a single data field OR an array of multiple fields. The default is “id” if omitted.
  • $addParam: Optional. Parameters with static value in addition to $dynaParam. They are added to the end of the URL string. e.g. “&foo=bar”
  • $target: Optional. This sets the value of the hyperlink “Target” attribute. The available options are:
    • _new
    • _blank
    • _top
    • _parent
• Description:
• • This method sets a specific column to display HTML hyperlink URL based on dynamic values. It is different from set_col_link() method where it is simply a static link stored in a data field.
• Remark:
  • Developers should always check the validity of the dynamic URL constructed when using this method.
• Example:

• Parameter(s):
  • $col_name: Column name
  • $ctrl_type: HTML control type. A list of valid controls are:
    • text
    • textarea
    • select
    • checkbox
    • password
    • button
  • $keyvalue_pair: This parameter is only required when the $ctrl_type is type “select”. It essentially represents list of value key pairs in the dropdown. e.g. “1:San Francisco;2:Boston;3:NYC”. It is ignored if the control type is not “select”.*

    v4.2 Update:
    you can now use values from a database lookup table to bind the dropdown. Simply pass SELECT statement for the $keyvalue_pair when the $ctrl_type is “select”. For example:

        SELECT key, value FROM FOO

  • $multiple: This parameter is only used when control type is “select”. It indicates whether multiple items can be selected in the list of options. The values are passed and stored as a comma delimited string. e.g. “1,2,3″. For single value “select”, this is not required.
• Description:
  • Set control of a specific column used for grid editing. It displays HTML input tag of different type accordingly e.g. <input type=”text” />, <input type=”textarea” />
  • Remark:
    • Text and textarea are set automatically based on the database access library ADOdb metatype as the default edit control. Users do not need to understand how ADOdb works since phpGrid took care all the plumbing work internally. Isn’t that nice?
  • Example:

  1 2 3 4

  $dg -> set_col_edittype("officeCode", "select", "1:San Francisco;2:Boston;3:NYC", false); $dg -> set_col_edittype("isActive", "checkbox", "1:0"); // bind dropdown menu to a lookup table $dg -> set_col_edittype("officeCode", "select", "Select officeCode,city from offices",false);

• Parameter(s):
  • $col_name: Datagrid column name
  • $format: The format types are:
    • integer
    • number
    • email
    • link
    • showlink
    • currency
    • date
    • checkbox
    • select
  • $formatoptions: PHP array stores format options of different formatting.
• Description:
  • Although this method is purely for cosmetic purpose, it is very useful and also practical in many situations when displaying different type of data.
  • Depending on the type of format, it could have different format options. In most cases, users only need to set column formatting for “integer”, “number”, and “mail” using this method. For “currency’, “link”, and “showlink” formats, phpGrid provides a number of helper functions to make formatting simpler and easier. They are
    • set_col_currency()
    • set_col_link()
    • set_col_date()
    • set_col_dynalink()
  • The helper functions will be covered later in the documentation.
  • For type “date”, users don’t have to do anything for formatting. The format is automatically set to “date” when the database data field type is date or datetime.
  • In addition, the formats are automatically set as “checkbox” or “select” if the edit type is checkbox or select defined in set_col_edittype().
• Remark:
  • Though all of the formattings can be done in this method, it is recommended to use helper functions whenever possible. phpGrid ensures the formatting is automated as much as possible. Automation means less coding, and thus less room for error. Simplicity is what phpGrid strives for.
• Example:

• Parameter(s):
  • $col_name: Column name
  • $edithidden: Boolean value indicating whether the column is editable. The default value is set to true. This only applies when the edit mode is “FORM”.  A hidden column cannot be editable in “INLINE” edit mode.
• Description:
  • Hide a column in datagrid when displayed
• Remark:
  • To hide column in both datagrid and form, set the second parameter to false
• Example:

• Parameter(s):
  • $col_name: Colume name
  • $base_Url: Optional. Base URL to image (added in version 5.0)
• Description:
  • Display as image for a data field in data grid. The optional second parameter is added in version 5.0.  It specifies the base URL/target for all relative URLs to images file.
• Example:

Assuming the productImag value is “abc.jpg”, the following will render a img tag similar to . The 2nd parameter “/images/” form the base URL to the “abc.jpg”

• Parameter(s):
  • $col_name: Column name
  • $target: Hyperlink target attribute. The default is _new
• Description:
  • Display the text in column as a static hyperlink.
• Remark:
  • Use this method for displaying static HTML hyperlink. For dynamic links, use set_col_dynalink() method.
• Example:

• Parameter(s):
  • $col_names: Comma delimited one or more column names
• Description:
  • Set one more more columns as read only field
• Example:

• Parameter(s):
  • $col_names: Comma delimited one or more column names
• Description:
  • Set one more more columns as required field during edit
• Example:

• Parameter(s):
  • $col_name: Colume name
  • $new_title: Display title in grid column header
• Description:
  • Change data grid column header text from the default data field name to more user friendly name
• Remark:
  • The default column header text is the database table data field name
• Example:

• Parameter(s):
  • $width: Datagrid width
  • $height: Datagrid height. The default is 100% which expanses grid vertically to the entire browser height
  •  $shrinkToFit: true or false. If set to false, horizontal bar will appear when the total width of grid is wider than the dimesion width. The default is true.
• Description:
  • Set the overall height and width of phpGrid
• Remark:
• It is recommended to set $shrinkToFit to false when there are a large number of columns to display.
• Example:

• Parameter(s):
  • $datatype: Internal data source type. It can be either “json” or “xml“. The default is “json“.
• Description:
  • Manually sets data type used by jqGrid when displaying data grid.
• Remark:
  • In most cases, you do not need to call this method.

* Please note this feature is only available in paid versions.

• Parameter(s):
  • $obj_grid: phpGrid object as the detail datagrid
  • $fkey: Foreign key to the detail table.
• Description:
  • This method sets the master detail, or the parent child, relationship between datagrids.
  • The phpGrid went the extra mile to make creating the master detail datagrid a simple task for developers. The primary key value of master datagrid is auomatically retrieved when user selects a row and used as the value to the foreign key in the detail grid. The detail grid renders dynamically based on the row selected in parent grid.
• Remark:
  • The detail grid is a regular phpGrid object and can have the same methods like any other phpGrid, such as description title, sort, and update etc. A master detail can have one or more detail datagrid. The foreign key, or $fkey, does NOT necessarily have to have the same name as the master table primary key, as long as the same name exists in both master and detail tables.
  • When foreign keys don’t have the same name, you should use SQL alias.
  • Master grid prefills a detail grid with the value of the foreign key during data entry add operation. Version 4.5.5 and above only.
• Example:

When foreign keys don’t have the same name, you can use SQL alias.

• Parameter(s):
  • $multiselect:  Boolean value indicates whether the multiselect is allowed
• Description:
  • When parameter $multiselect is set to true, a checkbox is shown to the left of each row. It is currently only used for enabling deleting multiple records. More functions will be added to this feature in the future.
• Example:

• Parameter(s):
  • $pagesize: An integer value indicates number of results displaying in a page in the datagrid
• Description:
  • This method changes the default pagination of the datagrid. The default is 20.
• Remark:
  • Pagination is disabled when set_scroll() is set to true. See set_scroll() for more information.
• Example:

• Parameter(s):
  • $hover_color: Background color when mouse is over a row
  • $highlight_color: Background color when a row is clicked on
  • $alt_color: Alternating row color
• Descript:
  • This method is pure cosmetic. When modified, it overwrites color of jQuery UI properties:
    • ui-state-hover,
    • ui-state-highlight
    • ui-priority-secondary
• Example:

• Parameter(s):
  • $scroll: Boolean value indicates wheter
  • $height: phpGrid height
• Description:
  • Use vertical scroll to load data. The datagrid will not load everything at once and will hold all the items from the start through to the latest point ever visited. This prevents memory leaks from happening.
• Remark:
  • Pagination is disabled when scroll is set to true.
  • The default height is 400 when scroll is true and should never be ’100%’.
• Example:

• Parameter(s):
  • $col_name: Column name to sort
  • $sort_order: ’ASC’ or ‘DESC’. Default value is ‘ASC’  (version 4.4+)
• Description:
  • Set column sort by and sort order when datagrid is initially loaded.
• Example:

• Parameter(s):
  • $obj_grid: phpGrid object as subgrid
  • $s_fkey: subgrid foreign key.
  • $m_fkey: Optional. Master foreign key. (ver 4.5+).
• Description:
  • The method displays inline and read-only detail grid rather than in separate datagrid table. It is similar to set_masterdetail() except it can takes an additional parameter as the foreign key from master grid. When ignored, phpGrid assumes that m_fkey has the same value as the s_fkey.
• Remark:
  • Edit is currently not supported in subgrid.
  • Nested subgrid is currently not supported.
  • The 3rd parameter is only available to version 4.5 and above.
  • When the subgrid is the same table(self-reference, in database term) as the master grid, subgrid must use an different alias as table name in the select statement.
• Example:

• Parameter(s):
  • $theme_name: Theme name
• Description:
  • This is the phpGrid “Theme Roller”. phpGrid bundles the following themes from jQuery UI:
    • ‘dot-luv’
    • ‘excite-bike’
    • ‘flick’
    • ‘overcast’
    • ‘pepper-grinder’
    • ‘redmond’
    • ‘smoothness’
    • ‘start’
    • ‘ui-darkness’
    • ‘ui-lightness’
  • The default theme is ‘start‘.
• Example:

• Parameters:
  • $col_name: column name
  • $width: width
• Description:
  • Specify column width in pixel. The width should be an integer value.
• Example:

* Please note this feature is only available in paid versions.

* Please note this feature is only available in paid versions.

• Parameters:
  • $col_name: column name
  • $align: alignment direction: “left”, “center”, or “right”.
• Description:
  • Horizontal alignment of text in a column. The default alignment is left.
• Example:

• Parameters:
  • $has_adsearch: boolean value. Set true to enable advanced search
• Description:
  • Advanced search is different from the integrated search (see enable_search()). It can apply mulitple conditionals to a single field during advanced search. It is super flexible and easy to use.
• Example:

• Parameters:
  • $locale: language locale. List of values are: bg, cat, cn, cs, de, dk, el, en, fa, fi, fr, he, is, it, ja, nl, no, pl, pt, ro, ru, sp, sv, tr, ua.
• Description:
  • If you are using phpGrid in a language rather English, you may want the datagrid to display appropriate system text used by phpGrid such as “Submit”, “Next”, “Page”, “Find” etc. The language locale files are located in js\src\i18n directory.
• Example:

* Please note this feature is not available in Lite and Basic versions.

• Parameters:
  • $col_name: column name
  • $type: CELL or ROW
  • $formatoptions: array that stores condition and css style options
• Description:
  • Format a cell based on the specified condition. CELL formats the a single cell. ROW formats the entire row.
     

    $formatoption is the most important parameter which itself is an array contains three elements:

    • condition,
    • value,
    • css.
     

    The elements are described in details as the following:

    The first parameter, condition, has the following available value.

    eq: Equals
    ne: Not Equals
    lt: Less than
    le: Less than or Equal
    gt: Greater than
    ge: Greater than or Equal
    cn: Contains
    nc: Does not Contain
    bw: Begins With
    bn: Not Begins With
    ew: Ends With
    en: Not Ends With

    The second parameter, value, is the comparing value in the right operand.

    css parameter in $formattoptions is an array collection that contains css style element for current cell or row.

• Example:

* Please note this feature is not available in Lite and Basic versions.

• Parameters:
  • $col_name: Name of column to display data bar. It should be numeric type
    
  • $color: Data bar color
• Description:
  • Creates a data bar with gradient effect on a specified column. For complex data visualization, PHP Chart is highly recommended.
• Remark:
• For complex data visualization, we recommend phpGrid sister product, PHP Chart, a highly customizable PHP charting solution.
• Example:

* Please note this feature is not available in Lite and Basic versions.

• Parameters:
  • $col_name: Name of the column. Its value is used as the left operand for comparison.
    
  • $condition: comparison condition that compares given left and rigth hand operand with comparison operator . e.g. ” > 10 “; ” = ‘abc’”; ” != true ” etc.
  • $formatoptions:  an array stores CSS style format options. The value can be text, HTML, or even CSS class. See example.
  • TCellValue: value to display when condition is True
  • FCellValue: value to display when condition is False
• Description:
  • It formats and displays value in a cell when specified condition is met. You can think it as a simplified version to set_conditional_format() method.
• Remark:
• The condition is not “stackable” for a single column. In other words, only one condition can be applied to any giving column.
• Example:

Note that tstyle and fstyle are CSS styles used as the formatoptions.

PHP Code

• Parameters:
  • $autowidth: true or false
• Description:
  • Use this method to set datagrid width as the same as the current page width.
• Example:

• Parameters:
  • $add_script_includeonce: true or false. Whether or not to include script header.
• Description:
  • It returns the grid body with options to include script header. It is useful for MVC framework integration such as Joomla! and Drupal.
• Remark:
  • The get_display() function should be called AFTER display() is called so that the grid body and header is saved to an internal output buffer that can be later retrieved by get_display().

Example:

• Parameters:
  • $is_enabled: true or false
• Description:
  • Enable navigation by keyboard using up and down arrow keys.
• Remark:
• This is a beta feature currently. Not recommended using it in production.
• Example:

• Parameters:
  • $f_width: form width. The default value is ’400px’
    
  • $f_height: form height. The default is -1 so it is automatically adjusted to number of rows.
• Description:
  • Set edit FORM width and height during edit.
• Remark:
• The default $f_height value is -1 (negative one) so it is automatically adjusted to number of rows.
• Example:

* only available in Professional and above.

• Parameters:
  • $col_name: column name
• Description:
  • Turns simple text field into word processor by replacing textarea with rich text editor. Should only be used for text fields that allows large amount of text such as notes and comment fields.
• Remark:
• The field must be a text data type. If not, use set_col_edittype and set edit type to “textarea” first.
• Example:

• Parameters:
  • $col_name: column name
  • $default: column default value
• Description:
  • Set column default value This option is only valid for Form Editing when adding a new record. User can override this entry.
• Example:

* Please note this feature is currently only available for Enterprise and Universal licenses.

• Parameters:
  • $col_name: column name that stores file name
  • $base_url: base URL to the files
  • $physical_path: specify physical path to the folder where the files are uploaded. When PHP is installed as Apache module, this parameter is optional.
• Description:
  •  The file upload is seamlessly integrated with the edit form using Ajax, no page refresh ever occurred. Files can be uploaded and deleted right within the form.
• Remark:
• A single file upload per datagrid is allowed.
• FORM edit mode only
• File system only with valid upload_tmp_dir value in php.ini
• File name column should allow NULL value
• $physical_path is automatically obtained if PHP running in Apache module, or MUST be provided as fallback
• Example:

• Parameters:
  • $col_name: column name
  • $srcformat: source date format, eg. “Y-m-d”
    
  • $newformat: new date form to be displayed, eg. “n/j/Y”
    
  • $datepicker_format: datepicker format, eg. “m/dd/yy”
    
• Description:
  •  Helper function to format date using PHP date format options (http://php.net/manual/en/function.date.php)
• Remark:
• In most cases, you don’t need to call this method because phpGrid automatically formats the data with corresponding data type including date.
• Only use this method in order to display date format that is different from default date format.
• To display time only, please use set_col_property instead.
• Example:

• Parameters:
  • $col_name: column name
  • $size/$cols: If the column is a text box, it’s the size that represents number of characters. If the column is a textarea, it’s the value for cols attribute in textarea.
    
  • $rows: Optional. Number of rows in a textarea
    
• Description:
  •  Set input text box size or textarea cols and rows values in edit form.
    
• Remark:
• To set dimension for entire edit form, use set_form_dimension()
  
• Example:

• Parameters:
  • $col_name: column name
  • $property: An array represents the column properties. List of available properties (http://www.trirand.com/jqgridwiki/doku.php?id=wiki:colmodel_options)
• Description:
  •  This method allows you to directly manipulate column properties.  Since column properties are an array, you can directly change the properties. This is more “closer to the metal” for users who are already familiar with jqGrid colMdel API.
    
• Remark:
• This is an advanced method. In most cases, you don’t need to call this method.  It does not replace existing helper functions such as set_col_date, set_col_currency, etc. We suggest you use those helper functions if you are new to phpGrid.
  
• Example:

• Parameter(s):
  • $event_name: Event name from one of the following available events
    • jqGridResizeStart
    • jqGridResizeStop
    • jqGridAfterInsertRow
    • jqGridGridComplete
    • jqGridAfterGridComplete
    • jqGridBeforeRequest
    • jqGridLoadComplete
    • jqGridAfterLoadComplete
    • jqGridSortCol
    • jqGridSelectAll
    • jqGridBeforeSelectRow
    • jqGridCellSelect
    • jqGridDblClickRow
    • jqGridRightClickRow
    • jqGridHeaderClick
    • jqGridSelectRow
    • jqGridShowHideCol
    • jqGridRemapColumns
    • jqGridKeyLeft
    • jqGridKeyRight
    • jqGridKeyEnter
    • jqGridKeySpace
    • jqGridToolbarBeforeSearch
    • reloadGrid
    • jqGridToolbarAfterSearch
    • jqGridToolbarBeforeClear
    • jqGridToolbarAfterClear
    • jqGridFilterBeforeShow
    • jqGridFilterAfterShow
    • jqGridFilterInitialize
    • jqGridFilterSearch
    • jqGridFilterReset
    • jqGridAddEditBeforeCheckValues
    • jqGridAddEditClickSubmit
    • jqGridAddEditBeforeSubmit
    • jqGridAddEditErrorTextFormat
    • jqGridAddEditAfterSubmit
    • jqGridAddEditAfterComplete
    • jqGridAddEditBeforeInitData
    • jqGridAddEditBeforeShowForm
    • jqGridAddEditAfterShowForm
    • jqGridAddEditInitializeForm
    • jqGridAddEditClickPgButtons
    • jqGridAddEditAfterClickPgButtons
    • jqGridInlineEditRow
    • jqGridInlineAfterSaveRow
    • jqGridInlineSuccessSaveRow
    • jqGridInlineErrorSaveRow
    • jqGridInlineAfterRestoreRow
    • jqGridBeforeEditCell
    • jqGridAfterEditCell
    • jqGridSelectCell
    • jqGridBeforeSaveCell
    • jqGridBeforeSubmitCell
    • jqGridAfterSubmitCell
    • jqGridAfterSaveCell
    • jqGridErrorCell
    • jqGridAfterRestoreCell
    • jqGridSubGridBeforeExpand
    • jqGridSubGridRowExpanded
    • jqGridSubGridRowColapsed
    • jqGridGroupingClickGroup
    • jqGridImportComplete
  • $js_event_handler: JavaScript event handler to the specified event
• Description:
  • Custom event handler. A list of supported events:
    http://www.trirand.com/jqgridwiki/doku.php?id=wiki:events#list_of_triggered_events_new_in_v4.3.2
• Remark:
  • This is an advanced method.  The event handler is JavaScript.
• Example:
  • http://phpgrid.com/example/custom-event-handler/

• Parameter(s):
  • None
• Description:
• • Includes required Javascript libraries before displaying our grids.
• Remark:
  • Developers don’t need to call this method to include required Javascript libraries (jqGrid, jwysiwyg, ajaxfilupload etc.) because the phpGrid includes those Javascript automatically for you. This method is only used in get_display() in a MVC framework.

• Parameter(s):
  • $col_name: Name of the calculated/virtual column. It cannot have space and must NOT be one of the existing database column names.
  • $property: Column properties. See set_col_property() for available column properties usage.
  • $title: Optional. Title for this virtual column. If omitted, it’s the same as the column name $col_name.
• Description:
  • Append virtual column, AKA calculated column, to the end of an existing datagrid with this method.
• Remark:
  • The $col_name cannot contain space and must begin with a letter
  • Use “formatter” column property to hook up Javascript function, e.g. below, $col_formatter is the Javascript to display value in virtual column.
  • The virtual column always adds to the end of the grid in the order of virtual column is created.
  • Text must be surrounded with SINGLE quote.
  • Virtual column is not sortable.
• Example:

• Parameters:
  • $col_name: column name
  • $custom rule: Javascript function to validate data
• Description:
  • Create custom javascript validation for column value during edit. phpGrid has automatic default validation based on database data type. This method comes in handy when additional data validation is required such as value range, data dependency etc.
• Example:

• Parameter(s):
  • $col_name: Column name
• Description:
  • Similar to Excel column freeze, phpGrid can now freeze column(s)
• Remark:
  • Note that the frozen columns should be from left to right, one after other.
  • In inline edit, the frozen columns are not editable.
  • Columns are not draggable if any column is frozen
• Example:

• Parameter(s):
  • $method_name: method name
  • $options: method options. It must be an array. Different method has different options.
• Description:
  • Calling a jqGrid method to perform a specific action on the current grid. It is considered an advanced method.
  • A list of basic methods can be found here: http://www.trirand.com/jqgridwiki/doku.php?id=wiki:methods
• Remark:
  • Only available in 5.5.5 and higher.
  • Only use this method to call jqGrid methods that can act on the grid as a whole. It’s NOT possible to manipulate the grid on a row or cell level using set_grid_method because the generated javascript code is appended to the end of the script before closing bracket.
• Example: