xref: /plugin/avbarchart/syntax.php (revision 4d2a03177d4dbcf31f8a3acff6e9765be93a8ad3)

<?php

/**
 * Plugin AVBarChart: Generates a very simple CSS/HTML bar chart
 *
 * USAGE: <barchart>MAXVAL|Label1:#,Label2:#,Label3:#</barchart>
 *
 * EXAMPLE: <barchart>100|A:55,B:5,C:23,D:38</barchart>
 *
 * With Colored Bars: <barchart>100|A:55:#FFCCCC,B:5,C:23#00FF00,D:38</barchart>
 *
 * @license    GPL-2.0 (https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
 * @author     Sherri W. (http://syntaxseed.com)
 */

if (!defined('DOKU_INC')) {
    define('DOKU_INC', realpath(dirname(__FILE__) . '/../../') . '/');
}
if (!defined('DOKU_PLUGIN')) {
    define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
}


/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_avbarchart extends DokuWiki_Syntax_Plugin
{
    // ********* CHART CONFIG SETTINGS *************
    public $barWidth = 25;         // Pixel width of chart bars.
    public $barColor = "#ccccff";  // Default color of graph bars.
    public $fontSize = "8pt;";     // Font size of labels and values.
    public $maxPxHeight = "200";   // Maximum height of the chart in pixels.
    // *********************************************

    /**
     * What kind of syntax are we?
     */
    public function getType()
    {
        return 'substition';
    }

    /**
     * Where to sort in?
     */
    public function getSort()
    {
        return 999;
    }


    /**
     * Connect pattern to lexer
     */
    public function connectTo($mode)
    {
        $this->Lexer->addEntryPattern('\<barchart\>', $mode, 'plugin_avbarchart');
    }

    public function postConnect()
    {
        $this->Lexer->addExitPattern('\</barchart\>', 'plugin_avbarchart');
    }


    /**
     * Handle the match
     */
    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        switch ($state) {
            case DOKU_LEXER_ENTER:
                return array($state, '');
            case DOKU_LEXER_MATCHED:
                break;
            case DOKU_LEXER_UNMATCHED:

                $chart = "";
                list($maxRange, $data1) = preg_split("/\|/", $match);
                $maxRange = floatval($maxRange);

                if ($maxRange > 0 && !empty($data1)) {
                    $values = preg_split("/,/", $data1);

                    $chart = "";
                    foreach ($values as $col) {
                        if (!empty($col)) {
                            $inColumn = preg_split("/:/", $col);
                            $label = $inColumn[0] ?? '';
                            $amount = $inColumn[1] ?? 0;
                            $color = $inColumn[2] ?? null;

                            $amount = floatval($amount);

                            if (empty($label)) {
                                $label = '&nbsp;';
                            } else {
                                $label = hsc($label);
                            }

                            if (empty($color)) {
                                $color = $this->barColor;
                            } else {
                                $color = hsc($color);
                            }

                            if ($amount >= 0) {
                                $height = round(($amount / $maxRange * $this->maxPxHeight));
                                $chart .= "<td valign='bottom' style='border:0;vertical-align:bottom;text-align:center;' align='center'><span style='font-size:" . $this->fontSize . ";'>" . $amount . "</span><br clear='all' /><table style='display:inline;border:0;' cellpadding='1' cellspacing='0'><tr><td height='" . $height . "' width='" . $this->barWidth . "' bgcolor='" . $color . "' valign='bottom'></td></tr></table><br clear='all' /><span style='font-size:" . $this->fontSize . ";'><b>" . $label . "</b></span></td>";
                            }
                        }
                    }
                }

                $match = $chart;
                return array($state, $match);

            case DOKU_LEXER_EXIT:
                return array($state, '');
            case DOKU_LEXER_SPECIAL:
                break;
        }
        return array();
    }


    /**
     * Create output
     */
    public function render($mode, Doku_Renderer $renderer, $data)
    {
        if ($mode == 'xhtml') {
            list($state, $match) = $data;

            switch ($state) {
                case DOKU_LEXER_ENTER:
                    $renderer->doc .= "<table border='0' cellspacing='2' style='border:0;'><tr>";
                    break;

                case DOKU_LEXER_MATCHED:
                    break;

                case DOKU_LEXER_UNMATCHED:

                    $renderer->doc .= $match;
                    break;

                case DOKU_LEXER_EXIT:
                    $renderer->doc .= "</tr></table>";
                    break;

                case DOKU_LEXER_SPECIAL:
                    break;
            }
            return true;
        }
        return false;
    }
} // End class