ShellErrorHandler::getErrorDetail() - Code Metrics - Inspection of "v0.9.10" - kristuff/abuseipdb-cli - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — dev (044aa2)

by Kris

created 2021-01-30 10:37 UTC

ShellErrorHandler::getErrorDetail() A

↳ Parent: ShellErrorHandler

Complexity

Conditions	5
Paths	6

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	3
c	1
b	0
f	0
nc	6
nop	3
dl	0
loc	7
rs	9.6111

<?php

/**
 *     _    _                    ___ ____  ____  ____
 *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
 *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
 *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
 * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
 *
 * This file is part of Kristuff\AbsuseIPDB.
 *
 * (c) Kristuff <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @version    0.9.10
 * @copyright  2020-2021 Kristuff
 */
namespace Kristuff\AbuseIPDB;

use Kristuff\Mishell\Console;
use Kristuff\Mishell\Program;

/**
 * Class ShellErrorHandler
 * 
 * Abstract base class for main cli program
 */
abstract class ShellErrorHandler extends ShellUtils
{
    /**
     * Check and print errors in API response. 
     * 
     * @access protected
     * @static
     * @param object     $response       
     * @param bool       $checkForEmpty     
     * 
     * @return bool     
     */
    protected static function hasErrors(object $response, bool $checkForEmpty = true )
    {
        return $checkForEmpty ? self::parseErrors($response) || self::checkForEmpty($response) : self::parseErrors($response);
    }

    /**
     * Check and print errors in API response. 
     * 
     * @access protected
     * @static
     * @param object     $response       
     * @param bool       $checkForEmpty     
     * 
     * @return bool     
     */
    private static function parseErrors(object $response)
    {
        if (isset($response) && isset($response->errors)){
            switch (self::$outputFormat){
                case self::OUTPUT_DEFAULT:
                    self::printFormattedErrors($response);
                    break;

                case self::OUTPUT_PLAINTEXT:
                    self::printPlainTextErrors($response);
                    break;

                case self::OUTPUT_JSON:
                    echo json_encode($response, JSON_PRETTY_PRINT);
                    break;
            }
            return true;
        }
        return false;    
    }

    /**
     * 
     * @access protected
     * @static
     * @param object     $response       
     * 
     * @return void     
     */
    protected static function printFormattedErrors(object $response)
    {
        // top error badge    
        Console::log('  ' .   Console::text(' ERROR ','white', 'red'));

        $num = 0;
        // errors is an array, could have more than one error..
        foreach ($response->errors as $err){
            $num++;

            Console::log(Console::text('   ✗', 'red') .  self::printResult(' Number:    ', $num, 'lightyellow','', false));
            self::printResult('     Status:    ', $err->status ?? null, 'lightyellow','');    
            
            if (!empty($err->source) && !empty($err->source->parameter)){
                self::printResult('     Parameter: ', $err->source->parameter, 'lightyellow');    
            }
            self::printResult('     Title:     ', $err->title ?? null, 'lightyellow');    
            self::printResult('     Detail:    ', $err->detail ?? null, 'lightyellow');    

            // separate errors
            if (count($response->errors) > 1){
                Console::log('   ---');
            }
        }
        Console::log();           
    }

    /**
     * Print a single error
     * 
     * @access protected
     * @static
     * @param string    $error      The error message
     * 
     * @return void
     */
    protected static function error(string $error)
    {
        if (self::isDefaultOuput()) {
            // ✗
            Console::log('  ' .   Console::text(' ERROR ','white', 'red'));
            Console::log(
                Console::text('   ✗', 'red') . 
                Console::text(' Detail:    ', 'white') . 
                Console::text($error, 'lightyellow') . 
                Console::text('', 'white')
            );    
            Console::log();
        }    
    }
    
    /**
     * Helper to validate a condition or exit with an error
     * 
     * @access protected
     * @static
     * @param bool      $condition      The condition to evaluate
     * @param string    $message        Error message
     * @param bool      $print          True to print error. Default is true
     * 
     * @return bool
     */
    protected static function validate(bool $condition, string $message, bool $print = true)
    {
        if ( !$condition ){
            if ($print && self::isDefaultOuput()) {
                Console::log();
                self::error($message);
                self::printFooter();
            }
            Program::exit(1);
        }
    }

    /**
     * Get numeric parameter and exit on error
     * 
     * @access protected
     * @static
     * @param array     $arguments
     * @param string    $shortArg           The short argument name
     * @param string    $longArg            The long argument name
     * @param int       $defaultValue
     * 
     * @return int
     */
    protected static function getNumericParameter(array $arguments, string $shortArg, string $longArg, int $defaultValue)
    {
         if (self::inArguments($arguments,$shortArg, $longArg)){
            $val = self::getArgumentValue($arguments,$shortArg, $longArg);

            if (!is_numeric($val)){
                self::error("Invalid parameter: $longArg must be a numeric value.");
                self::printFooter();
                Program::exit(1);
            }
            return intval($val);
        }
        return $defaultValue;
    }

