BuildTaskTools::askOptions() - Code Metrics - lekoala/silverstripe-devtoolkit - Measure and Improve Code Quality continuously with Scrutinizer

BuildTaskTools::askOptions() B
last analyzed 2024-06-21 16:40 UTC

↳ Parent: BuildTaskTools

Complexity

Conditions	11
Paths	23

Size

Total Lines	52
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	39
c	1
b	0
f	0
nc	23
nop	0
dl	0
loc	52
rs	7.3166

How to fix Long Method Complexity

<?php

namespace LeKoala\DevToolkit;

use SilverStripe\ORM\ArrayLib;
use SilverStripe\Core\ClassInfo;
use SilverStripe\ORM\DataObject;
use SilverStripe\Control\Director;
use SilverStripe\Core\Environment;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Manifest\ClassLoader;
use SilverStripe\Core\Manifest\ModuleLoader;

/**
 * Makes your life easier with build tasks
 */
trait BuildTaskTools
{
    /**
     * @var \SilverStripe\Control\HTTPRequest
     */
    protected $request;

    /**
     * @var array
     */
    protected $options = [];

    /**
     * Increase time limit
     *
     * @return void
     */
    protected function increaseTimeLimitTo($timeLimit = null)
    {
        Environment::increaseTimeLimitTo($timeLimit);
        if (!$timeLimit) {
            $this->message("Time limit is disabled", "info");
        } else {
            $this->message("Time limit has been set to $timeLimit seconds", "info");
        }
    }

    /**
     * Rebuild the class manifest
     *
     * @return void
     */
    protected function regenerateClassManifest()
    {
        ClassLoader::inst()->getManifest()->regenerate(false);
        $this->message("The class manifest has been rebuilt", "created");
    }

    /**
     * All dataobjects
     *
     * @return array
     */
    protected function getValidDataObjects()
    {
        $list = ClassInfo::getValidSubClasses(DataObject::class);
        array_shift($list);
        return $list;
    }

    /**
     * All modules
     *
     * @return array
     */
    protected function getModules()
    {
        return ArrayLib::valuekey(array_keys(ModuleLoader::inst()->getManifest()->getModules()));
    }

    /**
     * Get the request (and keep your imports clean :-) )
     *
     * @return HTTPRequest
     */
    protected function getRequest()
    {
        if (!$this->request) {
            die('Make sure to call $this->request = $request in your own class');

        }
        return $this->request;
    }

    /**
     * Add options (to be called later with askOptions)
     *
     * @param string $key
     * @param string $title
     * @param mixed $default Default value. Input type will be based on this (bool => checkbox, etc)
     * @param array|Map $list An array of value for a dropdown
filter:
    dependency_paths: ["lib/*"]
     * @return void
     */
    protected function addOption($key, $title, $default = '', $list = null)
    {
        // Handle maps
        if (is_object($list) && method_exists($list, 'toArray')) {
            $list = $list->toArray();
        }
        $opt = [
            'key' => $key,
            'title' => $title,
            'default' => $default,
            'list' => $list,
        ];
        $this->options[] = $opt;

        return $opt;

    }

    /**
     * Display a form with options
     *
     * Options are added through addOption method
     *
     * @return array Array with key => value corresponding to options asked
     */
    protected function askOptions()
    {
        $values = [];
        $request = $this->getRequest();
        echo '<form action="" method="post"><fieldset>';
        foreach ($this->options as $opt) {
            $val = $request->requestVar($opt['key']);
            if ($val === null) {
                $val = $opt['default'];
            }

            $values[$opt['key']] = $val;

            if ($opt['list']) {
                $input = '<select name="' . $opt['key'] . '">';
                $input .= '<option></option>';
                foreach ($opt['list'] as $k => $v) {
                    $selected = '';
                    if ($k == $val) {
                        $selected = ' selected="selected"';
                    }
                    $input .= '<option value="' . $k . '"' . $selected . '>' . $v . '</option>';
                }
                $input .= '</select>';
            } else {
                $type = 'text';
                $input = null;
                if (isset($opt['default'])) {
                    if (is_bool($opt['default'])) {
                        $type = 'checkbox';
                        $checked = $val ? ' checked="checked"' : '';
                        $input = '<input type="hidden" name="' . $opt['key'] . '" value="0" />';
                        $input .= '<input type="' . $type . '" name="' . $opt['key'] . '" value="1"' . $checked . ' />';
                    } else {
                        if (is_int($opt['default'])) {
                            $type = 'numeric';
                        }
                    }
                }
                if (!$input) {
                    $input = '<input type="' . $type . '" name="' . $opt['key'] . '" value="' . $val . '" />';
                }
            }
            echo '<div class="field">';
            echo '<label> ' . $opt['title'] . ' ' . $input . '</label>';
            echo '</div>';
            echo '<br/>';
        }
        echo '</fieldset><br/><input type="submit" />';
        echo '</form>';
        echo '<hr/ >';
        return $values;
    }

