JmsSerializeListener::getHostUrl() - Code Metrics - Inspection of "fix bugs" - Bukashk0zzz/LiipImagineSerializationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( baecb6...a0f97c )

by Bukashk0zzz

created 2016-03-09 13:39 UTC

JmsSerializeListener::getHostUrl() B

↳ Parent: JmsSerializeListener

Complexity

Conditions	7
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	12
rs	8.2222
cc	7
eloc	7
nc	3
nop	0

<?php
/*
 * This file is part of the Bukashk0zzzLiipImagineSerializationBundle
 *
 * (c) Denis Golubovskiy <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Bukashk0zzz\LiipImagineSerializationBundle\EventListener;

use Bukashk0zzz\LiipImagineSerializationBundle\Annotation\LiipImagineSerializableClass;
use Bukashk0zzz\LiipImagineSerializationBundle\Annotation\LiipImagineSerializableField;
use Doctrine\Common\Annotations\CachedReader;
use Doctrine\Common\Util\ClassUtils;
use JMS\Serializer\EventDispatcher\ObjectEvent;
use Symfony\Component\Routing\RequestContext;
use Doctrine\Common\Persistence\Proxy;
use Liip\ImagineBundle\Imagine\Cache\CacheManager;
use Vich\UploaderBundle\Storage\StorageInterface;

/**
 * JmsSerializeListener
 *
 * @author Denis Golubovskiy <[email protected]>
 */
class JmsSerializeListener
{
    /**
     * @var RequestContext $requestContext Request context
     */
    private $requestContext;

    /**
     * @var CachedReader $annotationReader Cached annotation reader
     */
    private $annotationReader;

    /**
     * @var CacheManager $cacheManager LiipImagineBundle Cache Manager
     */
    private $cacheManager;

    /**
     * @var StorageInterface $storage Vich storage
     */
    private $vichStorage;

    /**
     * @var array $config Bundle config
     */
    private $config;

    /**
     * @var array $serializedObjects Pre Serialized objects
     */
    private $preSerializedObjects = [];

    /**
     * @var array $postSerializedObjects Post Serialized objects
     */
    private $postSerializedObjects = [];

    /** @noinspection MoreThanThreeArgumentsInspection
     *
     * JmsSerializeListener constructor.
     * @param RequestContext   $requestContext
     * @param CachedReader     $annotationReader
     * @param CacheManager     $cacheManager
     * @param StorageInterface $vichStorage
     * @param array            $config
     */
    public function __construct(
        RequestContext $requestContext,
        CachedReader $annotationReader,
        CacheManager $cacheManager,
        StorageInterface $vichStorage,
        array $config
    ) {
        $this->requestContext = $requestContext;
        $this->annotationReader = $annotationReader;
        $this->cacheManager = $cacheManager;
        $this->vichStorage = $vichStorage;
        $this->config = $config;
    }

    /**
     * On pre serialize
     *
     * @param ObjectEvent $event Event
     */
    public function onPreSerialize(ObjectEvent $event)
    {
        $object = $this->getObject($event);
        $objectUid = spl_object_hash($object);

        if (in_array($objectUid, $this->preSerializedObjects, true)) {
            return;
        }

        $classAnnotation = $this->annotationReader->getClassAnnotation(
            new \ReflectionClass(ClassUtils::getClass($object)),
            LiipImagineSerializableClass::class
        );

        if ($classAnnotation instanceof LiipImagineSerializableClass) {
            $reflectionClass = ClassUtils::newReflectionClass(get_class($object));

            foreach ($reflectionClass->getProperties() as $property) {
                $liipImagineAnnotation = $this->annotationReader->getPropertyAnnotation($property, LiipImagineSerializableField::class);
                $property->setAccessible(true);

                if ($liipImagineAnnotation instanceof LiipImagineSerializableField && $value = $property->getValue($object) && !$liipImagineAnnotation->getVirtualField()) {

                    $property->setValue($object, $this->serializeValue($liipImagineAnnotation, $object, $value));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                }
            }

            $this->preSerializedObjects[$objectUid] = $objectUid;
        }

    }

