Kaliop\eZMigrationBundle\Core\Executor\SectionManager

Complexity

Total Complexity

26

Size/Duplication

Total Lines	154
Duplicated Lines	37.66 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	create()	0	15	1
B	update()	0	28	6
A	delete()	0	12	2
B	matchSections()	21	21	5
C	setReferences()	37	37	11

<?php

namespace Kaliop\eZMigrationBundle\Core\Executor;

use Kaliop\eZMigrationBundle\API\Collection\SectionCollection;
use Kaliop\eZMigrationBundle\Core\Matcher\SectionMatcher;

/**
 * Implements the actions for managing (create/update/delete) section in the system through
 * migrations and abstracts away the eZ Publish Public API.
 */
class SectionManager extends RepositoryExecutor
{
    protected $supportedStepTypes = array('section');

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

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

    /**
     * Handle the section create migration action
     */
    protected function create()
    {
        $sectionService = $this->repository->getSectionService();

        $sectionCreateStruct = $sectionService->newSectionCreateStruct();

        $sectionCreateStruct->identifier = $this->dsl['identifier'];
        $sectionCreateStruct->name = $this->dsl['name'];

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

        $this->setReferences($section);

        return $section;
    }

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

        if (count($sectionCollection) > 1 && array_key_exists('references', $this->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) {

The expression $sectionCollection of type object<Kaliop\eZMigrationBundle\API\Collection\SectionCollection>|null is not guaranteed to be traversable. How about adding an additional type check?

            $sectionUpdateStruct = $sectionService->newSectionUpdateStruct();

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

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

            $sectionCollection[$key] = $section;
        }

        $this->setReferences($sectionCollection);

It seems like $sectionCollection defined by $this->matchSections('update') on line 51 can be null; however, Kaliop\eZMigrationBundle\Core\Executor\SectionManager::setReferences() does not accept null, maybe add an additional type check?

        return $sectionCollection;
    }

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

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

        foreach ($sectionCollection as $section) {

The expression $sectionCollection of type object<Kaliop\eZMigrationBundle\API\Collection\SectionCollection>|null is not guaranteed to be traversable. How about adding an additional type check?

            $sectionService->deleteSection($section);
        }

        return $sectionCollection;
    }

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

This method seems to be duplicated in your project.

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

        $match = $this->dsl['match'];

        // convert the references passed in the match
        foreach ($match as $condition => $values) {
            if (is_array($values)) {
                foreach ($values as $position => $value) {
                    $match[$condition][$position] = $this->referenceResolver->resolveReference($value);
                }
            } else {
                $match[$condition] = $this->referenceResolver->resolveReference($values);
            }
        }

        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)

This method seems to be duplicated in your project.

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

        if ($section instanceof SectionCollection) {
            if (count($section) > 1) {
                throw new \InvalidArgumentException('Section Manager does not support setting references for creating/updating of multiple sections');
            }
            $section = reset($section);
        }

        foreach ($this->dsl['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']);
            }

            $this->referenceResolver->addReference($reference['identifier'], $value);

It seems like you code against a concrete implementation and not the interface Kaliop\eZMigrationBundle\API\ReferenceResolverInterface as the method addReference() does only exist in the following implementations of said interface: Kaliop\eZMigrationBundle\Core\ReferenceResolver\ChainPrefixResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\ChainRegexpResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\ChainResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\CustomReferenceResolver.

        }

        return true;
    }
}