webdivane / table

table.php

<?php

/** Note: table::prepare() - call must come before `headers_sent()`;
 *     1. Create (initial setup):
 *        <code>table::create('tableId', 'sortByDbCol', 'sortDirection');</code>
 *     1.1. Set columns to be displayed: <code>
 *          table::$cols[] = ['innerHtml', 'dbColumn|Name',
 *                                      ['width'=>'?px','sort'=>false]];</code>
 *     2. Execute (data query)
 *        <code>table::execute(sqlQuery);</code>
 *     2.1. Alter loaded data, before table load <code>
 *          foreach(table::$data as $r => &$cells){
 *              $cells['id'] = $cells['id']==3 ?
 *                              [$cells['id'] ,['class'=>'red']] : $cells['id'];
 *          }</code>
 *     3. Loads the markup, or json data (on sort/page/export etc. actions).
 *        <code>table::load();</code> */
class table extends table_getter
{
    /** @param string class name, where $helper::prepare() is expected */
    public static $helper_class;
    /** @param closure to MySql select function (example: db::select()) */
    public static $select;

    /** #1. Create (setup)
     * @param string $items - The items name
     * @param string $orderBy - a db column name
     * @param string $orderDir - (Default: self::DEFAULT_SORT_ORDER)
     * @param int $paging - Rows per page */
    public static function create(
            $items,
            $orderBy,
            $orderDir = 'asc',
            $paging = 10
    )
    {
        self::reset((self::$t['items'] = $items));
        self::prepare(true);
        self::$t['order']['col'] = $orderBy;
        $dir = strtolower($orderDir);
        self::$t['order']['dir'] = in_array($dir, ['asc', 'desc']) ?
                $dir : self::err('Invalid orderDir (Asc/Desc): ' . $orderDir);
        self::$t['paging'] = ($p = abs($paging)) > 10 ?
                $p : self::err('Invalid paging (>10): ' . $paging);
    }

    /** #2. Execute (queries)
     * @param string $q - query for the table data;
     * @param (null)|string $qTotal - simple version of $sql if applicable
     * (used only for Total count in the table footer).<br>
     * Example: <pre>$sql = 'SELECT `id`, ... FROM `table` WHERE ...'</pre>
     * For query to many thousands results, will be faster to have:
     * <pre>$sqlTotals = 'SELECT `id` FROM `table` WHERE ...'</pre> */
    public static function execute($q, $qTotal = null)
    {
        self::$t['order']['col'] = self::requestOrderCol();
        self::$t['order']['dir'] = self::requestOrderDir();
        self::$t['page'] = self::requestPage();
        self::$export = self::requestExport();

        $filter = self::requestFilter();
        $order = [self::$t['order']['col'] => self::$t['order']['dir']];
        $offset = (self::$t['page'] - 1) * self::$t['paging'];
        $limit = [$offset, self::$t['paging']];
        self::$t['q'] = self::q($q, $filter, $order, $limit, true);

        $qAll = isset($qTotal) && !$filter ? $qTotal : $q;
        $orderAll = !self::$export ? [] : $order;
        self::$t['qAll'] = self::q($qAll, $filter, $orderAll, 0, true);

        $query = !self::$export ? self::$t['q'] : self::$t['qAll'];

        try {
            self::$data = self::select($query);
        } catch (Exception $e) {
            self::err('ERROR: ' . $q . '<br />' . $e->getMessage());
        }
    }

    /** #3. Loads output (html, json or csv file) */
    public static function load()
    {
        if (self::$pageExt !== 'json') {
            echo parent::load();
        } else {
            ob_get_clean();
            $tableId = filter_input(INPUT_GET, 'table-id') ?: null;
            if ($tableId === self::$t['items'] . '-table') {
                if (!self::$export) {
                    header('Content-Type: application/json');
                    $jsonArr = ['body' => self::jsonGetBodyData(),
                        'footer' => self::jsonGetFooterData()];
                    die(json_encode($jsonArr));

Using exit here is not recommended.

                } else {
                    self::exportData();
                }
            }
        }
    }

    /** Adds needed JavaScript and CSS into the page header, it has to be
     * included before "headers_sent()"
     * @param str|bool $setOrCheck - uses helper class to verify own load */
    public static function prepare($setOrCheck = false)
    {
        //@see  http://php.net/manual/es/function.filter-input.php#77307
        $uri = filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL) ?:
                filter_var($_SERVER['REQUEST_URI'], FILTER_SANITIZE_URL);

        $extension = pathinfo(strtok($uri, '?'), PATHINFO_EXTENSION);

        self::$t['slug'] = pathinfo($uri, PATHINFO_BASENAME);
        self::$pageExt = strtolower($extension);

        if (self::$helper_class::prepare(__METHOD__, $setOrCheck) !== true) {
            if (self::$pageExt === 'json' && !isset(self::$t['prepared'])) {
                ob_start();
                self::$t['prepared'] = true;
            }
        }
    }
}