phpGrid框架基于curd

http://phpgrid.com/documentation/  文档说明地址  

 

System Requirements

phpGrid is operating system independent. It works on both Windows and Linux as long as the following components are installed:

• PHP 5.2 or later
• Apache or Microsoft IIS web server
• mySQL 4.1 or above

If you are new to Apache/PHP/mySql, consider using  XAMPP, an integrated installation from Apache Friends. It installs Apache, PHP, and MySQL in one batch installation and requires almost no configuration for both Windows and Linux operating systems.

Technical Overview

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.

Installation

Before you begin coding using phpGrid, you must specify database information in conf.php. conf.php is our phpGrid configuration file in which we specify database connection parameters and path to the phpGrid. 

Please note that in PHP, the method name and parameters are case sensitive.

1 2 3 4 5 6 7 8

define ( 'DB_HOSTNAME' , 'hostname' ) ;  // database host name or TNS name (Oracle only) define ( 'DB_USERNAME' ,  'username' ) ;  // database user name define ( 'DB_PASSWORD' ,  'password' ) ;  // database password define ( 'DB_NAME' ,  'sampledb' ) ;  // database name define ( 'DB_TYPE' ,  'mysql' ) ;  // database type define ( 'DB_CHARSET' , 'utf8' ) ;  // OPTIONAL. Leave blank to use the default charset define ( 'SERVER_ROOT' ,  '<URL TO PHPGRID FOLDER>' ) ;  // URL to phpGrid folder. Must start with "/"

 

IMPORTANT: About SERVER_ROOT

SERVER_ROOT, formerly known as ABS_PATH, represents the absolute URL to the phpGrid library folder on the web server. This value tells your script where to find phpGrid library on the web server.

For instance, if the URL to get to the phpGrid is http://www.yoursite.com/phpGrid, orhttp://localhost/phpGrid, the SERVER_ROOT should be “/phpGrid” (must include the leading forward slash character “/”);

if the URL to phpGrid is http://www.yoursite.com/admin/phpGrid, orhttp://localhost/admin/phpGrid, the SERVER_ROOT should be “/admin/phpGrid“,

and so forth.

Once values in conf.php are set, simply reference phpGrid by adding the following at on top of your PHP code:

1	require_once ( "phpGrid/conf.php" ) ;

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.

DB_TYPE	Description
mysql	MySQL (default)
odbc_mssql	SQL Server
oci8	Oracle
oci8po	Oracle (portable, slightly slower but more reliable)
postgres	PostGreSql
access	Microsoft Access
db2	DB2
odbc	Generic ODBC

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.

 

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>);

phpGrid Constructor

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

1	$dg  =  new C_DataGrid ( "SELECT * FROM Orders" ,  "orderNumber" ,  "Orders" ) ;

The details of phpGrid constructor is explained below:

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

• Parameter(s):
  • $sql: SQL query statement. This is the only SQL statement users needs to implement. Normally it is the SELECT statement.
  • $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.
• Example:

1	$dg  =  new C_DataGrid ( "SELECT * FROM Orders" ,  "orderNumber" ,  'Orders' ) ;

set_query_filter($WHERE)

• Paramters:
  • $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:

1 2	$dg  ->  set_query_filter ( "status='Shipped'" ) ; $dg  ->  set_query_filter ( "YEAR(shippedDate) = 2003" ) ;

enable_edit() *

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

• Paramters:
  • $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.
• Example:

1	$dg  ->  enable_edit ( 'FORM' ,  'CRU' ) ;   // Note: delete is disallowed

enable_export()

• 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:

1	$dg  ->  enable_export ( 'HTML' ) ;

enable_resize()

• 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:

1	$dg  ->  enable_resize ( true ) ;

display()

• Parameter(s):
• $output_buffer: Optional. True or false. Flag to turn on output buffer. Default value is false. Required by get_display() method.
• $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.
• Remark:
• • Unless used together wtih get_display(), it’s not necessary to supply parameter value.
• Example:

1	$dg  ->  display ( ) :

enable_debug()

• 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:

1	$dg  ->  enable_debug ( true ) ;

enable_search()

• 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:

1	$dg  ->  enable_search ( true ) ;

set_caption()

• 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:

1	$dg  ->  set_caption ( '' ) ;  // this will hide the caption

set_col_currency()

• 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:

1	$dg  ->  set_col_currency ( "price" ,  "EUR" ,  "" ,  "," ,  2 ,  "0.00" ) ;

set_col_dynalink()

