ImportRun::timestampsToState() - Code Metrics - Inspection of "timestampToState static function" - mathielen/import-engine - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 300670...9cad2d )

by Markus

created 2016-03-10 19:15 UTC

ImportRun::timestampsToState() A

↳ Parent: ImportRun

Complexity

Conditions	4
Paths	4

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	14
ccs	8
cts	8
cp	1
rs	9.2
cc	4
eloc	8
nc	4
nop	3
crap	4

<?php
namespace Mathielen\ImportEngine\ValueObject;

class ImportRun
{

    const STATE_REVOKED = 'revoked';
    const STATE_FINISHED = 'finished';
    const STATE_CREATED = 'created';
    const STATE_VALIDATED = 'validated';

    protected $id;

    /**
     * @var ImportConfiguration
     */
    protected $configuration;

    /**
     * @var \DateTime
     */
    protected $createdAt;
    protected $createdBy;

    /**
     * @var \DateTime
     */
    protected $validatedAt;
    protected $validationMessages;

    /**
     * @var \DateTime
     */
    protected $finishedAt;

    /**
     * @var \DateTime
     */
    protected $revokedAt;
    protected $revokedBy;

    protected $statistics = array();
    protected $info = array();

    /**
     * arbitrary data
     */
    protected $context;

    public function __construct(ImportConfiguration $configuration=null, $createdBy = null)
    {
        $this->id = uniqid();
        $this->createdAt = new \DateTime();
        $this->configuration = $configuration;
        $this->createdBy = $createdBy;
    }

    /**
     * @return ImportRun
     */
    public static function create(ImportConfiguration $configuration=null, $createdBy = null)
    {
        return new self($configuration, $createdBy);
    }

    /**
     * @return ImportRun
     */
    public function setContext($context)
    {
        //merge existing context with new one, if both are arrays
        if (is_array($context) && is_array($this->context)) {
            $context = array_merge($this->context, $context);
        }

        $this->context = $context;

        return $this;
    }

    public function getContext()
    {
        return $this->context;
    }

    public function getId()
    {
        return $this->id;
    }

    public function getCreatedBy()
    {
        return $this->createdBy;
    }

    /**
     * @return ImportRun
     */
    public function revoke($revokedBy = null)
    {
        if (!$this->isFinished()) {
            throw new \LogicException('Cannot revoke import if not already finished.');
        }

        $this->revokedAt = new \DateTime();
        $this->revokedBy = $revokedBy;

        return $this;
    }

    /**
     * @return ImportRun
     */
    public function reset()
    {
        $this->finishedAt = null;

        return $this;
    }

    public function isRevoked()
    {
        return $this->getState() == self::STATE_REVOKED;
    }

    /**
     * @return ImportRun
     */
    public function finish()
    {
        $this->finishedAt = new \DateTime();

        return $this;
    }

    public function isFinished()
    {
        return $this->getState() == self::STATE_FINISHED;
    }

    /**
     * @return ImportRun
     */
    public function validated(array $validationMessages=null)
    {
        $this->validatedAt = empty($this->validatedAt)?new \DateTime():$this->validatedAt;
        $this->validationMessages = $validationMessages;

        return $this;
    }

    public function getValidationMessages()
    {
        return $this->validationMessages;
    }

    public function isValidated()
    {
        return $this->isFinished() || $this->getState() == self::STATE_VALIDATED;
    }

    public function isRunnable()
    {
        return !$this->isFinished() && !$this->isRevoked();
    }

    /**
     * @return ImportConfiguration
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * @return ImportRun
     */
    public function setStatistics(array $statistics)
    {
        $this->statistics = $statistics;

        return $this;
    }

    public function getStatistics()
    {
        return $this->statistics;
    }

    /**
     * @return ImportRun
     */
    public function setInfo(array $info)
    {
        $this->info = $info;

        return $this;
    }

    public function getInfo()
    {
        return $this->info;
    }

    public function getState()
    {
        return self::timestampsToState($this->revokedAt, $this->finishedAt, $this->validatedAt);
    }

    public static function timestampsToState($revokedAt, $finishedAt, $validatedAt)
    {
        if (!empty($revokedAt)) {
            return self::STATE_REVOKED;
        }
        if (!empty($finishedAt)) {
            return self::STATE_FINISHED;
        }
        if (!empty($validatedAt)) {
            return self::STATE_VALIDATED;
        }

        return self::STATE_CREATED;
    }

    public function toArray()
    {
        return array(
            'id' => $this->id,
            'configuration' => $this->configuration?$this->configuration->toArray():null,
            'statistics' => $this->statistics,
            'created_by' => $this->createdBy,
            'created_at' => $this->createdAt->getTimestamp(),
            'revoked_by' => $this->revokedBy,
            'revoked_at' => $this->revokedAt?$this->revokedAt->getTimestamp():null,
            'finished_at' => $this->finishedAt?$this->finishedAt->getTimestamp():null,
            'state' => $this->getState()
        );
    }

}


