AbstractCommand::parseResponse() - Code Metrics - Inspection of "Merge pull request #2 from graze/initialCommit" - graze/dynamark3-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0df352...724305 )

by John

created 2016-02-18 16:33 UTC

AbstractCommand::parseResponse() A

↳ Parent: AbstractCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	3.1852

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	14
ccs	3
cts	9
cp	0.3333
rs	9.4285
nc	2
cc	2
eloc	8
nop	1
crap	3.1852

<?php

/**
 * This file is part of graze/dynamark3-client.
 *
 * Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://github.com/graze/dynamark3-client/blob/master/LICENSE
 * @link https://github.com/graze/dynamark3-client
 */

namespace Graze\Dynamark3Client\Command;

use Graze\Dynamark3Client\Command\CommandInterface;
use Graze\TelnetClient\TelnetResponseInterface;
use Graze\Dynamark3Client\Dynamark3Response;
use Graze\Dynamark3Client\Dynamark3Constants;

abstract class AbstractCommand implements CommandInterface
{
    /**
     * @return string
     */
    abstract public function getCommandText();

    /**
     * Default to the TelnetClient's prompt
     *
     * @return string
     */
    public function getPrompt()
    {
        return null;
    }

    /**
     * @param TelnetResponseInterface $response
     *
     * @return Graze\Dynamark3Client\Dynamark3Response
     */
    public function parseResponse(TelnetResponseInterface $response)
    {
        $errorCode = null;
        $prompt = reset($response->getPromptMatches());

        if ($response->isError()) {
            // error prompt - ERROR nnn
            $errorCode = substr($prompt, 6);
        }

        return new Dynamark3Response(
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());
}
            $prompt,
            $errorCode
        );
    }
}


1		<?php
2
3		/**
4		* This file is part of graze/dynamark3-client.
5		*
6		* Copyright (c) 2016 Nature Delivered Ltd. <https://www.graze.com>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* @license https://github.com/graze/dynamark3-client/blob/master/LICENSE
12		* @link https://github.com/graze/dynamark3-client
13		*/
14
15		namespace Graze\Dynamark3Client\Command;
16
17		use Graze\Dynamark3Client\Command\CommandInterface;
18		use Graze\TelnetClient\TelnetResponseInterface;
19		use Graze\Dynamark3Client\Dynamark3Response;
20		use Graze\Dynamark3Client\Dynamark3Constants;
21
22		abstract class AbstractCommand implements CommandInterface
23		{
24		/**
25		* @return string
26		*/
27		abstract public function getCommandText();
28
29		/**
30		* Default to the TelnetClient's prompt
31		*
32		* @return string
33		*/
34	2	public function getPrompt()
35		{
36	2	return null;
37		}
38
39		/**
40		* @param TelnetResponseInterface $response
41		*
42		* @return Graze\Dynamark3Client\Dynamark3Response
43		*/
44	3	public function parseResponse(TelnetResponseInterface $response)
45		{
46	3	$errorCode = null;
47	3	$prompt = reset($response->getPromptMatches());
		0 ignored issues – show Bug introduced 2016-02-18 16:37 UTC by Report Bug Copy Issue Report `$response->getPromptMatches()` cannot be passed to `reset()` as the parameter `$array` expects a reference. Loading history...
48		if ($response->isError()) {
49		// error prompt - ERROR nnn
50		$errorCode = substr($prompt, 6);
51		}
52
53		return new Dynamark3Response(
		0 ignored issues – show Bug Best Practice introduced 2016-02-18 16:37 UTC by Report Bug Copy Issue Report The return type of `return new \Graze\Dynama...e($prompt, $errorCode);` (`Graze\Dynamark3Client\Dynamark3Response`) is incompatible with the return type declared by the interface `Graze\Dynamark3Client\Co...nterface::parseResponse` of type `Graze\Dynamark3Client\Co...lient\Dynamark3Response`. 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...
54		$prompt,
55		$errorCode
56		);
57		}
58		}
59

graze / dynamark3-client

Push — master ( 0df352...724305 )

AbstractCommand::parseResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like