• Parameter(s):
  • $col_name: Name of column to display dynamic URL
  • $baseLinkUrl: The base URL. e.g. “http://www.example.com”
  • $idName: Name of data field. It is usually the primary key of a table though it does not have to be. The default is “id”.
  • $addParam: Parameters in addition to $idName. They are added to the end of the URL. e.g. “&foo=bar”
  • $target: This sets the value of the hyperlink “Target” attribute. The available options are:
    • _new
    • _blank
    • _top
    • _parent
• Description:
• This mentod sets a specfic 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:

1	$dg  ->  set_col_dynalink ( "productCode" ,  "http://www.example.com/" ,  "orderLineNumber" ,  '&foo=bar' ,  "_top" ) ;

set_col_edittype()

• 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”.*
  • $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 libraryADOdb 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 ) ;

set_col_format()

• 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_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:

1 2 3

$dg  ->  set_col_format ( 'quantity' , 'integer' ,  array ( 'thousandsSeparator' => ',' ,  'defaultValue' => '0' ) ) ; $dg  ->  set_col_format ( "emailAddress" ,  "email" ) ; $dg  ->  set_col_format ( "weight" ,  'number' ,  array ( "thousandsSeparator"  =>  "," ,  "decimalSeparator"  =>  "." ,  "decimalPlaces"  =>  '2' ,  "defaultValue"  =>  '0.00' ) ) ;

set_col_hidden()

• Parameter(s):
  • $col_name: Column name
  • $edithidden: Boolean value indicating whether the column is editable. 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:

1	$dg  ->  set_col_hidden ( 'employeeNumber' ) ;

set_col_img()

• Parameter(s):
  • $col_name: Colume name
• Description:
  • Display as image for a data field in data grid
• Example:

1	$dg  ->  set_col_img ( "productImage" )

set_col_link()

• 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, useset_col_dynalink() method.
• Example:

1	$dg  ->  set_col_link ( "productCode" ) ;

set_col_readonly()

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

1	$dg  ->  set_col_readonly ( "SSN, lastname, employeeNumber" ) ;

set_col_required()

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

1	$dg  ->  set_col_required ( "phone, email" ) ;

set_col_title()

• 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:

1	$dg  ->  set_col_title ( "fname" ,  "First Name" ) ;

set_dimension()

• 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:

1	$dg  ->  set_dimension ( 800 ,  600 ) ;

set_jq_datatype()

• 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.

set_jq_editurl()

• Parameter(s):
  • $url: URL
• Description:
  • Manually set URL used for editing. The default URL is edit.php. phpGrid takes care all of data insert, delete, and update in edit.php. No coding is required.
• Remark:
  • Only use this method when the users need to mannually handle data update using their own routin.
  • In most cases, you do not need to call this method.

set_jq_gridName()

• Parameter(s):
  • $grid_name: Unique name of the datagrid used internally by phpGrid
• Description:
  • Manually set the unqiue name of the datagrid. By default, the name is the database table name associated with the grid.
• Remark:
  • In most cases, you do not need to call this method.

set_masterdetail() *

* 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 detail datagrid. The foreign key, or $fkey, does NOT necessarily have to have the same name used for the primary key in the master.
• Example:

1 2 3

$dg  =  new C_DataGrid ( "SELECT orderId, orderDate, customerId FROM Orders" ,  "orderNumber" ,  "Orders" ) ; $sdg  =  new C_DataGrid ( "SELECT lineId,orderId,productCode,price FROM OrderDetails" ,  "lineId" ,  "OrderDetails" ) ; $dg  ->  set_masterdetail ( $sdg ,  'orderId' ) ;

set_multiselect()

• 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:

1	$dg  ->  set_multiselect ( true ) ;

set_pagesize()

• 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:

1	$dg  ->  set_pagesize ( 40 ) ;   // display up to 40 rows in a page

set_row_color()

• Parameter(s):
  • $hover_color: Background color when mouse is over a row
  • $highlight_color: Background color when a row is clicked on
• Descript:
  • This method is pure cosmetic. When modified, it overwrites color of jQuery UI properties:
    • ui-state-hover,
    • ui-state-highlight
  • Alternatively, user can directly declare style in HTML to overwrite those colors.
• Example:

1	$dg  ->  set_row_color ( 'yellow' ,  'lightblue' ) ;

set_scroll()

• 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:

1	$dg  ->  set_scroll ( true ) ;

set_sortname()

• 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:

1	$dg  ->  set_sortname ( 'productName' ) ;

set_subgrid()

• 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 current not supported in subgrid. Please use master detail datagrid for editing.
  • The 3rd parameter is only available to version 4.5 and above.
• Example:

1 2 3

$dg  =  new C_DataGrid ( "SELECT orderId, orderDate, customerId FROM Orders" ,  "orderNumber" ,  "Orders" ) ; $subdg  =  new C_DataGrid ( "SELECT lineId,orderId,productCode,price FROM OrderDetails" ,  "lineId" ,  "OrderDetails" ) ; $dg  ->  set_subgrid ( $subdg ,  'orderId' ) ;

