Connection_Error::get_info() - Code Metrics - Inspection of "wip" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/connection-error-handling ( 525cd7...e29761 )

unknown

created 2020-06-18 20:51 UTC

Connection_Error::get_info() A

↳ Parent: Connection_Error

Complexity

Conditions	5
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	8
nop	2
dl	0
loc	14
rs	9.4888
c	0
b	0
f	0

<?php
/**
 * The Jetpack Connection error class file.
 *
 * @package automattic/jetpack-connection
 */

namespace Automattic\Jetpack\Connection;

/**
 * The Jetpack Connection Error class represents one Connection Error
 */
class Connection_Error extends \WP_Error {

	/**
	 * Stores the list of data for error codes.
	 *
	 * @var array
	 */
	public $error_info = array();

	public function __construct( $error_code, $data, $report = true ) {

		$this->errors_handler = new Errors();
class MyClass { }

$x = new MyClass();
$x->foo = true;

		$error = $this->errors_handler->get_error( $error_code );

		parent::__construct(
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
			$error_code,
			$error['title'],
			$data
		);

		$this->error_info[ $error_code ] = $error;

		if ( $report ) {
			$this->errors_handler->report_error( $this );
		}

	}

	public function get_info( $info_key = '', $code = '' ) {
		if ( empty( $code ) ) {
			$code = $this->get_error_code();

		}
		if ( isset( $this->error_info[ $code ] ) ) {
			if ( empty( $info_key ) ) {
				return $this->error_info[ $code ];
			}

			if ( isset( $this->error_info[ $code ][ $info_key ] ) ) {
				return $this->error_info[ $code ][ $info_key ];
			}
		}
	}

	public function get_title( $code = '' ) {
		return $this->get_info( 'title', $code );
	}

	public function get_fix_tip( $code = '' ) {
		return $this->get_info( 'fix_tip', $code );
	}

}


1			<?php
2			/**
3			* The Jetpack Connection error class file.
4			*
5			* @package automattic/jetpack-connection
6			*/
7
8			namespace Automattic\Jetpack\Connection;
9
10			/**
11			* The Jetpack Connection Error class represents one Connection Error
12			*/
13			class Connection_Error extends \WP_Error {
14
15			/**
16			* Stores the list of data for error codes.
17			*
18			* @var array
19			*/
20			public $error_info = array();
21
22			public function __construct( $error_code, $data, $report = true ) {
23
24			$this->errors_handler = new Errors();
			0 ignored issues – show Bug introduced 2020-06-05 19:05 UTC by Report Bug Copy Issue Report The property `errors_handler` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
25
26			$error = $this->errors_handler->get_error( $error_code );
27
28			parent::__construct(
			0 ignored issues – show Bug introduced 2020-06-05 19:05 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `WP_Error` as the method `__construct()` does only exist in the following sub-classes of `WP_Error`: `Automattic\Jetpack\Connection\Connection_Error`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
29			$error_code,
30			$error['title'],
31			$data
32			);
33
34			$this->error_info[ $error_code ] = $error;
35
36			if ( $report ) {
37			$this->errors_handler->report_error( $this );
38			}
39
40			}
41
42			public function get_info( $info_key = '', $code = '' ) {
43			if ( empty( $code ) ) {
44			$code = $this->get_error_code();
			0 ignored issues – show Bug introduced 2020-06-18 20:58 UTC by Report Bug Copy Issue Report The method `get_error_code()` does not seem to exist on `object<Automattic\Jetpac...ction\Connection_Error>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
45			}
46			if ( isset( $this->error_info[ $code ] ) ) {
47			if ( empty( $info_key ) ) {
48			return $this->error_info[ $code ];
49			}
50
51			if ( isset( $this->error_info[ $code ][ $info_key ] ) ) {
52			return $this->error_info[ $code ][ $info_key ];
53			}
54			}
55			}
56
57			public function get_title( $code = '' ) {
58			return $this->get_info( 'title', $code );
59			}
60
61			public function get_fix_tip( $code = '' ) {
62			return $this->get_info( 'fix_tip', $code );
63			}
64
65			}
66

Automattic / jetpack

Push — add/connection-error-handling ( 525cd7...e29761 )

Connection_Error::get_info() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like