Console - Code Metrics - jaeger-app/console - Measure and Improve Code Quality continuously with Scrutinizer

Console A
last analyzed 2016-07-05 01:52 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	10
c	1
b	0
f	0
lcom	2
cbo	2
dl	0
loc	108
rs	10

7 Methods

Rating	Name	Size	Complexity
A	__construct()	2	1
A	outputError()	4	1
A	outputLine()	8	2
A	outputPageBreak()	5	1
A	getLang()	4	1
A	setLang()	5	1
A	getArgs()	17	3

<?php
/**
 * Jaeger
 *
 * @author		Eric Lamb <[email protected]>
 * @copyright	Copyright (c) 2015-2016, mithra62, Eric Lamb
 * @link		http://jaeger-app.com
 * @version		1.0
 * @filesource 	./Console.php
 */
 
namespace JaegerApp;

/**
 * Jaeger - Console Output Object
 *
 * Handles outputting/writing data to the console 
 *
 * @package Platforms\Console
 * @author Eric Lamb <[email protected]>
 */
class Console
{
    /**
     * The arguments object
     * 
     * @var \cli\Arguments
     */
    protected $args = null;

    /**
     * The mithra62 Language object
     * 
     * @param
     *            Language
     */
    protected $lang = null;

    /**
     * The cli input string
     * 
     * @param string $tokens            
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct()
    {}

    /**
     * Outputs an error to the console
     * 
     * @param string $error
     *            The language key for the message to display
     */
    public function outputError($error)
    {
        \cli\err($this->getLang()->__($error));
    }

    /**
     * Outputs a new line
     * 
     * @param string $string The output we want to display to the console out
     * @param bool $translate Whether the string should be sent through the mithra62\Language object
     * @return void
     */
    public function outputLine($string = '', $translate = true)
    {
        if ($translate) {
            \cli\line($this->getLang()->__($string));
        } else {
            \cli\line($string);
        }
    }

    /**
     * Adds a new line with page break
     */
    public function outputPageBreak()
    {
        \cli\line('');
        \cli\line('========================================================');
    }

    /**
     * An instance of the language object
     * 
     * @return \JaegerApp\Language
     */
    public function getLang()
    {
        return $this->lang;
    }

    /**
     * Sets the language object
     * 
     * @param Language $lang            
     * @return \JaegerApp\Console
     */
    public function setLang(Language $lang)
    {
        $this->lang = $lang;
        return $this;
    }

    /**
     * Returns the available commands the Console provides
     * @see \cli\Arguments
     * @param string $strict
     * @param string $force
     * @return \cli\Arguments
     */
    public function getArgs($strict = false, $force = false)
    {
        if (is_null($this->args) || $force) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->args = new \cli\Arguments($strict);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->args->addFlag(array(
                'verbose',
                'v'
            ), 'Turn on verbose output');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->args->addFlag('version', 'Display the version');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $this->args->addFlag(array(
                'help',
                'h'
            ), 'Show this help screen');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        
        return $this->args;
    }
}

1			<?php
2			/**
3			* Jaeger
4			*
5			* @author Eric Lamb <[email protected]>
6			* @copyright Copyright (c) 2015-2016, mithra62, Eric Lamb
7			* @link http://jaeger-app.com
8			* @version 1.0
9			* @filesource ./Console.php
10			*/
11
12			namespace JaegerApp;
13
14			/**
15			* Jaeger - Console Output Object
16			*
17			* Handles outputting/writing data to the console
18			*
19			* @package Platforms\Console
20			* @author Eric Lamb <[email protected]>
21			*/
22			class Console
23			{
24			/**
25			* The arguments object
26			*
27			* @var \cli\Arguments
28			*/
29			protected $args = null;
30
31			/**
32			* The mithra62 Language object
33			*
34			* @param
35			* Language
36			*/
37			protected $lang = null;
38
39			/**
40			* The cli input string
41			*
42			* @param string $tokens
			0 ignored issues – show Bug introduced 2016-04-19 01:30 UTC by Report Bug Copy Issue Report There is no parameter named `$tokens`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
43			*/
44			public function __construct()
45			{}
46
47			/**
48			* Outputs an error to the console
49			*
50			* @param string $error
51			* The language key for the message to display
52			*/
53			public function outputError($error)
54			{
55			\cli\err($this->getLang()->__($error));
56			}
57
58			/**
59			* Outputs a new line
60			*
61			* @param string $string The output we want to display to the console out
62			* @param bool $translate Whether the string should be sent through the mithra62\Language object
63			* @return void
64			*/
65			public function outputLine($string = '', $translate = true)
66			{
67			if ($translate) {
68			\cli\line($this->getLang()->__($string));
69			} else {
70			\cli\line($string);
71			}
72			}
73
74			/**
75			* Adds a new line with page break
76			*/
77			public function outputPageBreak()
78			{
79			\cli\line('');
80			\cli\line('========================================================');
81			}
82
83			/**
84			* An instance of the language object
85			*
86			* @return \JaegerApp\Language
87			*/
88			public function getLang()
89			{
90			return $this->lang;
91			}
92
93			/**
94			* Sets the language object
95			*
96			* @param Language $lang
97			* @return \JaegerApp\Console
98			*/
99			public function setLang(Language $lang)
100			{
101			$this->lang = $lang;
102			return $this;
103			}
104
105			/**
106			* Returns the available commands the Console provides
107			* @see \cli\Arguments
108			* @param string $strict
109			* @param string $force
110			* @return \cli\Arguments
111			*/
112			public function getArgs($strict = false, $force = false)
113			{
114			if (is_null($this->args) \|\| $force) {
			0 ignored issues – show Bug Best Practice introduced 2016-04-19 01:30 UTC by Report Bug Copy Issue Report The expression `$force` of type `false\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
115			$this->args = new \cli\Arguments($strict);
			0 ignored issues – show Documentation introduced 2016-04-19 01:30 UTC by Report Bug Copy Issue Report `$strict` is of type `false\|string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
116			$this->args->addFlag(array(
117			'verbose',
118			'v'
119			), 'Turn on verbose output');
			0 ignored issues – show Documentation introduced 2016-04-19 01:30 UTC by Report Bug Copy Issue Report `'Turn on verbose output'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
120			$this->args->addFlag('version', 'Display the version');
			0 ignored issues – show Documentation introduced 2016-04-19 01:30 UTC by Report Bug Copy Issue Report `'Display the version'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
121			$this->args->addFlag(array(
122			'help',
123			'h'
124			), 'Show this help screen');
			0 ignored issues – show Documentation introduced 2016-04-19 01:30 UTC by Report Bug Copy Issue Report `'Show this help screen'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
125			}
126
127			return $this->args;
128			}
129			}

jaeger-app / console

Console A last analyzed 2016-07-05 01:52 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like

Console A
last analyzed 2016-07-05 01:52 UTC