ClientInspector - Code Metrics - joomla-framework/oauth1 - Measure and Improve Code Quality continuously with Scrutinizer

ClientInspector A
last analyzed 2020-10-02 10:33 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	5
c	0
b	0
f	0
lcom	1
cbo	1
dl	0
loc	38
rs	10

2 Methods

Rating	Name	Duplication	Size	Complexity
A	verifyCredentials()	0	9	2
A	validateResponse()	0	7	3

<?php
/**
 * @copyright  Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE
 */

namespace Joomla\OAuth1\Tests;

use Joomla\OAuth1\Client;

/**
 * Inspector for the Client class.
 *
 * @since  1.0
 */
class ClientInspector extends Client
{
	/**
	 * Mimic verifing credentials.
	 *
	 * @return void
	 *
	 * @since 1.0
	 */
	public function verifyCredentials()
	{
		if (!strcmp($this->token['key'], 'valid'))
		{
			return true;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
		}

		return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	 * Method to validate a response.
	 *
	 * @param   string    $url       The request URL.
	 * @param   Response  $response  The response to validate.
	 *
	 * @return  void
	 *
	 * @since   1.0
	 * @throws  \DomainException
	 */
	public function validateResponse($url, $response)
	{
		if ($response->code < 200 || $response->code > 399)
		{
				throw new \DomainException($response->body);
		}
	}
}


1			<?php
2			/**
3			* @copyright Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
4			* @license GNU General Public License version 2 or later; see LICENSE
5			*/
6
7			namespace Joomla\OAuth1\Tests;
8
9			use Joomla\OAuth1\Client;
10
11			/**
12			* Inspector for the Client class.
13			*
14			* @since 1.0
15			*/
16			class ClientInspector extends Client
17			{
18			/**
19			* Mimic verifing credentials.
20			*
21			* @return void
22			*
23			* @since 1.0
24			*/
25			public function verifyCredentials()
26			{
27			if (!strcmp($this->token['key'], 'valid'))
28			{
29			return true;
			0 ignored issues – show Bug Best Practice introduced 2016-01-30 19:27 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) is incompatible with the return type declared by the abstract method `Joomla\Oauth1\Client::verifyCredentials` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
30			}
31
32			return false;
			0 ignored issues – show Bug Best Practice introduced 2016-01-30 19:27 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the abstract method `Joomla\Oauth1\Client::verifyCredentials` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
33			}
34
35			/**
36			* Method to validate a response.
37			*
38			* @param string $url The request URL.
39			* @param Response $response The response to validate.
40			*
41			* @return void
42			*
43			* @since 1.0
44			* @throws \DomainException
45			*/
46			public function validateResponse($url, $response)
47			{
48			if ($response->code < 200 \|\| $response->code > 399)
49			{
50			throw new \DomainException($response->body);
51			}
52			}
53			}
54

joomla-framework / oauth1

ClientInspector A last analyzed 2020-10-02 10:33 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like

ClientInspector A
last analyzed 2020-10-02 10:33 UTC