Check documentation for the latest version of dhtmlxSuite Step 4. Create a Grid DHTMLX Docs

Step 4. Create a Grid

On this step, we will create a grid.
We will divide the step into 2 substeps:

If after completing the step, you will run webhost/laravel_dhtmlx/public/grid, the app will produce the following grid that loads data from server and saves them back:

Step 4.1. Configuring the View object

Let's create a View file that will present our grid. In the view we will use a standard code that initializes dhtmlxGrid and if you have been working with this component, it won't be difficult for you to understand the technique.

We will also initialize dhtmlxDataProcessor. The initialization of dhtmlxDataProcessor is usual.

If you slightly know dhtmlxGrid and will doubt what one or another command makes, refer to the following tutorials:

To configure the View object:
  1. In the "views " folder create a new file and name it "grid.php "
  2. Open the "grid.php " file and add the following code there:

    "views/grid.php" file

    <!DOCTYPE html>
        <meta http-equiv="Content-type" content="text/html; charset=utf-8">
        <script src="dhtmlx/codebase/dhtmlx.js"></script>
        <link rel="stylesheet" href="dhtmlx/codebase/dhtmlx.css">
        <div id="grid_here" style="width: 600px; height: 400px;"></div>
        <script type="text/javascript" charset="utf-8">
            mygrid = new dhtmlXGridObject('grid_here');
            mygrid.setHeader("Start date,End date,Text");
            // refers to the 'data' action that we will create in the next substep
            // refers to the 'data' action as well
            var dp = new dataProcessor("./grid_data");
    </script> </body>

Step 4.2. Configuring the Controller object

In the controller, we'll need to implement 2 actions:

  1. One that loads the view.
  2. One that loads and processes data.

To load and process data we will use GridConnector. A common use of GridConnector is:

$connector = new GridConnector(null, "PHPLaravel");
$connector->configure(new SchedulerEvent(),"event_id","start_date,end_date,event_name");

The GridConnector constructor takes 2 parameters:

  • null - null is passed, as a model, not a database is used;
  • $PHPLaravel - the module for working with PHP, the hardcoded value.

The configure method configures the GridConnector object without rendering data and takes 5 parameters:

  • new $modelName - the method creating a model (e.g. new SchedulerEvent());
  • $id - the name of the id field;
  • $text - a comma separated list of rendered data fields;
  • $extra - (optional) a comma separated list of extra fields;
  • $relation_id - (optional) used for building hierarchy in case of Tree and TreeGrid.
To configure the Controller object:
  1. Create a new file in the "controllers " folder and name it "GridController.php ".

  2. Open the "GridController.php " file and specify the namespace for controllers and include the GridConnector class and the method used for creating the model - SchedulerEvent():

    "controllers/GridController.php" file

    namespace App\Http\Controllers;
    use App\SchedulerEvent;
    use Dhtmlx\Connector\GridConnector;

  3. Create the root controller class "GridController ":

    "controllers/GridController.php" file

    namespace App\Http\Controllers;
    use App\SchedulerEvent;
    use Dhtmlx\Connector\GridConnector;
    class GridController extends Controller {                // here you should place all your functions       }

  4. Create an action that will load data to the view and render the grid:

    "controllers/GridController.php" file

    class GridController extends Controller
        public function data() {                                            $connector = new GridConnector(null, "PHPLaravel");             $connector->configure(                                              new SchedulerEvent(),                                           "event_id",                                                     "start_date, end_date, event_name"                          );                                                              $connector->render();                                       }                                                           }

    It is also possible to use the result of the query instead of the model, e.g.:
        SchedulerEvent::where('user_id', '=', 1)->get(),
        "start_date, end_date, event_name"                  
Back to top