ProcessState::markExit() - Code Metrics - Inspection of "Je veux un contexte de boucle ainsi qu'un accès pl..." - jean-pasqualini/import - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 0.4 (#42)

by jean

created 2018-08-01 18:37 UTC

ProcessState::markExit() A

↳ Parent: ProcessState

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Darkilliant\ProcessBundle\State;

use Psr\Log\AbstractLogger;
use Psr\Log\LoggerInterface;
use Darkilliant\ProcessBundle\Runner\StepRunner;

class ProcessState extends AbstractLogger
{
    const RESULT_KO = 1;
    const RESULT_SKIP = 2;
    const RESULT_OK = 3;
    const RESULT_BREAK = 4;
    const RESULT_EXIT = 5;

    private $data;
    private $loopContext;
    private $logContext = [];
    private $context = [];
    private $options = [];
    private $logger;
    private $result;

    private $dryRun = false;

    /** @var StepRunner */
    private $stepRunner;

    /** @var \Traversable */
    private $iterator;

    private $name;

    private $loop;

    public function __construct(array $context, LoggerInterface $logger, StepRunner $stepRunner)
    {
        $this->context = $context;
        $this->logger = $logger;
        $this->stepRunner = $stepRunner;
    }

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

    /**
     * @return mixed
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * @param mixed $data
     */
    public function setData($data)
    {
        $this->data = $data;
    }

    /**
     * @return mixed
     */
    public function getContext($key, $default = null)
    {
        return $this->context[$key] ?? $default;
    }

    public function getLoop()
    {
        return $this->loop;
    }

    public function noLoop()
    {
        $this->loop = null;
        $this->loopContext = null;
    }

    public function loop(int $index, int $count, bool $last)
    {
        $this->loop = [
            'index' => $index,
            'count' => $count,
            'last' => $last,
        ];
    }

    public function isLoop()
    {
        return (bool) $this->loop;
    }

    public function setContext(string $key, $value, bool $logContext = true)
    {
        $this->context[$key] = $value;
        if ($logContext) {
            $this->logContext[$key] = $value;
        }
    }

    public function hasContext(string $key): bool
    {
        return isset($this->context[$key]);
    }

    public function setLoopContext($value)
    {
        $this->loopContext = $value;
    }

    public function getLoopContext()
    {
        return $this->loopContext;
    }

    public function getRawContext(): array
    {
        return $this->context;
    }

    /**
     * @return LoggerInterface
     */
    public function getLogger(): LoggerInterface
    {
        return $this->logger;
    }

    /**
     * @return array
     */
    public function getOptions(): array
    {
        return $this->options;
    }

    public function getOption($name, $default = null)
    {
        return $this->options[$name] ?? $default;
    }

    /**
     * @param array $options
     */
    public function setOptions(array $options): ProcessState
    {
        $this->options = $options;

        return $this;
    }

    public function hasOption(string $name): bool
    {
        return isset($this->options[$name]);
    }

    public function log($level, $message, array $context = [])
    {
        $this->logger->log($level, $message, array_merge($context, $this->logContext));
    }

    public function getResult()
    {
        return $this->result;
    }

    public function markFail()
    {
        $this->result = self::RESULT_KO;
    }

    public function markIgnore()
    {
        $this->result = self::RESULT_SKIP;
    }

    public function markSuccess()
    {
        $this->result = self::RESULT_OK;
    }

    public function markBreak()
    {
        $this->result = self::RESULT_BREAK;
    }

    public function markExit()
    {
        $this->result = self::RESULT_EXIT;
    }

    public function getStepRunner(): StepRunner
    {
        return $this->stepRunner;
    }

    public function duplicate($logger = null): self
    {
        $duplicate = new self($this->context, $logger ?? $this->logger, $this->stepRunner);
        $duplicate->setData($this->data);

        return $duplicate;
    }

    /**
     * @return \ArrayIterator
     */
    public function getIterator()
    {
        return $this->iterator;
    }

    /**
     * @param \Traversable $iterator
     */
    public function setIterator($iterator)
    {
        $this->iterator = $iterator;
    }

    public function setDryRun(bool $dryRun)
    {
        $this->dryRun = $dryRun;
    }

    public function isDryRun(): bool
    {
        return $this->dryRun;
    }

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Darkilliant\ProcessBundle\State;
6
7		use Psr\Log\AbstractLogger;
8		use Psr\Log\LoggerInterface;
9		use Darkilliant\ProcessBundle\Runner\StepRunner;
10
11		class ProcessState extends AbstractLogger
12		{
13		const RESULT_KO = 1;
14		const RESULT_SKIP = 2;
15		const RESULT_OK = 3;
16		const RESULT_BREAK = 4;
17		const RESULT_EXIT = 5;
18
19		private $data;
20		private $loopContext;
21		private $logContext = [];
22		private $context = [];
23		private $options = [];
24		private $logger;
25		private $result;
26
27		private $dryRun = false;
28
29		/** @var StepRunner */
30		private $stepRunner;
31
32		/** @var \Traversable */
33		private $iterator;
34
35		private $name;
36
37		private $loop;
38
39	159	public function __construct(array $context, LoggerInterface $logger, StepRunner $stepRunner)
40		{
41	159	$this->context = $context;
42	159	$this->logger = $logger;
43	159	$this->stepRunner = $stepRunner;
44	159	}
45
46	9	public function setName(string $name)
47		{
48	9	$this->name = $name;
49	9	}
50
51		/**
52		* @return mixed
53		*/
54	39	public function getData()
55		{
56	39	return $this->data;
57		}
58
59		/**
60		* @param mixed $data
61		*/
62	44	public function setData($data)
63		{
64	44	$this->data = $data;
65	44	}
66
67		/**
68		* @return mixed
69		*/
70	9	public function getContext($key, $default = null)
71		{
72	9	return $this->context[$key] ?? $default;
73		}
74
75	3	public function getLoop()
76		{
77	3	return $this->loop;
78		}
79
80	4	public function noLoop()
81		{
82	4	$this->loop = null;
83	4	$this->loopContext = null;
84	4	}
85
86	8	public function loop(int $index, int $count, bool $last)
87		{
88	8	$this->loop = [
89	8	'index' => $index,
90	8	'count' => $count,
91	8	'last' => $last,
92		];
93	8	}
94
95	2	public function isLoop()
96		{
97	2	return (bool) $this->loop;
98		}
99
100	24	public function setContext(string $key, $value, bool $logContext = true)
101		{
102	24	$this->context[$key] = $value;
103	24	if ($logContext) {
104	24	$this->logContext[$key] = $value;
105		}
106	24	}
107
108	1	public function hasContext(string $key): bool
109		{
110	1	return isset($this->context[$key]);
111		}
112
113	4	public function setLoopContext($value)
114		{
115	4	$this->loopContext = $value;
116	4	}
117
118	4	public function getLoopContext()
119		{
120	4	return $this->loopContext;
121		}
122
123	8	public function getRawContext(): array
124		{
125	8	return $this->context;
126		}
127
128		/**
129		* @return LoggerInterface
130		*/
131	5	public function getLogger(): LoggerInterface
132		{
133	5	return $this->logger;
134		}
135
136		/**
137		* @return array
138		*/
139	89	public function getOptions(): array
140		{
141	89	return $this->options;
142		}
143
144	1	public function getOption($name, $default = null)
145		{
146	1	return $this->options[$name] ?? $default;
147		}
148
149		/**
150		* @param array $options
151		*/
152	102	public function setOptions(array $options): ProcessState
153		{
154	102	$this->options = $options;
155
156	102	return $this;
157		}
158
159	1	public function hasOption(string $name): bool
160		{
161	1	return isset($this->options[$name]);
162		}
163
164	40	public function log($level, $message, array $context = [])
165		{
166	40	$this->logger->log($level, $message, array_merge($context, $this->logContext));
167	40	}
168
169	25	public function getResult()
170		{
171	25	return $this->result;
172		}
173
174	5	public function markFail()
175		{
176	5	$this->result = self::RESULT_KO;
177	5	}
178
179	4	public function markIgnore()
180		{
181	4	$this->result = self::RESULT_SKIP;
182	4	}
183
184	20	public function markSuccess()
185		{
186	20	$this->result = self::RESULT_OK;
187	20	}
188
189	5	public function markBreak()
190		{
191	5	$this->result = self::RESULT_BREAK;
192	5	}
193
194	1	public function markExit()
195		{
196	1	$this->result = self::RESULT_EXIT;
197	1	}
198
199	3	public function getStepRunner(): StepRunner
200		{
201	3	return $this->stepRunner;
202		}
203
204	1	public function duplicate($logger = null): self
205		{
206	1	$duplicate = new self($this->context, $logger ?? $this->logger, $this->stepRunner);
207	1	$duplicate->setData($this->data);
208
209	1	return $duplicate;
210		}
211
212		/**
213		* @return \ArrayIterator
214		*/
215	19	public function getIterator()
216		{
217	19	return $this->iterator;
218		}
219
220		/**
221		* @param \Traversable $iterator
222		*/
223	23	public function setIterator($iterator)
224		{
225	23	$this->iterator = $iterator;
226	23	}
227
228	15	public function setDryRun(bool $dryRun)
229		{
230	15	$this->dryRun = $dryRun;
231	15	}
232
233	10	public function isDryRun(): bool
234		{
235	10	return $this->dryRun;
236		}
237
238	1	public function getName(): string
239		{
240	1	return $this->name;
241		}
242		}
243

jean-pasqualini / import

Pull Request — 0.4 (#42)

ProcessState::markExit() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like