Setting::prompt() - Code Metrics - Inspection of "Moved settings to their own namespace" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2-config ( de33cd...0a5b05 )

by Andreas

created 2018-05-18 12:57 UTC

Setting::prompt() A

↳ Parent: Setting

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0

<?php


namespace dokuwiki\plugin\config\core\Setting;
use dokuwiki\plugin\config\core\Configuration;

/**
 * Class Setting
 */
class Setting {
    /** @var string unique identifier of this setting */
    protected $key = '';

    /** @var mixed the default value of this setting */
    protected $default = null;
    /** @var mixed the local value of this setting */
    protected $local = null;
    /** @var mixed the protected value of this setting */
    protected $protected = null;

    /** @var array valid alerts, images matching the alerts are in the plugin's images directory */
    static protected $validCautions = array('warning', 'danger', 'security');

    protected $pattern = '';
    protected $error = false;            // only used by those classes which error check
    protected $input = null;             // only used by those classes which error check
    protected $caution = null;           // used by any setting to provide an alert along with the setting

    /**
     * Constructor.
     *
     * The given parameters will be set up as class properties
     *
     * @param string $key
     * @param array|null $params array with metadata of setting
     */
    public function __construct($key, $params = null) {
        $this->key = $key;

        if(is_array($params)) {
            foreach($params as $property => $value) {
                $property = trim($property, '_'); // we don't use underscores anymore
                $this->$property = $value;
            }
        }
    }

    /**
     * Receives current values for the setting $key
     *
     * @param mixed $default default setting value
     * @param mixed $local local setting value
     * @param mixed $protected protected setting value
     */
    public function initialize($default, $local, $protected) {
        if(isset($default)) $this->default = $default;
        if(isset($local)) $this->local = $local;
        if(isset($protected)) $this->protected = $protected;
    }

    /**
     * Should this type of config have a default?
     *
     * @return bool
     */
    public function shouldHaveDefault() {
        return true;
    }

    /**
     * Get this setting's unique key
     *
     * @return string
     */
    public function getKey() {
        return $this->key;
    }

    /**
     * Get the key of this setting marked up human readable
     *
     * @param bool $url link to dokuwiki.org manual?
     * @return string
     */
    public function getPrettyKey($url = true) {
        $out = str_replace(Configuration::KEYMARKER, "»", $this->key);
        if($url && !strstr($out, '»')) {//provide no urls for plugins, etc.
            if($out == 'start') {
                // exception, because this config name is clashing with our actual start page
                return '<a href="http://www.dokuwiki.org/config:startpage">' . $out . '</a>';
            } else {
                return '<a href="http://www.dokuwiki.org/config:' . $out . '">' . $out . '</a>';
            }
        }
        return $out;
    }

    /**
     * Returns setting key as an array key separator
     *
     * This is used to create form output
     *
     * @return string key
     */
    public function getArrayKey() {
        return str_replace(Configuration::KEYMARKER, "']['", $this->key);
    }

