GetWorkflowCommand::getResponseParser() - 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

GetWorkflowCommand::getResponseParser() A

↳ Parent: GetWorkflowCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Pheanstalk\Command;

use Doctrine\Common\Collections\ArrayCollection;
use Pheanstalk\Structure\Job;
use Pheanstalk\Structure\Task;
use Pheanstalk\Structure\Workflow;

/**
 * The 'GetWorkflow' command.
 *
 * Retrieve a workflow by its id, if there is no workflow for the id given in the construct, returns false
 *
 * @author  Valentin Corre
 * @package Pheanstalk
 * @license http://www.opensource.org/licenses/mit-license.php
 */
class GetWorkflowCommand extends AbstractCommand implements \Pheanstalk\ResponseParser
{

    /** @var Workflow $workflow */
    private $workflow;

    /**
     * GetWorkflowCommand constructor.
     *
     * @param Workflow $workflow
     */
    public function __construct(Workflow $workflow)
    {
        $this->workflow = $workflow;
    }

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

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

    /**
     * @inheritDoc
     */
    public function getFilters(): array
    {
        return [
            'id' => $this->workflow->getId()
        ];
    }

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

    /**
     * @inheritDoc
     */
    public function parseResponse($responseLine, $responseData)
    {
        $workflow = $responseData['workflow'];
        $jobs = $workflow['workflow']['subjobs'];
        $workflow = $workflow['@attributes'] ?? $workflow;

        $jobObjects = [];
        foreach ($jobs as $job) {
            $taskObjects = [];
            foreach ($job['tasks'] as $task) {
                $task = $task['@attributes'];
                $taskObjects[] = new Task($task['path'], $task['queue'], $task['use-agent'], $task['user'], $task['host'], $task['output-method'], $task['parameters-mode']);
            }
            $jobObjects[] = new Job(new ArrayCollection($taskObjects));
        }
        $this->workflow->setJobs(new ArrayCollection($jobObjects));

        return $this->workflow;
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\Structure\Job;
7			use Pheanstalk\Structure\Task;
8			use Pheanstalk\Structure\Workflow;
9
10			/**
11			* The 'GetWorkflow' command.
12			*
13			* Retrieve a workflow by its id, if there is no workflow for the id given in the construct, returns false
14			*
15			* @author Valentin Corre
16			* @package Pheanstalk
17			* @license http://www.opensource.org/licenses/mit-license.php
18			*/
19			class GetWorkflowCommand extends AbstractCommand implements \Pheanstalk\ResponseParser
20			{
21
22			/** @var Workflow $workflow */
23			private $workflow;
24
25			/**
26			* GetWorkflowCommand constructor.
27			*
28			* @param Workflow $workflow
29			*/
30			public function __construct(Workflow $workflow)
31			{
32			$this->workflow = $workflow;
33			}
34
35			/**
36			* @inheritDoc
37			*/
38			public function getGroup(): string
39			{
40			return 'workflow';
41			}
42
43			/**
44			* @inheritDoc
45			*/
46			public function getAction(): string
47			{
48			return 'get';
49			}
50
51			/**
52			* @inheritDoc
53			*/
54			public function getFilters(): array
55			{
56			return [
57			'id' => $this->workflow->getId()
58			];
59			}
60
61			/**
62			* @inheritDoc
63			*/
64			public function getResponseParser()
65			{
66			return $this;
67			}
68
69			/**
70			* @inheritDoc
71			*/
72			public function parseResponse($responseLine, $responseData)
73			{
74			$workflow = $responseData['workflow'];
75			$jobs = $workflow['workflow']['subjobs'];
76			$workflow = $workflow['@attributes'] ?? $workflow;
			0 ignored issues – show Unused Code introduced 2019-07-26 14:57 UTC by Report Bug Copy Issue Report The assignment to `$workflow` is dead and can be removed. Loading history...
77			$jobObjects = [];
78			foreach ($jobs as $job) {
79			$taskObjects = [];
80			foreach ($job['tasks'] as $task) {
81			$task = $task['@attributes'];
82			$taskObjects[] = new Task($task['path'], $task['queue'], $task['use-agent'], $task['user'], $task['host'], $task['output-method'], $task['parameters-mode']);
83			}
84			$jobObjects[] = new Job(new ArrayCollection($taskObjects));
85			}
86			$this->workflow->setJobs(new ArrayCollection($jobObjects));
87
88			return $this->workflow;
			0 ignored issues – show Bug Best Practice introduced 2019-07-29 10:41 UTC by Report Bug Copy Issue Report The expression `return $this->workflow` returns the type `Pheanstalk\Structure\Workflow` 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...
89			}
90			}
91

PyRowMan / pheanstalk

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

GetWorkflowCommand::getResponseParser() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like