1		<?php
2		namespace Mathielen\ImportEngine\ValueObject;
3
4		class ImportRun
5		{
6
7		const STATE_REVOKED = 'revoked';
8		const STATE_FINISHED = 'finished';
9		const STATE_CREATED = 'created';
10		const STATE_VALIDATED = 'validated';
11
12		protected $id;
13
14		/**
15		* @var ImportConfiguration
16		*/
17		protected $configuration;
18
19		/**
20		* @var \DateTime
21		*/
22		protected $createdAt;
23		protected $createdBy;
24
25		/**
26		* @var \DateTime
27		*/
28		protected $validatedAt;
29		protected $validationMessages;
30
31		/**
32		* @var \DateTime
33		*/
34		protected $finishedAt;
35
36		/**
37		* @var \DateTime
38		*/
39		protected $revokedAt;
40		protected $revokedBy;
41
42		protected $statistics = array();
43		protected $info = array();
44
45		/**
46		* arbitrary data
47		*/
48		protected $context;
49
50	29	public function __construct(ImportConfiguration $configuration=null, $createdBy = null)
51		{
52	29	$this->id = uniqid();
53	29	$this->createdAt = new \DateTime();
54	29	$this->configuration = $configuration;
55	29	$this->createdBy = $createdBy;
56	29	}
57
58		/**
59		* @return ImportRun
60		*/
61		public static function create(ImportConfiguration $configuration=null, $createdBy = null)
62		{
63		return new self($configuration, $createdBy);
64		}
65
66		/**
67		* @return ImportRun
68		*/
69	1	public function setContext($context)
70		{
71		//merge existing context with new one, if both are arrays
72	1	if (is_array($context) && is_array($this->context)) {
73		$context = array_merge($this->context, $context);
74		}
75
76	1	$this->context = $context;
77
78	1	return $this;
79		}
80
81	6	public function getContext()
82		{
83	6	return $this->context;
84		}
85
86	2	public function getId()
87		{
88	2	return $this->id;
89		}
90
91	1	public function getCreatedBy()
92		{
93	1	return $this->createdBy;
94		}
95
96		/**
97		* @return ImportRun
98		*/
99	1	public function revoke($revokedBy = null)
100		{
101	1	if (!$this->isFinished()) {
102		throw new \LogicException('Cannot revoke import if not already finished.');
103		}
104
105	1	$this->revokedAt = new \DateTime();
106	1	$this->revokedBy = $revokedBy;
107
108	1	return $this;
109		}
110
111		/**
112		* @return ImportRun
113		*/
114	1	public function reset()
115		{
116	1	$this->finishedAt = null;
117
118	1	return $this;
119		}
120
121	4	public function isRevoked()
122		{
123	4	return $this->getState() == self::STATE_REVOKED;
124		}
125
126		/**
127		* @return ImportRun
128		*/
129	14	public function finish()
130		{
131	14	$this->finishedAt = new \DateTime();
132
133	14	return $this;
134		}
135
136	5	public function isFinished()
137		{
138	5	return $this->getState() == self::STATE_FINISHED;
139		}
140
141		/**
142		* @return ImportRun
143		*/
144	1	public function validated(array $validationMessages=null)
145		{
146	1	$this->validatedAt = empty($this->validatedAt)?new \DateTime():$this->validatedAt;
147	1	$this->validationMessages = $validationMessages;
148
149	1	return $this;
150		}
151
152	1	public function getValidationMessages()
153		{
154	1	return $this->validationMessages;
155		}
156
157	1	public function isValidated()
158		{
159	1	return $this->isFinished() \|\| $this->getState() == self::STATE_VALIDATED;
160		}
161
162	5	public function isRunnable()
163		{
164	5	return !$this->isFinished() && !$this->isRevoked();
165		}
166
167		/**
168		* @return ImportConfiguration
169		*/
170	1	public function getConfiguration()
171		{
172	1	return $this->configuration;
173		}
174
175		/**
176		* @return ImportRun
177		*/
178	14	public function setStatistics(array $statistics)
179		{
180	14	$this->statistics = $statistics;
181
182	14	return $this;
183		}
184
185	2	public function getStatistics()
186		{
187	2	return $this->statistics;
188		}
189
190		/**
191		* @return ImportRun
192		*/
193	2	public function setInfo(array $info)
194		{
195	2	$this->info = $info;
196
197	2	return $this;
198		}
199
200	1	public function getInfo()
201		{
202	1	return $this->info;
203		}
204
205	17	public function getState()
206		{
207	17	return self::timestampsToState($this->revokedAt, $this->finishedAt, $this->validatedAt);
208		}
209
210	17	public static function timestampsToState($revokedAt, $finishedAt, $validatedAt)
211		{
212	17	if (!empty($revokedAt)) {
213	1	return self::STATE_REVOKED;
214		}
215	17	if (!empty($finishedAt)) {
216	13	return self::STATE_FINISHED;
217		}
218	16	if (!empty($validatedAt)) {
219	1	return self::STATE_VALIDATED;
220		}
221
222	16	return self::STATE_CREATED;
223		}
224
225	12	public function toArray()
226		{
227		return array(
228	12	'id' => $this->id,
229	12	'configuration' => $this->configuration?$this->configuration->toArray():null,
230	12	'statistics' => $this->statistics,
231	12	'created_by' => $this->createdBy,
232	12	'created_at' => $this->createdAt->getTimestamp(),
233	12	'revoked_by' => $this->revokedBy,
234	12	'revoked_at' => $this->revokedAt?$this->revokedAt->getTimestamp():null,
235	12	'finished_at' => $this->finishedAt?$this->finishedAt->getTimestamp():null,
236	12	'state' => $this->getState()
237	12	);
238		}
239
240		}
241

mathielen / import-engine

Push — master ( 300670...9cad2d )

ImportRun::timestampsToState() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like