ZoneDomain::removeComponent() - Code Metrics - Inspection of "Refactor component deletion using zone domain" - Synapse-Cmf/synapse-cmf - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — nyx-delete-component ( b55c61 )

by Quentin

created 2017-02-06 10:31 UTC

ZoneDomain::removeComponent() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	2

<?php

namespace Synapse\Cmf\Framework\Theme\Zone\Domain;

use Majora\Framework\Domain\ActionDispatcherDomain;
use Majora\Framework\Domain\Action\ActionFactory;
use Synapse\Cmf\Framework\Theme\ComponentType\Model\ComponentTypeInterface;
use Synapse\Cmf\Framework\Theme\Component\Entity\ComponentCollection;
use Synapse\Cmf\Framework\Theme\Component\Model\ComponentInterface;
use Synapse\Cmf\Framework\Theme\ZoneType\Model\ZoneTypeInterface;
use Synapse\Cmf\Framework\Theme\Zone\Model\ZoneInterface;

/**
 * Zone domain use cases class.
 */
class ZoneDomain extends ActionDispatcherDomain implements DomainInterface
{
    /**
     * @var ActionFactory
     */
    protected $commandFactory;

    /**
     * Construct.
     *
     * @param ActionFactory $commandFactory
     */
    public function __construct(ActionFactory $commandFactory)
    {
        $this->commandFactory = $commandFactory;

        parent::__construct($commandFactory); // backward compatibility
    }

    /**
     * @see DomainInterface::create()
     */
    public function create(ZoneTypeInterface $zoneType, ComponentCollection $components = null)
    {
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('create')
                ->setZoneType($zoneType)
                ->setComponents($components ?: new ComponentCollection())
            ->resolve()
        ;
    }

    /**
     * @see DomainInterface::edit()
     */
    public function edit(ZoneInterface $zone, ComponentCollection $components)
    {
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('edit')
                ->init($zone)
                ->setComponents($components)
            ->resolve()
        ;
    }

    /**
     * @see DomainInterface::addComponent()
     */
    public function addComponent(ZoneInterface $zone, ComponentTypeInterface $componentType, array $componentData = array())
    {
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('add_component')
                ->init($zone)
                ->setComponentType($componentType)
                ->setComponentData($componentData)
            ->resolve()
        ;
    }

    /**
     * @see DomainInterface::removeComponent()
     */
    public function removeComponent(ZoneInterface $zone, ComponentInterface $component)
    {
        return $this->commandFactory
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->createAction('delete_component')
                ->init($zone)
                ->setComponent($component)
            ->resolve()
        ;
    }
}


