Setting::__construct() - Code Metrics - Inspection of "Merge pull request #2382 from splitbrain/psr2-conf..." - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — psr2 ( 8eb28c...c68e26 )

by Andreas

created 2018-06-15 08:27 UTC

Setting::__construct() A

↳ Parent: Setting

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	2
dl	0
loc	10
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
     *
     * @see initialize() to set the actual value of the setting
     *
     * @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;
            }
        }
    }

    /**
     * Set the current values for the setting $key
     *
     * This is used to initialize the setting with the data read form the config files.
     *
     * @see update() to set a new value
     * @param mixed $default default setting value
     * @param mixed $local local setting value
     * @param mixed $protected protected setting value
     */
    public function initialize($default = null, $local = null, $protected = null) {
        $this->default = $this->cleanValue($default);
        $this->local = $this->cleanValue($local);
        $this->protected = $this->cleanValue($protected);
    }

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

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

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

        // update local copy of this setting with new value
        $this->local = $input;

        // setting ready for update
        return true;
    }

    /**
     * Clean a value read from a config before using it internally
     *
     * Default implementation returns $value as is. Subclasses can override.
     * Note: null should always be returned as null!
     *
     * This is applied in initialize() and update()
     *
     * @param mixed $value
     * @return mixed
     */
    protected function cleanValue($value) {
        return $value;
    }

    /**
     * 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
     * 'dokuwiki' 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 'dokuwiki';
        }
    }

    /**
     * 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);
    }

    /**
     * Should the current local value be saved?
     *
     * @see out() to run when this returns true
     * @return bool
     */
    public function shouldBeSaved() {
        if($this->isProtected()) return false;
        if($this->local === null) return false;
        if($this->default == $this->local) return false;
        return true;
    }

    /**
     * Generate string to save local setting value to file according to $fmt
     *
     * @see shouldBeSaved() to check if this should be called
     * @param string $var name of variable
     * @param string $fmt save format
     * @return string
     */
    public function out($var, $fmt = 'php') {
        if($fmt != 'php') return '';

        $tr = array("\\" => '\\\\', "'" => '\\\''); // escape the value
        $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)) return false;
        if(!in_array($this->caution, Setting::$validCautions)) {
            throw new \RuntimeException(
                'Invalid caution string (' . $this->caution . ') in metadata for setting "' . $this->key . '"'
            );
        }
        return $this->caution;
    }

}


