SectionManager::matchSections() - Code Metrics - Inspection of "more flexibility with tags; allow to set array ref..." - kaliop-uk/ezmigrationbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 09cee1...75eab4 )

by Gaetano

created 2018-05-12 16:39 UTC

SectionManager::matchSections() A

↳ Parent: SectionManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	11
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	11
loc	11
ccs	0
cts	7
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	2
crap	6

<?php

namespace Kaliop\eZMigrationBundle\Core\Executor;

use eZ\Publish\API\Repository\Values\Content\Section;
use Kaliop\eZMigrationBundle\API\Collection\SectionCollection;
use Kaliop\eZMigrationBundle\API\MigrationGeneratorInterface;
use Kaliop\eZMigrationBundle\Core\Matcher\SectionMatcher;

/**
 * Handles section migrations.
 */
class SectionManager extends RepositoryExecutor implements MigrationGeneratorInterface
{
    protected $supportedStepTypes = array('section');

    /** @var SectionMatcher $sectionMatcher */
    protected $sectionMatcher;

    /**
     * @param SectionMatcher $sectionMatcher
     */
    public function __construct(SectionMatcher $sectionMatcher)
    {
        $this->sectionMatcher = $sectionMatcher;
    }

    /**
     * Handles the section create migration action
     */
    protected function create($step)
    {
        foreach (array('name', 'identifier') as $key) {

            if (!isset($step->dsl[$key])) {
                throw new \Exception("The '$key' key is missing in a section creation definition");
            }
        }

        $sectionService = $this->repository->getSectionService();

        $sectionCreateStruct = $sectionService->newSectionCreateStruct();

        $sectionIdentifier = $this->referenceResolver->resolveReference($step->dsl['identifier']);
        $sectionCreateStruct->identifier = $sectionIdentifier;
        $sectionCreateStruct->name = $step->dsl['name'];

        $section = $sectionService->createSection($sectionCreateStruct);

        $this->setReferences($section, $step);

        return $section;
    }

    /**
     * Handles the section update migration action
     */
    protected function update($step)
    {
        $sectionCollection = $this->matchSections('update', $step);

        if (count($sectionCollection) > 1 && array_key_exists('references', $step->dsl)) {
            throw new \Exception("Can not execute Section update because multiple types match, and a references section is specified in the dsl. References can be set when only 1 section matches");
        }

        $sectionService = $this->repository->getSectionService();
        foreach ($sectionCollection as $key => $section) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $sectionUpdateStruct = $sectionService->newSectionUpdateStruct();

            if (isset($step->dsl['identifier'])) {
                $sectionUpdateStruct->identifier = $this->referenceResolver->resolveReference($step->dsl['identifier']);
            }
            if (isset($step->dsl['name'])) {
                $sectionUpdateStruct->name = $step->dsl['name'];
            }

            $section = $sectionService->updateSection($section, $sectionUpdateStruct);

            $sectionCollection[$key] = $section;
        }

