Config::getGlobalIgnore() - Code Metrics - Inspection of "Merge pull request #39 from TomHAnderson/feature/9..." - API-Skeletons/doctrine-orm-graphql - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — main (0cd36c)

by Tom

created 2023-12-12 23:16 UTC

Config::getGlobalIgnore() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace ApiSkeletons\Doctrine\ORM\GraphQL;

use ApiSkeletons\Doctrine\ORM\GraphQL\Filter\Filters;

/**
 * This class is used for setting parameters when
 * creating the driver
 */
class Config
{
    /**
     * @var string The GraphQL group. This allows multiple GraphQL
     *             configurations within the same application or
     *             even within the same group of entities and Object Manager.
     */
    protected string $group = 'default';

    /**
     * @var string|null The group is usually suffixed to GraphQL type names.
     *                  You may specify a different string for the group suffix
     *                  or you my supply an empty string to exclude the suffix.
     *                  Be warned, using the same groupSuffix with two different
     *                  groups can cause collisions.
     */
    protected string|null $groupSuffix = null;

    /**
     * @var bool When set to true hydrator results will be cached for the
     *           duration of the request thereby saving multiple extracts for
     *           the same entity.
     */
    protected bool $useHydratorCache = false;

    /** @var int A hard limit for fetching any collection within the schema */
    protected int $limit = 1000;

    /**
     * @var bool When set to true all fields and all associations will be
     *           enabled.  This is best used as a development setting when
     *           the entities are subject to change.
     */
    protected bool $globalEnable = false;

    /** @var string[] An array of field names to ignore when using globalEnable. */
    protected array $ignoreFields = [];

    /**
     * @var bool|null When set to true, all entities will be extracted by value
     *                across all hydrators in the driver.  When set to false,
     *                all hydrators will extract by reference.  This overrides
     *                per-entity attribute configuration.
     */
    protected bool|null $globalByValue = null;

    /**
     * @var string|null When set, the entityPrefix will be removed from each
     *                  type name.  This simplifies type names and makes reading
     *                  the GraphQL documentation easier.
     */
    protected string|null $entityPrefix = null;

    /**
     * @var bool|null When set to true entity fields will be
     *                sorted alphabetically
     */
    protected bool|null $sortFields = null;

    /**
     * @var Filters[] An array of filters to exclude from
     *                available filters for all fields and
     *                associations in every entity
     */
    protected array $excludeFilters = [];

    /** @param mixed[] $config */
    public function __construct(array $config = [])
    {
        /**
         * Dynamic setters will fail for invalid settings and allow for
         * validation of field types through setters
         */
        foreach ($config as $setting => $value) {
            $setter = 'set' . $setting;
            $this->$setter($value);
        }
    }

    protected function setGroup(string $group): self
    {
        $this->group = $group;

        return $this;
    }

    public function getGroup(): string
    {
        return $this->group;
    }

    protected function setGroupSuffix(string|null $groupSuffix): self
    {
        $this->groupSuffix = $groupSuffix;

        return $this;
    }

    public function getGroupSuffix(): string|null
    {
        return $this->groupSuffix;
    }

    protected function setUseHydratorCache(bool $useHydratorCache): self
    {
        $this->useHydratorCache = $useHydratorCache;

        return $this;
    }

    public function getUseHydratorCache(): bool
    {
        return $this->useHydratorCache;
    }

    protected function setLimit(int $limit): self
    {
        $this->limit = $limit;

        return $this;
    }

    public function getLimit(): int
    {
        return $this->limit;
    }

    protected function setGlobalEnable(bool $globalEnable): self
    {
        $this->globalEnable = $globalEnable;

        return $this;
    }

    public function getGlobalEnable(): bool
    {
        return $this->globalEnable;
    }

    /** @param string[] $ignoreFields */
    protected function setIgnoreFields(array $ignoreFields): self
    {
        $this->ignoreFields = $ignoreFields;

        return $this;
    }

    /** @return string[] */
    public function getIgnoreFields(): array
    {
        return $this->ignoreFields;
    }

    protected function setGlobalByValue(bool|null $globalByValue): self
    {
        $this->globalByValue = $globalByValue;

        return $this;
    }

    public function getGlobalByValue(): bool|null
    {
        return $this->globalByValue;
    }

    protected function setEntityPrefix(string|null $entityPrefix): self
    {
        $this->entityPrefix = $entityPrefix;

        return $this;
    }

    public function getEntityPrefix(): string|null
    {
        return $this->entityPrefix;
    }

    public function setSortFields(bool|null $sortFields): self
    {
        $this->sortFields = $sortFields;

        return $this;
    }

    public function getSortFields(): bool|null
    {
        return $this->sortFields;
    }

    /** @param Filters[] $excludeFilters */
    public function setExcludeFilters(array $excludeFilters): self
    {
        $this->excludeFilters = $excludeFilters;

        return $this;
    }