    /**
     * On post serialize
     *
     * @param ObjectEvent $event Event
     */
    public function onPostSerialize(ObjectEvent $event)
    {
        $object = $this->getObject($event);
        $objectUid = spl_object_hash($object);

        if (in_array($objectUid, $this->postSerializedObjects, true)) {
            return;
        }

        $classAnnotation = $this->annotationReader->getClassAnnotation(
            new \ReflectionClass(ClassUtils::getClass($object)),
            LiipImagineSerializableClass::class
        );

        if ($classAnnotation instanceof LiipImagineSerializableClass) {
            $reflectionClass = ClassUtils::newReflectionClass(get_class($object));

            foreach ($reflectionClass->getProperties() as $property) {
                $liipImagineAnnotation = $this->annotationReader->getPropertyAnnotation($property, LiipImagineSerializableField::class);
                $property->setAccessible(true);

                if ($liipImagineAnnotation instanceof LiipImagineSerializableField && $value = $property->getValue($object) && $virtualField = $liipImagineAnnotation->getVirtualField()) {

                    /** @noinspection PhpUndefinedMethodInspection */
                    $event->getVisitor()->addData($virtualField, $this->serializeValue($liipImagineAnnotation, $object, $value));
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

                    if ($vichField = $liipImagineAnnotation->getVichUploaderField() && array_key_exists('vichUploaderSerialize', $this->config) && $this->config['vichUploaderSerialize']) {

                        $originalImageUri = $this->vichStorage->resolveUri($object, $vichField);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

                        if (array_key_exists('includeHost', $this->config) && $this->config['includeHost']) {
                            $originalImageUri = $this->getHostUrl().$originalImageUri;
                        }
                        $property->setValue($object, $originalImageUri);
                    }
                }
            }

            $this->postSerializedObjects[$objectUid] = $objectUid;
        }

    }

    /**
     * @param ObjectEvent $event Event
     * @return mixed
     */
    protected function getObject($event)
    {
        $object = $event->getObject();

        if ($object instanceof Proxy
            && ! $object->__isInitialized()
        ) {
            $object->__load();
        }

        return $object;
    }

    /** @noinspection GenericObjectTypeUsageInspection
     * @param LiipImagineSerializableField $liipImagineAnnotation
     * @param object $object Serialized object
     * @param string $value Value of field
     * @return string
     */
    private function serializeValue(LiipImagineSerializableField $liipImagineAnnotation, $object, $value)
    {
        if ($vichField = $liipImagineAnnotation->getVichUploaderField()) {
            $value = $this->vichStorage->resolveUri($object, $vichField);
        }

        return $this->cacheManager->getBrowserPath($value, $liipImagineAnnotation->getFilter());
    }

    /**
     * Get host url (scheme, host, port)
     *
     * @return string Host url
     */
    private function getHostUrl()
    {
        $url = $this->requestContext->getScheme().'://'.$this->requestContext->getHost();

        if ($this->requestContext->getScheme() === 'http' && $this->requestContext->getHttpPort() && $this->requestContext->getHttpPort() !== 80) {
            $url .= ':'.$this->requestContext->getHttpPort();
        } elseif ($this->requestContext->getScheme() === 'https' && $this->requestContext->getHttpsPort() && $this->requestContext->getHttpsPort() !== 443) {
            $url .= ':'.$this->requestContext->getHttpsPort();
        }

        return $url;
    }
}


Push — master ( baecb6...a0f97c )