        /**
     * Check and print errors in API response. Null response object is considered as no errors
     * 
     * @access protected
     * @static
     * @param object     $response       
     * 
     * @return void     
     */
    protected static function printPlainTextErrors(object $response)
    {
        foreach ($response->errors as $err){
            $text = 'Error: ';
            $text .= self::getErrorDetail($err, 'title');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            $text .= self::getErrorDetail($err, 'statuts');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            $text .= self::getErrorDetail($err, 'parameter', 'source');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            $text .= self::getErrorDetail($err, 'detail');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            $text .= PHP_EOL;
            echo $text;
        }
    }

    /**
     * Get error property if exist
     * 
     * @access protected
     * @static
     * @param object     $error       
     * @param string     $field       
     * 
     * @return void     
     */
    private static function getErrorDetail(object $error, string $field, ?string $parent = null)
    {
        if (!empty($parent)){
            return  !empty($error->$parent) && !empty($error->$parent->$field) ? ' ' . $field . ': ' . $error->$parent->$field : '';

        }

        return !empty($error->$field) ? ' ' . $field . ': ' . $error->$field : '';

    }

    /**
     * Check and print errors in API response. 
     * 
     * @access protected
     * @static
     * @param object     $response       
     * 
     * @return bool     
     */
    protected static function checkForEmpty(object $response)
    {
        // check for empty response ?
        if ( empty($response) || empty($response->data) ){
            self::error('An unexpected error occurred.');
            return true;
        }
        return false;    
    }
}

