ListWorkflowsCommand::parseResponse() - Code Metrics - Inspection of "Fix phpdoc" - PyRowMan/pheanstalk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4a6f0d...73b924 )

by Valentin

created 2019-07-29 10:38 UTC

ListWorkflowsCommand::parseResponse() A

↳ Parent: ListWorkflowsCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	11
c	1
b	0
f	0
dl	0
loc	15
ccs	0
cts	11
cp	0
rs	9.9
cc	2
nc	2
nop	2
crap	6

<?php

namespace Pheanstalk\Command;

use Doctrine\Common\Collections\ArrayCollection;
use Pheanstalk\Exception;
use Pheanstalk\Response;
use Pheanstalk\Structure\Workflow;
use Pheanstalk\XmlResponseParser;

/**
 * The 'ListWorkflows' command.
 *
 * Inserts a new workflow into the client.
 *
 *
 * @author  Valentin Corre
 * @package Pheanstalk
 * @license http://www.opensource.org/licenses/mit-license.php
 */
class ListWorkflowsCommand extends AbstractCommand implements \Pheanstalk\ResponseParser
{

    /**
     * @inheritDoc
     */
    public function getGroup(): string
    {
        return 'workflows';
    }

    /**
     * @inheritDoc
     */
    public function getAction(): string
    {
        return 'list';
    }

    /**
     * @inheritDoc
     */
    public function getResponseParser()
    {
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function parseResponse($responseLine, $responseData)
    {
        $workflows = [];
        foreach ($responseData['workflow'] as $workflow) {
            $workflow = $workflow['@attributes'] ?? $workflow;
            $object = new Workflow($workflow['name'], $workflow['group'], new ArrayCollection([]), $workflow['comment']);
            $object
                ->setId($workflow['id'])
                ->setBoundToSchedule((int) $workflow['bound-to-schedule'])
                ->setLastcommit((int) $workflow['lastcommit'])
                ->setModified((int) $workflow['modified'])
            ;
            $workflows[] = $object;
        }
        return new ArrayCollection($workflows);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1			<?php
2
3			namespace Pheanstalk\Command;
4
5			use Doctrine\Common\Collections\ArrayCollection;
6			use Pheanstalk\Exception;
7			use Pheanstalk\Response;
8			use Pheanstalk\Structure\Workflow;
9			use Pheanstalk\XmlResponseParser;
10
11			/**
12			* The 'ListWorkflows' command.
13			*
14			* Inserts a new workflow into the client.
15			*
16			*
17			* @author Valentin Corre
18			* @package Pheanstalk
19			* @license http://www.opensource.org/licenses/mit-license.php
20			*/
21			class ListWorkflowsCommand extends AbstractCommand implements \Pheanstalk\ResponseParser
22			{
23
24			/**
25			* @inheritDoc
26			*/
27			public function getGroup(): string
28			{
29			return 'workflows';
30			}
31
32			/**
33			* @inheritDoc
34			*/
35			public function getAction(): string
36			{
37			return 'list';
38			}
39
40			/**
41			* @inheritDoc
42			*/
43			public function getResponseParser()
44			{
45			return $this;
46			}
47
48			/**
49			* @inheritDoc
50			*/
51			public function parseResponse($responseLine, $responseData)
52			{
53			$workflows = [];
54			foreach ($responseData['workflow'] as $workflow) {
55			$workflow = $workflow['@attributes'] ?? $workflow;
56			$object = new Workflow($workflow['name'], $workflow['group'], new ArrayCollection([]), $workflow['comment']);
57			$object
58			->setId($workflow['id'])
59			->setBoundToSchedule((int) $workflow['bound-to-schedule'])
60			->setLastcommit((int) $workflow['lastcommit'])
61			->setModified((int) $workflow['modified'])
62			;
63			$workflows[] = $object;
64			}
65			return new ArrayCollection($workflows);
			0 ignored issues – show Bug Best Practice introduced 2019-07-29 10:41 UTC by Report Bug Copy Issue Report The expression `return new Doctrine\Comm...yCollection($workflows)` returns the type `Doctrine\Common\Collections\ArrayCollection` which is incompatible with the return type mandated by `Pheanstalk\ResponseParser::parseResponse()` of `Pheanstalk\Response`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
66			}
67			}
68

PyRowMan / pheanstalk

Push — master ( 4a6f0d...73b924 )

ListWorkflowsCommand::parseResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like