xref: /plugin/struct/syntax/serial.php (revision b9d35ff22b6a99d33aa2af304df64848b7983f3c)

<?php
/**
 * DokuWiki Plugin struct (Syntax Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr, Michael Große, Anna Dabrowska <dokuwiki@cosmocode.de>
 */

use dokuwiki\plugin\struct\meta\AccessTableData;
use dokuwiki\plugin\struct\meta\SerialTable;

class syntax_plugin_struct_serial extends syntax_plugin_struct_table {

    /** @var string which class to use for output */
    protected $tableclass = SerialTable::class;

    /**
     * Connect serial pattern to lexer.
     *
     * @param string $mode Parser mode
     */
    public function connectTo($mode) {
        $this->Lexer->addSpecialPattern('----+ *struct serial *-+\n.*?\n----+', $mode, 'plugin_struct_serial');
    }

    /**
     * Handle matches of the struct syntax
     *
     * @param string $match The match of the syntax
     * @param int $state The state of the handler
     * @param int $pos The position in the document
     * @param Doku_Handler $handler The handler
     * @return array Data for the renderer
     */
    public function handle($match, $state, $pos, Doku_Handler $handler) {
        // usual parsing
        $config = parent::handle($match, $state, $pos, $handler);
        if(is_null($config)) return null;

        $config = $this->addTypeFilter($config);

        // adjust some things for the serial editor
        $config['cols'] = array('*'); // always select all columns
        if(isset($config['rownumbers'])) unset($config['rownumbers']); // this annoying to update dynamically

        return $config;
    }

    /**
     * Filter based on primary key columns
     *
     * @param array $config
     * @return array
     */
    protected function addTypeFilter($config)
    {
        $config['filter'][] = ['%rowid%', '!=', (string)AccessTableData::DEFAULT_PAGE_RID, 'AND'];
        $config['filter'][] = ['%pageid%', '!=', '', 'AND'];
        return $config;
    }
}