ProcessingInstructionsTrait::setProcessingInstructions() - Code Metrics - Inspection of "Extracted object properties traits" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8c9387...9f1772 )

by Joschi

created 2016-05-08 08:55 UTC

setProcessingInstructions() A

↳ Parent: ProcessingInstructionsTrait

Complexity

Conditions	4
Paths	2

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Domain
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Domain\Model\Object\Traits;
use Apparat\Object\Domain\Model\Properties\GenericPropertiesInterface;
use Apparat\Object\Domain\Model\Properties\ProcessingInstructions;

/**
 * Processing instructions trait
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain
 */
trait ProcessingInstructionsTrait
{
    /**
     * Processing instructions
     *
     * @var ProcessingInstructions
     */
    protected $processingInstructions;

    /**
     * Set the processing instruction collection
     *
     * @param GenericPropertiesInterface $processingInstructions Processing instruction collection
     * @param bool $overwrite Overwrite the existing collection (if present)
     */
    protected function setProcessingInstructions(GenericPropertiesInterface $processingInstructions, $overwrite = false)
    {
        $this->processingInstructions = $processingInstructions;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $processingInstructionsState = spl_object_hash($this->processingInstructions);

        // If the domain property collection state has changed
        if (!$overwrite
            && !empty($this->collectionStates[ProcessingInstructions::COLLECTION])
class MyClass { }

$x = new MyClass();
$x->foo = true;
            && ($processingInstructionsState !== $this->collectionStates[ProcessingInstructions::COLLECTION])
        ) {
            // Flag this object as dirty
            $this->setDirtyState();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        $this->collectionStates[ProcessingInstructions::COLLECTION] = $processingInstructionsState;
    }
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\Domain
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Apparat\Object\Domain\Model\Object\Traits;
38		use Apparat\Object\Domain\Model\Properties\GenericPropertiesInterface;
39		use Apparat\Object\Domain\Model\Properties\ProcessingInstructions;
40
41		/**
42		* Processing instructions trait
43		*
44		* @package Apparat\Object
45		* @subpackage Apparat\Object\Domain
46		*/
47		trait ProcessingInstructionsTrait
48		{
49		/**
50		* Processing instructions
51		*
52		* @var ProcessingInstructions
53		*/
54		protected $processingInstructions;
55
56		/**
57		* Set the processing instruction collection
58		*
59		* @param GenericPropertiesInterface $processingInstructions Processing instruction collection
60		* @param bool $overwrite Overwrite the existing collection (if present)
61		*/
62	18	protected function setProcessingInstructions(GenericPropertiesInterface $processingInstructions, $overwrite = false)
63		{
64	18	$this->processingInstructions = $processingInstructions;
		0 ignored issues – show Documentation Bug introduced 2016-05-08 08:58 UTC by Report Bug Copy Issue Report `$processingInstructions` is of type `object<Apparat\Object\Do...ricPropertiesInterface>`, but the property `$processingInstructions` was declared to be of type `object<Apparat\Object\Do...ProcessingInstructions>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
65	18	$processingInstructionsState = spl_object_hash($this->processingInstructions);
66
67		// If the domain property collection state has changed
68	18	if (!$overwrite
69	18	&& !empty($this->collectionStates[ProcessingInstructions::COLLECTION])
		0 ignored issues – show Bug introduced 2016-05-08 08:58 UTC by Report Bug Copy Issue Report The property `collectionStates` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
70	18	&& ($processingInstructionsState !== $this->collectionStates[ProcessingInstructions::COLLECTION])
71		) {
72		// Flag this object as dirty
73	1	$this->setDirtyState();
		0 ignored issues – show Bug introduced 2016-05-08 08:58 UTC by Report Bug Copy Issue Report It seems like `setDirtyState()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
74		}
75
76	18	$this->collectionStates[ProcessingInstructions::COLLECTION] = $processingInstructionsState;
77	18	}
78		}
79

apparat / object

Push — master ( 8c9387...9f1772 )

setProcessingInstructions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like