    /** @return Filters[] */
    public function getExcludeFilters(): array
    {
        return $this->excludeFilters;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace ApiSkeletons\Doctrine\ORM\GraphQL;
6
7			use ApiSkeletons\Doctrine\ORM\GraphQL\Filter\Filters;
8
9			/**
10			* This class is used for setting parameters when
11			* creating the driver
12			*/
13			class Config
14			{
15			/**
16			* @var string The GraphQL group. This allows multiple GraphQL
17			* configurations within the same application or
18			* even within the same group of entities and Object Manager.
19			*/
20			protected string $group = 'default';
21
22			/**
23			* @var string\|null The group is usually suffixed to GraphQL type names.
24			* You may specify a different string for the group suffix
25			* or you my supply an empty string to exclude the suffix.
26			* Be warned, using the same groupSuffix with two different
27			* groups can cause collisions.
28			*/
29			protected string\|null $groupSuffix = null;
30
31			/**
32			* @var bool When set to true hydrator results will be cached for the
33			* duration of the request thereby saving multiple extracts for
34			* the same entity.
35			*/
36			protected bool $useHydratorCache = false;
37
38			/** @var int A hard limit for fetching any collection within the schema */
39			protected int $limit = 1000;
40
41			/**
42			* @var bool When set to true all fields and all associations will be
43			* enabled. This is best used as a development setting when
44			* the entities are subject to change.
45			*/
46			protected bool $globalEnable = false;
47
48			/** @var string[] An array of field names to ignore when using globalEnable. */
49			protected array $ignoreFields = [];
50
51			/**
52			* @var bool\|null When set to true, all entities will be extracted by value
53			* across all hydrators in the driver. When set to false,
54			* all hydrators will extract by reference. This overrides
55			* per-entity attribute configuration.
56			*/
57			protected bool\|null $globalByValue = null;
58
59			/**
60			* @var string\|null When set, the entityPrefix will be removed from each
61			* type name. This simplifies type names and makes reading
62			* the GraphQL documentation easier.
63			*/
64			protected string\|null $entityPrefix = null;
65
66			/**
67			* @var bool\|null When set to true entity fields will be
68			* sorted alphabetically
69			*/
70			protected bool\|null $sortFields = null;
71
72			/**
73			* @var Filters[] An array of filters to exclude from
74			* available filters for all fields and
75			* associations in every entity
76			*/
77			protected array $excludeFilters = [];
78
79			/** @param mixed[] $config */
80			public function __construct(array $config = [])
81			{
82			/**
83			* Dynamic setters will fail for invalid settings and allow for
84			* validation of field types through setters
85			*/
86			foreach ($config as $setting => $value) {
87			$setter = 'set' . $setting;
88			$this->$setter($value);
89			}
90			}
91
92			protected function setGroup(string $group): self
93			{
94			$this->group = $group;
95
96			return $this;
97			}
98
99			public function getGroup(): string
100			{
101			return $this->group;
102			}
103
104			protected function setGroupSuffix(string\|null $groupSuffix): self
105			{
106			$this->groupSuffix = $groupSuffix;
107
108			return $this;
109			}
110
111			public function getGroupSuffix(): string\|null
112			{
113			return $this->groupSuffix;
114			}
115
116			protected function setUseHydratorCache(bool $useHydratorCache): self
117			{
118			$this->useHydratorCache = $useHydratorCache;
119
120			return $this;
121			}
122
123			public function getUseHydratorCache(): bool
124			{
125			return $this->useHydratorCache;
126			}
127
128			protected function setLimit(int $limit): self
129			{
130			$this->limit = $limit;
131
132			return $this;
133			}
134
135			public function getLimit(): int
136			{
137			return $this->limit;
138			}
139
140			protected function setGlobalEnable(bool $globalEnable): self
141			{
142			$this->globalEnable = $globalEnable;
143
144			return $this;
145			}
146
147			public function getGlobalEnable(): bool
148			{
149			return $this->globalEnable;
150			}
151
152			/** @param string[] $ignoreFields */
153			protected function setIgnoreFields(array $ignoreFields): self
154			{
155			$this->ignoreFields = $ignoreFields;
156
157			return $this;
158			}
159
160			/** @return string[] */
161			public function getIgnoreFields(): array
162			{
163			return $this->ignoreFields;
164			}
165
166			protected function setGlobalByValue(bool\|null $globalByValue): self
167			{
168			$this->globalByValue = $globalByValue;
169
170			return $this;
171			}
172
173			public function getGlobalByValue(): bool\|null
174			{
175			return $this->globalByValue;
176			}
177
178			protected function setEntityPrefix(string\|null $entityPrefix): self
179			{
180			$this->entityPrefix = $entityPrefix;
181
182			return $this;
183			}
184
185			public function getEntityPrefix(): string\|null
186			{
187			return $this->entityPrefix;
188			}
189
190			public function setSortFields(bool\|null $sortFields): self
191			{
192			$this->sortFields = $sortFields;
193
194			return $this;
195			}
196
197			public function getSortFields(): bool\|null
198			{
199			return $this->sortFields;
200			}
201
202			/** @param Filters[] $excludeFilters */
203			public function setExcludeFilters(array $excludeFilters): self
204			{
205			$this->excludeFilters = $excludeFilters;
206
207			return $this;
208			}
209
210			/** @return Filters[] */
211			public function getExcludeFilters(): array
212			{
213			return $this->excludeFilters;
214			}
215			}
216

API-Skeletons / doctrine-orm-graphql

Branch — main (0cd36c)

Config::getGlobalIgnore() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like