Server Side Paging with jqxGrid using PHP and MySQL
This help topic shows how to implement server-side paging with the jqxGrid widget. The Grid will request data from the server when the user navigates to a new page or changes the page's size. The server-side script is going to deliver the data records in JSON format depending on the page number and page size. We will obtain the data from Northwind Database and especially from the Orders table. You can download the Northwind database .sql script here and run it into MySQL to create the database.
You can download the Northwind database .sql script here and run it into MySQL to create the database.
By default, the Grid sends the following data to the server:
- sortdatafield - the sort column's datafield.
- sortorder - the sort order - 'asc', 'desc' or ''
- pagenum - the current page's number when the paging feature is enabled.
- pagesize - the page's size which represents the number of rows displayed in the view.
- groupscount - the number of groups in the Grid
- group - the group's name. The group's name for the first group is 'group0', for the second group is 'group1' and so on.
- filterscount - the number of filters applied to the Grid
- filtervalue - the filter's value. The filtervalue name for the first filter is "filtervalue0", for the second filter is "filtervalue1" and so on.
- filtercondition - the filter's condition. The condition can be any of these: "CONTAINS", "DOES_NOT_CONTAIN", "EQUAL", "EQUAL_CASE_SENSITIVE",
NOT_EQUAL","GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "STARTS_WITH",
"STARTS_WITH_CASE_SENSITIVE", "ENDS_WITH", "ENDS_WITH_CASE_SENSITIVE", "NULL", "NOT_NULL", "EMPTY", "NOT_EMPTY"
- filterdatafield - the filter column's datafield
- filteroperator - the filter's operator - 0 for "AND" and 1 for "OR"
Assume that you are working on a web page which lists the customers from a database. Assume that you need to display 10 records in a page. The database has 30,000 records consisting all the customers. In the above scenario, it really makes sense to retrieve only the required records. for example, in the first page, retrieve 1 to 10 records. When the user clicks on “next” button, retrieve records 11 to 20 and so on. In this help topic, we will show you how to populate the jqxGrid on demand when the current page is changed. When a page is changed, the jqxGrid will request records in a specific range from the server. In reply to each request for information that the Grid plug-in makes to the server, it expects to get a well formed JSON object. Let’s see how to achieve that in a few steps.
1. The first step is to create the file we’ll connect with. We will call the file ‘connect.php’
2. The second step is to create the file that will handle the queries. We will call the file data.php. The data.php file connects to the ‘Customers’ table from the Northwind Database and returns the data as JSON. Our goal is to send data to client in small pieces that the client requests, and respond when the page number or page size is changed by the user. In the implementation, we check for the ‘pagenum’ and ‘pagesize’ members which the Grid sends to the server and we use the values of these members to specify the range of records in the query to the database. We also make a query to find the total rows in the ‘Customers’ table. The returned JSON data contains two thinkgs- the total rows in the ‘Customers’ table and the requested records.
3. The final step is to create the Grid and bind it to the ‘Customers’ table. Our goal is to populate the Grid on demand when a page or the page’s size is changed.
Here’s the full source code:
Let’s see how the above code works. As we need to populate the Grid on demand, we set its ‘virtualmode’ property to true. This means that the Grid will display only the records returned as array from the ‘rendergridrows’ callback function. The Grid will make requests to the server when the user clicks the ‘Next’ or ‘Previous’ buttons or changes the page’s size. We also set the source object’s totalrecords property to the TotalRows value returned from the server. In the source object’s initialization we set the ‘datatype’ to ‘json’ as the returned data will be JSON data and the ‘root’ member to ‘Rows’ as the records are stored in the ‘Rows’ array.