MetadataRelationsTrait::addRelationsHook() - Code Metrics - Inspection of "WIP: Metadata relation clean" - Algo-Web/POData-Laravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#219)

by Christopher

created 2020-02-24 16:30 UTC

MetadataRelationsTrait::addRelationsHook() A

↳ Parent: MetadataRelationsTrait

Complexity

Conditions	3
Paths	4

Size

Total Lines	22
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	10
c	2
b	0
f	0
dl	0
loc	22
rs	9.9332
cc	3
nc	4
nop	8

How to fix Many Parameters

<?php
/**
 * Created by PhpStorm.
 * User: alex
 * Date: 13/02/20
 * Time: 1:08 PM.
 */
namespace AlgoWeb\PODataLaravel\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasManyThrough;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Database\Eloquent\Relations\MorphOne;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use Illuminate\Database\Eloquent\Relations\Relation;
use POData\Common\InvalidOperationException;

trait MetadataRelationsTrait
{
    use MetadataKeyMethodNamesTrait;

    protected static $relationHooks = [];
    protected static $relationCategories = [];


    /**
     * Get model's relationships.
     *
     * @throws InvalidOperationException
     * @throws \ReflectionException
     * @return array
     */
    public function getRelationships()
    {
        if (empty(static::$relationHooks)) {
            $hooks = [];

            $rels = $this->getRelationshipsFromMethods(true);

            $this->getRelationshipsUnknownPolyMorph($rels, $hooks);

            $this->getRelationshipsKnownPolyMorph($rels, $hooks);

            $this->getRelationshipsHasOne($rels, $hooks);

            $this->getRelationshipsHasMany($rels, $hooks);

            static::$relationHooks = $hooks;
        }

        return static::$relationHooks;
    }

    /**
     * Is this model the known side of at least one polymorphic relation?
     *
     * @throws InvalidOperationException
     * @throws \ReflectionException
     */
    public function isKnownPolymorphSide()
    {
        // isKnownPolymorph needs to be checking KnownPolymorphSide results - if you're checking UnknownPolymorphSide,
        // you're turned around
        $rels = $this->getRelationshipsFromMethods();
        return !empty($rels['KnownPolyMorphSide']);
    }

    /**
     * Is this model on the unknown side of at least one polymorphic relation?
     *
     * @throws InvalidOperationException
     * @throws \ReflectionException
     */
    public function isUnknownPolymorphSide()
    {
        // isUnknownPolymorph needs to be checking UnknownPolymorphSide results - if you're checking KnownPolymorphSide,
        // you're turned around
        $rels = $this->getRelationshipsFromMethods();
        return !empty($rels['UnknownPolyMorphSide']);
    }
    /**
     * @param \ReflectionMethod $method
     * @return string
     * @throws InvalidOperationException
     */
    protected function getCodeForMethod(\ReflectionMethod $method) : string
    {
        $fileName = $method->getFileName();

        $file = new \SplFileObject($fileName);
        $file->seek($method->getStartLine() - 1);
        $code = '';
        while ($file->key() < $method->getEndLine()) {
            $code .= $file->current();
            $file->next();
        }

        $code = trim(preg_replace('/\s\s+/', '', $code));
        if (false === stripos($code, 'function')) {
            $msg = 'Function definition must have keyword \'function\'';
            throw new InvalidOperationException($msg);
        }
        $begin = strpos($code, 'function(');
        $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
        $lastCode = $code[strlen($code) - 1];
        if ('}' != $lastCode) {
            $msg = 'Final character of function definition must be closing brace';
            throw new InvalidOperationException($msg);
        }
        return $code;
    }
    /**
     * @param bool $biDir
     *
     * @throws InvalidOperationException
     * @throws \ReflectionException
     * @return array
     */
    protected function getRelationshipsFromMethods(bool $biDir = false)
    {
        $biDirVal = intval($biDir);
        $isCached = isset(static::$relationCategories[$biDirVal]) && !empty(static::$relationCategories[$biDirVal]);
        if ($isCached) {
            return static::$relationCategories[$biDirVal];
        }
        /** @var Model $model */
        $model = $this;
        $relationships = [
            'HasOne' => [],
            'UnknownPolyMorphSide' => [],
            'HasMany' => [],
            'KnownPolyMorphSide' => []
        ];
        $methods = $this->getModelClassMethods($model);
        foreach ($methods as $method) {
            //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
            $reflection = new \ReflectionMethod($model, $method);
            $code = $this->getCodeForMethod($reflection);
            foreach (static::$relTypes as $relation) {
                $search = '$this->' . $relation . '(';
                $found = stripos($code, $search);
                if (!$found) {
                    continue;
                }
                //Resolve the relation's model to a Relation object.
                $relationObj = $model->$method();
                if (!($relationObj instanceof Relation)) {
                    continue;
                }
                $relObject = $relationObj->getRelated();
                $relatedModel = '\\' . get_class($relObject);
                if (!in_array(MetadataTrait::class, class_uses($relatedModel))) {
                    continue;
                }
                $targObject = $biDir ? $relationObj : $relatedModel;
                if (in_array($relation, static::$manyRelTypes)) {
                    //Collection or array of models (because Collection is Arrayable)
                    $relationships['HasMany'][$method] = $targObject;
                } elseif ('morphTo' === $relation) {
                    // Model isn't specified because relation is polymorphic
                    $relationships['UnknownPolyMorphSide'][$method] =
                        $biDir ? $relationObj : '\Illuminate\Database\Eloquent\Model|\Eloquent';
                } else {
                    //Single model is returned
                    $relationships['HasOne'][$method] = $targObject;
                }
                if (in_array($relation, ['morphMany', 'morphOne', 'morphToMany'])) {
                    $relationships['KnownPolyMorphSide'][$method] = $targObject;
                }
                if (in_array($relation, ['morphedByMany'])) {
                    $relationships['UnknownPolyMorphSide'][$method] = $targObject;
                }
            }
        }
        return static::$relationCategories[$biDirVal] = $relationships;
    }