1			<?php
2
3			/**
4			* _ _ ___ ____ ____ ____
5			* / \ \| \|__ _ _ ___ ___\|_ _\| _ \\| _ \\| __ )
6			* / _ \ \| '_ \\| \| \| / __\|/ _ \\| \|\| \|_) \| \| \| \| _ \
7			* / ___ \\| \|_) \| \|_\| \__ \ __/\| \|\| __/\| \|_\| \| \|_) \|
8			* /_/ \_\_.__/ \__,_\|___/\___\|___\|_\| \|____/\|____/
9			*
10			* This file is part of Kristuff\AbsuseIPDB.
11			*
12			* (c) Kristuff <[email protected]>
13			*
14			* For the full copyright and license information, please view the LICENSE
15			* file that was distributed with this source code.
16			*
17			* @version 0.9.10
18			* @copyright 2020-2021 Kristuff
19			*/
20			namespace Kristuff\AbuseIPDB;
21
22			use Kristuff\Mishell\Console;
23			use Kristuff\Mishell\Program;
24
25			/**
26			* Class ShellErrorHandler
27			*
28			* Abstract base class for main cli program
29			*/
30			abstract class ShellErrorHandler extends ShellUtils
31			{
32			/**
33			* Check and print errors in API response.
34			*
35			* @access protected
36			* @static
37			* @param object $response
38			* @param bool $checkForEmpty
39			*
40			* @return bool
41			*/
42			protected static function hasErrors(object $response, bool $checkForEmpty = true )
43			{
44			return $checkForEmpty ? self::parseErrors($response) \|\| self::checkForEmpty($response) : self::parseErrors($response);
45			}
46
47			/**
48			* Check and print errors in API response.
49			*
50			* @access protected
51			* @static
52			* @param object $response
53			* @param bool $checkForEmpty
54			*
55			* @return bool
56			*/
57			private static function parseErrors(object $response)
58			{
59			if (isset($response) && isset($response->errors)){
60			switch (self::$outputFormat){
61			case self::OUTPUT_DEFAULT:
62			self::printFormattedErrors($response);
63			break;
64
65			case self::OUTPUT_PLAINTEXT:
66			self::printPlainTextErrors($response);
67			break;
68
69			case self::OUTPUT_JSON:
70			echo json_encode($response, JSON_PRETTY_PRINT);
71			break;
72			}
73			return true;
74			}
75			return false;
76			}
77
78			/**
79			*
80			* @access protected
81			* @static
82			* @param object $response
83			*
84			* @return void
85			*/
86			protected static function printFormattedErrors(object $response)
87			{
88			// top error badge
89			Console::log(' ' . Console::text(' ERROR ','white', 'red'));
90
91			$num = 0;
92			// errors is an array, could have more than one error..
93			foreach ($response->errors as $err){
94			$num++;
95
96			Console::log(Console::text(' ✗', 'red') . self::printResult(' Number: ', $num, 'lightyellow','', false));
97			self::printResult(' Status: ', $err->status ?? null, 'lightyellow','');
98
99			if (!empty($err->source) && !empty($err->source->parameter)){
100			self::printResult(' Parameter: ', $err->source->parameter, 'lightyellow');
101			}
102			self::printResult(' Title: ', $err->title ?? null, 'lightyellow');
103			self::printResult(' Detail: ', $err->detail ?? null, 'lightyellow');
104
105			// separate errors
106			if (count($response->errors) > 1){
107			Console::log(' ---');
108			}
109			}
110			Console::log();
111			}
112
113			/**
114			* Print a single error
115			*
116			* @access protected
117			* @static
118			* @param string $error The error message
119			*
120			* @return void
121			*/
122			protected static function error(string $error)
123			{
124			if (self::isDefaultOuput()) {
125			// ✗
126			Console::log(' ' . Console::text(' ERROR ','white', 'red'));
127			Console::log(
128			Console::text(' ✗', 'red') .
129			Console::text(' Detail: ', 'white') .
130			Console::text($error, 'lightyellow') .
131			Console::text('', 'white')
132			);
133			Console::log();
134			}
135			}
136
137			/**
138			* Helper to validate a condition or exit with an error
139			*
140			* @access protected
141			* @static
142			* @param bool $condition The condition to evaluate
143			* @param string $message Error message
144			* @param bool $print True to print error. Default is true
145			*
146			* @return bool
147			*/
148			protected static function validate(bool $condition, string $message, bool $print = true)
149			{
150			if ( !$condition ){
151			if ($print && self::isDefaultOuput()) {
152			Console::log();
153			self::error($message);
154			self::printFooter();
155			}
156			Program::exit(1);
157			}
158			}
159
160			/**
161			* Get numeric parameter and exit on error
162			*
163			* @access protected
164			* @static
165			* @param array $arguments
166			* @param string $shortArg The short argument name
167			* @param string $longArg The long argument name
168			* @param int $defaultValue
169			*
170			* @return int
171			*/
172			protected static function getNumericParameter(array $arguments, string $shortArg, string $longArg, int $defaultValue)
173			{
174			if (self::inArguments($arguments,$shortArg, $longArg)){
175			$val = self::getArgumentValue($arguments,$shortArg, $longArg);
176
177			if (!is_numeric($val)){
178			self::error("Invalid parameter: $longArg must be a numeric value.");
179			self::printFooter();
180			Program::exit(1);
181			}
182			return intval($val);
183			}
184			return $defaultValue;
185			}
186
187			/**
188			* Check and print errors in API response. Null response object is considered as no errors
189			*
190			* @access protected
191			* @static
192			* @param object $response
193			*
194			* @return void
195			*/
196			protected static function printPlainTextErrors(object $response)
197			{
198			foreach ($response->errors as $err){
199			$text = 'Error: ';
200			$text .= self::getErrorDetail($err, 'title');
			0 ignored issues – show Bug introduced 2021-01-30 10:39 UTC by Report Bug Copy Issue Report Are you sure the usage of `self::getErrorDetail($err, 'title')` targeting `Kristuff\AbuseIPDB\Shell...ndler::getErrorDetail()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
201			$text .= self::getErrorDetail($err, 'statuts');
			0 ignored issues – show Bug introduced 2021-01-30 10:39 UTC by Report Bug Copy Issue Report Are you sure the usage of `self::getErrorDetail($err, 'statuts')` targeting `Kristuff\AbuseIPDB\Shell...ndler::getErrorDetail()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
202			$text .= self::getErrorDetail($err, 'parameter', 'source');
			0 ignored issues – show Bug introduced 2021-01-30 10:39 UTC by Report Bug Copy Issue Report Are you sure the usage of `self::getErrorDetail($err, 'parameter', 'source')` targeting `Kristuff\AbuseIPDB\Shell...ndler::getErrorDetail()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
203			$text .= self::getErrorDetail($err, 'detail');
			0 ignored issues – show Bug introduced 2021-01-30 10:39 UTC by Report Bug Copy Issue Report Are you sure the usage of `self::getErrorDetail($err, 'detail')` targeting `Kristuff\AbuseIPDB\Shell...ndler::getErrorDetail()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
204			$text .= PHP_EOL;
205			echo $text;
206			}
207			}
208
209			/**
210			* Get error property if exist
211			*
212			* @access protected
213			* @static
214			* @param object $error
215			* @param string $field
216			*
217			* @return void
218			*/
219			private static function getErrorDetail(object $error, string $field, ?string $parent = null)
220			{
221			if (!empty($parent)){
222			return !empty($error->$parent) && !empty($error->$parent->$field) ? ' ' . $field . ': ' . $error->$parent->$field : '';
			0 ignored issues – show Bug Best Practice introduced 2021-01-30 08:49 UTC by Report Bug Copy Issue Report The expression `return ! empty($error->$...r->$parent->$field : ''` returns the type `string` which is incompatible with the documented return type `void`. Loading history...
223			}
224
225			return !empty($error->$field) ? ' ' . $field . ': ' . $error->$field : '';
			0 ignored issues – show Bug Best Practice introduced 2021-01-30 08:49 UTC by Report Bug Copy Issue Report The expression `return ! empty($error->$...' . $error->$field : ''` returns the type `string` which is incompatible with the documented return type `void`. Loading history...
226			}
227
228			/**
229			* Check and print errors in API response.
230			*
231			* @access protected
232			* @static
233			* @param object $response
234			*
235			* @return bool
236			*/
237			protected static function checkForEmpty(object $response)
238			{
239			// check for empty response ?
240			if ( empty($response) \|\| empty($response->data) ){
241			self::error('An unexpected error occurred.');
242			return true;
243			}
244			return false;
245			}
246			}

kristuff / abuseipdb-cli

Branch — dev (044aa2)

ShellErrorHandler::getErrorDetail() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like