ConstraintUtils::onSchemaValidation() - Code Metrics - Inspection of "Fix travis build & update deps (except Symfony)" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#609)

by Narcotic

created 2017-10-05 11:22 UTC

ConstraintUtils::onSchemaValidation() A

↳ Parent: ConstraintUtils

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	0
cts	5
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php
/**
 * Common functions for constraints, mostly here for performance reasons
 */

namespace Graviton\SchemaBundle\Constraint;

use Doctrine\ODM\MongoDB\DocumentManager;
use Graviton\JsonSchemaBundle\Validator\Constraint\Event\ConstraintEventSchema;
use Graviton\RestBundle\Service\RestUtils;
use JsonSchema\Entity\JsonPointer;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class ConstraintUtils
{

    /**
     * @var array
     */
    private $entities = [];

    /**
     * @var \stdClass
     */
    private $currentSchema;

    /**
     * @var \stdClass
     */
    private $currentData;

    /**
     * @var RequestStack
     */
    private $requestStack;

    /**
     * Constructor.
     *
     * @param DocumentManager $dm           DocumentManager
     * @param RestUtils       $restUtils    RestUtils
     * @param RequestStack    $requestStack RequestStack
     *
     */
    public function __construct(DocumentManager $dm, RestUtils $restUtils, RequestStack $requestStack)
    {
        $this->dm = $dm;
        $this->restUtils = $restUtils;
        $this->requestStack = $requestStack;
    }

    /**
     * Gets a entity from the database as a generic object. All constraints that need the saved data to compare
     * values or anything should call this function to get what they need. As this is cached in the instance,
     * it will fetched only once even if multiple constraints need that object.
     *
     * @param string $documentClass document class
     * @param string $recordId      record id
     *
     * @throws \Doctrine\ODM\MongoDB\LockException
     * @throws \Exception
     *
     * @return object|null entity
     */
    public function getSerializedEntity($documentClass, $recordId)
    {
        if (!isset($this->entities[$documentClass][$recordId])) {
            $current = $this->dm->getRepository($documentClass)->find($recordId);

            if (is_null($current)) {
                $this->entities[$documentClass][$recordId] = null;
            } else {
                $this->entities[$documentClass][$recordId] = json_decode($this->restUtils->serializeContent($current));
            }
        }

        return $this->entities[$documentClass][$recordId];
    }

    /**
     * Returns the current request entity (as \stdClass) if possible
     *
     * @return null|object
     */
    public function getCurrentEntity()
    {
        $currentRecordId = null;

        // first, let's the one from the payload..
        if (isset($this->currentData->id)) {
            $currentRecordId = $this->currentData->id;
        }

        // if we have a request, it must override it..
        if ($this->requestStack->getCurrentRequest() instanceof Request &&
            $this->requestStack->getCurrentRequest()->attributes->has('id')
        ) {
            $currentRecordId = $this->requestStack->getCurrentRequest()->attributes->get('id');
        }

        if (isset($this->currentSchema->{'x-documentClass'}) &&
            !empty($this->currentSchema->{'x-documentClass'}) &&
            !is_null($currentRecordId)
        ) {
            return $this->getSerializedEntity($this->currentSchema->{'x-documentClass'}, $currentRecordId);
        }

        return null;
    }

    /**
     * Returns the request method of the current request
     *
     * @return null|string the request method
     */
    public function getCurrentRequestMethod()
    {
        if ($this->requestStack->getCurrentRequest() instanceof Request) {
            return $this->requestStack->getCurrentRequest()->getMethod();
        }
        return null;
    }

    /**
     * Returns the current request content
     *
     * @return bool|null|resource|string the content

     */
    public function getCurrentRequestContent()
    {
        if ($this->requestStack->getCurrentRequest() instanceof Request) {
            return $this->requestStack->getCurrentRequest()->getContent();
        }
        return null;
    }

    /**
     * gets the current schema. helpful for field schema validators that need access to the whole schema in some way.
     *
     * @return \stdClass
     */
    public function getCurrentSchema()
    {
        return $this->currentSchema;
    }

    /**
     * gets the current data from the client (the whole object).
     * helpful for field schema validators that need access to the whole data in some way.
     *
     * @return \stdClass
     */
    public function getCurrentData()
    {
        return $this->currentData;
    }

    /**
     * own function to get standard path from a JsonPointer object
     *
     * @param JsonPointer|null $pointer pointer
     *
     * @return string path as string
     */
    public function getNormalizedPathFromPointer(JsonPointer $pointer = null)
    {
        $result = array_map(
            function ($path) {
                return sprintf(is_numeric($path) ? '[%d]' : '.%s', $path);
            },
            $pointer->getPropertyPaths()
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        );
        return trim(implode('', $result), '.');
    }

    /**
     * called on the first schema validation, before anything else.
     *
     * @param ConstraintEventSchema $event event
     *
     * @return void
     */
    public function onSchemaValidation(ConstraintEventSchema $event)
    {
        $this->currentSchema = $event->getSchema();
        $this->currentData = $event->getElement();
    }
}


