CommandGetxml::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

CommandGetxml::parseResponse() A

↳ Parent: CommandGetxml

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1.216

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	2
cts	5
cp	0.4
rs	9.4285
nc	1
cc	1
eloc	5
nop	1
crap	1.216

<?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.md
 * @link https://github.com/graze/dynamark3-client
 */

namespace Graze\Dynamark3Client\Command;

use Graze\TelnetClient\TelnetResponseInterface;

class CommandGetxml extends AbstractCommand
{
    /**
     * @return string
     */
    public function getCommandText()
    {
        return 'GETXML';
    }

    /**
     * @return string
     */
    public function getPrompt()
    {
        return 'RESULT GETXML .+';
    }

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


        $response = parent::parseResponse($telnetResponse);
        // prompt = RESULT GETXML <xml><something...
        $response->setResponseText(substr($prompt, 14));

        return $response;
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());
}
    }
}


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.md
12		* @link https://github.com/graze/dynamark3-client
13		*/
14
15		namespace Graze\Dynamark3Client\Command;
16
17		use Graze\TelnetClient\TelnetResponseInterface;
18
19		class CommandGetxml extends AbstractCommand
20		{
21		/**
22		* @return string
23		*/
24	1	public function getCommandText()
25		{
26	1	return 'GETXML';
27		}
28
29		/**
30		* @return string
31		*/
32	1	public function getPrompt()
33		{
34	1	return 'RESULT GETXML .+';
35		}
36
37		/**
38		* @param TelnetResponseInterface $telnetResponse
39		*
40		* @return Graze\Dynamark3Client\Dynamark3Response
41		*/
42	2	public function parseResponse(TelnetResponseInterface $telnetResponse)
43		{
44	2	$prompt = reset($telnetResponse->getPromptMatches());
		0 ignored issues – show Bug introduced 2016-02-18 16:37 UTC by Report Bug Copy Issue Report `$telnetResponse->getPromptMatches()` cannot be passed to `reset()` as the parameter `$array` expects a reference. Loading history...
45
46		$response = parent::parseResponse($telnetResponse);
47		// prompt = RESULT GETXML <xml><something...
48		$response->setResponseText(substr($prompt, 14));
49
50		return $response;
		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 $response;` (`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...
51		}
52		}
53

graze / dynamark3-client

Push — master ( 0df352...724305 )

CommandGetxml::parseResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like