CrudRelationsExtension::_attachAssociations() - Code Metrics - CakeDC/cakephp-api - Measure and Improve Code Quality continuously with Scrutinizer

CrudRelationsExtension::_attachAssociations() A
last analyzed 2021-05-07 09:37 UTC

↳ Parent: CrudRelationsExtension

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	26
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
nc	4
nop	2
dl	0
loc	35
rs	9.0488
c	0
b	0
f	0
ccs	26
cts	26
cp	1
crap	5

<?php
/**
 * Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

namespace CakeDC\Api\Service\Action\Extension;

use CakeDC\Api\Service\Action\Action;
use CakeDC\Api\Service\Action\CrudAction;
use Cake\Event\Event;
use Cake\Event\EventListenerInterface;
use Cake\ORM\Association;
use Cake\ORM\Query;
use Cake\Utility\Inflector;

/**
 * Class CrudRelationsExtension
 *
 * Allow to include relations for fetched entities to return by index, view or edit crud actions.
 * Currently limited only by HasOne and BelongsTo associations.
 *
 * @package CakeDC\Api\Service\Action\Extension
 */
class CrudRelationsExtension extends Extension implements EventListenerInterface
{

    /**
     * Returns a list of events this object is implementing. When the class is registered
     * in an event manager, each individual method will be associated with the respective event.
     *
     * @return array
     */
    public function implementedEvents()
    {
        return [
            'Action.Crud.onFindEntities' => 'findEntities',
            'Action.Crud.onFindEntity' => 'findEntity',
        ];
    }

