Filtered by category "Docs"

System Requirements

phpGrid is an operating system independent PHP library. It runs on Windows, Linux, and even IBM [...]

Technical Overview

System Environment: Web-based Intended Audience: Non-Technical Users, Web Developers, Language: [...]

Installation

Web-based install This is the easiest method for installing phpGrid on your web server. It is [...]

phpGrid Constructor

After successful installation, call the constructor like the following: 1$dg = new [...]

set_query_filter($WHERE)

Parameters: $WHERE: Sql WHERE statement to select data conditionally (DO NOT include WHERE [...]

enable_edit() *

* Please note this feature is only available in paid versions. CELL edit is only available in [...]

enable_export() *

* In Basic edition, export feature is limited to non-lookup tables only Parameter(s): $type: [...]

enable_resize()

Parameter(s): $is_resizable: boolean value indicating whether the phpGrid is resizable. $min_w: [...]

display()

Parameter(s): $render_content: Optional. True or false. Render content to screen, default value [...]

enable_debug()

Note: this method is going to be deprecated in the future. Please use DEBUG global constant [...]

enable_search()

Parameter(s): $can_search: boolean. When set to true, the search icon displays in the footer, [...]

set_caption()

Parameter(s): $caption | false: the text for the grid caption. Set to false to completely hide [...]

set_col_currency()

Parameter(s): $col_name: column name $prefix: currency prefix. The default is USD symbol, $ [...]

set_col_dynalink()

Now supports local array (version 6) ! Parameter(s): $col_name: Name of column to display [...]

set_col_edittype()

Parameter(s): $col_name: Column name $ctrl_type: HTML control type. A list of valid controls [...]

set_col_format()

Parameter(s): $col_name: Datagrid column name $format: The format types are: integer number [...]

set_col_hidden()

Parameter(s): $col_name: Comma delimited one or more column names $edithidden: Boolean value [...]

set_col_img()

Parameter(s): $col_name: Colume name $base_path: Optional. Base path to image Description: [...]

set_col_link()

Parameter(s): $col_name: Column name $target: Hyperlink target attribute. The default is _new [...]

set_col_readonly()

Parameter(s): $col_names: Comma delimited one or more column names Description: Set one more [...]

set_col_required()

Parameter(s): $col_names: Comma delimited one or more column names Description: Set one more [...]

set_col_title()

Parameter(s): $col_name: Colume name $new_title: Display title in grid column header [...]

set_dimension()

Parameter(s): $width: Datagrid width $height: Datagrid height. The default is 100% which [...]

set_jq_datatype()

Parameter(s): $datatype: Internal data source type. It can be either “json” or [...]

set_jq_editurl()

Parameter(s): $url: URL Description: Manually set URL used for editing. The default URL is [...]

set_jq_gridName()

Parameter(s): $grid_name: Unique name of the datagrid used internally by phpGrid Description: [...]

set_masterdetail() *

* Please note this feature is only available in Premium and higher licenses.   [...]

set_multiselect()

Parameter(s): $multiselect:  Boolean value indicates whether the multiselect is allowed [...]

set_pagesize()

Parameter(s): $pagesize: An integer value indicates number of results displaying in a page in [...]

set_row_color()

Parameter(s): $hover_color: Background color when mouse is over a row $highlight_color: [...]

set_scroll()

Parameter(s): $scroll: Boolean value indicates wheter $height: phpGrid height Description: Use [...]

set_sortname()

Parameter(s): $col_name: Column name to sort $sort_order: ‘ASC’ or [...]

set_subgrid()

Parameter(s): $obj_grid: phpGrid object as subgrid $s_fkey: subgrid foreign key. $m_fkey: [...]

set_theme()

* Premium themes are currently available in phpGrid commercial licenses.   Parameter(s): [...]

set_col_width()

Parameters: $col_name: column name $width: width Description: Specify column width in pixel. [...]

set_group_properties() *

* Please note this feature is only available in paid versions. Parameters: $column_name: column [...]

set_group_summary() *

* Please note this feature is only available in paid versions. Parameters: $column_name: column [...]

enable_rownumbers()

Parameters: $has_rownumbers: boolean value indicating whether row number is displayed. [...]

set_col_align()

Parameters: $col_name: column name $align: alignment direction: “left”, [...]

enable_advanced_search()

Parameters: $has_adsearch: boolean value. Set true to enable advanced search Description: [...]

set_locale()

Parameters: $locale: language locale. List of values are: bg, cat, cn, cs, de, dk, el, en, fa, [...]

set_conditional_format() *

* Please note this feature is not available in Lite and Basic versions. Parameters: $col_name: [...]

set_databar() *

* Please note this feature is not available in Lite and Basic versions. Parameters: $col_name: [...]

set_conditional_value() *

* Please note this feature is not available in Lite and Basic versions. Parameters: [...]

enable_autowidth()

Parameters: $autowidth: true or false Description: Use this method to set datagrid width [...]

get_display()

Parameters: $add_script_includeonce: true or false. Whether or not to include script header. [...]

enable_kb_nav() – beta

Parameters: $is_enabled: true or false Description: Enable navigation by keyboard using up and [...]

set_form_dimension()

Parameters: $f_width: form width. The default value is ‘400px’ $f_height: form [...]

setCallBack

Parameters: $callback_str: callback string Description: Used for pass setting between 3rd party [...]

set_col_wysiwyg()

* Only available in the Premium & Ultimate version. Parameters: $col_name: column name [...]

set_col_default()

Parameters: $col_name: column name $default: column default value Description: Set column [...]

set_col_fileupload() *

* Please note this feature is currently only available for commercial licenses. Parameters: [...]

set_col_date()

Parameters: $col_name: column name $srcformat: source date format, eg. “Y-m-d” $newformat: new [...]

set_col_edit_dimension()

Parameters: $col_name: column name $size/$cols: If the column is a text box, it’s the size that [...]

set_col_property()

Parameters: $col_name: column name $property: An array represents the column properties. List [...]

add_event()

Parameter(s): $event_name: Event name from one of the following available events jqGrid events [...]

display_script_includeonce()

Parameter(s): None Description: Includes required Javascript libraries before displaying our [...]

add_column()

Parameter(s): $col_name: Name of the calculated/virtual column. It cannot have space and must [...]

set_col_customrule()

Parameters: $col_name: column name $custom rule: Javascript function to validate data [...]

set_col_frozen()

Parameter(s): $col_name: Column name Description: Similar to Excel column freeze, phpGrid can [...]

set_grid_method()

Parameter(s): parameter: A variable argument. Variable argument makes the function more [...]

odbc_mssql

“odbc_mssql” should only be used for DSN connection for Microsoft SQL Server in [...]

before_script_end

before_script_end is not a function but a variable. It allows you to inject custom javascript [...]

$cust_prop_jsonstr

$custo_prop_jsonstr is a variable, not a function. The variable type is JSONString (string in [...]

set_grid_property()

Parameters: $grid_property: An array represents grid property. The property will add to or [...]

set_edit_condition()

Parameters: $edit_conditoin: An array stores edit permission condition. Description: Set [...]

DEBUG global constant

Note: DEBUG global constant is only available starting version 6. For phpGrid version 5.5.5 and [...]

THEME global constant

Available starting phpGrid version 6, you can set a global constant “THEME” in [...]

set_sortablerow()

Parameters: $sortable: true or false Description: Activate sortable row. Drag and drop row to [...]

enable_columnchooser()

Parameters: $enable: true or false Description: Enable column chooser. Remark: The column [...]

enable_autoheight()

Parameters: $autoheight: true or false. Default to false. Description: Use this method to set [...]

enable_global_search() *

* Please note this feature is only available in commercial  edition. Parameters: $enable: true [...]

set_pivotgrid()

* Pivot grid is only available in commercial license 6.6+.  Parameter(s): $configuration: Pivot [...]

set_col_headerTooltip()

Parameter(s): $col_name: Column name. $tooltip: Tooltip text. Description: Set column tooltip [...]

load_form()

* Paid version only.  Supported from version 7.0 and above. Parameter(s): $key: A database [...]

redirect_after_submit()

Parameter(s): $url: Redirect URL Description: Redirect form after submit. Remarks: It does not [...]

add_form_group_header()

Parameter(s): $before_col_name: Name of column name before which display group header text [...]

add_form_tooltip()

Parameter(s): $col_name: Name of column name for the tooltip $tooltip_text: Tool tip text [...]

form_only() *

* Please note Form-only mode is only available in paid versions. It is supported from version [...]

enable_pagecount()

* This function is available in commercial licenses. Parameters: $page_count: boolean: true or [...]

set_col_time() *

* Note that currently it is not supported in the Lite and Basic edition. Set the edit type to [...]

set_col_datetime()

* Currently only supported in the commercial licenses  The function is almost identical to [...]

enable_dnd_grouping()

* Please note this feature is only available in commercial licenses. Parameter(s): [...]

set_grid_style()

* Currently only supported in the commercial licenses  set_grid_style() is a helper function [...]

set_ws_editurl()*

* Available in commercial versions for IBM i DB2 only Details on IBM i RESTful Web Services [...]