EzPlatformAdapter::executeAction() - Code Metrics - Inspection of "[WIP] Improve content api" - transfer-framework/ezplatform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.0 (#53)

by Harald

created 2016-05-08 18:11 UTC

EzPlatformAdapter::executeAction() B

↳ Parent: Project

Complexity

Conditions	5
Paths	5

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	6.6

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	21
ccs	9
cts	15
cp	0.6
rs	8.7624
cc	5
eloc	15
nc	5
nop	2
crap	6.6

<?php

/*
 * This file is part of Transfer.
 *
 * For the full copyright and license information, please view the LICENSE file located
 * in the root directory.
 */

namespace Transfer\EzPlatform\Adapter;

use eZ\Publish\API\Repository\Repository;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use ReflectionClass;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Transfer\Adapter\TargetAdapterInterface;
use Transfer\Adapter\Transaction\Request;
use Transfer\Adapter\Transaction\Response;
use Transfer\Data\ObjectInterface;
use Transfer\Data\TreeObject;
use Transfer\EzPlatform\Repository\Values\Action\ActionInterface;
use Transfer\EzPlatform\Repository\Values\Action\Enum\Action;
use Transfer\EzPlatform\Repository\Manager\Core\AbstractRepositoryService;
use Transfer\EzPlatform\Repository\Manager\Core\ContentTreeService;
use Transfer\EzPlatform\Repository\Manager\Core\ObjectService;

/**
 * eZ Platform adapter.
 */
class EzPlatformAdapter implements TargetAdapterInterface, LoggerAwareInterface
{
    /**
     * @var ContentTreeService Tree service
     */
    protected $treeService;

    /**
     * @var ObjectService Object service
     */
    protected $objectService;

    /**
     * @var LoggerInterface Logger
     */
    protected $logger;

    /**
     * @var array Options
     */
    protected $options;

    /**
     * Constructor.
     *
     * @param array $options
     */
    public function __construct(array $options = array())
    {
        $resolver = new OptionsResolver();
        $this->configureOptions($resolver);

        $this->options = $resolver->resolve($options);

        $this->objectService = new ObjectService($this->options['repository']);
        $this->treeService = new ContentTreeService($this->options['repository'], $this->objectService);
    }

    /**
     * Option configuration.
     *
     * @param OptionsResolver $resolver
     */
    protected function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(array(
            'repository_current_user' => 'admin',
        ));

        $resolver->setRequired(array('repository'));

        $resolver->setAllowedTypes('repository', array('eZ\Publish\API\Repository\Repository'));
        $resolver->setAllowedTypes('repository_current_user', array('string', 'null'));
    }

    /**
     * {@inheritdoc}
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
        $this->objectService->setLogger($logger);
        $this->treeService->setLogger($logger);
    }

    /**
     * {@inheritdoc}
     */
    public function send(Request $request)
    {
        /** @var Repository $repository */
        $repository = $this->options['repository'];
        $repository->beginTransaction();

        if ($this->logger) {
            $this->treeService->setLogger($this->logger);
            $this->objectService->setLogger($this->logger);
        }

        $response = new Response();

        $objects = array();
        foreach ($request as $object) {
            $service = $this->getService($object);

            try {
                $objects[] = $this->executeAction($object, $service);
            } catch (\Exception $e) {
                $repository->rollback();
                throw $e;
            }

            if (!empty($objects)) {
                $response->setData(new \ArrayIterator($objects));
            }
        }

        $repository->commit();

        return $response;
    }

    /**
     * @param ObjectInterface           $object
     * @param AbstractRepositoryService $service
     *
     * @return ObjectInterface
     */
    protected function executeAction(ObjectInterface $object, AbstractRepositoryService $service)
    {
        $reflection = new ReflectionClass($object);

        if ($reflection->implementsInterface(ActionInterface::class)) {
            /** @var ActionInterface $object */
            switch ($object->getAction()) {
                case Action::CREATEORUPDATE:
                    return $service->createOrUpdate($object);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                case Action::DELETE:
                    return $service->remove($object);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                case Action::SKIP:
                default:
                    break;
            }
        } else {
            return $service->createOrUpdate($object);
        }
    }

    /**
     * Decides which service to use, based on the type of $object given.
     *
     * @param ObjectInterface $object
     *
     * @return ContentTreeService|ObjectService
     */
    protected function getService($object)
    {
        if ($object instanceof TreeObject) {
            $service = $this->treeService;
        } else {
            $service = $this->objectService;
        }

        if ($this->options['repository_current_user']) {
            $service->setCurrentUser($this->options['repository_current_user']);
        }

        return $service;
    }
}