    /**
     * On find entity
     *
     * @param Event $event An Event instance.
     * @return \Cake\ORM\Query
     */
    public function findEntity(Event $event)
    {
        return $this->_attachAssociations($event->getSubject(), $event->getData('query'));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * On find entities.
     *
     * @param Event $event An Event instance.
     * @return \Cake\ORM\Query
     */
    public function findEntities(Event $event)
    {
        return $this->_attachAssociations($event->getSubject(), $event->getData('query'));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * Checks if endpoint returns additional associations.
     *
     * @param CrudAction $action A CrudAction instance.
     * @return array|bool
     */
    protected function _includeAssociations(CrudAction $action)
    {
        $data = $action->getData();
        if (!empty($data['include_associations']) && empty($data['include_relations'])) {
            $data['include_relations'] = $data['include_associations'];
        }
        $exists = (is_array($data) && !empty($data['include_relations']));
        if (!$exists) {
            return false;
        }
        $associations = $data['include_relations'];
        if (!is_array($associations)) {
            return explode(',', $associations);
        }
        if (is_array($associations) && count($associations) > 0) {
            return $associations;
        }

        return false;
    }

    /**
     * Checks if endpoint returns direct associations, i.e. all belongsTo and all hasOne.
     *
     * @param CrudAction $action An CrudAction instance.
     * @return bool
     */
    protected function _includeDirectAssociations(CrudAction $action)
    {
        $data = $action->getData();

        return (is_array($data) && !empty($data['include_direct']));
    }

    /**
     * @param CrudAction $action An Action instance.
     * @param Query $query A Query instance.
     * @return mixed
     */
    protected function _attachAssociations(CrudAction $action, Query $query)
    {
        $associations = $this->_includeAssociations($action);
        if (empty($associations) && $this->_includeDirectAssociations($action)) {
            $relations = $action
                ->getTable()
                ->associations()
                ->getByType(['HasOne', 'BelongsTo']);
            $associations = collection($relations)
                ->map(function (Association $relation) {
                    return $relation->getTarget()->getTable();
                })
                ->toArray();
        }
        if (empty($associations)) {
            return $query;
        }

        $tables = collection($associations)
            ->map(function ($name) {
                return Inflector::camelize($name);
            })
            ->toArray();

        collection($tables)->each(function ($name) use ($query, $action) {
            $assoc = $action->getTable()->getAssociation($name);
            if ($assoc !== null) {
                $query->select($assoc);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        });
        $query->select($action->getTable());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $query->contain($tables);

        return $query;
    }
}


1		<?php
2		/**
3		* Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
4		*
5		* Licensed under The MIT License
6		* Redistributions of files must retain the above copyright notice.
7		*
8		* @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
9		* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
10		*/
11
12		namespace CakeDC\Api\Service\Action\Extension;
13
14		use CakeDC\Api\Service\Action\Action;
15		use CakeDC\Api\Service\Action\CrudAction;
16		use Cake\Event\Event;
17		use Cake\Event\EventListenerInterface;
18		use Cake\ORM\Association;
19		use Cake\ORM\Query;
20		use Cake\Utility\Inflector;
21
22		/**
23		* Class CrudRelationsExtension
24		*
25		* Allow to include relations for fetched entities to return by index, view or edit crud actions.
26		* Currently limited only by HasOne and BelongsTo associations.
27		*
28		* @package CakeDC\Api\Service\Action\Extension
29		*/
30		class CrudRelationsExtension extends Extension implements EventListenerInterface
31		{
32
33		/**
34		* Returns a list of events this object is implementing. When the class is registered
35		* in an event manager, each individual method will be associated with the respective event.
36		*
37		* @return array
38		*/
39	4	public function implementedEvents()
40		{
41		return [
42	4	'Action.Crud.onFindEntities' => 'findEntities',
43	4	'Action.Crud.onFindEntity' => 'findEntity',
44	4	];
45		}
46
47		/**
48		* On find entity
49		*
50		* @param Event $event An Event instance.
51		* @return \Cake\ORM\Query
52		*/
53	4	public function findEntity(Event $event)
54		{
55	4	return $this->_attachAssociations($event->getSubject(), $event->getData('query'));
		0 ignored issues – show Documentation introduced 2018-04-20 17:18 UTC by Report Bug Copy Issue Report `$event->getSubject()` is of type `object\|null`, but the function expects a `object<CakeDC\Api\Service\Action\CrudAction>`. 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...
56		}
57
58		/**
59		* On find entities.
60		*
61		* @param Event $event An Event instance.
62		* @return \Cake\ORM\Query
63		*/
64		public function findEntities(Event $event)
65		{
66		return $this->_attachAssociations($event->getSubject(), $event->getData('query'));
		0 ignored issues – show Documentation introduced 2018-04-20 17:18 UTC by Report Bug Copy Issue Report `$event->getSubject()` is of type `object\|null`, but the function expects a `object<CakeDC\Api\Service\Action\CrudAction>`. 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...
67		}
68
69		/**
70		* Checks if endpoint returns additional associations.
71		*
72		* @param CrudAction $action A CrudAction instance.
73		* @return array\|bool
74		*/
75	4	protected function _includeAssociations(CrudAction $action)
76		{
77	4	$data = $action->getData();
78	4	if (!empty($data['include_associations']) && empty($data['include_relations'])) {
79		$data['include_relations'] = $data['include_associations'];
80		}
81	4	$exists = (is_array($data) && !empty($data['include_relations']));
82	4	if (!$exists) {
83	3	return false;
84		}
85	1	$associations = $data['include_relations'];
86	1	if (!is_array($associations)) {
87	1	return explode(',', $associations);
88		}
89		if (is_array($associations) && count($associations) > 0) {
90		return $associations;
91		}
92
93		return false;
94		}
95
96		/**
97		* Checks if endpoint returns direct associations, i.e. all belongsTo and all hasOne.
98		*
99		* @param CrudAction $action An CrudAction instance.
100		* @return bool
101		*/
102	3	protected function _includeDirectAssociations(CrudAction $action)
103		{
104	3	$data = $action->getData();
105
106	3	return (is_array($data) && !empty($data['include_direct']));
107		}
108
109		/**
110		* @param CrudAction $action An Action instance.
111		* @param Query $query A Query instance.
112		* @return mixed
113		*/
114	4	protected function _attachAssociations(CrudAction $action, Query $query)
115		{
116	4	$associations = $this->_includeAssociations($action);
117	4	if (empty($associations) && $this->_includeDirectAssociations($action)) {
118		$relations = $action
119	1	->getTable()
120	1	->associations()
121	1	->getByType(['HasOne', 'BelongsTo']);
122	1	$associations = collection($relations)
123		->map(function (Association $relation) {
124	1	return $relation->getTarget()->getTable();
125	1	})
126	1	->toArray();
127	1	}
128	4	if (empty($associations)) {
129	2	return $query;
130		}
131
132	2	$tables = collection($associations)
133		->map(function ($name) {
134	2	return Inflector::camelize($name);
135	2	})
136	2	->toArray();
137
138	2	collection($tables)->each(function ($name) use ($query, $action) {
139	2	$assoc = $action->getTable()->getAssociation($name);
140	2	if ($assoc !== null) {
141	2	$query->select($assoc);
		0 ignored issues – show Documentation introduced 2018-10-01 11:26 UTC by Report Bug Copy Issue Report `$assoc` is of type `object<Cake\ORM\Association>`, but the function expects a `callable`. 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...
142	2	}
143	2	});
144	2	$query->select($action->getTable());
		0 ignored issues – show Documentation introduced 2018-10-01 11:26 UTC by Report Bug Copy Issue Report `$action->getTable()` is of type `object<Cake\ORM\Table>`, but the function expects a `callable`. 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...
145	2	$query->contain($tables);
146
147	2	return $query;
148		}
149		}
150

CakeDC / cakephp-api

CrudRelationsExtension::_attachAssociations() A last analyzed 2021-05-07 09:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CrudRelationsExtension::_attachAssociations() A
last analyzed 2021-05-07 09:37 UTC