<?php
    /**
    * This an example script that uses the datagrid and shows it off
    */
    
    /**
    * Include the datagrid code
    */
    require_once('Datagrid.php');

    /**
    * Make sure errors are turned on
    */
    ini_set('display_errors', 1);
    error_reporting(E_ALL);

    
    $params['hostname'] = 'localhost';
    $params['username'] = 'root';
    $params['password'] = '';
    $params['database'] = 'phpguru';

    $sql = "SELECT cm_id,
                   ne_title,
                   cm_author,
                   cm_datetime,
                   cm_status
              FROM comments,
                   news
             WHERE cm_status = 'ACTIVE'
               AND cm_neid = ne_id
          ORDER BY ne_id DESC";

    /**
    * Create the datagrid with the connection parameters and SQL query
    * defined above. You MUST specify an ORDER BY
    * clause (with ASC/DESC direction indicator) - if not then ordering
    * will be fubar. I will eventually fix this so that the headers
    * aren't clickable if you don't supply an ORDER BY, for the time
    * being just specify an ORDER BY clause (the one you specify will
    * be used by default).
    */
    $grid = DataGrid::Create($params, $sql);

    /**
    * Turn the column headers off/on
    */
    $grid->showHeaders = true;
    
    /**
    * Different to the above - this is the HTML that is shown above the
    * actual datagrid
    */
    $grid->SetHeaderHTML('<div style="text-align: center">[This the (static) header HTML]</div>');

    /**
    * Sets nice(r) display names instead of the raw column names
    */
    $grid->SetDisplayNames(array('cm_id'       => 'ID',
                                 'cm_author'   => 'Author',
                                 'cm_email'    => 'Email',
                                 'cm_datetime' => 'Date & time',
                                 'cm_status'   => 'Status',
                                 'ne_title'    => 'Title'));

    /**
    * This hides a column from the result set. It would of course be easier and
    * faster just to not select it, but this isn't always possible.
    */
    #$grid->HideColumn('cm_live');
                                 
    /**
    * This simply sets the specified columns not to be passed through htmlspecialchars()
    * Generally any column that shows HTML
    */
    $grid->NoSpecialChars('actions', 'ac_id');
    
    /**
    * A callback function that gets called for each and every row.
    * The callback function should take a single argument by reference,
    * which is an associative array of the row data. It's by reference
    * so that any changes you make will not be lost.
    */
    $grid->rowcallback = 'RowCallback';
    function RowCallback(&$row)
    {
        // Add the actions column
        $row['actions'] = sprintf('<a href="example.php?ac_id=%d" onmouseover="window.status = \'Edit this row: %1$d\'; return 0" onmouseout="window.status = \'\'" onclick="alert(\'This link doesn\\\'t actually do anything\'); return false">Edit</a>', @$row['ac_id']);
        // " - Closes off the quotes (purely for my own editors colouring)
    }
    
    /**
    * Here just for show. This function sets the number of rows to set per page.
    * The default is 20.
    */
    $grid->SetPerPage(25);
    
    /**
    * Again, this is purely here for show. It doesn't do anything, but simply shows
    * how you can use this function. If you change the perPage after you call
    * this function, then obviously the page count will change.
    */
    echo '<p>Number of pages: ' . $grid->GetPageCount() . '<br />';
    
    /**
    * Again, here just for show. Gets the number of rows in the grid.
    */
    echo 'Number of rows: ' . $grid->GetRowCount() . '</p>';
    
    /**
    * Gets the connection resource. Here just for show.
    */
    echo 'The connection (var_dump()): ';
    var_dump($grid->GetConnection());

    /**
    * Gets the result resource. Here just for show.
    */
    echo '<br />The result resouce (var_dump()): ';
    var_dump($grid->GetResultset());

    /**
    * The HTML. The appearance can be customised using CSS. Naturally you would (should) put
    * all of the datagrid styling in a central CSS file that can be <link>ed to by all of
    * your websites' pages. That way:
    *  o All of your datagrids will look the same
    *  o Changes to the appearance will affect all of your datagrids across your
    *    entire website. You might want this necessarily, but must do.
    *
    * eg. <link rel="stylesheet" type="text/css" media="screen" href="/css/datagrid.css" />
    */
?>
<html>
<head>
    <title>Datagrid example</title>
    
    <style type="text/css">
    <!--
        table.datagrid {
            font-family: Arial;
        }
        /**
        * Format the table headers
        */
        .datagrid thead th#header {
            background-color: #ddd;
        }

        .datagrid thead th {
            color: black;
            border-bottom: 1px solid #000;
            font-weight: bold;
            font-size: 10pt;
            font-family: Verdana;
            text-align: left;
            padding-left: 5px;
        }
        
        .datagrid thead th#header {
            border: 0;
        }
        
        /**
        * This is here to illustrate how to format the alternative rows
        */
        .datagrid tbody td.altrow {
            background-color: #fff;
        }
        
        /**
        * Format the alternative columns with a light grey background
        */
        .datagrid tbody td.altcol
        {
          background-color: #eee;
        }
        
        /**
        * Format the actions column
        */
        .datagrid tbody td.col_4 a {
            text-decoration: none;
        }

        /**
        * Format the table headers
        */
        .datagrid tbody td {
            padding-left: 5px;
        }

        /**
        * Format the mouseover
        */
        .datagrid tbody td.mouseover {
            background-color: #FFB7B7;
        }
        
        /**
        * No link underlining
        */
        .datagrid a {
            text-decoration: none;
        }
    // -->
    </style>
</head>
<body>
    <p />

    This is the datagrid. As you can see my choice of colours is not the best... They can of course be customised, using CSS.
    By studying this example.php file (the .phps anyhoo), you'll see how and what selectors are available.

    <p />

    <?$grid->Display()?>
    
    <?if(preg_match('/^\/datagrid/', $_SERVER['REQUEST_URI'])):?>
        <pre><?print_r($grid)?></pre>
    <?endif?>
</body>
</html>