    /**
     * What type of configuration is this
     *
     * Returns one of
     *
     * 'plugin' for plugin configuration
     * 'template' for template configuration
     * 'conf' for core configuration
     *
     * @return string
     */
    public function getType() {
        if(substr($this->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
            return 'plugin';
        } else if(substr($this->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
            return 'template';
        } else {
            return 'conf';
        }
    }

    /**
     * update changed setting with user provided value $input
     * - if changed value fails error check, save it to $this->_input (to allow echoing later)
     * - if changed value passes error check, set $this->_local to the new value
     *
     * @param  mixed $input the new value
     * @return boolean          true if changed, false otherwise (also on error)
     */
    public function update($input) {
        if(is_null($input)) return false;
        if($this->isProtected()) return false;

        $value = is_null($this->local) ? $this->default : $this->local;
        if($value == $input) return false;

        if($this->pattern && !preg_match($this->pattern, $input)) {
            $this->error = true;
            $this->input = $input;
            return false;
        }

        $this->local = $input;
        return true;
    }

    /**
     * Build html for label and input of setting
     *
     * @param \admin_plugin_config $plugin object of config plugin
     * @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
     * @return string[] with content array(string $label_html, string $input_html)
     */
    public function html(\admin_plugin_config $plugin, $echo = false) {
        $disable = '';

        if($this->isProtected()) {
            $value = $this->protected;
            $disable = 'disabled="disabled"';
        } else {
            if($echo && $this->error) {
                $value = $this->input;
            } else {
                $value = is_null($this->local) ? $this->default : $this->local;
            }
        }

        $key = htmlspecialchars($this->key);
        $value = formText($value);

        $label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
        $input = '<textarea rows="3" cols="40" id="config___' . $key .
            '" name="config[' . $key . ']" class="edit" ' . $disable . '>' . $value . '</textarea>';
        return array($label, $input);
    }

    /**
     * Generate string to save setting value to file according to $fmt
     *
     * @param string $var name of variable
     * @param string $fmt save format
     * @return string
     */
    public function out($var, $fmt = 'php') {

        if($this->isProtected()) return '';
        if(is_null($this->local) || ($this->default == $this->local)) return '';

        $out = '';

        if($fmt == 'php') {
            $tr = array("\\" => '\\\\', "'" => '\\\'');

            $out = '$' . $var . "['" . $this->getArrayKey() . "'] = '" . strtr(cleanText($this->local), $tr) . "';\n";
        }

        return $out;
    }

    /**
     * Returns the localized prompt
     *
     * @param \admin_plugin_config $plugin object of config plugin
     * @return string text
     */
    public function prompt(\admin_plugin_config $plugin) {
        $prompt = $plugin->getLang($this->key);
        if(!$prompt) $prompt = htmlspecialchars(str_replace(array('____', '_'), ' ', $this->key));
        return $prompt;
    }

    /**
     * Is setting protected
     *
     * @return bool
     */
    public function isProtected() {
        return !is_null($this->protected);
    }

    /**
     * Is setting the default?
     *
     * @return bool
     */
    public function isDefault() {
        return !$this->isProtected() && is_null($this->local);
    }

    /**
     * Has an error?
     *
     * @return bool
     */
    public function hasError() {
        return $this->error;
    }

    /**
     * Returns caution
     *
     * @return false|string caution string, otherwise false for invalid caution
     */
    public function caution() {
        if(!empty($this->caution)) {
            if(!in_array($this->caution, Setting::$validCautions)) {
                trigger_error(
                    'Invalid caution string (' . $this->caution . ') in metadata for setting "' . $this->key . '"',
                    E_USER_WARNING
                );
                return false;
            }
            return $this->caution;
        }
        // compatibility with previous cautionList
        // TODO: check if any plugins use; remove
        if(!empty($this->cautionList[$this->key])) {

            $this->caution = $this->cautionList[$this->key];

            unset($this->cautionList);

            return $this->caution();
        }
        return false;
    }

}


1			<?php
2
3
4			namespace dokuwiki\plugin\config\core\Setting;
5			use dokuwiki\plugin\config\core\Configuration;
6
7			/**
8			* Class Setting
9			*/
10			class Setting {
11			/** @var string unique identifier of this setting */
12			protected $key = '';
13
14			/** @var mixed the default value of this setting */
15			protected $default = null;
16			/** @var mixed the local value of this setting */
17			protected $local = null;
18			/** @var mixed the protected value of this setting */
19			protected $protected = null;
20
21			/** @var array valid alerts, images matching the alerts are in the plugin's images directory */
22			static protected $validCautions = array('warning', 'danger', 'security');
23
24			protected $pattern = '';
25			protected $error = false; // only used by those classes which error check
26			protected $input = null; // only used by those classes which error check
27			protected $caution = null; // used by any setting to provide an alert along with the setting
28
29			/**
30			* Constructor.
31			*
32			* The given parameters will be set up as class properties
33			*
34			* @param string $key
35			* @param array\|null $params array with metadata of setting
36			*/
37			public function __construct($key, $params = null) {
38			$this->key = $key;
39
40			if(is_array($params)) {
41			foreach($params as $property => $value) {
42			$property = trim($property, '_'); // we don't use underscores anymore
43			$this->$property = $value;
44			}
45			}
46			}
47
48			/**
49			* Receives current values for the setting $key
50			*
51			* @param mixed $default default setting value
52			* @param mixed $local local setting value
53			* @param mixed $protected protected setting value
54			*/
55			public function initialize($default, $local, $protected) {
56			if(isset($default)) $this->default = $default;
57			if(isset($local)) $this->local = $local;
58			if(isset($protected)) $this->protected = $protected;
59			}
60
61			/**
62			* Should this type of config have a default?
63			*
64			* @return bool
65			*/
66			public function shouldHaveDefault() {
67			return true;
68			}
69
70			/**
71			* Get this setting's unique key
72			*
73			* @return string
74			*/
75			public function getKey() {
76			return $this->key;
77			}
78
79			/**
80			* Get the key of this setting marked up human readable
81			*
82			* @param bool $url link to dokuwiki.org manual?
83			* @return string
84			*/
85			public function getPrettyKey($url = true) {
86			$out = str_replace(Configuration::KEYMARKER, "»", $this->key);
87			if($url && !strstr($out, '»')) {//provide no urls for plugins, etc.
88			if($out == 'start') {
89			// exception, because this config name is clashing with our actual start page
90			return '<a href="http://www.dokuwiki.org/config:startpage">' . $out . '</a>';
91			} else {
92			return '<a href="http://www.dokuwiki.org/config:' . $out . '">' . $out . '</a>';
93			}
94			}
95			return $out;
96			}
97
98			/**
99			* Returns setting key as an array key separator
100			*
101			* This is used to create form output
102			*
103			* @return string key
104			*/
105			public function getArrayKey() {
106			return str_replace(Configuration::KEYMARKER, "']['", $this->key);
107			}
108
109			/**
110			* What type of configuration is this
111			*
112			* Returns one of
113			*
114			* 'plugin' for plugin configuration
115			* 'template' for template configuration
116			* 'conf' for core configuration
117			*
118			* @return string
119			*/
120			public function getType() {
121			if(substr($this->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
122			return 'plugin';
123			} else if(substr($this->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
124			return 'template';
125			} else {
126			return 'conf';
127			}
128			}
129
130			/**
131			* update changed setting with user provided value $input
132			* - if changed value fails error check, save it to $this->_input (to allow echoing later)
133			* - if changed value passes error check, set $this->_local to the new value
134			*
135			* @param mixed $input the new value
136			* @return boolean true if changed, false otherwise (also on error)
137			*/
138			public function update($input) {
139			if(is_null($input)) return false;
140			if($this->isProtected()) return false;
141
142			$value = is_null($this->local) ? $this->default : $this->local;
143			if($value == $input) return false;
144
145			if($this->pattern && !preg_match($this->pattern, $input)) {
146			$this->error = true;
147			$this->input = $input;
148			return false;
149			}
150
151			$this->local = $input;
152			return true;
153			}
154
155			/**
156			* Build html for label and input of setting
157			*
158			* @param \admin_plugin_config $plugin object of config plugin
159			* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
160			* @return string[] with content array(string $label_html, string $input_html)
161			*/
162			public function html(\admin_plugin_config $plugin, $echo = false) {
163			$disable = '';
164
165			if($this->isProtected()) {
166			$value = $this->protected;
167			$disable = 'disabled="disabled"';
168			} else {
169			if($echo && $this->error) {
170			$value = $this->input;
171			} else {
172			$value = is_null($this->local) ? $this->default : $this->local;
173			}
174			}
175
176			$key = htmlspecialchars($this->key);
177			$value = formText($value);
178
179			$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
180			$input = '<textarea rows="3" cols="40" id="config___' . $key .
181			'" name="config[' . $key . ']" class="edit" ' . $disable . '>' . $value . '</textarea>';
182			return array($label, $input);
183			}
184
185			/**
186			* Generate string to save setting value to file according to $fmt
187			*
188			* @param string $var name of variable
189			* @param string $fmt save format
190			* @return string
191			*/
192			public function out($var, $fmt = 'php') {
193
194			if($this->isProtected()) return '';
195			if(is_null($this->local) \|\| ($this->default == $this->local)) return '';
196
197			$out = '';
198
199			if($fmt == 'php') {
200			$tr = array("\\" => '\\\\', "'" => '\\\'');
201
202			$out = '$' . $var . "['" . $this->getArrayKey() . "'] = '" . strtr(cleanText($this->local), $tr) . "';\n";
203			}
204
205			return $out;
206			}
207
208			/**
209			* Returns the localized prompt
210			*
211			* @param \admin_plugin_config $plugin object of config plugin
212			* @return string text
213			*/
214			public function prompt(\admin_plugin_config $plugin) {
215			$prompt = $plugin->getLang($this->key);
216			if(!$prompt) $prompt = htmlspecialchars(str_replace(array('____', '_'), ' ', $this->key));
217			return $prompt;
218			}
219
220			/**
221			* Is setting protected
222			*
223			* @return bool
224			*/
225			public function isProtected() {
226			return !is_null($this->protected);
227			}
228
229			/**
230			* Is setting the default?
231			*
232			* @return bool
233			*/
234			public function isDefault() {
235			return !$this->isProtected() && is_null($this->local);
236			}
237
238			/**
239			* Has an error?
240			*
241			* @return bool
242			*/
243			public function hasError() {
244			return $this->error;
245			}
246
247			/**
248			* Returns caution
249			*
250			* @return false\|string caution string, otherwise false for invalid caution
251			*/
252			public function caution() {
253			if(!empty($this->caution)) {
254			if(!in_array($this->caution, Setting::$validCautions)) {
255			trigger_error(
256			'Invalid caution string (' . $this->caution . ') in metadata for setting "' . $this->key . '"',
257			E_USER_WARNING
258			);
259			return false;
260			}
261			return $this->caution;
262			}
263			// compatibility with previous cautionList
264			// TODO: check if any plugins use; remove
265			if(!empty($this->cautionList[$this->key])) {
			0 ignored issues – show Bug introduced 2018-05-12 08:26 UTC by Report Bug Copy Issue Report The property `cautionList` does not seem to exist. Did you mean `caution`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
266			$this->caution = $this->cautionList[$this->key];
			0 ignored issues – show Bug introduced 2018-05-12 08:26 UTC by Report Bug Copy Issue Report The property `cautionList` does not seem to exist. Did you mean `caution`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
267			unset($this->cautionList);
268
269			return $this->caution();
270			}
271			return false;
272			}
273
274			}
275

splitbrain / dokuwiki

Push — psr2-config ( de33cd...0a5b05 )

Setting::prompt() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like