1			<?php
2			/**
3			* Common functions for constraints, mostly here for performance reasons
4			*/
5
6			namespace Graviton\SchemaBundle\Constraint;
7
8			use Doctrine\ODM\MongoDB\DocumentManager;
9			use Graviton\JsonSchemaBundle\Validator\Constraint\Event\ConstraintEventSchema;
10			use Graviton\RestBundle\Service\RestUtils;
11			use JsonSchema\Entity\JsonPointer;
12			use Symfony\Component\HttpFoundation\Request;
13			use Symfony\Component\HttpFoundation\RequestStack;
14
15			/**
16			* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
17			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
18			* @link http://swisscom.ch
19			*/
20			class ConstraintUtils
21			{
22
23			/**
24			* @var array
25			*/
26			private $entities = [];
27
28			/**
29			* @var \stdClass
30			*/
31			private $currentSchema;
32
33			/**
34			* @var \stdClass
35			*/
36			private $currentData;
37
38			/**
39			* @var RequestStack
40			*/
41			private $requestStack;
42
43			/**
44			* Constructor.
45			*
46			* @param DocumentManager $dm DocumentManager
47			* @param RestUtils $restUtils RestUtils
48			* @param RequestStack $requestStack RequestStack
49			*
50			*/
51			public function __construct(DocumentManager $dm, RestUtils $restUtils, RequestStack $requestStack)
52			{
53			$this->dm = $dm;
54			$this->restUtils = $restUtils;
55			$this->requestStack = $requestStack;
56			}
57
58			/**
59			* Gets a entity from the database as a generic object. All constraints that need the saved data to compare
60			* values or anything should call this function to get what they need. As this is cached in the instance,
61			* it will fetched only once even if multiple constraints need that object.
62			*
63			* @param string $documentClass document class
64			* @param string $recordId record id
65			*
66			* @throws \Doctrine\ODM\MongoDB\LockException
67			* @throws \Exception
68			*
69			* @return object\|null entity
70			*/
71			public function getSerializedEntity($documentClass, $recordId)
72			{
73			if (!isset($this->entities[$documentClass][$recordId])) {
74			$current = $this->dm->getRepository($documentClass)->find($recordId);
75
76			if (is_null($current)) {
77			$this->entities[$documentClass][$recordId] = null;
78			} else {
79			$this->entities[$documentClass][$recordId] = json_decode($this->restUtils->serializeContent($current));
80			}
81			}
82
83			return $this->entities[$documentClass][$recordId];
84			}
85
86			/**
87			* Returns the current request entity (as \stdClass) if possible
88			*
89			* @return null\|object
90			*/
91			public function getCurrentEntity()
92			{
93			$currentRecordId = null;
94
95			// first, let's the one from the payload..
96			if (isset($this->currentData->id)) {
97			$currentRecordId = $this->currentData->id;
98			}
99
100			// if we have a request, it must override it..
101			if ($this->requestStack->getCurrentRequest() instanceof Request &&
102			$this->requestStack->getCurrentRequest()->attributes->has('id')
103			) {
104			$currentRecordId = $this->requestStack->getCurrentRequest()->attributes->get('id');
105			}
106
107			if (isset($this->currentSchema->{'x-documentClass'}) &&
108			!empty($this->currentSchema->{'x-documentClass'}) &&
109			!is_null($currentRecordId)
110			) {
111			return $this->getSerializedEntity($this->currentSchema->{'x-documentClass'}, $currentRecordId);
112			}
113
114			return null;
115			}
116
117			/**
118			* Returns the request method of the current request
119			*
120			* @return null\|string the request method
121			*/
122			public function getCurrentRequestMethod()
123			{
124			if ($this->requestStack->getCurrentRequest() instanceof Request) {
125			return $this->requestStack->getCurrentRequest()->getMethod();
126			}
127			return null;
128			}
129
130			/**
131			* Returns the current request content
132			*
133			* @return bool\|null\|resource\|string the content
			0 ignored issues – show Documentation introduced 2017-07-03 15:13 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `resource\|string\|null`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
134			*/
135			public function getCurrentRequestContent()
136			{
137			if ($this->requestStack->getCurrentRequest() instanceof Request) {
138			return $this->requestStack->getCurrentRequest()->getContent();
139			}
140			return null;
141			}
142
143			/**
144			* gets the current schema. helpful for field schema validators that need access to the whole schema in some way.
145			*
146			* @return \stdClass
147			*/
148			public function getCurrentSchema()
149			{
150			return $this->currentSchema;
151			}
152
153			/**
154			* gets the current data from the client (the whole object).
155			* helpful for field schema validators that need access to the whole data in some way.
156			*
157			* @return \stdClass
158			*/
159			public function getCurrentData()
160			{
161			return $this->currentData;
162			}
163
164			/**
165			* own function to get standard path from a JsonPointer object
166			*
167			* @param JsonPointer\|null $pointer pointer
168			*
169			* @return string path as string
170			*/
171			public function getNormalizedPathFromPointer(JsonPointer $pointer = null)
172			{
173			$result = array_map(
174			function ($path) {
175			return sprintf(is_numeric($path) ? '[%d]' : '.%s', $path);
176			},
177			$pointer->getPropertyPaths()
			0 ignored issues – show Bug introduced 2016-08-29 09:40 UTC by Report Bug Copy Issue Report It seems like `$pointer` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
178			);
179			return trim(implode('', $result), '.');
180			}
181
182			/**
183			* called on the first schema validation, before anything else.
184			*
185			* @param ConstraintEventSchema $event event
186			*
187			* @return void
188			*/
189			public function onSchemaValidation(ConstraintEventSchema $event)
190			{
191			$this->currentSchema = $event->getSchema();
192			$this->currentData = $event->getElement();
193			}
194			}
195

libgraviton / graviton

Pull Request — develop (#609)

ConstraintUtils::onSchemaValidation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like