    protected function message($message, $type = 'default')
    {
        if (Director::is_cli()) {
            $cli_map = [
                'repaired' => '>',
                'success' => '✓',
                'created' => '+',
                'changed' => '+',
                'bad' => '-',
                'obsolete' => '-',
                'deleted' => '-',
                'notice' => '!',
                'error' => '-',
            ];

            $message = strip_tags($message);
            if (isset($cli_map[$type])) {
                $message = $cli_map[$type] . ' ' . $message;
            }
            if (!is_string($message)) {

                $message = json_encode($message);
            }
            echo "  $message\n";
        } else {
            $web_map = [
                'info' => 'blue',
                'repaired' => 'blue',
                'success' => 'green',
                'created' => 'green',
                'changed' => 'green',
                'obsolete' => 'red',
                'notice' => 'orange',
                'deleted' => 'red',
                'bad' => 'red',
                'error' => 'red',
            ];
            $color = '#000000';
            if (isset($web_map[$type])) {
                $color = $web_map[$type];
            }
            if (!is_string($message)) {
                $message = print_r($message, true);
                echo "<pre style=\"color:$color\">$message</pre>";
            } else {
                echo "<div style=\"color:$color\">$message</div>";
            }
        }
    }

    protected function isDev()
    {
        return Director::isDev();
    }

    protected function isLive()
    {
        return Director::isLive();
    }
}


