Command::bindParams() - Code Metrics - Inspection of "Use escapeshellarg" - pastuhov/php-exec-command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Dan Michael O.

created 2016-08-13 14:16 UTC

Command::bindParams() B

↳ Parent: Command

Complexity

Conditions	4
Paths	2

Size

Total Lines	33
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	25
CRAP Score	4

Importance

Changes	5
Bugs	0	Features	1

Metric	Value
c	5
b	0
f	1
dl	0
loc	33
ccs	25
cts	25
cp	1
rs	8.5806
cc	4
eloc	19
nc	2
nop	3
crap	4

<?php
namespace pastuhov\Command;

/**
 * Command.
 */
final class Command
{
    private function __construct()
    {
    }

    /**
     * Execute command with params.
     *
     * @param string $command
     * @param array  $params
     * @param bool   $escape  True to escape each param using escapeshellarg
     *
     * @return bool|string
     *
     * @throws \Exception
     */
    public static function exec($command, array $params = array(), $escape=true)
    {
        if (empty($command)) {
            throw new \Exception('Command line is empty');
        }

        $command = self::bindParams($command, $params, $escape);

        exec($command, $output, $code);

        if (count($output) === 0) {
            $output = $code;
        } else {
            $output = implode(PHP_EOL, $output);
        }

        if ($code !== 0) {
            throw new \Exception($output . ' Command line: ' . $command);
        }

        return $output;
    }

    /**
     * Bind params to command.
     *
     * @param string $command
     * @param array  $params
     *
     * @return string
     */
    public static function bindParams($command, array $params, $escape)
    {
        if (count($params) > 0) {
            $wrapper = function ($string) {
                return '{' . $string . '}';
            };
            $converter = function ($var) use ($escape) {
                if (is_array($var)) {
                    $var = implode(' ', $var);
                }

                if ($escape) {
                    $var = escapeshellarg($var);
                }

                return $var;
            };

            $command = str_replace(
                array_map(
                    $wrapper,
                    array_keys($params)
                ),
                array_map(
                    $converter,
                    array_values($params)
                ),
                $command
            );
        }

        return $command;
    }
}


1		<?php
2		namespace pastuhov\Command;
3
4		/**
5		* Command.
6		*/
7		final class Command
8		{
9		private function __construct()
10		{
11		}
12
13		/**
14		* Execute command with params.
15		*
16		* @param string $command
17		* @param array $params
18		* @param bool $escape True to escape each param using escapeshellarg
19		*
20		* @return bool\|string
21		*
22		* @throws \Exception
23		*/
24	15	public static function exec($command, array $params = array(), $escape=true)
25		{
26	15	if (empty($command)) {
27	3	throw new \Exception('Command line is empty');
28		}
29
30	12	$command = self::bindParams($command, $params, $escape);
31
32	12	exec($command, $output, $code);
33
34	12	if (count($output) === 0) {
35	3	$output = $code;
36	3	} else {
37	9	$output = implode(PHP_EOL, $output);
38		}
39
40	12	if ($code !== 0) {
41	3	throw new \Exception($output . ' Command line: ' . $command);
42		}
43
44	9	return $output;
45		}
46
47		/**
48		* Bind params to command.
49		*
50		* @param string $command
51		* @param array $params
52		*
53		* @return string
54		*/
55	12	public static function bindParams($command, array $params, $escape)
56		{
57	12	if (count($params) > 0) {
58		$wrapper = function ($string) {
59	9	return '{' . $string . '}';
60	9	};
61	9	$converter = function ($var) use ($escape) {
62	9	if (is_array($var)) {
63	3	$var = implode(' ', $var);
64	3	}
65
66	9	if ($escape) {
67	6	$var = escapeshellarg($var);
68	6	}
69
70	9	return $var;
71	9	};
72
73	9	$command = str_replace(
74	9	array_map(
75	9	$wrapper,
76	9	array_keys($params)
77	9	),
78	9	array_map(
79	9	$converter,
80	9	array_values($params)
81	9	),
82		$command
83	9	);
84	9	}
85
86	12	return $command;
87		}
88		}
89

pastuhov / php-exec-command

Pull Request — master (#5)

Command::bindParams() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like