PivotGrid PHP Class Overview

The Kendo UI PivotGrid for PHP is a server-side wrapper for the Kendo UI PivotGrid widget.

The Kendo UI PivotGrid for PHP supports Ajax data-binding to HTTP accessible OLAP cube as well as local flat data binding.

For more information on the OLAP concept supported by the Kendo UI PivotGrid for PHP, refer to the articles about OLAP fundamentals, setup an OLAP cube, or use the Kendo UI OLAP service at https://demos.telerik.com/olap/msmdpump.dll. Note that the service URL does not open directly in the browser.

Getting Started

Configuration

Below are listed the steps for you to follow when configuring the Kendo UI PivotGrid for PHP to do Ajax binding to an Adventure Works cube hosted on https://demos.telerik.com/olap/msmdpump.dll.

Step 1 Make sure you followed all the steps from the introductory article on Telerik UI for PHP—include the autoloader, JavaScript, and CSS files.

Step 2 Create a PivotDataSourceTransport and define the service URL.

    $transport = new \Kendo\Data\PivotDataSourceTransport();

    $read = new \Kendo\Data\PivotDataSourceTransportRead();

    $read->url('https://demos.telerik.com/olap/msmdpump.dll')
         ->contentType('text/xml')
         ->dataType('text')
         ->type('POST');

    $connection = new \Kendo\Data\PivotDataSourceTransportConnection();

    $connection->catalog('Adventure Works DW 2008R2')
                ->cube('Adventure Works');

    $discover = new \Kendo\Data\PivotDataSourceTransportDiscover();

    $discover->url('https://demos.telerik.com/olap/msmdpump.dll')
         ->contentType('text/xml')
         ->dataType('text')
         ->type('POST');

    $transport ->read($read)
                ->connection($connection)
                ->discover($discover);

Step 3 Create a PivotDataSourceSchema and set its type.

    $schema = new \Kendo\Data\PivotDataSourceSchema();
    $schema->type('xmla');

Step 4 Define the column and row dimensions of the PivotGrid.

    $dateColumn = new \Kendo\Data\PivotDataSourceColumn();
    $dateColumn->name('[Date].[Calendar]')
                ->expand(true);

    $cityColumn = new \Kendo\Data\PivotDataSourceColumn();
    $cityColumn->name('[Geography].[City]');

Step 5 Create a PivotDataSource instance.

    $dataSource = new \Kendo\Data\PivotDataSource();

    $dataSource->transport($transport)
        ->type("xmla")
        ->addColumn($dateColumn, $cityColumn)
        ->addRow('[Product].[Product]')
        ->addMeasure(array('[Measures].[Internet Sales Amount]'))
        ->schema($schema);

Step 6 Create a PivotGrid and set its dataSource.

    $pivotgrid = new \Kendo\UI\PivotGrid('pivotgrid');
    $pivotgrid->dataSource($dataSource);

Step 7 Render the PivotGrid.

    <?php
    echo $pivotgrid->render();
    ?>

Event Handling

You can subscribe to all PivotGrid events.

Specify Function Names

The example below demonstrates how to subscribe for events by specifying a JavaScript function name.

    <?php
    $pivotgrid = new \Kendo\UI\PivotGrid('pivotgrid');
    $pivotgrid->dataSource($dataSource);

    // The 'pivotgrid_dataBound' JavaScript function will handle the 'dataBound' event of the pivotgrid
    $grid->dataBound('pivotgrid_dataBound');

    echo $pivotgrid->render();
    ?>
    <script>
    function pivotgrid_dataBound() {
        // Handle the dataBound event
    }
    </script>

Provide Inline Code

The example below demonstrates how to subscribe to events by providing inline JavaScript code.

    <?php
    $pivotgrid = new \Kendo\UI\PivotGrid('pivotgrid');
    $pivotgrid->dataSource($dataSource);

    // Provide inline JavaScript code that will handle the 'dataBound' event of the grid
    $pivotgrid->dataBound('function() { /* Handle the dataBound event */ }');

    echo $pivotgrid->render();
    ?>
    <script>
    function pivotgrid_dataBound() {
        // Handle the dataBound event
    }
    </script>

Reference

Client-Side Instances

You are able to reference an existing PivotGrid instance via the jQuery.data(). Once a reference is established, use the PivotGrid API to control its behavior.

    <script>
    $(function() {
        // The constructor parameter is used as the 'id' HTML attribute of the pivotgrid
        var pivotgrid = $("#pivotgrid").data("kendoPivotGrid");
    });
    </script>

See Also

• Overview of the Kendo UI PivotGrid Widget
• Telerik UI for PHP API Reference Folder
• Telerik UI for PHP Classes Folder