    /**
     * @param  array                     $rels
     * @param  array                     $hooks
     * @throws InvalidOperationException
     */
    protected function getRelationshipsHasMany(array $rels, array &$hooks)
    {
        /**
         * @var string   $property
         * @var Relation $relation
         */
        foreach ($rels['HasMany'] as $property => $relation) {
            if ($relation instanceof MorphMany || $relation instanceof MorphToMany) {
                continue;
            }
            $mult = '*';
            $targ = get_class($relation->getRelated());
            $keyName = $this->polyglotFkKey($relation);
            $localName = $this->polyglotRkKey($relation);
            $thruName = $relation instanceof HasManyThrough ?
                $this->polyglotThroughKey($relation) :
                null;

            $first = $keyName;
            $last = $localName;
            $this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ, null, $thruName);
        }
    }

    /**
     * @param  array                     $rels
     * @param  array                     $hooks
     * @throws InvalidOperationException
     */
    protected function getRelationshipsHasOne(array $rels, array &$hooks)
    {
        /**
         * @var string   $property
         * @var Relation $foo
         */
        foreach ($rels['HasOne'] as $property => $foo) {
            if ($foo instanceof MorphOne) {
                continue;
            }
            $isBelong = $foo instanceof BelongsTo;
            $mult = $isBelong ? '1' : '0..1';
            $targ = get_class($foo->getRelated());

            $keyName = $this->polyglotFkKey($foo);
            $localName = $this->polyglotRkKey($foo);
            $first = $isBelong ? $localName : $keyName;
            $last = $isBelong ? $keyName : $localName;
            $this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ);
        }
    }

    /**
     * @param  array                     $rels
     * @param  array                     $hooks
     * @throws InvalidOperationException
     */
    protected function getRelationshipsKnownPolyMorph(array $rels, array &$hooks)
    {
        /**
         * @var string   $property
         * @var Relation $foo
         */
        foreach ($rels['KnownPolyMorphSide'] as $property => $foo) {
            $isMany = $foo instanceof MorphToMany;
            $targ = get_class($foo->getRelated());
            $mult = $isMany || $foo instanceof MorphMany ? '*' : '1';
            $mult = $foo instanceof MorphOne ? '0..1' : $mult;

            $keyName = $this->polyglotFkKey($foo);
            $localName = $this->polyglotRkKey($foo);
            $first = $isMany ? $keyName : $localName;
            $last = $isMany ? $localName : $keyName;
            $this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ, 'unknown');
        }
    }

    /**
     * @param  array                     $rels
     * @param  array                     $hooks
     * @throws InvalidOperationException
     */
    protected function getRelationshipsUnknownPolyMorph(array $rels, array &$hooks)
    {
        /**
         * @var string   $property
         * @var Relation $foo
         */
        foreach ($rels['UnknownPolyMorphSide'] as $property => $foo) {
            $isMany = $foo instanceof MorphToMany;
            $targ = get_class($foo->getRelated());
            $mult = $isMany ? '*' : '1';

            $keyName = $this->polyglotFkKey($foo);
            $localName = $this->polyglotRkKey($foo);

            $first = $keyName;
            $last = (isset($localName) && '' != $localName) ? $localName : $foo->getRelated()->getKeyName();
            $this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ, 'known');
        }
    }

    /**
     * @param             $hooks
     * @param             $foreignField
     * @param             $RelationName
     * @param             $localKey
     * @param             $mult
     * @param string|null $relatedObject
     * @param mixed|null  $type
     * @param mixed|null  $through
     */
    protected function addRelationsHook(
        array &$hooks,
        $foreignField,
        $RelationName,
        $localKey,
        $mult,
        $relatedObject,
        $type = null,
        $through = null
    ) {
        if (!isset($hooks[$foreignField])) {
            $hooks[$foreignField] = [];
        }
        if (!isset($hooks[$foreignField][$relatedObject])) {
            $hooks[$foreignField][$relatedObject] = [];
        }
        $hooks[$foreignField][$relatedObject][$RelationName] = [
            'property' => $RelationName,
            'local' => $localKey,
            'through' => $through,
            'multiplicity' => $mult,
            'type' => $type
        ];
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: alex
5			* Date: 13/02/20
6			* Time: 1:08 PM.
7			*/
8			namespace AlgoWeb\PODataLaravel\Models;
9
10			use Illuminate\Database\Eloquent\Model;
11			use Illuminate\Database\Eloquent\Relations\BelongsTo;
12			use Illuminate\Database\Eloquent\Relations\HasManyThrough;
13			use Illuminate\Database\Eloquent\Relations\MorphMany;
14			use Illuminate\Database\Eloquent\Relations\MorphOne;
15			use Illuminate\Database\Eloquent\Relations\MorphToMany;
16			use Illuminate\Database\Eloquent\Relations\Relation;
17			use POData\Common\InvalidOperationException;
18
19			trait MetadataRelationsTrait
20			{
21			use MetadataKeyMethodNamesTrait;
22
23			protected static $relationHooks = [];
24			protected static $relationCategories = [];
25
26
27			/**
28			* Get model's relationships.
29			*
30			* @throws InvalidOperationException
31			* @throws \ReflectionException
32			* @return array
33			*/
34			public function getRelationships()
35			{
36			if (empty(static::$relationHooks)) {
37			$hooks = [];
38
39			$rels = $this->getRelationshipsFromMethods(true);
40
41			$this->getRelationshipsUnknownPolyMorph($rels, $hooks);
42
43			$this->getRelationshipsKnownPolyMorph($rels, $hooks);
44
45			$this->getRelationshipsHasOne($rels, $hooks);
46
47			$this->getRelationshipsHasMany($rels, $hooks);
48
49			static::$relationHooks = $hooks;
50			}
51
52			return static::$relationHooks;
53			}
54
55			/**
56			* Is this model the known side of at least one polymorphic relation?
57			*
58			* @throws InvalidOperationException
59			* @throws \ReflectionException
60			*/
61			public function isKnownPolymorphSide()
62			{
63			// isKnownPolymorph needs to be checking KnownPolymorphSide results - if you're checking UnknownPolymorphSide,
64			// you're turned around
65			$rels = $this->getRelationshipsFromMethods();
66			return !empty($rels['KnownPolyMorphSide']);
67			}
68
69			/**
70			* Is this model on the unknown side of at least one polymorphic relation?
71			*
72			* @throws InvalidOperationException
73			* @throws \ReflectionException
74			*/
75			public function isUnknownPolymorphSide()
76			{
77			// isUnknownPolymorph needs to be checking UnknownPolymorphSide results - if you're checking KnownPolymorphSide,
78			// you're turned around
79			$rels = $this->getRelationshipsFromMethods();
80			return !empty($rels['UnknownPolyMorphSide']);
81			}
82			/**
83			* @param \ReflectionMethod $method
84			* @return string
85			* @throws InvalidOperationException
86			*/
87			protected function getCodeForMethod(\ReflectionMethod $method) : string
88			{
89			$fileName = $method->getFileName();
90
91			$file = new \SplFileObject($fileName);
92			$file->seek($method->getStartLine() - 1);
93			$code = '';
94			while ($file->key() < $method->getEndLine()) {
95			$code .= $file->current();
96			$file->next();
97			}
98
99			$code = trim(preg_replace('/\s\s+/', '', $code));
100			if (false === stripos($code, 'function')) {
101			$msg = 'Function definition must have keyword \'function\'';
102			throw new InvalidOperationException($msg);
103			}
104			$begin = strpos($code, 'function(');
105			$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
106			$lastCode = $code[strlen($code) - 1];
107			if ('}' != $lastCode) {
108			$msg = 'Final character of function definition must be closing brace';
109			throw new InvalidOperationException($msg);
110			}
111			return $code;
112			}
113			/**
114			* @param bool $biDir
115			*
116			* @throws InvalidOperationException
117			* @throws \ReflectionException
118			* @return array
119			*/
120			protected function getRelationshipsFromMethods(bool $biDir = false)
121			{
122			$biDirVal = intval($biDir);
123			$isCached = isset(static::$relationCategories[$biDirVal]) && !empty(static::$relationCategories[$biDirVal]);
124			if ($isCached) {
125			return static::$relationCategories[$biDirVal];
126			}
127			/** @var Model $model */
128			$model = $this;
129			$relationships = [
130			'HasOne' => [],
131			'UnknownPolyMorphSide' => [],
132			'HasMany' => [],
133			'KnownPolyMorphSide' => []
134			];
135			$methods = $this->getModelClassMethods($model);
136			foreach ($methods as $method) {
137			//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
138			$reflection = new \ReflectionMethod($model, $method);
139			$code = $this->getCodeForMethod($reflection);
140			foreach (static::$relTypes as $relation) {
141			$search = '$this->' . $relation . '(';
142			$found = stripos($code, $search);
143			if (!$found) {
144			continue;
145			}
146			//Resolve the relation's model to a Relation object.
147			$relationObj = $model->$method();
148			if (!($relationObj instanceof Relation)) {
149			continue;
150			}
151			$relObject = $relationObj->getRelated();
152			$relatedModel = '\\' . get_class($relObject);
153			if (!in_array(MetadataTrait::class, class_uses($relatedModel))) {
154			continue;
155			}
156			$targObject = $biDir ? $relationObj : $relatedModel;
157			if (in_array($relation, static::$manyRelTypes)) {
158			//Collection or array of models (because Collection is Arrayable)
159			$relationships['HasMany'][$method] = $targObject;
160			} elseif ('morphTo' === $relation) {
161			// Model isn't specified because relation is polymorphic
162			$relationships['UnknownPolyMorphSide'][$method] =
163			$biDir ? $relationObj : '\Illuminate\Database\Eloquent\Model\|\Eloquent';
164			} else {
165			//Single model is returned
166			$relationships['HasOne'][$method] = $targObject;
167			}
168			if (in_array($relation, ['morphMany', 'morphOne', 'morphToMany'])) {
169			$relationships['KnownPolyMorphSide'][$method] = $targObject;
170			}
171			if (in_array($relation, ['morphedByMany'])) {
172			$relationships['UnknownPolyMorphSide'][$method] = $targObject;
173			}
174			}
175			}
176			return static::$relationCategories[$biDirVal] = $relationships;
177			}
178
179			/**
180			* @param array $rels
181			* @param array $hooks
182			* @throws InvalidOperationException
183			*/
184			protected function getRelationshipsHasMany(array $rels, array &$hooks)
185			{
186			/**
187			* @var string $property
188			* @var Relation $relation
189			*/
190			foreach ($rels['HasMany'] as $property => $relation) {
191			if ($relation instanceof MorphMany \|\| $relation instanceof MorphToMany) {
192			continue;
193			}
194			$mult = '*';
195			$targ = get_class($relation->getRelated());
196			$keyName = $this->polyglotFkKey($relation);
197			$localName = $this->polyglotRkKey($relation);
198			$thruName = $relation instanceof HasManyThrough ?
199			$this->polyglotThroughKey($relation) :
200			null;
201
202			$first = $keyName;
203			$last = $localName;
204			$this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ, null, $thruName);
205			}
206			}
207
208			/**
209			* @param array $rels
210			* @param array $hooks
211			* @throws InvalidOperationException
212			*/
213			protected function getRelationshipsHasOne(array $rels, array &$hooks)
214			{
215			/**
216			* @var string $property
217			* @var Relation $foo
218			*/
219			foreach ($rels['HasOne'] as $property => $foo) {
220			if ($foo instanceof MorphOne) {
221			continue;
222			}
223			$isBelong = $foo instanceof BelongsTo;
224			$mult = $isBelong ? '1' : '0..1';
225			$targ = get_class($foo->getRelated());
226
227			$keyName = $this->polyglotFkKey($foo);
228			$localName = $this->polyglotRkKey($foo);
229			$first = $isBelong ? $localName : $keyName;
230			$last = $isBelong ? $keyName : $localName;
231			$this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ);
232			}
233			}
234
235			/**
236			* @param array $rels
237			* @param array $hooks
238			* @throws InvalidOperationException
239			*/
240			protected function getRelationshipsKnownPolyMorph(array $rels, array &$hooks)
241			{
242			/**
243			* @var string $property
244			* @var Relation $foo
245			*/
246			foreach ($rels['KnownPolyMorphSide'] as $property => $foo) {
247			$isMany = $foo instanceof MorphToMany;
248			$targ = get_class($foo->getRelated());
249			$mult = $isMany \|\| $foo instanceof MorphMany ? '*' : '1';
250			$mult = $foo instanceof MorphOne ? '0..1' : $mult;
251
252			$keyName = $this->polyglotFkKey($foo);
253			$localName = $this->polyglotRkKey($foo);
254			$first = $isMany ? $keyName : $localName;
255			$last = $isMany ? $localName : $keyName;
256			$this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ, 'unknown');
257			}
258			}
259
260			/**
261			* @param array $rels
262			* @param array $hooks
263			* @throws InvalidOperationException
264			*/
265			protected function getRelationshipsUnknownPolyMorph(array $rels, array &$hooks)
266			{
267			/**
268			* @var string $property
269			* @var Relation $foo
270			*/
271			foreach ($rels['UnknownPolyMorphSide'] as $property => $foo) {
272			$isMany = $foo instanceof MorphToMany;
273			$targ = get_class($foo->getRelated());
274			$mult = $isMany ? '*' : '1';
275
276			$keyName = $this->polyglotFkKey($foo);
277			$localName = $this->polyglotRkKey($foo);
278
279			$first = $keyName;
280			$last = (isset($localName) && '' != $localName) ? $localName : $foo->getRelated()->getKeyName();
281			$this->addRelationsHook($hooks, $first, $property, $last, $mult, $targ, 'known');
282			}
283			}
284
285			/**
286			* @param $hooks
287			* @param $foreignField
288			* @param $RelationName
289			* @param $localKey
290			* @param $mult
291			* @param string\|null $relatedObject
292			* @param mixed\|null $type
293			* @param mixed\|null $through
294			*/
295			protected function addRelationsHook(
296			array &$hooks,
297			$foreignField,
298			$RelationName,
299			$localKey,
300			$mult,
301			$relatedObject,
302			$type = null,
303			$through = null
304			) {
305			if (!isset($hooks[$foreignField])) {
306			$hooks[$foreignField] = [];
307			}
308			if (!isset($hooks[$foreignField][$relatedObject])) {
309			$hooks[$foreignField][$relatedObject] = [];
310			}
311			$hooks[$foreignField][$relatedObject][$RelationName] = [
312			'property' => $RelationName,
313			'local' => $localKey,
314			'through' => $through,
315			'multiplicity' => $mult,
316			'type' => $type
317			];
318			}
319			}
320

Algo-Web / POData-Laravel

Pull Request — master (#219)

MetadataRelationsTrait::addRelationsHook() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like