JsonEventSubscriber - Code Metrics - BigZ/Halapi - Measure and Improve Code Quality continuously with Scrutinizer

JsonEventSubscriber A
last analyzed 2017-05-22 22:19 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	2
dl	0
loc	47
c	0
b	0
f	0
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	onPostSerialize()	10	3
A	getSubscribedEvents()	10	1

<?php

namespace Halapi\Subscriber;

use Halapi\Factory\RelationFactory;
use Halapi\Representation\PaginatedRepresentation;
use JMS\Serializer\EventDispatcher\Events;
use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
use JMS\Serializer\EventDispatcher\ObjectEvent;

/**
 * Class JsonEventSubscriber.
 *
 * @author Romain Richard
 */
class JsonEventSubscriber implements EventSubscriberInterface
{
    /**
     * @var RelationFactory
     */
    private $relationFactory;

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            [
                'event' => Events::POST_SERIALIZE,
                'format' => 'json',
                'method' => 'onPostSerialize',
            ],
        ];
    }

    /**
     * JsonEventSubscriber constructor.
     *
     * @param RelationFactory $relationFactory
     */
    public function __construct(RelationFactory $relationFactory)
    {
        $this->relationFactory = $relationFactory;
    }

    /**
     * Add Hal Api Relations to serialized objects.
     *
     * @param ObjectEvent $event
     */
    public function onPostSerialize(ObjectEvent $event)
    {
        if ($event->getObject() instanceof PaginatedRepresentation) {
            return;
        }

        foreach ($this->relationFactory->getRelations($event->getObject()) as $relationKey => $relation) {
            $event->getVisitor()->addData($relationKey, $relation);
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.
    }
}
        }
    }
}


1			<?php
2
3			namespace Halapi\Subscriber;
4
5			use Halapi\Factory\RelationFactory;
6			use Halapi\Representation\PaginatedRepresentation;
7			use JMS\Serializer\EventDispatcher\Events;
8			use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
9			use JMS\Serializer\EventDispatcher\ObjectEvent;
10
11			/**
12			* Class JsonEventSubscriber.
13			*
14			* @author Romain Richard
15			*/
16			class JsonEventSubscriber implements EventSubscriberInterface
17			{
18			/**
19			* @var RelationFactory
20			*/
21			private $relationFactory;
22
23			/**
24			* {@inheritdoc}
25			*/
26			public static function getSubscribedEvents()
27			{
28			return [
29			[
30			'event' => Events::POST_SERIALIZE,
31			'format' => 'json',
32			'method' => 'onPostSerialize',
33			],
34			];
35			}
36
37			/**
38			* JsonEventSubscriber constructor.
39			*
40			* @param RelationFactory $relationFactory
41			*/
42			public function __construct(RelationFactory $relationFactory)
43			{
44			$this->relationFactory = $relationFactory;
45			}
46
47			/**
48			* Add Hal Api Relations to serialized objects.
49			*
50			* @param ObjectEvent $event
51			*/
52			public function onPostSerialize(ObjectEvent $event)
53			{
54			if ($event->getObject() instanceof PaginatedRepresentation) {
55			return;
56			}
57
58			foreach ($this->relationFactory->getRelations($event->getObject()) as $relationKey => $relation) {
59			$event->getVisitor()->addData($relationKey, $relation);
			0 ignored issues – show Bug introduced 2016-11-26 19:39 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `JMS\Serializer\VisitorInterface` as the method `addData()` does only exist in the following implementations of said interface: `JMS\Serializer\GenericSerializationVisitor`, `JMS\Serializer\JsonSerializationVisitor`. 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...
60			}
61			}
62			}
63

BigZ / Halapi

GitHub Access Token became invalid

JsonEventSubscriber A last analyzed 2017-05-22 22:19 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

JsonEventSubscriber A
last analyzed 2017-05-22 22:19 UTC