Descriptor::formatDefaultValue() - Code Metrics - Inspection of "修复有自定义名称的命令名称长度更大导致 php think list 命令报错" - top-think/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 6.0 (#2206)

unknown

created 2020-03-16 09:33 UTC

Descriptor::formatDefaultValue() A

↳ Parent: Descriptor

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2015 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: yunwuxin <[email protected]>
// +----------------------------------------------------------------------

namespace think\console\output;

use think\Console;
use think\console\Command;
use think\console\input\Argument as InputArgument;
use think\console\input\Definition as InputDefinition;
use think\console\input\Option as InputOption;
use think\console\Output;
use think\console\output\descriptor\Console as ConsoleDescription;

class Descriptor
{

    /**

     * @var Output
     */
    protected $output;

    /**

     * {@inheritdoc}
     */

    public function describe(Output $output, $object, array $options = [])
    {
        $this->output = $output;

        switch (true) {
            case $object instanceof InputArgument:
                $this->describeInputArgument($object, $options);
                break;
            case $object instanceof InputOption:
                $this->describeInputOption($object, $options);
                break;
            case $object instanceof InputDefinition:
                $this->describeInputDefinition($object, $options);
                break;
            case $object instanceof Command:
                $this->describeCommand($object, $options);
                break;
            case $object instanceof Console:
                $this->describeConsole($object, $options);
                break;
            default:
                throw new \InvalidArgumentException(sprintf('Object of type "%s" is not describable.', get_class($object)));
        }
    }

    /**
     * 输出内容
     * @param string $content

     * @param bool   $decorated

     */

    protected function write($content, $decorated = false)
    {
        $this->output->write($content, false, $decorated ? Output::OUTPUT_NORMAL : Output::OUTPUT_RAW);
    }

    /**
     * 描述参数
     * @param InputArgument $argument

     * @param array         $options

     * @return string|mixed
     */
    protected function describeInputArgument(InputArgument $argument, array $options = [])
    {
        if (null !== $argument->getDefault()
            && (!is_array($argument->getDefault())
                || count($argument->getDefault()))

        ) {
            $default = sprintf('<comment> [default: %s]</comment>', $this->formatDefaultValue($argument->getDefault()));
        } else {
            $default = '';
        }

        $totalWidth   = $options['total_width'] ?? strlen($argument->getName());
        $spacingWidth = $totalWidth - strlen($argument->getName()) + 2;

        $this->writeText(sprintf("  <info>%s</info>%s%s%s", $argument->getName(), str_repeat(' ', $spacingWidth), // + 17 = 2 spaces + <info> + </info> + 2 spaces

            preg_replace('/\s*\R\s*/', PHP_EOL . str_repeat(' ', $totalWidth + 17), $argument->getDescription()), $default), $options);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**
     * 描述选项
     * @param InputOption $option

     * @param array       $options

     * @return string|mixed
     */
    protected function describeInputOption(InputOption $option, array $options = [])
    {
        if ($option->acceptValue() && null !== $option->getDefault()
            && (!is_array($option->getDefault())
                || count($option->getDefault()))

        ) {
            $default = sprintf('<comment> [default: %s]</comment>', $this->formatDefaultValue($option->getDefault()));
        } else {
            $default = '';
        }

        $value = '';
        if ($option->acceptValue()) {
            $value = '=' . strtoupper($option->getName());

            if ($option->isValueOptional()) {
                $value = '[' . $value . ']';
            }
        }

        $totalWidth = $options['total_width'] ?? $this->calculateTotalWidthForOptions([$option]);
        $synopsis   = sprintf('%s%s', $option->getShortcut() ? sprintf('-%s, ', $option->getShortcut()) : '    ', sprintf('--%s%s', $option->getName(), $value));

        $spacingWidth = $totalWidth - strlen($synopsis) + 2;

        $this->writeText(sprintf("  <info>%s</info>%s%s%s%s", $synopsis, str_repeat(' ', $spacingWidth), // + 17 = 2 spaces + <info> + </info> + 2 spaces

            preg_replace('/\s*\R\s*/', "\n" . str_repeat(' ', $totalWidth + 17), $option->getDescription()), $default, $option->isArray() ? '<comment> (multiple values allowed)</comment>' : ''), $options);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**
     * 描述输入
     * @param InputDefinition $definition

     * @param array           $options

     * @return string|mixed
     */
    protected function describeInputDefinition(InputDefinition $definition, array $options = [])
    {
        $totalWidth = $this->calculateTotalWidthForOptions($definition->getOptions());
        foreach ($definition->getArguments() as $argument) {
            $totalWidth = max($totalWidth, strlen($argument->getName()));
        }

        if ($definition->getArguments()) {
            $this->writeText('<comment>Arguments:</comment>', $options);
            $this->writeText("\n");
            foreach ($definition->getArguments() as $argument) {
                $this->describeInputArgument($argument, array_merge($options, ['total_width' => $totalWidth]));
                $this->writeText("\n");
            }
        }

        if ($definition->getArguments() && $definition->getOptions()) {
            $this->writeText("\n");
        }

        if ($definition->getOptions()) {
            $laterOptions = [];

            $this->writeText('<comment>Options:</comment>', $options);
            foreach ($definition->getOptions() as $option) {
                if (strlen($option->getShortcut()) > 1) {
                    $laterOptions[] = $option;
                    continue;
                }
                $this->writeText("\n");
                $this->describeInputOption($option, array_merge($options, ['total_width' => $totalWidth]));
            }
            foreach ($laterOptions as $option) {
                $this->writeText("\n");
                $this->describeInputOption($option, array_merge($options, ['total_width' => $totalWidth]));
            }
        }
    }

    /**
     * 描述指令
     * @param Command $command

     * @param array   $options

     * @return string|mixed
     */
    protected function describeCommand(Command $command, array $options = [])
    {
        $command->getSynopsis(true);
        $command->getSynopsis(false);
        $command->mergeConsoleDefinition(false);

        $this->writeText('<comment>Usage:</comment>', $options);
        foreach (array_merge([$command->getSynopsis(true)], $command->getAliases(), $command->getUsages()) as $usage) {
            $this->writeText("\n");
            $this->writeText('  ' . $usage, $options);
        }
        $this->writeText("\n");

        $definition = $command->getNativeDefinition();
        if ($definition->getOptions() || $definition->getArguments()) {
            $this->writeText("\n");
            $this->describeInputDefinition($definition, $options);
            $this->writeText("\n");
        }

        if ($help = $command->getProcessedHelp()) {
            $this->writeText("\n");
            $this->writeText('<comment>Help:</comment>', $options);
            $this->writeText("\n");
            $this->writeText(' ' . str_replace("\n", "\n ", $help), $options);
            $this->writeText("\n");
        }
    }

    /**
     * 描述控制台
     * @param Console $console

     * @param array   $options

     * @return string|mixed
     */
    protected function describeConsole(Console $console, array $options = [])
    {
        $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
        $description        = new ConsoleDescription($console, $describedNamespace);

        if (isset($options['raw_text']) && $options['raw_text']) {
            $width = $this->getColumnWidth($description->getNamespaces());

            foreach ($description->getCommands() as $command) {
                $this->writeText(sprintf("%-${width}s %s", $command->getName(), $command->getDescription()), $options);
                $this->writeText("\n");
            }
        } else {
            if ('' != $help = $console->getHelp()) {
                $this->writeText("$help\n\n", $options);
            }

            $this->writeText("<comment>Usage:</comment>\n", $options);
            $this->writeText("  command [options] [arguments]\n\n", $options);

            $this->describeInputDefinition(new InputDefinition($console->getDefinition()->getOptions()), $options);

            $this->writeText("\n");
            $this->writeText("\n");

            $width = $this->getColumnWidth($description->getNamespaces());

            if ($describedNamespace) {
                $this->writeText(sprintf('<comment>Available commands for the "%s" namespace:</comment>', $describedNamespace), $options);
            } else {
                $this->writeText('<comment>Available commands:</comment>', $options);
            }

            // add commands by namespace
            foreach ($description->getNamespaces() as $namespace) {
                if (!$describedNamespace && ConsoleDescription::GLOBAL_NAMESPACE !== $namespace['id']) {
                    $this->writeText("\n");
                    $this->writeText(' <comment>' . $namespace['id'] . '</comment>', $options);
                }

                foreach ($namespace['commands'] as $name) {
                    $this->writeText("\n");
                    $spacingWidth = $width - strlen($name);
                    $this->writeText(sprintf("  <info>%s</info>%s%s", $name, str_repeat(' ', $spacingWidth), $description->getCommand($name)

                            ->getDescription()), $options);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
                }
            }

            $this->writeText("\n");
        }
    }

    /**

     * {@inheritdoc}
     */

    private function writeText($content, array $options = [])

    {
        $this->write(isset($options['raw_text'])

            && $options['raw_text'] ? strip_tags($content) : $content, isset($options['raw_output']) ? !$options['raw_output'] : true);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**
     * 格式化
     * @param mixed $default

     * @return string
     */
    private function formatDefaultValue($default)

    {
        return json_encode($default, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
    }

    /**

     * @param array

     * @return int
     */
    private function getColumnWidth(array $namespaceCommandGroups)

    {
        $width = 0;
        foreach ($namespaceCommandGroups as $namespaceCommandGroup) {
            foreach ($namespaceCommandGroup['commands'] as $command) {
                $width = strlen($command) > $width ? strlen($command) : $width;
            }
        }
        
        return $width + 2;
    }

    /**

     * @param InputOption[] $options

     * @return int
     */
    private function calculateTotalWidthForOptions($options)

    {
        $totalWidth = 0;
        foreach ($options as $option) {
            $nameLength = 4 + strlen($option->getName()) + 2; // - + shortcut + , + whitespace + name + --

            if ($option->acceptValue()) {
                $valueLength = 1 + strlen($option->getName()); // = + value
                $valueLength += $option->isValueOptional() ? 2 : 0; // [ + ]

                $nameLength += $valueLength;
            }
            $totalWidth = max($totalWidth, $nameLength);
        }

        return $totalWidth;
    }
}


1			<?php
2			// +----------------------------------------------------------------------
3			// \| ThinkPHP [ WE CAN DO IT JUST THINK ]
4			// +----------------------------------------------------------------------
5			// \| Copyright (c) 2006~2015 http://thinkphp.cn All rights reserved.
6			// +----------------------------------------------------------------------
7			// \| Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
8			// +----------------------------------------------------------------------
9			// \| Author: yunwuxin <[email protected]>
10			// +----------------------------------------------------------------------
11
12			namespace think\console\output;
13
14			use think\Console;
15			use think\console\Command;
16			use think\console\input\Argument as InputArgument;
17			use think\console\input\Definition as InputDefinition;
18			use think\console\input\Option as InputOption;
19			use think\console\Output;
20			use think\console\output\descriptor\Console as ConsoleDescription;
21
22			class Descriptor
23			{
24
25			/**
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
26			* @var Output
27			*/
28			protected $output;
29
30			/**
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$output` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$object` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$options` should have a doc-comment as per coding-style. Loading history...
31			* {@inheritdoc}
32			*/
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
33			public function describe(Output $output, $object, array $options = [])
34			{
35			$this->output = $output;
36
37			switch (true) {
38			case $object instanceof InputArgument:
39			$this->describeInputArgument($object, $options);
40			break;
41			case $object instanceof InputOption:
42			$this->describeInputOption($object, $options);
43			break;
44			case $object instanceof InputDefinition:
45			$this->describeInputDefinition($object, $options);
46			break;
47			case $object instanceof Command:
48			$this->describeCommand($object, $options);
49			break;
50			case $object instanceof Console:
51			$this->describeConsole($object, $options);
52			break;
53			default:
54			throw new \InvalidArgumentException(sprintf('Object of type "%s" is not describable.', get_class($object)));
55			}
56			}
57
58			/**
59			* 输出内容
60			* @param string $content
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
61			* @param bool $decorated
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
62			*/
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
63			protected function write($content, $decorated = false)
64			{
65			$this->output->write($content, false, $decorated ? Output::OUTPUT_NORMAL : Output::OUTPUT_RAW);
66			}
67
68			/**
69			* 描述参数
70			* @param InputArgument $argument
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
71			* @param array $options
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
72			* @return string\|mixed
73			*/
74			protected function describeInputArgument(InputArgument $argument, array $options = [])
75			{
76			if (null !== $argument->getDefault()
77			&& (!is_array($argument->getDefault())
78			\|\| count($argument->getDefault()))
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Multi-line IF statement not indented correctly; expected 12 spaces but found 16 Loading history...
79			) {
80			$default = sprintf('<comment> [default: %s]</comment>', $this->formatDefaultValue($argument->getDefault()));
81			} else {
82			$default = '';
83			}
84
85			$totalWidth = $options['total_width'] ?? strlen($argument->getName());
86			$spacingWidth = $totalWidth - strlen($argument->getName()) + 2;
87
88			$this->writeText(sprintf(" <info>%s</info>%s%s%s", $argument->getName(), str_repeat(' ', $spacingWidth), // + 17 = 2 spaces + <info> + </info> + 2 spaces
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
89			preg_replace('/\s\R\s/', PHP_EOL . str_repeat(' ', $totalWidth + 17), $argument->getDescription()), $default), $options);
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `8` spaces, but found `12`. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
90			}
91
92			/**
93			* 描述选项
94			* @param InputOption $option
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
95			* @param array $options
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
96			* @return string\|mixed
97			*/
98			protected function describeInputOption(InputOption $option, array $options = [])
99			{
100			if ($option->acceptValue() && null !== $option->getDefault()
101			&& (!is_array($option->getDefault())
102			\|\| count($option->getDefault()))
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Multi-line IF statement not indented correctly; expected 12 spaces but found 16 Loading history...
103			) {
104			$default = sprintf('<comment> [default: %s]</comment>', $this->formatDefaultValue($option->getDefault()));
105			} else {
106			$default = '';
107			}
108
109			$value = '';
110			if ($option->acceptValue()) {
111			$value = '=' . strtoupper($option->getName());
112
113			if ($option->isValueOptional()) {
114			$value = '[' . $value . ']';
115			}
116			}
117
118			$totalWidth = $options['total_width'] ?? $this->calculateTotalWidthForOptions([$option]);
119			$synopsis = sprintf('%s%s', $option->getShortcut() ? sprintf('-%s, ', $option->getShortcut()) : ' ', sprintf('--%s%s', $option->getName(), $value));
120
121			$spacingWidth = $totalWidth - strlen($synopsis) + 2;
122
123			$this->writeText(sprintf(" <info>%s</info>%s%s%s%s", $synopsis, str_repeat(' ', $spacingWidth), // + 17 = 2 spaces + <info> + </info> + 2 spaces
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
124			preg_replace('/\s\R\s/', "\n" . str_repeat(' ', $totalWidth + 17), $option->getDescription()), $default, $option->isArray() ? '<comment> (multiple values allowed)</comment>' : ''), $options);
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `8` spaces, but found `12`. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
125			}
126
127			/**
128			* 描述输入
129			* @param InputDefinition $definition
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
130			* @param array $options
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
131			* @return string\|mixed
132			*/
133			protected function describeInputDefinition(InputDefinition $definition, array $options = [])
134			{
135			$totalWidth = $this->calculateTotalWidthForOptions($definition->getOptions());
136			foreach ($definition->getArguments() as $argument) {
137			$totalWidth = max($totalWidth, strlen($argument->getName()));
138			}
139
140			if ($definition->getArguments()) {
141			$this->writeText('<comment>Arguments:</comment>', $options);
142			$this->writeText("\n");
143			foreach ($definition->getArguments() as $argument) {
144			$this->describeInputArgument($argument, array_merge($options, ['total_width' => $totalWidth]));
145			$this->writeText("\n");
146			}
147			}
148
149			if ($definition->getArguments() && $definition->getOptions()) {
150			$this->writeText("\n");
151			}
152
153			if ($definition->getOptions()) {
154			$laterOptions = [];
155
156			$this->writeText('<comment>Options:</comment>', $options);
157			foreach ($definition->getOptions() as $option) {
158			if (strlen($option->getShortcut()) > 1) {
159			$laterOptions[] = $option;
160			continue;
161			}
162			$this->writeText("\n");
163			$this->describeInputOption($option, array_merge($options, ['total_width' => $totalWidth]));
164			}
165			foreach ($laterOptions as $option) {
166			$this->writeText("\n");
167			$this->describeInputOption($option, array_merge($options, ['total_width' => $totalWidth]));
168			}
169			}
170			}
171
172			/**
173			* 描述指令
174			* @param Command $command
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
175			* @param array $options
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
176			* @return string\|mixed
177			*/
178			protected function describeCommand(Command $command, array $options = [])
179			{
180			$command->getSynopsis(true);
181			$command->getSynopsis(false);
182			$command->mergeConsoleDefinition(false);
183
184			$this->writeText('<comment>Usage:</comment>', $options);
185			foreach (array_merge([$command->getSynopsis(true)], $command->getAliases(), $command->getUsages()) as $usage) {
186			$this->writeText("\n");
187			$this->writeText(' ' . $usage, $options);
188			}
189			$this->writeText("\n");
190
191			$definition = $command->getNativeDefinition();
192			if ($definition->getOptions() \|\| $definition->getArguments()) {
193			$this->writeText("\n");
194			$this->describeInputDefinition($definition, $options);
195			$this->writeText("\n");
196			}
197
198			if ($help = $command->getProcessedHelp()) {
199			$this->writeText("\n");
200			$this->writeText('<comment>Help:</comment>', $options);
201			$this->writeText("\n");
202			$this->writeText(' ' . str_replace("\n", "\n ", $help), $options);
203			$this->writeText("\n");
204			}
205			}
206
207			/**
208			* 描述控制台
209			* @param Console $console
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
210			* @param array $options
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
211			* @return string\|mixed
212			*/
213			protected function describeConsole(Console $console, array $options = [])
214			{
215			$describedNamespace = isset($options['namespace']) ? $options['namespace'] : null;
216			$description = new ConsoleDescription($console, $describedNamespace);
217
218			if (isset($options['raw_text']) && $options['raw_text']) {
219			$width = $this->getColumnWidth($description->getNamespaces());
220
221			foreach ($description->getCommands() as $command) {
222			$this->writeText(sprintf("%-${width}s %s", $command->getName(), $command->getDescription()), $options);
223			$this->writeText("\n");
224			}
225			} else {
226			if ('' != $help = $console->getHelp()) {
227			$this->writeText("$help\n\n", $options);
228			}
229
230			$this->writeText("<comment>Usage:</comment>\n", $options);
231			$this->writeText(" command [options] [arguments]\n\n", $options);
232
233			$this->describeInputDefinition(new InputDefinition($console->getDefinition()->getOptions()), $options);
234
235			$this->writeText("\n");
236			$this->writeText("\n");
237
238			$width = $this->getColumnWidth($description->getNamespaces());
239
240			if ($describedNamespace) {
241			$this->writeText(sprintf('<comment>Available commands for the "%s" namespace:</comment>', $describedNamespace), $options);
242			} else {
243			$this->writeText('<comment>Available commands:</comment>', $options);
244			}
245
246			// add commands by namespace
247			foreach ($description->getNamespaces() as $namespace) {
248			if (!$describedNamespace && ConsoleDescription::GLOBAL_NAMESPACE !== $namespace['id']) {
249			$this->writeText("\n");
250			$this->writeText(' <comment>' . $namespace['id'] . '</comment>', $options);
251			}
252
253			foreach ($namespace['commands'] as $name) {
254			$this->writeText("\n");
255			$spacingWidth = $width - strlen($name);
256			$this->writeText(sprintf(" <info>%s</info>%s%s", $name, str_repeat(' ', $spacingWidth), $description->getCommand($name)
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
257			->getDescription()), $options);
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `20` spaces, but found `28`. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Object operator not indented correctly; expected 24 spaces but found 28 Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
258			}
259			}
260
261			$this->writeText("\n");
262			}
263			}
264
265			/**
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$content` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$options` should have a doc-comment as per coding-style. Loading history...
266			* {@inheritdoc}
267			*/
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
268			private function writeText($content, array $options = [])
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Private method name "Descriptor::writeText" must be prefixed with an underscore Loading history...
269			{
270			$this->write(isset($options['raw_text'])
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report The opening parenthesis of a multi-line function call should be the last content on the line. Loading history...
271			&& $options['raw_text'] ? strip_tags($content) : $content, isset($options['raw_output']) ? !$options['raw_output'] : true);
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `8` spaces, but found `12`. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
272			}
273
274			/**
275			* 格式化
276			* @param mixed $default
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
277			* @return string
278			*/
279			private function formatDefaultValue($default)
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Private method name "Descriptor::formatDefaultValue" must be prefixed with an underscore Loading history...
280			{
281			return json_encode($default, JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE);
282			}
283
284			/**
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2020-03-16 09:49 UTC by Report Bug Copy Issue Report Parameter `$namespaceCommandGroups` should have a doc-comment as per coding-style. Loading history...
285			* @param array
			0 ignored issues – show Coding Style Documentation introduced 2020-03-16 09:49 UTC by Report Bug Copy Issue Report Missing parameter name Loading history...
286			* @return int
287			*/
288			private function getColumnWidth(array $namespaceCommandGroups)
			0 ignored issues – show Coding Style introduced 2020-03-16 09:42 UTC by Report Bug Copy Issue Report Private method name "Descriptor::getColumnWidth" must be prefixed with an underscore Loading history...
289			{
290			$width = 0;
291			foreach ($namespaceCommandGroups as $namespaceCommandGroup) {
292			foreach ($namespaceCommandGroup['commands'] as $command) {
293			$width = strlen($command) > $width ? strlen($command) : $width;
294			}
295			}
296
297			return $width + 2;
298			}
299
300			/**
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
301			* @param InputOption[] $options
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
302			* @return int
303			*/
304			private function calculateTotalWidthForOptions($options)
			0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Private method name "Descriptor::calculateTotalWidthForOptions" must be prefixed with an underscore Loading history...
305			{
306			$totalWidth = 0;
307			foreach ($options as $option) {
308			$nameLength = 4 + strlen($option->getName()) + 2; // - + shortcut + , + whitespace + name + --
309
310			if ($option->acceptValue()) {
311			$valueLength = 1 + strlen($option->getName()); // = + value
312			$valueLength += $option->isValueOptional() ? 2 : 0; // [ + ]
313
314			$nameLength += $valueLength;
315			}
316			$totalWidth = max($totalWidth, $nameLength);
317			}
318
319			return $totalWidth;
320			}
321			}
322

top-think / framework

Pull Request — 6.0 (#2206)

Descriptor::formatDefaultValue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like