ConsoleApplication::router() - Code Metrics - Inspection of "Bumps ballen/collection version to 1.0.5." - allebb/clip - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2370af...49e850 )

by Bobby

created 2016-02-07 12:19 UTC

ConsoleApplication::router() A

↳ Parent: ConsoleApplication

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Ballen\Clip;

use Ballen\Clip\Utilities\ArgumentsParser;
use Ballen\Clip\Utilities\CommandRouter;
use InvalidArgumentException;

/**
 * Clip
 * 
 * A package for speeding up development of PHP console (CLI) applications.
 *
 * @author Bobby Allen <[email protected]>
 * @license https://raw.githubusercontent.com/bobsta63/clip/master/LICENSE
 * @link https://github.com/bobsta63/clip
 * @link http://www.bobbyallen.me
 *
 */
class ConsoleApplication
{

    /**
     * The CLI arguments
     * @var ArgumentsParser
     */
    private $arguments;

    /**
     * Command routing configuration.
     * @var CommandRouter 
     */
    private $router;

    /**
     * Console Application Constructor
     * @param ArgumentsParser $argv The PHP $argv array (Pass $argv global if you wish to access the CLI arguments)
     */
    public function __construct(ArgumentsParser $argv)
    {
        $this->arguments = $argv;
        $this->router = new CommandRouter();
    }

    /**
     * Returns the CLI arguments exposed to the CLI application.
     * @return ArgumentsParser
     */
    public function arguments()
    {
        return $this->arguments;
    }

    /**
     * Returns the router instance.
     * @return CommandRouter
     */
    public function router()
    {
        return $this->router;
    }

    /**
     * Enforces that the script must be run at the console.
     * @param boolean $enforced Enforce execution only through the CLI.
     * @param string $error_message Custom error message.
     * @return void
     */
    public function enforceCli($enforced = false, $error_message = 'CLI execution permitted only!')
    {
        if ($enforced && (php_sapi_name() != "cli")) {
            die($error_message);
        }
    }

    /**
     * Checks that the user is root!
     * @return boolean
     */
    public function isSuperUser()
    {
        if (!function_exists('posix_getuid')) {
            throw new RuntimeException('The isSuperUser() method requires the PHP POSIX extention to be enabled!');
        }
        if (posix_getuid() == 0) {
            return true;
        }
        return false;
    }

    /**
     * Executes a system command.
     * @param string $command The command to execute.
     * @return string
     */
    public function call($command)
    {
        return system($command);
    }

    /**
     * Write to the console.
     * @param string $text The text to output.
     * @return \Ballen\Clip\ConsoleApplication
     */
    public function write($text = '')
    {
        fwrite(STDOUT, $text);
        return $this;
    }

    /**
     * Write a line of characters (or an empty line) to the CLI.
     * @param string $text The text to output.
     * @return \Ballen\Clip\ConsoleApplication
     */
    public function writeln($text = '')
    {
        $this->write($text . PHP_EOL);
        return $this;
    }

    /**
     * Request user input
     * @param string $question The input question/text
     * @param string $default A default value if one is not selected.
     * @param array $options Valid options that are acceptable, these are case insensitive!
     * @return string
     */
    public function input($question, $default = '', $options = [])
    {
        if (empty($default)) {
            $this->write($question . ' ');
        } elseif (empty($options)) {
            $this->write($question . ' [' . $default . '] ');
        } else {
            $available_options = [];
            foreach (strtolower($options) as $option) {

                if ($option === strtolower($default)) {
                    $option = strtoupper($option);
                }
                $available_options[] = $option;
            }
            $available_opts = rtrim(implode($available_options, '/'), '/');
            $this->write($question . ' [' . $available_opts . '] ');
        }
        $answer = rtrim(fgets(STDIN), PHP_EOL);
        if (empty($answer)) {
            return $default;
        }
        if (count($options) > 0) {
            if (!in_array(strtolower($answer), array_map('strtolower', $options))) {
                return $this->input($question, $default, $options);
            }
            return $answer;
        }
        return $answer;
    }

    /**
     * Writes an array to the CLI output
     * @param array $array The array of data to write to the console.
     * @return \Ballen\Clip\ConsoleApplication
     */
    public function writearr($array = [])
    {
        print_r($array);
        return $this;
    }

    /**
     * Exits with a specific status code.
     * @param int $status The status code to exit with.
     * @throws InvalidArgumentException
     */
    public function exitWithStatus($status = 0)
    {
        if (!is_int($status)) {
            throw new InvalidArgumentException('The status code must be an integer value.');
        }
        exit($status);
    }

    /**
     * Exits the CLI with status code 0 (Successful)
     * @return void
     */
    public function exitWithSuccess()
    {
        $this->exitWithStatus(0);
    }

    /**
     * Exits the CLI with statu code 1 (Error)
     * @return void
     */
    public function exitWithError()
    {
        $this->exitWithStatus(1);
    }

    /**
     * Run the current application.
     * @return void
     */
    public function run()
    {
        $this->router()->dispatch($this->arguments()->getCommand(1));
    }
}