set_theme()

• 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:

1	$dg  ->  set_theme ( 'flick' ) ;

set_col_width()

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

1	$dg  ->  set_col_width ( "comments" ,  500 ) ;

set_group_properties() *

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

• Parameters:
  • $column_name: column name for grouping
  • $groupCollapsed: boolean value indicating whether to expand or collapse grouping when displayed.  The default is false.
  • $showSummaryOnHide: boolean value indicating whether to display group summary when grouping is collapsed. The default is true.
• Description:
  • Group grid values simply by specifying a column name.
• Remark:
  • Single level grouping is currently supported.
  • When grouping is enabled, the followings methods are disabled:
    • set_scroll();
    • enable_rownumbers();
    • set_subgrid();
• Example:

1	$dg  ->  set_group_properties ( 'customerNumber' ) ;

set_group_summary() *

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

• Parameters:
  • $column_name: column name for grouping
  • $summaryType: summary type. It can be one of the types below
    • sum
    • count
    • avg
    • min
    • max
• Description:
  • Display group summary of a specific summary type, such as sum or max, in the group summary footer.
• Remark:
  • This method must be used together with set_group_properties() method.
• Example:

1 2 3

$dg  ->  set_group_properties ( 'customerNumber' ) ; $dg  ->  set_group_summary ( 'amount' , 'sum' ) ; $dg  ->  set_group_summary ( 'checkNumber' , 'count' ) ;

enable_rownumbers()

• Parameters:
  • $has_rownumbers: boolean value indicating whether row number is displayed.
• Description:
  • Display row number before each row.
• Example:

1	$dg  ->  enable_rownumber ( true ) ;

set_col_align()

• 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:

1	$dg  ->  set_col_align ( 'amount' ,  'right' ) ;

enable_advanced_search()

• 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:

1	$dg  ->  enable_advanced_search ( true ) ;

set_locale()

• 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:

1	$dg  ->  set_locale ( "fr" ) ;  // French locale

set_conditional_format() *

* 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, and 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:

1 2 3 4 5 6 7 8 9 10 11 12 13

//Format a cell based on the specified condition $dg -> set_conditional_format ( "orderNumber" , "CELL" , array ( "condition" => "eq" ,                                                        "value" => "10107" ,                                                        "css" =>  array ( "color" => "#ffffff" , "background-color" => "green" ) ) ) ; $dg -> set_conditional_format ( "customerNumber" , "CELL" , array ( "condition" => "eq" ,                                                    "value" => "141" ,                                                    "css" =>  array ( "color" => "red" , "background-color" => "#DCDCDC" ) ) ) ; // Format a row based on the specified condition $dg -> set_conditional_format ( "comments" , "ROW" , array ( "condition" => "cn" ,                                                    "value" => "request" ,                                                    "css" => array ( "color" => "white" , "background-color" => "#4297D7" ) ) ) ;

set_databar() *

* 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:

1	$dg  ->  set_databar ( "percentComplete" , "red" ) ;

set_conditional_value() *

* 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.
• Example:

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

1 2 3 4 5 6 7 8

.tstyle { display : block ; background-image : none ; margin-right : -2px ; margin-left : -2px ; height : 14px ; padding : 5px ; background-color : green ; color : navy ; font-weight : bold } .fstyle {  display : block ; background-image : none ; margin-right : -2px ; margin-left : -2px ; height : 14px ; padding : 5px ; background-color : yellow ; color : navy }

PHP Code

1 2 3 4 5 6 7

$dg -> set_conditional_value ( "isClosed" ,  "==1" ,  array (      "TCellValue" => "<img src='SampleImages/checked.gif' />" ,      "FCellValue" => "<img src='SampleImages/unchecked.gif' />" ) ) ;   $dg -> set_conditional_value ( "status" ,  "=='Complete'" ,  array (      "TCellStyle" => "tstyle" ,      "FCellStyle" => "fstyle" ) ) ;

enable_autowidth()

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

1	$dg -> enable_autowidth ( true ) ;

get_display()

• 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().
• The $output_buffer must be set to true in display() before calling get_display().

enable_kb_nav() – beta

• 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:

1	$dg -> enable_kb_nav ( true ) ;

set_form_dimension()

• 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:

1	$dg -> set_form_dimension ( '500px' ) ;

setCallBack

• Parameters:
  • $callback_str: callback string
• Description:
  • Used for pass setting between 3rd party system and phpGrid using AJAX callback. Read the comments in file callbackstr.php for usage

set_col_wysiwyg()

* 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.
• Example:

1	$dg -> set_col_wysiwyg ( 'comments' ) ;