1			<?php
2
3			namespace dokuwiki\plugin\config\core\Setting;
4
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			* @see initialize() to set the actual value of the setting
35			*
36			* @param string $key
37			* @param array\|null $params array with metadata of setting
38			*/
39			public function __construct($key, $params = null) {
40			$this->key = $key;
41
42			if(is_array($params)) {
43			foreach($params as $property => $value) {
44			$property = trim($property, '_'); // we don't use underscores anymore
45			$this->$property = $value;
46			}
47			}
48			}
49
50			/**
51			* Set the current values for the setting $key
52			*
53			* This is used to initialize the setting with the data read form the config files.
54			*
55			* @see update() to set a new value
56			* @param mixed $default default setting value
57			* @param mixed $local local setting value
58			* @param mixed $protected protected setting value
59			*/
60			public function initialize($default = null, $local = null, $protected = null) {
61			$this->default = $this->cleanValue($default);
62			$this->local = $this->cleanValue($local);
63			$this->protected = $this->cleanValue($protected);
64			}
65
66			/**
67			* update changed setting with validated user provided value $input
68			* - if changed value fails validation check, save it to $this->input (to allow echoing later)
69			* - if changed value passes validation check, set $this->local to the new value
70			*
71			* @param mixed $input the new value
72			* @return boolean true if changed, false otherwise
73			*/
74			public function update($input) {
75			if(is_null($input)) return false;
76			if($this->isProtected()) return false;
77			$input = $this->cleanValue($input);
78
79			$value = is_null($this->local) ? $this->default : $this->local;
80			if($value == $input) return false;
81
82			// validate new value
83			if($this->pattern && !preg_match($this->pattern, $input)) {
84			$this->error = true;
85			$this->input = $input;
86			return false;
87			}
88
89			// update local copy of this setting with new value
90			$this->local = $input;
91
92			// setting ready for update
93			return true;
94			}
95
96			/**
97			* Clean a value read from a config before using it internally
98			*
99			* Default implementation returns $value as is. Subclasses can override.
100			* Note: null should always be returned as null!
101			*
102			* This is applied in initialize() and update()
103			*
104			* @param mixed $value
105			* @return mixed
106			*/
107			protected function cleanValue($value) {
108			return $value;
109			}
110
111			/**
112			* Should this type of config have a default?
113			*
114			* @return bool
115			*/
116			public function shouldHaveDefault() {
117			return true;
118			}
119
120			/**
121			* Get this setting's unique key
122			*
123			* @return string
124			*/
125			public function getKey() {
126			return $this->key;
127			}
128
129			/**
130			* Get the key of this setting marked up human readable
131			*
132			* @param bool $url link to dokuwiki.org manual?
133			* @return string
134			*/
135			public function getPrettyKey($url = true) {
136			$out = str_replace(Configuration::KEYMARKER, "»", $this->key);
137			if($url && !strstr($out, '»')) {//provide no urls for plugins, etc.
138			if($out == 'start') {
139			// exception, because this config name is clashing with our actual start page
140			return '<a href="http://www.dokuwiki.org/config:startpage">' . $out . '</a>';
141			} else {
142			return '<a href="http://www.dokuwiki.org/config:' . $out . '">' . $out . '</a>';
143			}
144			}
145			return $out;
146			}
147
148			/**
149			* Returns setting key as an array key separator
150			*
151			* This is used to create form output
152			*
153			* @return string key
154			*/
155			public function getArrayKey() {
156			return str_replace(Configuration::KEYMARKER, "']['", $this->key);
157			}
158
159			/**
160			* What type of configuration is this
161			*
162			* Returns one of
163			*
164			* 'plugin' for plugin configuration
165			* 'template' for template configuration
166			* 'dokuwiki' for core configuration
167			*
168			* @return string
169			*/
170			public function getType() {
171			if(substr($this->getKey(), 0, 10) == 'plugin' . Configuration::KEYMARKER) {
172			return 'plugin';
173			} else if(substr($this->getKey(), 0, 7) == 'tpl' . Configuration::KEYMARKER) {
174			return 'template';
175			} else {
176			return 'dokuwiki';
177			}
178			}
179
180			/**
181			* Build html for label and input of setting
182			*
183			* @param \admin_plugin_config $plugin object of config plugin
184			* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
185			* @return string[] with content array(string $label_html, string $input_html)
186			*/
187			public function html(\admin_plugin_config $plugin, $echo = false) {
188			$disable = '';
189
190			if($this->isProtected()) {
191			$value = $this->protected;
192			$disable = 'disabled="disabled"';
193			} else {
194			if($echo && $this->error) {
195			$value = $this->input;
196			} else {
197			$value = is_null($this->local) ? $this->default : $this->local;
198			}
199			}
200
201			$key = htmlspecialchars($this->key);
202			$value = formText($value);
203
204			$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
205			$input = '<textarea rows="3" cols="40" id="config___' . $key .
206			'" name="config[' . $key . ']" class="edit" ' . $disable . '>' . $value . '</textarea>';
207			return array($label, $input);
208			}
209
210			/**
211			* Should the current local value be saved?
212			*
213			* @see out() to run when this returns true
214			* @return bool
215			*/
216			public function shouldBeSaved() {
217			if($this->isProtected()) return false;
218			if($this->local === null) return false;
219			if($this->default == $this->local) return false;
220			return true;
221			}
222
223			/**
224			* Generate string to save local setting value to file according to $fmt
225			*
226			* @see shouldBeSaved() to check if this should be called
227			* @param string $var name of variable
228			* @param string $fmt save format
229			* @return string
230			*/
231			public function out($var, $fmt = 'php') {
232			if($fmt != 'php') return '';
233
234			$tr = array("\\" => '\\\\', "'" => '\\\''); // escape the value
235			$out = '$' . $var . "['" . $this->getArrayKey() . "'] = '" . strtr(cleanText($this->local), $tr) . "';\n";
236
237			return $out;
238			}
239
240			/**
241			* Returns the localized prompt
242			*
243			* @param \admin_plugin_config $plugin object of config plugin
244			* @return string text
245			*/
246			public function prompt(\admin_plugin_config $plugin) {
247			$prompt = $plugin->getLang($this->key);
248			if(!$prompt) $prompt = htmlspecialchars(str_replace(array('____', '_'), ' ', $this->key));
249			return $prompt;
250			}
251
252			/**
253			* Is setting protected
254			*
255			* @return bool
256			*/
257			public function isProtected() {
258			return !is_null($this->protected);
259			}
260
261			/**
262			* Is setting the default?
263			*
264			* @return bool
265			*/
266			public function isDefault() {
267			return !$this->isProtected() && is_null($this->local);
268			}
269
270			/**
271			* Has an error?
272			*
273			* @return bool
274			*/
275			public function hasError() {
276			return $this->error;
277			}
278
279			/**
280			* Returns caution
281			*
282			* @return false\|string caution string, otherwise false for invalid caution
283			*/
284			public function caution() {
285			if(empty($this->caution)) return false;
286			if(!in_array($this->caution, Setting::$validCautions)) {
287			throw new \RuntimeException(
288			'Invalid caution string (' . $this->caution . ') in metadata for setting "' . $this->key . '"'
289			);
290			}
291			return $this->caution;
292			}
293
294			}
295

splitbrain / dokuwiki

Push — psr2 ( 8eb28c...c68e26 )

Setting::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like