1		<?php
2
3		namespace Ballen\Clip;
4
5		use Ballen\Clip\Utilities\ArgumentsParser;
6		use Ballen\Clip\Utilities\CommandRouter;
7		use InvalidArgumentException;
8
9		/**
10		* Clip
11		*
12		* A package for speeding up development of PHP console (CLI) applications.
13		*
14		* @author Bobby Allen <[email protected]>
15		* @license https://raw.githubusercontent.com/bobsta63/clip/master/LICENSE
16		* @link https://github.com/bobsta63/clip
17		* @link http://www.bobbyallen.me
18		*
19		*/
20		class ConsoleApplication
21		{
22
23		/**
24		* The CLI arguments
25		* @var ArgumentsParser
26		*/
27		private $arguments;
28
29		/**
30		* Command routing configuration.
31		* @var CommandRouter
32		*/
33		private $router;
34
35		/**
36		* Console Application Constructor
37		* @param ArgumentsParser $argv The PHP $argv array (Pass $argv global if you wish to access the CLI arguments)
38		*/
39	12	public function __construct(ArgumentsParser $argv)
40		{
41	12	$this->arguments = $argv;
42	12	$this->router = new CommandRouter();
43	12	}
44
45		/**
46		* Returns the CLI arguments exposed to the CLI application.
47		* @return ArgumentsParser
48		*/
49	2	public function arguments()
50		{
51	2	return $this->arguments;
52		}
53
54		/**
55		* Returns the router instance.
56		* @return CommandRouter
57		*/
58	2	public function router()
59		{
60	2	return $this->router;
61		}
62
63		/**
64		* Enforces that the script must be run at the console.
65		* @param boolean $enforced Enforce execution only through the CLI.
66		* @param string $error_message Custom error message.
67		* @return void
68		*/
69		public function enforceCli($enforced = false, $error_message = 'CLI execution permitted only!')
70		{
71		if ($enforced && (php_sapi_name() != "cli")) {
72		die($error_message);
73		}
74		}
75
76		/**
77		* Checks that the user is root!
78		* @return boolean
79		*/
80		public function isSuperUser()
81		{
82		if (!function_exists('posix_getuid')) {
83		throw new RuntimeException('The isSuperUser() method requires the PHP POSIX extention to be enabled!');
84		}
85		if (posix_getuid() == 0) {
86		return true;
87		}
88		return false;
89		}
90
91		/**
92		* Executes a system command.
93		* @param string $command The command to execute.
94		* @return string
95		*/
96		public function call($command)
97		{
98		return system($command);
99		}
100
101		/**
102		* Write to the console.
103		* @param string $text The text to output.
104		* @return \Ballen\Clip\ConsoleApplication
105		*/
106		public function write($text = '')
107		{
108		fwrite(STDOUT, $text);
109		return $this;
110		}
111
112		/**
113		* Write a line of characters (or an empty line) to the CLI.
114		* @param string $text The text to output.
115		* @return \Ballen\Clip\ConsoleApplication
116		*/
117		public function writeln($text = '')
118		{
119		$this->write($text . PHP_EOL);
120		return $this;
121		}
122
123		/**
124		* Request user input
125		* @param string $question The input question/text
126		* @param string $default A default value if one is not selected.
127		* @param array $options Valid options that are acceptable, these are case insensitive!
128		* @return string
129		*/
130		public function input($question, $default = '', $options = [])
131		{
132		if (empty($default)) {
133		$this->write($question . ' ');
134		} elseif (empty($options)) {
135		$this->write($question . ' [' . $default . '] ');
136		} else {
137		$available_options = [];
138		foreach (strtolower($options) as $option) {
		0 ignored issues – show Bug introduced 2016-02-05 07:25 UTC by Report Bug Copy Issue Report The expression `strtolower($options)` of type `string` is not traversable. Loading history...
139		if ($option === strtolower($default)) {
140		$option = strtoupper($option);
141		}
142		$available_options[] = $option;
143		}
144		$available_opts = rtrim(implode($available_options, '/'), '/');
145		$this->write($question . ' [' . $available_opts . '] ');
146		}
147		$answer = rtrim(fgets(STDIN), PHP_EOL);
148		if (empty($answer)) {
149		return $default;
150		}
151		if (count($options) > 0) {
152		if (!in_array(strtolower($answer), array_map('strtolower', $options))) {
153		return $this->input($question, $default, $options);
154		}
155		return $answer;
156		}
157		return $answer;
158		}
159
160		/**
161		* Writes an array to the CLI output
162		* @param array $array The array of data to write to the console.
163		* @return \Ballen\Clip\ConsoleApplication
164		*/
165		public function writearr($array = [])
166		{
167		print_r($array);
168		return $this;
169		}
170
171		/**
172		* Exits with a specific status code.
173		* @param int $status The status code to exit with.
174		* @throws InvalidArgumentException
175		*/
176		public function exitWithStatus($status = 0)
177		{
178		if (!is_int($status)) {
179		throw new InvalidArgumentException('The status code must be an integer value.');
180		}
181		exit($status);
182		}
183
184		/**
185		* Exits the CLI with status code 0 (Successful)
186		* @return void
187		*/
188		public function exitWithSuccess()
189		{
190		$this->exitWithStatus(0);
191		}
192
193		/**
194		* Exits the CLI with statu code 1 (Error)
195		* @return void
196		*/
197		public function exitWithError()
198		{
199		$this->exitWithStatus(1);
200		}
201
202		/**
203		* Run the current application.
204		* @return void
205		*/
206		public function run()
207		{
208		$this->router()->dispatch($this->arguments()->getCommand(1));
209		}
210		}
211

allebb / clip

Push — master ( 2370af...49e850 )

ConsoleApplication::router() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like