        $this->setReferences($sectionCollection, $step);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        return $sectionCollection;
    }

    /**
     * Handles the section delete migration action
     */
    protected function delete($step)
    {
        $sectionCollection = $this->matchSections('delete', $step);

        $this->setReferences($sectionCollection, $step);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        $sectionService = $this->repository->getSectionService();

        foreach ($sectionCollection as $section) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $sectionService->deleteSection($section);
        }

        return $sectionCollection;
    }

    /**
     * @param string $action
     * @return SectionCollection
     * @throws \Exception
     */
    protected function matchSections($action, $step)

    {
        if (!isset($step->dsl['match'])) {
            throw new \Exception("A match condition is required to $action a section");
        }

        // convert the references passed in the match
        $match = $this->resolveReferencesRecursively($step->dsl['match']);

        return $this->sectionMatcher->match($match);
    }

    /**
     * Sets references to certain section attributes.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Section|SectionCollection $section
     * @throws \InvalidArgumentException When trying to set a reference to an unsupported attribute
     * @return boolean
     */
    protected function setReferences($section, $step)

    {
        if (!array_key_exists('references', $step->dsl)) {
            return false;
        }

        $references = $this->setReferencesCommon($section, $step->dsl['references']);
        $section = $this->insureSingleEntity($section, $references);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }

    /**
     * @param Section $section
     * @param array $references the definitions of the references to set
     * @throws \InvalidArgumentException When trying to assign a reference to an unsupported attribute
     * @return array key: the reference names, values: the reference values
     */
    protected function getReferencesValues(Section $section, array $references)
    {
        $refs = array();

        foreach ($references as $reference) {

            switch ($reference['attribute']) {
                case 'section_id':
                case 'id':
                    $value = $section->id;
                    break;
                case 'section_identifier':
                case 'identifier':
                    $value = $section->identifier;
                    break;
                case 'section_name':
                case 'name':
                    $value = $section->name;
                    break;
                default:
                    throw new \InvalidArgumentException('Section Manager does not support setting references for attribute ' . $reference['attribute']);
            }

            $refs[$reference['identifier']] = $value;
        }

        return $refs;
    }

    /**
     * @param array $matchCondition
     * @param string $mode
     * @param array $context
     * @throws \Exception
     * @return array
     */
    public function generateMigration(array $matchCondition, $mode, array $context = array())

    {
        $previousUserId = $this->loginUser($this->getAdminUserIdentifierFromContext($context));
        $sectionCollection = $this->sectionMatcher->match($matchCondition);
        $data = array();

        /** @var \eZ\Publish\API\Repository\Values\Content\Section $section */
        foreach ($sectionCollection as $section) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }

            $sectionData = array(
                'type' => reset($this->supportedStepTypes),
                'mode' => $mode,
            );

            switch ($mode) {
                case 'create':
                    $sectionData = array_merge(
                        $sectionData,
                        array(
                            'identifier' => $section->identifier,
                            'name' => $section->name,
                        )
                    );
                    break;
                case 'update':
                    $sectionData = array_merge(
                        $sectionData,
                        array(
                            'match' => array(
                                SectionMatcher::MATCH_SECTION_ID => $section->id
                            ),
                            'identifier' => $section->identifier,
                            'name' => $section->name,
                        )
                    );
                    break;
                case 'delete':
                    $sectionData = array_merge(
                        $sectionData,
                        array(
                            'match' => array(
                                SectionMatcher::MATCH_SECTION_ID => $section->id
                            )
                        )
                    );
                    break;
                default:
                    throw new \Exception("Executor 'section' doesn't support mode '$mode'");
            }

            $data[] = $sectionData;
        }

        $this->loginUser($previousUserId);
        return $data;
    }
}