1			<?php
2
3			namespace Synapse\Cmf\Framework\Theme\Zone\Domain;
4
5			use Majora\Framework\Domain\ActionDispatcherDomain;
6			use Majora\Framework\Domain\Action\ActionFactory;
7			use Synapse\Cmf\Framework\Theme\ComponentType\Model\ComponentTypeInterface;
8			use Synapse\Cmf\Framework\Theme\Component\Entity\ComponentCollection;
9			use Synapse\Cmf\Framework\Theme\Component\Model\ComponentInterface;
10			use Synapse\Cmf\Framework\Theme\ZoneType\Model\ZoneTypeInterface;
11			use Synapse\Cmf\Framework\Theme\Zone\Model\ZoneInterface;
12
13			/**
14			* Zone domain use cases class.
15			*/
16			class ZoneDomain extends ActionDispatcherDomain implements DomainInterface
17			{
18			/**
19			* @var ActionFactory
20			*/
21			protected $commandFactory;
22
23			/**
24			* Construct.
25			*
26			* @param ActionFactory $commandFactory
27			*/
28			public function __construct(ActionFactory $commandFactory)
29			{
30			$this->commandFactory = $commandFactory;
31
32			parent::__construct($commandFactory); // backward compatibility
33			}
34
35			/**
36			* @see DomainInterface::create()
37			*/
38			public function create(ZoneTypeInterface $zoneType, ComponentCollection $components = null)
39			{
40			return $this->commandFactory
			0 ignored issues – show Bug introduced 2016-10-13 09:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `setZoneType()` does only exist in the following implementations of said interface: `Synapse\Cmf\Framework\Th...n\Command\CreateCommand`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
41			->createAction('create')
42			->setZoneType($zoneType)
43			->setComponents($components ?: new ComponentCollection())
44			->resolve()
45			;
46			}
47
48			/**
49			* @see DomainInterface::edit()
50			*/
51			public function edit(ZoneInterface $zone, ComponentCollection $components)
52			{
53			return $this->commandFactory
			0 ignored issues – show Bug introduced 2017-02-06 10:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `init()` does only exist in the following implementations of said interface: `Majora\Framework\Domain\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\FormatAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Th...n\Command\DeleteCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...and\AddComponentCommand`, `Synapse\Cmf\Framework\Th...\RemoveComponentCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Page\Bundle\Action\Page\AbstractAction`, `Synapse\Page\Bundle\Action\Page\CreateAction`, `Synapse\Page\Bundle\Action\Page\DeleteAction`, `Synapse\Page\Bundle\Action\Page\UpdateAction`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
54			->createAction('edit')
55			->init($zone)
56			->setComponents($components)
57			->resolve()
58			;
59			}
60
61			/**
62			* @see DomainInterface::addComponent()
63			*/
64			public function addComponent(ZoneInterface $zone, ComponentTypeInterface $componentType, array $componentData = array())
65			{
66			return $this->commandFactory
			0 ignored issues – show Bug introduced 2017-02-06 10:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `init()` does only exist in the following implementations of said interface: `Majora\Framework\Domain\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\FormatAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Th...n\Command\DeleteCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...and\AddComponentCommand`, `Synapse\Cmf\Framework\Th...\RemoveComponentCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Page\Bundle\Action\Page\AbstractAction`, `Synapse\Page\Bundle\Action\Page\CreateAction`, `Synapse\Page\Bundle\Action\Page\DeleteAction`, `Synapse\Page\Bundle\Action\Page\UpdateAction`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
67			->createAction('add_component')
68			->init($zone)
69			->setComponentType($componentType)
70			->setComponentData($componentData)
71			->resolve()
72			;
73			}
74
75			/**
76			* @see DomainInterface::removeComponent()
77			*/
78			public function removeComponent(ZoneInterface $zone, ComponentInterface $component)
79			{
80			return $this->commandFactory
			0 ignored issues – show Bug introduced 2017-02-06 10:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Majora\Framework\Domain\Action\ActionInterface` as the method `init()` does only exist in the following implementations of said interface: `Majora\Framework\Domain\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...e\Action\AbstractAction`, `Synapse\Cmf\Framework\Me...n\Dal\AbstractDalAction`, `Synapse\Cmf\Framework\Me...Action\Dal\CreateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\DeleteAction`, `Synapse\Cmf\Framework\Me...Action\Dal\FormatAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UpdateAction`, `Synapse\Cmf\Framework\Me...Action\Dal\UploadAction`, `Synapse\Cmf\Framework\Th...n\Command\DeleteCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Cmf\Framework\Th...and\AddComponentCommand`, `Synapse\Cmf\Framework\Th...\RemoveComponentCommand`, `Synapse\Cmf\Framework\Th...n\Command\UpdateCommand`, `Synapse\Page\Bundle\Action\Page\AbstractAction`, `Synapse\Page\Bundle\Action\Page\CreateAction`, `Synapse\Page\Bundle\Action\Page\DeleteAction`, `Synapse\Page\Bundle\Action\Page\UpdateAction`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
81			->createAction('delete_component')
82			->init($zone)
83			->setComponent($component)
84			->resolve()
85			;
86			}
87			}
88

Synapse-Cmf / synapse-cmf

Push — nyx-delete-component ( b55c61 )

ZoneDomain::removeComponent() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like