1		<?php
2
3		/*
4		* This file is part of Transfer.
5		*
6		* For the full copyright and license information, please view the LICENSE file located
7		* in the root directory.
8		*/
9
10		namespace Transfer\EzPlatform\Adapter;
11
12		use eZ\Publish\API\Repository\Repository;
13		use Psr\Log\LoggerAwareInterface;
14		use Psr\Log\LoggerInterface;
15		use ReflectionClass;
16		use Symfony\Component\OptionsResolver\OptionsResolver;
17		use Transfer\Adapter\TargetAdapterInterface;
18		use Transfer\Adapter\Transaction\Request;
19		use Transfer\Adapter\Transaction\Response;
20		use Transfer\Data\ObjectInterface;
21		use Transfer\Data\TreeObject;
22		use Transfer\EzPlatform\Repository\Values\Action\ActionInterface;
23		use Transfer\EzPlatform\Repository\Values\Action\Enum\Action;
24		use Transfer\EzPlatform\Repository\Manager\Core\AbstractRepositoryService;
25		use Transfer\EzPlatform\Repository\Manager\Core\ContentTreeService;
26		use Transfer\EzPlatform\Repository\Manager\Core\ObjectService;
27
28		/**
29		* eZ Platform adapter.
30		*/
31		class EzPlatformAdapter implements TargetAdapterInterface, LoggerAwareInterface
32		{
33		/**
34		* @var ContentTreeService Tree service
35		*/
36		protected $treeService;
37
38		/**
39		* @var ObjectService Object service
40		*/
41		protected $objectService;
42
43		/**
44		* @var LoggerInterface Logger
45		*/
46		protected $logger;
47
48		/**
49		* @var array Options
50		*/
51		protected $options;
52
53		/**
54		* Constructor.
55		*
56		* @param array $options
57		*/
58	17	public function __construct(array $options = array())
59		{
60	17	$resolver = new OptionsResolver();
61	17	$this->configureOptions($resolver);
62
63	17	$this->options = $resolver->resolve($options);
64
65	17	$this->objectService = new ObjectService($this->options['repository']);
66	17	$this->treeService = new ContentTreeService($this->options['repository'], $this->objectService);
67	17	}
68
69		/**
70		* Option configuration.
71		*
72		* @param OptionsResolver $resolver
73		*/
74	17	protected function configureOptions(OptionsResolver $resolver)
75		{
76	17	$resolver->setDefaults(array(
77	17	'repository_current_user' => 'admin',
78	17	));
79
80	17	$resolver->setRequired(array('repository'));
81
82	17	$resolver->setAllowedTypes('repository', array('eZ\Publish\API\Repository\Repository'));
83	17	$resolver->setAllowedTypes('repository_current_user', array('string', 'null'));
84	17	}
85
86		/**
87		* {@inheritdoc}
88		*/
89	17	public function setLogger(LoggerInterface $logger)
90		{
91	17	$this->logger = $logger;
92	17	$this->objectService->setLogger($logger);
93	17	$this->treeService->setLogger($logger);
94	17	}
95
96		/**
97		* {@inheritdoc}
98		*/
99	17	public function send(Request $request)
100		{
101		/** @var Repository $repository */
102	17	$repository = $this->options['repository'];
103	17	$repository->beginTransaction();
104
105	17	if ($this->logger) {
106	17	$this->treeService->setLogger($this->logger);
107	17	$this->objectService->setLogger($this->logger);
108	17	}
109
110	17	$response = new Response();
111
112	17	$objects = array();
113	17	foreach ($request as $object) {
114	17	$service = $this->getService($object);
115
116		try {
117	17	$objects[] = $this->executeAction($object, $service);
118	17	} catch (\Exception $e) {
119	2	$repository->rollback();
120	2	throw $e;
121		}
122
123	15	if (!empty($objects)) {
124	15	$response->setData(new \ArrayIterator($objects));
125	15	}
126	15	}
127
128	15	$repository->commit();
129
130	15	return $response;
131		}
132
133		/**
134		* @param ObjectInterface $object
135		* @param AbstractRepositoryService $service
136		*
137		* @return ObjectInterface
138		*/
139	17	protected function executeAction(ObjectInterface $object, AbstractRepositoryService $service)
140		{
141	17	$reflection = new ReflectionClass($object);
142
143	17	if ($reflection->implementsInterface(ActionInterface::class)) {
144		/** @var ActionInterface $object */
145	14	switch ($object->getAction()) {
146	14	case Action::CREATEORUPDATE:
147	12	return $service->createOrUpdate($object);
		0 ignored issues – show Documentation introduced 2016-05-06 17:02 UTC by Report Bug Copy Issue Report `$object` is of type `object<Transfer\EzPlatfo...Action\ActionInterface>`, but the function expects a `object<Transfer\Data\ObjectInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
148		break;
		0 ignored issues – show Unused Code introduced 2016-05-06 17:02 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
149	2	case Action::DELETE:
150	2	return $service->remove($object);
		0 ignored issues – show Bug introduced 2016-05-06 17:02 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Transfer\EzPlatform\Repo...stractRepositoryService` as the method `remove()` does only exist in the following sub-classes of `Transfer\EzPlatform\Repo...stractRepositoryService`: `Transfer\EzPlatform\Repo...ager\Core\ObjectService`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
151		break;
		0 ignored issues – show Unused Code introduced 2016-05-06 17:02 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
152		case Action::SKIP:
153		default:
154		break;
155		}
156		} else {
157	3	return $service->createOrUpdate($object);
158		}
159		}
160
161		/**
162		* Decides which service to use, based on the type of $object given.
163		*
164		* @param ObjectInterface $object
165		*
166		* @return ContentTreeService\|ObjectService
167		*/
168	17	protected function getService($object)
169		{
170	17	if ($object instanceof TreeObject) {
171	2	$service = $this->treeService;
172	2	} else {
173	15	$service = $this->objectService;
174		}
175
176	17	if ($this->options['repository_current_user']) {
177	17	$service->setCurrentUser($this->options['repository_current_user']);
178	17	}
179
180	17	return $service;
181		}
182		}
183

transfer-framework / ezplatform

Pull Request — 1.0 (#53)

EzPlatformAdapter::executeAction() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like