1		<?php
2
3		namespace Kaliop\eZMigrationBundle\Core\Executor;
4
5		use eZ\Publish\API\Repository\Values\Content\Section;
6		use Kaliop\eZMigrationBundle\API\Collection\SectionCollection;
7		use Kaliop\eZMigrationBundle\API\MigrationGeneratorInterface;
8		use Kaliop\eZMigrationBundle\Core\Matcher\SectionMatcher;
9
10		/**
11		* Handles section migrations.
12		*/
13		class SectionManager extends RepositoryExecutor implements MigrationGeneratorInterface
14		{
15		protected $supportedStepTypes = array('section');
16
17		/** @var SectionMatcher $sectionMatcher */
18		protected $sectionMatcher;
19
20		/**
21		* @param SectionMatcher $sectionMatcher
22		*/
23		public function __construct(SectionMatcher $sectionMatcher)
24		{
25		$this->sectionMatcher = $sectionMatcher;
26		}
27
28		/**
29		* Handles the section create migration action
30		*/
31		protected function create($step)
32		{
33	View Code Duplication	foreach (array('name', 'identifier') as $key) {
		0 ignored issues – show Duplication introduced 2016-10-16 16:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
34		if (!isset($step->dsl[$key])) {
35		throw new \Exception("The '$key' key is missing in a section creation definition");
36		}
37		}
38
39		$sectionService = $this->repository->getSectionService();
40
41		$sectionCreateStruct = $sectionService->newSectionCreateStruct();
42
43		$sectionIdentifier = $this->referenceResolver->resolveReference($step->dsl['identifier']);
44		$sectionCreateStruct->identifier = $sectionIdentifier;
45		$sectionCreateStruct->name = $step->dsl['name'];
46
47		$section = $sectionService->createSection($sectionCreateStruct);
48
49		$this->setReferences($section, $step);
50
51		return $section;
52		}
53
54		/**
55		* Handles the section update migration action
56		*/
57		protected function update($step)
58		{
59		$sectionCollection = $this->matchSections('update', $step);
60
61		if (count($sectionCollection) > 1 && array_key_exists('references', $step->dsl)) {
62		throw new \Exception("Can not execute Section update because multiple types match, and a references section is specified in the dsl. References can be set when only 1 section matches");
63		}
64
65		$sectionService = $this->repository->getSectionService();
66		foreach ($sectionCollection as $key => $section) {
		0 ignored issues – show Bug introduced 2017-02-12 16:09 UTC by Report Bug Copy Issue Report The expression `$sectionCollection` of type `object<Kaliop\eZMigratio...SectionCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
67		$sectionUpdateStruct = $sectionService->newSectionUpdateStruct();
68
69		if (isset($step->dsl['identifier'])) {
70		$sectionUpdateStruct->identifier = $this->referenceResolver->resolveReference($step->dsl['identifier']);
71		}
72		if (isset($step->dsl['name'])) {
73		$sectionUpdateStruct->name = $step->dsl['name'];
74		}
75
76		$section = $sectionService->updateSection($section, $sectionUpdateStruct);
77
78		$sectionCollection[$key] = $section;
79		}
80
81		$this->setReferences($sectionCollection, $step);
		0 ignored issues – show Bug introduced 2017-05-13 23:58 UTC by Report Bug Copy Issue Report It seems like `$sectionCollection` defined by `$this->matchSections('update', $step)` on line `59` can be `null`; however, `Kaliop\eZMigrationBundle...anager::setReferences()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
82
83		return $sectionCollection;
84		}
85
86		/**
87		* Handles the section delete migration action
88		*/
89		protected function delete($step)
90		{
91		$sectionCollection = $this->matchSections('delete', $step);
92
93		$this->setReferences($sectionCollection, $step);
		0 ignored issues – show Bug introduced 2017-06-06 18:01 UTC by Report Bug Copy Issue Report It seems like `$sectionCollection` defined by `$this->matchSections('delete', $step)` on line `91` can be `null`; however, `Kaliop\eZMigrationBundle...anager::setReferences()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
94
95		$sectionService = $this->repository->getSectionService();
96
97		foreach ($sectionCollection as $section) {
		0 ignored issues – show Bug introduced 2017-02-12 16:09 UTC by Report Bug Copy Issue Report The expression `$sectionCollection` of type `object<Kaliop\eZMigratio...SectionCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
98		$sectionService->deleteSection($section);
99		}
100
101		return $sectionCollection;
102		}
103
104		/**
105		* @param string $action
106		* @return SectionCollection
107		* @throws \Exception
108		*/
109	View Code Duplication	protected function matchSections($action, $step)
		0 ignored issues – show Duplication introduced 2017-11-09 09:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		{
111		if (!isset($step->dsl['match'])) {
112		throw new \Exception("A match condition is required to $action a section");
113		}
114
115		// convert the references passed in the match
116		$match = $this->resolveReferencesRecursively($step->dsl['match']);
117
118		return $this->sectionMatcher->match($match);
119		}
120
121		/**
122		* Sets references to certain section attributes.
123		*
124		* @param \eZ\Publish\API\Repository\Values\Content\Section\|SectionCollection $section
125		* @throws \InvalidArgumentException When trying to set a reference to an unsupported attribute
126		* @return boolean
127		*/
128	View Code Duplication	protected function setReferences($section, $step)
		0 ignored issues – show Duplication introduced 2017-08-29 17:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
129		{
130		if (!array_key_exists('references', $step->dsl)) {
131		return false;
132		}
133
134		$references = $this->setReferencesCommon($section, $step->dsl['references']);
135		$section = $this->insureSingleEntity($section, $references);
		0 ignored issues – show Unused Code introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report `$section` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
136		}
137
138		/**
139		* @param Section $section
140		* @param array $references the definitions of the references to set
141		* @throws \InvalidArgumentException When trying to assign a reference to an unsupported attribute
142		* @return array key: the reference names, values: the reference values
143		*/
144		protected function getReferencesValues(Section $section, array $references)
145		{
146		$refs = array();
147
148	View Code Duplication	foreach ($references as $reference) {
		0 ignored issues – show Duplication introduced 2017-07-01 23:08 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
149		switch ($reference['attribute']) {
150		case 'section_id':
151		case 'id':
152		$value = $section->id;
153		break;
154		case 'section_identifier':
155		case 'identifier':
156		$value = $section->identifier;
157		break;
158		case 'section_name':
159		case 'name':
160		$value = $section->name;
161		break;
162		default:
163		throw new \InvalidArgumentException('Section Manager does not support setting references for attribute ' . $reference['attribute']);
164		}
165
166		$refs[$reference['identifier']] = $value;
167		}
168
169		return $refs;
170		}
171
172		/**
173		* @param array $matchCondition
174		* @param string $mode
175		* @param array $context
176		* @throws \Exception
177		* @return array
178		*/
179	View Code Duplication	public function generateMigration(array $matchCondition, $mode, array $context = array())
		0 ignored issues – show Duplication introduced 2017-08-29 17:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
180		{
181		$previousUserId = $this->loginUser($this->getAdminUserIdentifierFromContext($context));
182		$sectionCollection = $this->sectionMatcher->match($matchCondition);
183		$data = array();
184
185		/** @var \eZ\Publish\API\Repository\Values\Content\Section $section */
186		foreach ($sectionCollection as $section) {
		0 ignored issues – show Bug introduced 2017-02-20 00:00 UTC by Report Bug Copy Issue Report The expression `$sectionCollection` of type `object<Kaliop\eZMigratio...SectionCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
187
188		$sectionData = array(
189		'type' => reset($this->supportedStepTypes),
190		'mode' => $mode,
191		);
192
193		switch ($mode) {
194		case 'create':
195		$sectionData = array_merge(
196		$sectionData,
197		array(
198		'identifier' => $section->identifier,
199		'name' => $section->name,
200		)
201		);
202		break;
203		case 'update':
204		$sectionData = array_merge(
205		$sectionData,
206		array(
207		'match' => array(
208		SectionMatcher::MATCH_SECTION_ID => $section->id
209		),
210		'identifier' => $section->identifier,
211		'name' => $section->name,
212		)
213		);
214		break;
215		case 'delete':
216		$sectionData = array_merge(
217		$sectionData,
218		array(
219		'match' => array(
220		SectionMatcher::MATCH_SECTION_ID => $section->id
221		)
222		)
223		);
224		break;
225		default:
226		throw new \Exception("Executor 'section' doesn't support mode '$mode'");
227		}
228
229		$data[] = $sectionData;
230		}
231
232		$this->loginUser($previousUserId);
233		return $data;
234		}
235		}
236

kaliop-uk / ezmigrationbundle

Push — master ( 09cee1...75eab4 )

SectionManager::matchSections() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like