JmsSerializeListener::getHostUrl() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/*
3			* This file is part of the Bukashk0zzzLiipImagineSerializationBundle
4			*
5			* (c) Denis Golubovskiy <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace Bukashk0zzz\LiipImagineSerializationBundle\EventListener;
12
13			use Bukashk0zzz\LiipImagineSerializationBundle\Annotation\LiipImagineSerializableClass;
14			use Bukashk0zzz\LiipImagineSerializationBundle\Annotation\LiipImagineSerializableField;
15			use Doctrine\Common\Annotations\CachedReader;
16			use Doctrine\Common\Util\ClassUtils;
17			use JMS\Serializer\EventDispatcher\ObjectEvent;
18			use Symfony\Component\Routing\RequestContext;
19			use Doctrine\Common\Persistence\Proxy;
20			use Liip\ImagineBundle\Imagine\Cache\CacheManager;
21			use Vich\UploaderBundle\Storage\StorageInterface;
22
23			/**
24			* JmsSerializeListener
25			*
26			* @author Denis Golubovskiy <[email protected]>
27			*/
28			class JmsSerializeListener
29			{
30			/**
31			* @var RequestContext $requestContext Request context
32			*/
33			private $requestContext;
34
35			/**
36			* @var CachedReader $annotationReader Cached annotation reader
37			*/
38			private $annotationReader;
39
40			/**
41			* @var CacheManager $cacheManager LiipImagineBundle Cache Manager
42			*/
43			private $cacheManager;
44
45			/**
46			* @var StorageInterface $storage Vich storage
47			*/
48			private $vichStorage;
49
50			/**
51			* @var array $config Bundle config
52			*/
53			private $config;
54
55			/**
56			* @var array $serializedObjects Pre Serialized objects
57			*/
58			private $preSerializedObjects = [];
59
60			/**
61			* @var array $postSerializedObjects Post Serialized objects
62			*/
63			private $postSerializedObjects = [];
64
65			/** @noinspection MoreThanThreeArgumentsInspection
66			*
67			* JmsSerializeListener constructor.
68			* @param RequestContext $requestContext
69			* @param CachedReader $annotationReader
70			* @param CacheManager $cacheManager
71			* @param StorageInterface $vichStorage
72			* @param array $config
73			*/
74			public function __construct(
75			RequestContext $requestContext,
76			CachedReader $annotationReader,
77			CacheManager $cacheManager,
78			StorageInterface $vichStorage,
79			array $config
80			) {
81			$this->requestContext = $requestContext;
82			$this->annotationReader = $annotationReader;
83			$this->cacheManager = $cacheManager;
84			$this->vichStorage = $vichStorage;
85			$this->config = $config;
86			}
87
88			/**
89			* On pre serialize
90			*
91			* @param ObjectEvent $event Event
92			*/
93			public function onPreSerialize(ObjectEvent $event)
94			{
95			$object = $this->getObject($event);
96			$objectUid = spl_object_hash($object);
97
98			if (in_array($objectUid, $this->preSerializedObjects, true)) {
99			return;
100			}
101
102			$classAnnotation = $this->annotationReader->getClassAnnotation(
103			new \ReflectionClass(ClassUtils::getClass($object)),
104			LiipImagineSerializableClass::class
105			);
106
107			if ($classAnnotation instanceof LiipImagineSerializableClass) {
108			$reflectionClass = ClassUtils::newReflectionClass(get_class($object));
109
110			foreach ($reflectionClass->getProperties() as $property) {
111			$liipImagineAnnotation = $this->annotationReader->getPropertyAnnotation($property, LiipImagineSerializableField::class);
112			$property->setAccessible(true);
113
114			if ($liipImagineAnnotation instanceof LiipImagineSerializableField && $value = $property->getValue($object) && !$liipImagineAnnotation->getVirtualField()) {
			0 ignored issues – show Comprehensibility introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `$value = ($property->get...ion->getVirtualField())`, Probably Intended Meaning: `($value = $property->get...tion->getVirtualField()` Loading history...
115			$property->setValue($object, $this->serializeValue($liipImagineAnnotation, $object, $value));
			0 ignored issues – show Documentation introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report `$value` is of type `boolean`, but the function expects a `string`. 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...
116			}
117			}
118
119			$this->preSerializedObjects[$objectUid] = $objectUid;
120			}
121
122			}
123
124			/**
125			* On post serialize
126			*
127			* @param ObjectEvent $event Event
128			*/
129			public function onPostSerialize(ObjectEvent $event)
130			{
131			$object = $this->getObject($event);
132			$objectUid = spl_object_hash($object);
133
134			if (in_array($objectUid, $this->postSerializedObjects, true)) {
135			return;
136			}
137
138			$classAnnotation = $this->annotationReader->getClassAnnotation(
139			new \ReflectionClass(ClassUtils::getClass($object)),
140			LiipImagineSerializableClass::class
141			);
142
143			if ($classAnnotation instanceof LiipImagineSerializableClass) {
144			$reflectionClass = ClassUtils::newReflectionClass(get_class($object));
145
146			foreach ($reflectionClass->getProperties() as $property) {
147			$liipImagineAnnotation = $this->annotationReader->getPropertyAnnotation($property, LiipImagineSerializableField::class);
148			$property->setAccessible(true);
149
150			if ($liipImagineAnnotation instanceof LiipImagineSerializableField && $value = $property->getValue($object) && $virtualField = $liipImagineAnnotation->getVirtualField()) {
			0 ignored issues – show Comprehensibility introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `$value = ($property->get...on->getVirtualField()))`, Probably Intended Meaning: `($value = $property->get...tion->getVirtualField()` Loading history...
151			/** @noinspection PhpUndefinedMethodInspection */
152			$event->getVisitor()->addData($virtualField, $this->serializeValue($liipImagineAnnotation, $object, $value));
			0 ignored issues – show Bug introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report The variable `$virtualField` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Documentation introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report `$value` is of type `boolean`, but the function expects a `string`. 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... Bug introduced 2016-03-09 13:41 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...
153
154			if ($vichField = $liipImagineAnnotation->getVichUploaderField() && array_key_exists('vichUploaderSerialize', $this->config) && $this->config['vichUploaderSerialize']) {
			0 ignored issues – show Comprehensibility introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report Consider adding parentheses for clarity. Current Interpretation: `$vichField = ($liipImagi...ichUploaderSerialize'])`, Probably Intended Meaning: `($vichField = $liipImagi...vichUploaderSerialize']` Loading history...
155			$originalImageUri = $this->vichStorage->resolveUri($object, $vichField);
			0 ignored issues – show Documentation introduced 2016-03-09 13:41 UTC by Report Bug Copy Issue Report `$vichField` is of type `boolean`, but the function expects a `string`. 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...
156
157			if (array_key_exists('includeHost', $this->config) && $this->config['includeHost']) {
158			$originalImageUri = $this->getHostUrl().$originalImageUri;
159			}
160			$property->setValue($object, $originalImageUri);
161			}
162			}
163			}
164
165			$this->postSerializedObjects[$objectUid] = $objectUid;
166			}
167
168			}
169
170			/**
171			* @param ObjectEvent $event Event
172			* @return mixed
173			*/
174			protected function getObject($event)
175			{
176			$object = $event->getObject();
177
178			if ($object instanceof Proxy
179			&& ! $object->__isInitialized()
180			) {
181			$object->__load();
182			}
183
184			return $object;
185			}
186
187			/** @noinspection GenericObjectTypeUsageInspection
188			* @param LiipImagineSerializableField $liipImagineAnnotation
189			* @param object $object Serialized object
190			* @param string $value Value of field
191			* @return string
192			*/
193			private function serializeValue(LiipImagineSerializableField $liipImagineAnnotation, $object, $value)
194			{
195			if ($vichField = $liipImagineAnnotation->getVichUploaderField()) {
196			$value = $this->vichStorage->resolveUri($object, $vichField);
197			}
198
199			return $this->cacheManager->getBrowserPath($value, $liipImagineAnnotation->getFilter());
200			}
201
202			/**
203			* Get host url (scheme, host, port)
204			*
205			* @return string Host url
206			*/
207			private function getHostUrl()
208			{
209			$url = $this->requestContext->getScheme().'://'.$this->requestContext->getHost();
210
211			if ($this->requestContext->getScheme() === 'http' && $this->requestContext->getHttpPort() && $this->requestContext->getHttpPort() !== 80) {
212			$url .= ':'.$this->requestContext->getHttpPort();
213			} elseif ($this->requestContext->getScheme() === 'https' && $this->requestContext->getHttpsPort() && $this->requestContext->getHttpsPort() !== 443) {
214			$url .= ':'.$this->requestContext->getHttpsPort();
215			}
216
217			return $url;
218			}
219			}
220

Bukashk0zzz / LiipImagineSerializationBundle

Push — master ( baecb6...a0f97c )

JmsSerializeListener::getHostUrl() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like