admin_plugin_config::addLang() - Code Metrics - Inspection of "moved language loading to the loader" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — psr2-config ( 077c27...5675a0 )

by Andreas

created 2018-05-12 07:11 UTC

admin_plugin_config::addLang() A

↳ Parent: admin_plugin_config

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	2
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Configuration Manager admin plugin
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Christopher Smith <[email protected]>
 * @author     Ben Coburn <[email protected]>
 */

use dokuwiki\plugin\config\core\Configuration;
use dokuwiki\plugin\config\core\Setting;
use dokuwiki\plugin\config\core\SettingFieldset;
use dokuwiki\plugin\config\core\SettingHidden;

/**
 * All DokuWiki plugins to extend the admin function
 * need to inherit from this class
 */
class admin_plugin_config extends DokuWiki_Admin_Plugin {

    const METADATA = __DIR__ . 'settings/config.metadata.php';
    const IMGDIR = DOKU_BASE . 'lib/plugins/config/images/';

    protected $_localised_prompts = false;

    /** @var Configuration */
    protected $configuration;

    /**
     * admin_plugin_config constructor.
     */
    public function __construct() {
        $this->configuration = new Configuration();
    }

    /**
     * handle user request
     */
    public function handle() {
        global $ID, $INPUT;

        if(!$INPUT->bool('save') || !checkSecurityToken()) {
            return;
        }

        // don't go any further if the configuration is locked
        if($this->configuration->isLocked()) return;

        // update settings and redirect of successful
        $ok = $this->configuration->updateSettings($INPUT->arr('config'));
        if($ok) { // no errors
            try {
                if($this->configuration->hasChanged()) {
                    $this->configuration->save();
                } else {
                    $this->configuration->touch();
                }
                msg($this->getLang('updated'), -1);
            } catch(Exception $e) {
                msg($this->getLang('error'), -1);
            }
            send_redirect(wl($ID, array('do' => 'admin', 'page' => 'config'), true, '&'));
        }
    }