1			<?php
2
3			namespace LeKoala\DevToolkit;
4
5			use SilverStripe\ORM\ArrayLib;
6			use SilverStripe\Core\ClassInfo;
7			use SilverStripe\ORM\DataObject;
8			use SilverStripe\Control\Director;
9			use SilverStripe\Core\Environment;
10			use SilverStripe\Control\HTTPRequest;
11			use SilverStripe\Core\Manifest\ClassLoader;
12			use SilverStripe\Core\Manifest\ModuleLoader;
13
14			/**
15			* Makes your life easier with build tasks
16			*/
17			trait BuildTaskTools
18			{
19			/**
20			* @var \SilverStripe\Control\HTTPRequest
21			*/
22			protected $request;
23
24			/**
25			* @var array
26			*/
27			protected $options = [];
28
29			/**
30			* Increase time limit
31			*
32			* @return void
33			*/
34			protected function increaseTimeLimitTo($timeLimit = null)
35			{
36			Environment::increaseTimeLimitTo($timeLimit);
37			if (!$timeLimit) {
38			$this->message("Time limit is disabled", "info");
39			} else {
40			$this->message("Time limit has been set to $timeLimit seconds", "info");
41			}
42			}
43
44			/**
45			* Rebuild the class manifest
46			*
47			* @return void
48			*/
49			protected function regenerateClassManifest()
50			{
51			ClassLoader::inst()->getManifest()->regenerate(false);
52			$this->message("The class manifest has been rebuilt", "created");
53			}
54
55			/**
56			* All dataobjects
57			*
58			* @return array
59			*/
60			protected function getValidDataObjects()
61			{
62			$list = ClassInfo::getValidSubClasses(DataObject::class);
63			array_shift($list);
64			return $list;
65			}
66
67			/**
68			* All modules
69			*
70			* @return array
71			*/
72			protected function getModules()
73			{
74			return ArrayLib::valuekey(array_keys(ModuleLoader::inst()->getManifest()->getModules()));
75			}
76
77			/**
78			* Get the request (and keep your imports clean :-) )
79			*
80			* @return HTTPRequest
81			*/
82			protected function getRequest()
83			{
84			if (!$this->request) {
85			die('Make sure to call $this->request = $request in your own class');
			0 ignored issues – show Best Practice introduced 2021-02-05 14:24 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
86			}
87			return $this->request;
88			}
89
90			/**
91			* Add options (to be called later with askOptions)
92			*
93			* @param string $key
94			* @param string $title
95			* @param mixed $default Default value. Input type will be based on this (bool => checkbox, etc)
96			* @param array\|Map $list An array of value for a dropdown
			0 ignored issues – show Bug introduced 2021-02-05 14:24 UTC by Report Bug Copy Issue Report The type `LeKoala\DevToolkit\Map` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
97			* @return void
98			*/
99			protected function addOption($key, $title, $default = '', $list = null)
100			{
101			// Handle maps
102			if (is_object($list) && method_exists($list, 'toArray')) {
103			$list = $list->toArray();
104			}
105			$opt = [
106			'key' => $key,
107			'title' => $title,
108			'default' => $default,
109			'list' => $list,
110			];
111			$this->options[] = $opt;
112
113			return $opt;
			0 ignored issues – show Bug Best Practice introduced 2021-02-05 14:24 UTC by Report Bug Copy Issue Report The expression `return $opt` returns the type `array<string,mixed\|string>` which is incompatible with the documented return type `void`. Loading history...
114			}
115
116			/**
117			* Display a form with options
118			*
119			* Options are added through addOption method
120			*
121			* @return array Array with key => value corresponding to options asked
122			*/
123			protected function askOptions()
124			{
125			$values = [];
126			$request = $this->getRequest();
127			echo '<form action="" method="post"><fieldset>';
128			foreach ($this->options as $opt) {
129			$val = $request->requestVar($opt['key']);
130			if ($val === null) {
131			$val = $opt['default'];
132			}
133
134			$values[$opt['key']] = $val;
135
136			if ($opt['list']) {
137			$input = '<select name="' . $opt['key'] . '">';
138			$input .= '<option></option>';
139			foreach ($opt['list'] as $k => $v) {
140			$selected = '';
141			if ($k == $val) {
142			$selected = ' selected="selected"';
143			}
144			$input .= '<option value="' . $k . '"' . $selected . '>' . $v . '</option>';
145			}
146			$input .= '</select>';
147			} else {
148			$type = 'text';
149			$input = null;
150			if (isset($opt['default'])) {
151			if (is_bool($opt['default'])) {
152			$type = 'checkbox';
153			$checked = $val ? ' checked="checked"' : '';
154			$input = '<input type="hidden" name="' . $opt['key'] . '" value="0" />';
155			$input .= '<input type="' . $type . '" name="' . $opt['key'] . '" value="1"' . $checked . ' />';
156			} else {
157			if (is_int($opt['default'])) {
158			$type = 'numeric';
159			}
160			}
161			}
162			if (!$input) {
163			$input = '<input type="' . $type . '" name="' . $opt['key'] . '" value="' . $val . '" />';
164			}
165			}
166			echo '<div class="field">';
167			echo '<label> ' . $opt['title'] . ' ' . $input . '</label>';
168			echo '</div>';
169			echo '<br/>';
170			}
171			echo '</fieldset><br/><input type="submit" />';
172			echo '</form>';
173			echo '<hr/ >';
174			return $values;
175			}
176
177			protected function message($message, $type = 'default')
178			{
179			if (Director::is_cli()) {
180			$cli_map = [
181			'repaired' => '>',
182			'success' => '✓',
183			'created' => '+',
184			'changed' => '+',
185			'bad' => '-',
186			'obsolete' => '-',
187			'deleted' => '-',
188			'notice' => '!',
189			'error' => '-',
190			];
191
192			$message = strip_tags($message);
193			if (isset($cli_map[$type])) {
194			$message = $cli_map[$type] . ' ' . $message;
195			}
196			if (!is_string($message)) {
			0 ignored issues – show introduced 2021-02-05 14:24 UTC by Report Bug Copy Issue Report The condition `is_string($message)` is always `true`. Loading history...
197			$message = json_encode($message);
198			}
199			echo " $message\n";
200			} else {
201			$web_map = [
202			'info' => 'blue',
203			'repaired' => 'blue',
204			'success' => 'green',
205			'created' => 'green',
206			'changed' => 'green',
207			'obsolete' => 'red',
208			'notice' => 'orange',
209			'deleted' => 'red',
210			'bad' => 'red',
211			'error' => 'red',
212			];
213			$color = '#000000';
214			if (isset($web_map[$type])) {
215			$color = $web_map[$type];
216			}
217			if (!is_string($message)) {
218			$message = print_r($message, true);
219			echo "<pre style=\"color:$color\">$message</pre>";
220			} else {
221			echo "<div style=\"color:$color\">$message</div>";
222			}
223			}
224			}
225
226			protected function isDev()
227			{
228			return Director::isDev();
229			}
230
231			protected function isLive()
232			{
233			return Director::isLive();
234			}
235			}
236

lekoala / silverstripe-devtoolkit

BuildTaskTools::askOptions() B last analyzed 2024-06-21 16:40 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

BuildTaskTools::askOptions() B
last analyzed 2024-06-21 16:40 UTC