xref: /plugin/struct/meta/SchemaEditor.php (revision 6af24d3eff33249280549e60e18474e2cc0bf9d0)
1ae697e1fSAndreas Gohr<?php
2ae697e1fSAndreas Gohr
3ae697e1fSAndreas Gohrnamespace plugin\struct\meta;
4ae697e1fSAndreas Gohr
5ae697e1fSAndreas Gohruse dokuwiki\Form\Form;
6ae697e1fSAndreas Gohruse plugin\struct\types\Text;
7ae697e1fSAndreas Gohr
8ae697e1fSAndreas Gohr/**
9ae697e1fSAndreas Gohr * Class SchemaEditor
10ae697e1fSAndreas Gohr *
11ae697e1fSAndreas Gohr * Provides the editing interface for a given Schema as used in the admin backend. The actual modifying of the
12ae697e1fSAndreas Gohr * schema happens in the SchemaBuilder class.
13ae697e1fSAndreas Gohr *
14ae697e1fSAndreas Gohr * @package plugin\struct\meta
15ae697e1fSAndreas Gohr */
16ae697e1fSAndreas Gohrclass SchemaEditor {
17ae697e1fSAndreas Gohr    /** @var Schema the schema that is edited */
18ae697e1fSAndreas Gohr    protected $schema;
19ae697e1fSAndreas Gohr
20*6af24d3eSAndreas Gohr    /** @var \DokuWiki_Plugin  */
21*6af24d3eSAndreas Gohr    protected $hlp;
22*6af24d3eSAndreas Gohr
23ae697e1fSAndreas Gohr    /**
24ae697e1fSAndreas Gohr     * SchemaEditor constructor.
25ae697e1fSAndreas Gohr     * @param Schema $schema
26ae697e1fSAndreas Gohr     */
27ae697e1fSAndreas Gohr    public function __construct(Schema $schema) {
28ae697e1fSAndreas Gohr        $this->schema = $schema;
29*6af24d3eSAndreas Gohr        $this->hlp = plugin_load('helper', 'struct_config');
30ae697e1fSAndreas Gohr    }
31ae697e1fSAndreas Gohr
32ae697e1fSAndreas Gohr    /**
33ae697e1fSAndreas Gohr     * Returns the Admin Form to edit the schema
34ae697e1fSAndreas Gohr     *
35ae697e1fSAndreas Gohr     * This data is processed by the SchemaBuilder class
36ae697e1fSAndreas Gohr     *
37ae697e1fSAndreas Gohr     * @return string the HTML for the editor form
38ae697e1fSAndreas Gohr     * @see SchemaBuilder
39ae697e1fSAndreas Gohr     */
40ae697e1fSAndreas Gohr    public function getEditor() {
41a57a64a5SAndreas Gohr        $form = new Form(array('method' => 'POST', 'id'=>'plugin__struct'));
42ae697e1fSAndreas Gohr        $form->setHiddenField('do', 'admin');
43dbffe06eSAndreas Gohr        $form->setHiddenField('page', 'struct_schemas');
44ae697e1fSAndreas Gohr        $form->setHiddenField('table', $this->schema->getTable());
45ae697e1fSAndreas Gohr        $form->setHiddenField('schema[id]', $this->schema->getId());
46ae697e1fSAndreas Gohr
47ae697e1fSAndreas Gohr        $form->addHTML('<table class="inline">');
48*6af24d3eSAndreas Gohr        $form->addHTML("<tr>
49*6af24d3eSAndreas Gohr            <th>{$this->hlp->getLang('editor_sort')}</th>
50*6af24d3eSAndreas Gohr            <th>{$this->hlp->getLang('editor_label')}</th>
51*6af24d3eSAndreas Gohr            <th>{$this->hlp->getLang('editor_multi')}</th>
52*6af24d3eSAndreas Gohr            <th>{$this->hlp->getLang('editor_conf')}</th>
53*6af24d3eSAndreas Gohr            <th>{$this->hlp->getLang('editor_type')}</th>
54*6af24d3eSAndreas Gohr        </tr>");
55*6af24d3eSAndreas Gohr
56ae697e1fSAndreas Gohr
57ae697e1fSAndreas Gohr        foreach($this->schema->getColumns() as $key => $obj) {
58ae697e1fSAndreas Gohr            $form->addHTML($this->adminColumn($key, $obj));
59ae697e1fSAndreas Gohr        }
60ae697e1fSAndreas Gohr
61ae697e1fSAndreas Gohr        // FIXME new one needs to be added dynamically, this is just for testing
62ae697e1fSAndreas Gohr        $form->addHTML($this->adminColumn('new1', new Column($this->schema->getMaxsort()+10, new Text()), 'new'));
63ae697e1fSAndreas Gohr
64ae697e1fSAndreas Gohr        $form->addHTML('</table>');
65ae697e1fSAndreas Gohr        $form->addButton('save', 'Save')->attr('type','submit');
66a57a64a5SAndreas Gohr        return $form->toHTML() . $this->initJSONEditor();
67a57a64a5SAndreas Gohr    }
68a57a64a5SAndreas Gohr
69a57a64a5SAndreas Gohr    /**
70a57a64a5SAndreas Gohr     * Gives the code to attach the JSON editor to the config field
71a57a64a5SAndreas Gohr     *
72a57a64a5SAndreas Gohr     * We do not use the "normal" way, because this is rarely used code and there's no need to always load it.
73a57a64a5SAndreas Gohr     * @return string
74a57a64a5SAndreas Gohr     */
75a57a64a5SAndreas Gohr    protected function initJSONEditor() {
76a57a64a5SAndreas Gohr        $html = '';
77a57a64a5SAndreas Gohr        $html .= '<link href="'.DOKU_BASE.'lib/plugins/struct/jsoneditor/jsoneditor.min.css" rel="stylesheet" type="text/css">';
78a57a64a5SAndreas Gohr        $html .= '<link href="'.DOKU_BASE.'lib/plugins/struct/jsoneditor/setup.css" rel="stylesheet" type="text/css">';
79a57a64a5SAndreas Gohr        $html .= '<script src="'.DOKU_BASE.'lib/plugins/struct/jsoneditor/jsoneditor-minimalist.min.js"></script>';
80a57a64a5SAndreas Gohr        $html .= '<script src="'.DOKU_BASE.'lib/plugins/struct/jsoneditor/setup.js"></script>';
81a57a64a5SAndreas Gohr        return $html;
82ae697e1fSAndreas Gohr    }
83ae697e1fSAndreas Gohr
84ae697e1fSAndreas Gohr    /**
85ae697e1fSAndreas Gohr     * Returns the HTML to edit a single column definition of the schema
86ae697e1fSAndreas Gohr     *
87ae697e1fSAndreas Gohr     * @param string $column_id
88ae697e1fSAndreas Gohr     * @param Column $col
89ae697e1fSAndreas Gohr     * @param string $key The key to use in the form
90ae697e1fSAndreas Gohr     * @return string
91ae697e1fSAndreas Gohr     * @todo this should probably be reused for adding new columns via AJAX later?
92ae697e1fSAndreas Gohr     */
93ae697e1fSAndreas Gohr    protected function adminColumn($column_id, Column $col, $key='cols') {
94ae697e1fSAndreas Gohr        $base = 'schema['.$key.'][' . $column_id . ']'; // base name for all fields
95ae697e1fSAndreas Gohr
96ae697e1fSAndreas Gohr        $html = '<tr>';
97ae697e1fSAndreas Gohr
98ae697e1fSAndreas Gohr        $html .= '<td>';
99ae697e1fSAndreas Gohr        $html .= '<input type="text" name="' . $base . '[sort]" value="' . hsc($col->getSort()) . '" size="3">';
100ae697e1fSAndreas Gohr        $html .= '</td>';
101ae697e1fSAndreas Gohr
102ae697e1fSAndreas Gohr        $html .= '<td>';
103ae697e1fSAndreas Gohr        $html .= '<input type="text" name="' . $base . '[label]" value="' . hsc($col->getType()->getLabel()) . '">';
104ae697e1fSAndreas Gohr        $html .= '</td>';
105ae697e1fSAndreas Gohr
106ae697e1fSAndreas Gohr        $html .= '<td>';
107ae697e1fSAndreas Gohr        $checked = $col->getType()->isMulti() ? 'checked="checked"' : '';
108ae697e1fSAndreas Gohr        $html .= '<input type="checkbox" name="' . $base . '[ismulti]" value="1" ' . $checked . '>';
109ae697e1fSAndreas Gohr        $html .= '</td>';
110ae697e1fSAndreas Gohr
111ae697e1fSAndreas Gohr        $html .= '<td>';
112ae697e1fSAndreas Gohr        $config = json_encode($col->getType()->getConfig(), JSON_PRETTY_PRINT);
113a57a64a5SAndreas Gohr        $html .= '<textarea name="' . $base . '[config]" cols="45" rows="10" class="config">' . hsc($config) . '</textarea>';
114ae697e1fSAndreas Gohr        $html .= '</td>';
115ae697e1fSAndreas Gohr
116ae697e1fSAndreas Gohr        $types = Column::allTypes();
117ae697e1fSAndreas Gohr        $html .= '<td>';
118ae697e1fSAndreas Gohr        $html .= '<select name="' . $base . '[class]">';
119ae697e1fSAndreas Gohr        foreach($types as $type) {
120ae697e1fSAndreas Gohr            $selected = ($col->getType()->getClass() == $type) ? 'selected="selected"' : '';
121ae697e1fSAndreas Gohr            $html .= '<option value="' . hsc($type) . '" ' . $selected . '>' . hsc($type) . '</option>';
122ae697e1fSAndreas Gohr        }
123ae697e1fSAndreas Gohr        $html .= '</select>';
124ae697e1fSAndreas Gohr        $html .= '</td>';
125ae697e1fSAndreas Gohr
126ae697e1fSAndreas Gohr        $html .= '</tr>';
127ae697e1fSAndreas Gohr
128ae697e1fSAndreas Gohr        return $html;
129ae697e1fSAndreas Gohr    }
130ae697e1fSAndreas Gohr
131ae697e1fSAndreas Gohr}
132