    /**
     * output appropriate html
     */
    public function html() {
        $allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
        global $lang;
        global $ID;

        $this->setupLocale(true);

        print $this->locale_xhtml('intro');

        ptln('<div id="config__manager">');

        if($this->configuration->isLocked()) {
            ptln('<div class="info">' . $this->getLang('locked') . '</div>');
        }

        // POST to script() instead of wl($ID) so config manager still works if
        // rewrite config is broken. Add $ID as hidden field to remember
        // current ID in most cases.
        ptln('<form action="' . script() . '" method="post">');
        ptln('<div class="no"><input type="hidden" name="id" value="' . $ID . '" /></div>');
        formSecurityToken();
        $this->_print_h1('dokuwiki_settings', $this->getLang('_header_dokuwiki'));

        $in_fieldset = false;
        $first_plugin_fieldset = true;
        $first_template_fieldset = true;
        foreach($this->configuration->getSettings() as $setting) {
            if(is_a($setting, SettingHidden::class)) {
                continue;
            } else if(is_a($setting, settingFieldset::class)) {
                // config setting group
                if($in_fieldset) {
                    ptln('  </table>');
                    ptln('  </div>');
                    ptln('  </fieldset>');
                } else {
                    $in_fieldset = true;
                }
                // fixme this should probably be a function in setting:
                if($first_plugin_fieldset && substr($setting->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
                    $this->_print_h1('plugin_settings', $this->getLang('_header_plugin'));
                    $first_plugin_fieldset = false;
                } else if($first_template_fieldset && substr($setting->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
                    $this->_print_h1('template_settings', $this->getLang('_header_template'));
                    $first_template_fieldset = false;
                }
                ptln('  <fieldset id="' . $setting->getKey() . '">');
                ptln('  <legend>' . $setting->prompt($this) . '</legend>');
                ptln('  <div class="table">');
                ptln('  <table class="inline">');
            } else {
                // config settings
                list($label, $input) = $setting->html($this, $this->_error);
class MyClass { }

$x = new MyClass();
$x->foo = true;

                $class = $setting->is_default()
                    ? ' class="default"'
                    : ($setting->is_protected() ? ' class="protected"' : '');
                $error = $setting->error()
                    ? ' class="value error"'
                    : ' class="value"';
                $icon = $setting->caution()
                    ? '<img src="' . self::IMGDIR . $setting->caution() . '.png" ' .
                    'alt="' . $setting->caution() . '" title="' . $this->getLang($setting->caution()) . '" />'
                    : '';

                ptln('    <tr' . $class . '>');
                ptln('      <td class="label">');
                ptln('        <span class="outkey">' . $setting->_out_key(true, true) . '</span>');
                ptln('        ' . $icon . $label);
                ptln('      </td>');
                ptln('      <td' . $error . '>' . $input . '</td>');
                ptln('    </tr>');
            }
        }

        ptln('  </table>');
        ptln('  </div>');
        if($in_fieldset) {
            ptln('  </fieldset>');
        }

        // show undefined settings list
        $undefined_settings = $this->configuration->getUndefined();
        if($allow_debug && !empty($undefined_settings)) {
            /**
             * Callback for sorting settings
             *
             * @param Setting $a
             * @param Setting $b
             * @return int if $a is lower/equal/higher than $b
             */
            function _setting_natural_comparison($a, $b) {
                return strnatcmp($a->getKey(), $b->getKey());
            }

            usort($undefined_settings, '_setting_natural_comparison');
            $this->_print_h1('undefined_settings', $this->getLang('_header_undefined'));
            ptln('<fieldset>');
            ptln('<div class="table">');
            ptln('<table class="inline">');
            $undefined_setting_match = array();
            foreach($undefined_settings as $setting) {
                if(
                preg_match(
                    '/^(?:plugin|tpl)' . Configuration::KEYMARKER . '.*?' . Configuration::KEYMARKER . '(.*)$/',
                    $setting->getKey(),
                    $undefined_setting_match
                )
                ) {
                    $undefined_setting_key = $undefined_setting_match[1];
                } else {
                    $undefined_setting_key = $setting->getKey();
                }
                ptln('  <tr>');
                ptln(
                    '    <td class="label"><span title="$meta[\'' . $undefined_setting_key . '\']">$' .
                    'conf' . '[\'' . $setting->_out_key() . '\']</span></td>'
                );
                ptln('    <td>' . $this->getLang('_msg_' . get_class($setting)) . '</td>');
                ptln('  </tr>');
            }
            ptln('</table>');
            ptln('</div>');
            ptln('</fieldset>');
        }

        // finish up form
        ptln('<p>');
        ptln('  <input type="hidden" name="do"     value="admin" />');
        ptln('  <input type="hidden" name="page"   value="config" />');

        if(!$this->configuration->isLocked()) {
            ptln('  <input type="hidden" name="save"   value="1" />');
            ptln('  <button type="submit" name="submit" accesskey="s">' . $lang['btn_save'] . '</button>');
            ptln('  <button type="reset">' . $lang['btn_reset'] . '</button>');
        }

        ptln('</p>');

        ptln('</form>');
        ptln('</div>');
    }

    /**
     * @param bool $prompts
     */
    public function setupLocale($prompts = false) {
        parent::setupLocale();
        if(!$prompts || $this->_localised_prompts) return;
        $this->configuration->getLangs();
        $this->_localised_prompts = true;
    }

    /**
     * Generates a two-level table of contents for the config plugin.
     *
     * @author Ben Coburn <[email protected]>
     *
     * @return array
     */
    public function getTOC() {
        $this->setupLocale(true);

        $allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.

        // gather toc data
        $toc = array('conf' => array(), 'plugin' => array(), 'template' => null);
        foreach($this->configuration->getSettings() as $setting) {
            if(is_a($setting, 'setting_fieldset')) {
                // FIXME as above this should go into Setting class
                if(substr($setting->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
                    $toc['plugin'][] = $setting;
                } else if(substr($setting->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
                    $toc['template'] = $setting;
                } else {
                    $toc['conf'][] = $setting;
                }
            }
        }

        // build toc
        $t = array();

        $check = false;
        $title = $this->getLang('_configuration_manager');
        $t[] = html_mktocitem(sectionID($title, $check), $title, 1);
        $t[] = html_mktocitem('dokuwiki_settings', $this->getLang('_header_dokuwiki'), 1);
        /** @var setting $setting */
        foreach($toc['conf'] as $setting) {
            $name = $setting->prompt($this);
            $t[] = html_mktocitem($setting->getKey(), $name, 2);
        }
        if(!empty($toc['plugin'])) {
            $t[] = html_mktocitem('plugin_settings', $this->getLang('_header_plugin'), 1);
        }
        foreach($toc['plugin'] as $setting) {
            $name = $setting->prompt($this);
            $t[] = html_mktocitem($setting->getKey(), $name, 2);
        }
        if(isset($toc['template'])) {
            $t[] = html_mktocitem('template_settings', $this->getLang('_header_template'), 1);
            $setting = $toc['template'];
            $name = $setting->prompt($this);
            $t[] = html_mktocitem($setting->getKey(), $name, 2);
        }
        if(count($this->configuration->getUndefined()) && $allow_debug) {
            $t[] = html_mktocitem('undefined_settings', $this->getLang('_header_undefined'), 1);
        }

        return $t;
    }

    /**
     * @param string $id
     * @param string $text
     */
    protected function _print_h1($id, $text) {
        ptln('<h1 id="' . $id . '">' . $text . '</h1>');
    }

    /**
     * Adds a translation to this plugin's language array
     *
     * @param string $key
     * @param string $value
     */
    public function addLang($key, $value) {
        if(!$this->localised) $this->setupLocale();
        $this->lang[$key] = $value;
    }
}


1			<?php
2			/**
3			* Configuration Manager admin plugin
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Christopher Smith <[email protected]>
7			* @author Ben Coburn <[email protected]>
8			*/
9
10			use dokuwiki\plugin\config\core\Configuration;
11			use dokuwiki\plugin\config\core\Setting;
12			use dokuwiki\plugin\config\core\SettingFieldset;
13			use dokuwiki\plugin\config\core\SettingHidden;
14
15			/**
16			* All DokuWiki plugins to extend the admin function
17			* need to inherit from this class
18			*/
19			class admin_plugin_config extends DokuWiki_Admin_Plugin {
20
21			const METADATA = __DIR__ . 'settings/config.metadata.php';
22			const IMGDIR = DOKU_BASE . 'lib/plugins/config/images/';
23
24			protected $_localised_prompts = false;
25
26			/** @var Configuration */
27			protected $configuration;
28
29			/**
30			* admin_plugin_config constructor.
31			*/
32			public function __construct() {
33			$this->configuration = new Configuration();
34			}
35
36			/**
37			* handle user request
38			*/
39			public function handle() {
40			global $ID, $INPUT;
41
42			if(!$INPUT->bool('save') \|\| !checkSecurityToken()) {
43			return;
44			}
45
46			// don't go any further if the configuration is locked
47			if($this->configuration->isLocked()) return;
48
49			// update settings and redirect of successful
50			$ok = $this->configuration->updateSettings($INPUT->arr('config'));
51			if($ok) { // no errors
52			try {
53			if($this->configuration->hasChanged()) {
54			$this->configuration->save();
55			} else {
56			$this->configuration->touch();
57			}
58			msg($this->getLang('updated'), -1);
59			} catch(Exception $e) {
60			msg($this->getLang('error'), -1);
61			}
62			send_redirect(wl($ID, array('do' => 'admin', 'page' => 'config'), true, '&'));
63			}
64			}
65
66			/**
67			* output appropriate html
68			*/
69			public function html() {
70			$allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
71			global $lang;
72			global $ID;
73
74			$this->setupLocale(true);
75
76			print $this->locale_xhtml('intro');
77
78			ptln('<div id="config__manager">');
79
80			if($this->configuration->isLocked()) {
81			ptln('<div class="info">' . $this->getLang('locked') . '</div>');
82			}
83
84			// POST to script() instead of wl($ID) so config manager still works if
85			// rewrite config is broken. Add $ID as hidden field to remember
86			// current ID in most cases.
87			ptln('<form action="' . script() . '" method="post">');
88			ptln('<div class="no"><input type="hidden" name="id" value="' . $ID . '" /></div>');
89			formSecurityToken();
90			$this->_print_h1('dokuwiki_settings', $this->getLang('_header_dokuwiki'));
91
92			$in_fieldset = false;
93			$first_plugin_fieldset = true;
94			$first_template_fieldset = true;
95			foreach($this->configuration->getSettings() as $setting) {
96			if(is_a($setting, SettingHidden::class)) {
97			continue;
98			} else if(is_a($setting, settingFieldset::class)) {
99			// config setting group
100			if($in_fieldset) {
101			ptln(' </table>');
102			ptln(' </div>');
103			ptln(' </fieldset>');
104			} else {
105			$in_fieldset = true;
106			}
107			// fixme this should probably be a function in setting:
108			if($first_plugin_fieldset && substr($setting->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
109			$this->_print_h1('plugin_settings', $this->getLang('_header_plugin'));
110			$first_plugin_fieldset = false;
111			} else if($first_template_fieldset && substr($setting->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
112			$this->_print_h1('template_settings', $this->getLang('_header_template'));
113			$first_template_fieldset = false;
114			}
115			ptln(' <fieldset id="' . $setting->getKey() . '">');
116			ptln(' <legend>' . $setting->prompt($this) . '</legend>');
117			ptln(' <div class="table">');
118			ptln(' <table class="inline">');
119			} else {
120			// config settings
121			list($label, $input) = $setting->html($this, $this->_error);
			0 ignored issues – show Bug introduced 2018-05-11 22:24 UTC by Report Bug Copy Issue Report The property `_error` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
122
123			$class = $setting->is_default()
124			? ' class="default"'
125			: ($setting->is_protected() ? ' class="protected"' : '');
126			$error = $setting->error()
127			? ' class="value error"'
128			: ' class="value"';
129			$icon = $setting->caution()
130			? '<img src="' . self::IMGDIR . $setting->caution() . '.png" ' .
131			'alt="' . $setting->caution() . '" title="' . $this->getLang($setting->caution()) . '" />'
132			: '';
133
134			ptln(' <tr' . $class . '>');
135			ptln(' <td class="label">');
136			ptln(' <span class="outkey">' . $setting->_out_key(true, true) . '</span>');
137			ptln(' ' . $icon . $label);
138			ptln(' </td>');
139			ptln(' <td' . $error . '>' . $input . '</td>');
140			ptln(' </tr>');
141			}
142			}
143
144			ptln(' </table>');
145			ptln(' </div>');
146			if($in_fieldset) {
147			ptln(' </fieldset>');
148			}
149
150			// show undefined settings list
151			$undefined_settings = $this->configuration->getUndefined();
152			if($allow_debug && !empty($undefined_settings)) {
153			/**
154			* Callback for sorting settings
155			*
156			* @param Setting $a
157			* @param Setting $b
158			* @return int if $a is lower/equal/higher than $b
159			*/
160			function _setting_natural_comparison($a, $b) {
161			return strnatcmp($a->getKey(), $b->getKey());
162			}
163
164			usort($undefined_settings, '_setting_natural_comparison');
165			$this->_print_h1('undefined_settings', $this->getLang('_header_undefined'));
166			ptln('<fieldset>');
167			ptln('<div class="table">');
168			ptln('<table class="inline">');
169			$undefined_setting_match = array();
170			foreach($undefined_settings as $setting) {
171			if(
172			preg_match(
173			'/^(?:plugin\|tpl)' . Configuration::KEYMARKER . '.?' . Configuration::KEYMARKER . '(.)$/',
174			$setting->getKey(),
175			$undefined_setting_match
176			)
177			) {
178			$undefined_setting_key = $undefined_setting_match[1];
179			} else {
180			$undefined_setting_key = $setting->getKey();
181			}
182			ptln(' <tr>');
183			ptln(
184			' <td class="label"><span title="$meta[\'' . $undefined_setting_key . '\']">$' .
185			'conf' . '[\'' . $setting->_out_key() . '\']</span></td>'
186			);
187			ptln(' <td>' . $this->getLang('_msg_' . get_class($setting)) . '</td>');
188			ptln(' </tr>');
189			}
190			ptln('</table>');
191			ptln('</div>');
192			ptln('</fieldset>');
193			}
194
195			// finish up form
196			ptln('<p>');
197			ptln(' <input type="hidden" name="do" value="admin" />');
198			ptln(' <input type="hidden" name="page" value="config" />');
199
200			if(!$this->configuration->isLocked()) {
201			ptln(' <input type="hidden" name="save" value="1" />');
202			ptln(' <button type="submit" name="submit" accesskey="s">' . $lang['btn_save'] . '</button>');
203			ptln(' <button type="reset">' . $lang['btn_reset'] . '</button>');
204			}
205
206			ptln('</p>');
207
208			ptln('</form>');
209			ptln('</div>');
210			}
211
212			/**
213			* @param bool $prompts
214			*/
215			public function setupLocale($prompts = false) {
216			parent::setupLocale();
217			if(!$prompts \|\| $this->_localised_prompts) return;
218			$this->configuration->getLangs();
219			$this->_localised_prompts = true;
220			}
221
222			/**
223			* Generates a two-level table of contents for the config plugin.
224			*
225			* @author Ben Coburn <[email protected]>
226			*
227			* @return array
228			*/
229			public function getTOC() {
230			$this->setupLocale(true);
231
232			$allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
233
234			// gather toc data
235			$toc = array('conf' => array(), 'plugin' => array(), 'template' => null);
236			foreach($this->configuration->getSettings() as $setting) {
237			if(is_a($setting, 'setting_fieldset')) {
238			// FIXME as above this should go into Setting class
239			if(substr($setting->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
240			$toc['plugin'][] = $setting;
241			} else if(substr($setting->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
242			$toc['template'] = $setting;
243			} else {
244			$toc['conf'][] = $setting;
245			}
246			}
247			}
248
249			// build toc
250			$t = array();
251
252			$check = false;
253			$title = $this->getLang('_configuration_manager');
254			$t[] = html_mktocitem(sectionID($title, $check), $title, 1);
255			$t[] = html_mktocitem('dokuwiki_settings', $this->getLang('_header_dokuwiki'), 1);
256			/** @var setting $setting */
257			foreach($toc['conf'] as $setting) {
258			$name = $setting->prompt($this);
259			$t[] = html_mktocitem($setting->getKey(), $name, 2);
260			}
261			if(!empty($toc['plugin'])) {
262			$t[] = html_mktocitem('plugin_settings', $this->getLang('_header_plugin'), 1);
263			}
264			foreach($toc['plugin'] as $setting) {
265			$name = $setting->prompt($this);
266			$t[] = html_mktocitem($setting->getKey(), $name, 2);
267			}
268			if(isset($toc['template'])) {
269			$t[] = html_mktocitem('template_settings', $this->getLang('_header_template'), 1);
270			$setting = $toc['template'];
271			$name = $setting->prompt($this);
272			$t[] = html_mktocitem($setting->getKey(), $name, 2);
273			}
274			if(count($this->configuration->getUndefined()) && $allow_debug) {
275			$t[] = html_mktocitem('undefined_settings', $this->getLang('_header_undefined'), 1);
276			}
277
278			return $t;
279			}
280
281			/**
282			* @param string $id
283			* @param string $text
284			*/
285			protected function _print_h1($id, $text) {
286			ptln('<h1 id="' . $id . '">' . $text . '</h1>');
287			}
288
289			/**
290			* Adds a translation to this plugin's language array
291			*
292			* @param string $key
293			* @param string $value
294			*/
295			public function addLang($key, $value) {
296			if(!$this->localised) $this->setupLocale();
297			$this->lang[$key] = $value;
298			}
299			}
300

splitbrain / dokuwiki

Push — psr2-config ( 077c27...5675a0 )

admin_plugin_config::addLang() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like