Lines 92.07% 186 / 202
Methods 79.06% 34 / 43
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 getDefaults 100.00% 8 / 8 100.00% 1 / 1 1
 hasMail 100.00% 1 / 1 100.00% 1 / 1 2
 getContactPerson 100.00% 1 / 1 100.00% 1 / 1 1
 getContact 100.00% 1 / 1 100.00% 1 / 1 1
 getDayoffList 100.00% 6 / 6 100.00% 1 / 1 4
 getClusterByScopeId 100.00% 9 / 9 100.00% 1 / 1 5
 withOutClusterDuplicates 95.45% 21 / 22 0.00% 0 / 1 10
 withCompleteScopeList 100.00% 3 / 3 100.00% 1 / 1 1
 getScopeList 100.00% 13 / 13 100.00% 1 / 1 8
 hasAccess 100.00% 1 / 1 100.00% 1 / 1 2
 withLessData 88.23% 15 / 17 0.00% 0 / 1 8.10
 [BO\Zmsentities\Schema\Entity] __construct 100.00% 4 / 4 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] exchangeArray 100.00% 4 / 4 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] offsetSet 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] getUnflattenedArray 100.00% 5 / 5 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] getValidator 100.00% 6 / 6 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] isValid 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] testValid 100.00% 7 / 7 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] createExample 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] getExample 100.00% 5 / 5 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] readJsonSchema 66.66% 6 / 9 0.00% 0 / 1 3.33
 [BO\Zmsentities\Schema\Entity] getEntityName 100.00% 4 / 4 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] setJsonCompressLevel 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] jsonSerialize 100.00% 11 / 11 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] __toString 100.00% 2 / 2 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] __get 0.00% 0 / 1 0.00% 0 / 1 2
 [BO\Zmsentities\Schema\Entity] __isset 0.00% 0 / 1 0.00% 0 / 1 2
 [BO\Zmsentities\Schema\Entity] __set 0.00% 0 / 1 0.00% 0 / 1 2
 [BO\Zmsentities\Schema\Entity] __unset 0.00% 0 / 1 0.00% 0 / 1 2
 [BO\Zmsentities\Schema\Entity] __clone 100.00% 3 / 3 100.00% 1 / 1 3
 [BO\Zmsentities\Schema\Entity] addData 100.00% 14 / 14 100.00% 1 / 1 6
 [BO\Zmsentities\Schema\Entity] withData 0.00% 0 / 3 0.00% 0 / 1 2
 [BO\Zmsentities\Schema\Entity] hasId 100.00% 1 / 1 100.00% 1 / 1 2
 [BO\Zmsentities\Schema\Entity] getId 100.00% 2 / 2 100.00% 1 / 1 3
 [BO\Zmsentities\Schema\Entity] toProperty 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] hasProperty 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] getProperty 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] withProperty 0.00% 0 / 3 0.00% 0 / 1 2
 [BO\Zmsentities\Schema\Entity] withCleanedUpFormData 100.00% 6 / 6 100.00% 1 / 1 3
 [BO\Zmsentities\Schema\Entity] getResolveLevel 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] setResolveLevel 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsentities\Schema\Entity] withResolveLevel 100.00% 9 / 9 100.00% 1 / 1 5
 [BO\Zmsentities\Schema\Entity] withReference 100.00% 5 / 5 100.00% 1 / 1 2
7class Department extends Schema\Entity implements Useraccount\AccessInterface
8{
9    public const string PRIMARY = 'id';
10
11    public static $schema = "department.json";
12
13    /**
14     * @return (Collection\ClusterList|Collection\DayoffList|Collection\LinkList|Collection\ScopeList|int|string)[]
15     *
16     */
17    #[\Override]
18    public function getDefaults()
19    {
20        return [
21            'id' => 0,
22            'scopes' => new Collection\ScopeList(),
23            'clusters' => new Collection\ClusterList(),
24            'links' => new Collection\LinkList(),
25            'dayoff' => new Collection\DayoffList(),
26            'name' => '',
27        ];
28    }
29
30    public function hasMail(): bool
31    {
32        return ($this->toProperty()->email->isAvailable() && $this->toProperty()->email->get());
33    }
34
35    public function getContactPerson(): mixed
36    {
37        return $this->toProperty()->contact->name->get();
38    }
39
40    public function getContact(): Contact
41    {
42        return new Contact($this->toProperty()->contact->get());
43    }
44
45    public function getDayoffList(): Collection\DayoffList
46    {
47        if (!$this->dayoff instanceof Collection\DayoffList) {
48            $this->dayoff = new Collection\DayoffList((array)$this->dayoff);
49            foreach ($this->dayoff as $key => $dayOff) {
50                if (!$dayOff instanceof Dayoff) {
51                    $this->dayoff[$key] = new Dayoff($dayOff);
52                }
53            }
54        }
55        return $this->dayoff;
56    }
57
58    public function getClusterByScopeId(mixed $scopeId): mixed
59    {
60        $selectedCluster = false;
61        if (isset($this->clusters)) {
62            foreach ($this->clusters as $cluster) {
63                $cluster = new Cluster($cluster);
64                foreach ($cluster['scopes'] as $clusterScope) {
65                    if ($scopeId == $clusterScope['id']) {
66                        $selectedCluster = $cluster->getId();
67                        break;
68                    }
69                }
70            }
71        }
72        return $selectedCluster;
73    }
74
75    /**
76     * Remove duplicate scopes from clusters
77     * Move scopes to clusters to keep the same resolveReference Level
78     */
79    public function withOutClusterDuplicates(): static
80    {
81        $department = clone $this;
82        if ($this->offsetExists('scopes') && $this->scopes) {
83            $scopes = $this->scopes;
84            $scopeList = $scopes instanceof Collection\ScopeList
85                ? clone $scopes
86                : new Collection\ScopeList($scopes);
87            $department->scopes = new Collection\ScopeList();
88            $removeScopeList = new Collection\ScopeList();
89            if ($department->toProperty()->clusters->get()) {
90                foreach ($department->clusters as $cluster) {
91                    $cluster = new Cluster($cluster);
92                    foreach ($cluster['scopes'] as $key => $clusterScope) {
93                        $scope = $scopeList->getEntity($clusterScope['id']);
94                        if ($scope) {
95                            $scope = new Scope($scope);
96                            $cluster['scopes'][$key] = clone $scope;
97                            $removeScopeList[] = $scope;
98                        }
99                    }
100                }
101                foreach ($scopeList as $scope) {
102                    if (! $removeScopeList->hasEntity($scope['id'])) {
103                        $scope = new Scope($scope);
104                        $department->scopes->addEntity($scope);
105                    }
106                }
107            }
108        }
109        return $department;
110    }
111
112    public function withCompleteScopeList(): static
113    {
114        $department = clone $this;
115        $department->scopes = $this->getScopeList()->withUniqueScopes();
116        return $department;
117    }
118
119    public function getScopeList(): Collection\ScopeList
120    {
121        $scopeList = new Collection\ScopeList();
122        if ($this->toProperty()->clusters->isAvailable()) {
123            foreach ($this->clusters as $cluster) {
124                if (Property::__keyExists('scopes', $cluster)) {
125                    foreach ($cluster['scopes'] as $clusterScope) {
126                        $scope = new Scope($clusterScope);
127                        $scopeList->addEntity($scope);
128                    }
129                }
130            }
131        }
132        if ($this->toProperty()->scopes->isAvailable()) {
133            foreach ($this->scopes as $scope) {
134                if (! $scopeList->hasEntity($scope['id'])) {
135                    $scope = new Scope($scope);
136                    $scopeList->addEntity($scope);
137                }
138            }
139        }
140        return $scopeList;
141    }
142
143    /**
144     * @return bool
145     */
146    #[\Override]
147    public function hasAccess(Useraccount $useraccount): bool
148    {
149        return $useraccount->isSuperUser() || $useraccount->hasDepartment($this->id);
150    }
151
152    /**
153     * Reduce data of dereferenced entities to a required minimum
154     *
155     * @return static
156     */
157    #[\Override]
158    public function withLessData()
159    {
160        $entity = clone $this;
161        if (isset($entity['preferences'])) {
162            unset($entity['preferences']);
163            $entity['preferences'] = [];
164        }
165        if (isset($entity['email'])) {
166            unset($entity['email']);
167        }
168        if (isset($entity['scopes'])) {
169            unset($entity['scopes']);
170        }
171        if (isset($entity['clusters'])) {
172            unset($entity['clusters']);
173        }
174        if (isset($entity['links'])) {
175            unset($entity['links']);
176        }
177        if (isset($entity['dayoff'])) {
178            unset($entity['dayoff']);
179        }
180        if (isset($entity['contact'])) {
181            unset($entity['contact']);
182        }
183        return $entity;
184    }
185}

Inherited from BO\Zmsentities\Schema\Entity

59    public function __construct(mixed $input = null, int $flags = \ArrayObject::ARRAY_AS_PROPS, string $iterator_class = "ArrayIterator")
60    {
61        /** @var class-string<\ArrayIterator> $iterator_class */
62        parent::__construct($this->getDefaults(), $flags, $iterator_class);
63        if ($input) {
64            $input = $this->getUnflattenedArray($input);
65            $this->addData($input);
66        }
67    }
70    public function exchangeArray(object|array $input): array
71    {
72        parent::exchangeArray($this->getDefaults());
73        $input = $this->getUnflattenedArray($input);
74        $this->addData($input);
75        return $this->getArrayCopy();
76    }
82    public function offsetSet(mixed $key, mixed $value): void
83    {
84        /** @psalm-suppress PossiblyNullArgument */
85        parent::offsetSet($key, $value);
86    }
88    public function getUnflattenedArray(mixed $input): mixed
89    {
90        if (!$input instanceof UnflattedArray) {
91            $input = new UnflattedArray($input);
92            $input->getUnflattenedArray();
93        }
94        $input = $input->getValue();
95        return $input;
96    }
112    public function getValidator(string $locale = 'de_DE', int $resolveLevel = 0): Validator
113    {
114        $jsonSchema = self::readJsonSchema()->withResolvedReferences($resolveLevel);
115        $data = (new Schema($this))->withoutRefs();
116        if (Property::__keyExists('$schema', $data)) {
117            unset($data['$schema']);
118        }
119        $validator = new Validator($data->toJsonObject(true), $jsonSchema, $locale);
120        return $validator;
121    }
128    public function isValid(int $resolveLevel = 0): bool
129    {
130        $validator = $this->getValidator('de_DE', $resolveLevel = 0);
131        return $validator->isValid();
132    }
140    public function testValid(string $locale = 'de_DE', int $resolveLevel = 0): bool
141    {
142        $validator = $this->getValidator($locale, $resolveLevel);
143        if (!$validator->isValid()) {
144            $exception = new \BO\Zmsentities\Exception\SchemaValidation();
145            $exception->setSchemaName($this->getEntityName());
146            $exception->setValidationError($validator->getErrors());
147            throw $exception;
148        }
149        return true;
150    }
157    public static function createExample()
158    {
159        $object = new static();
160        return $object->getExample();
161    }
168    public static function getExample()
169    {
170        $class = get_called_class();
171        $jsonSchema = self::readJsonSchema();
172        if ($jsonSchema->offsetExists('example')) {
173            return new $class($jsonSchema['example']);
174        }
175        return new $class();
176    }
178    protected static function readJsonSchema(): mixed
179    {
180        $class = get_called_class();
181        if (!array_key_exists($class, self::$schemaCache)) {
182            $schemaFile = $class::$schema;
183            if (!is_string($schemaFile)) {
184                throw new \BO\Zmsentities\Exception\SchemaMissingJsonFile(
185                    'Missing JSON-Schema file for ' . $class
186                );
187            }
188            self::$schemaCache[$class] = Loader::asArray($schemaFile);
189        }
190        return self::$schemaCache[$class];
191    }
193    public function getEntityName(): string
194    {
195        $entity = get_class($this);
196        $entity = preg_replace('#.*[\\\]#', '', $entity) ?? '';
197        $entity = strtolower($entity);
198        return $entity;
199    }
201    public function setJsonCompressLevel(mixed $jsonCompressLevel): static
202    {
203        $this->jsonCompressLevel = $jsonCompressLevel;
204        return $this;
205    }
208    public function jsonSerialize(): mixed
209    {
210        $schema = array(
211            '$schema' => 'https://schema.berlin.de/queuemanagement/' . $this->getEntityName() . '.json'
212        );
213        $schema = array_merge($schema, $this->getArrayCopy());
214        if ($this instanceof \BO\Zmsentities\Helper\NoSanitize) {
215            $serialize = $schema;
216        } else {
217            $schema = new Schema($schema);
218            $schema->setDefaults($this->getDefaults());
219            $schema->setJsonCompressLevel($this->jsonCompressLevel);
220            $serialize = $schema->toJsonObject();
221        }
222        return $serialize;
223    }
225    public function __toString()
226    {
227        $encoded = json_encode($this->jsonSerialize(), JSON_HEX_QUOT);
228        return $encoded !== false ? $encoded : '';
229    }
235    public function __get(string $name): mixed
236    {
237        return $this->offsetGet($name);
238    }
240    public function __isset(string $name): bool
241    {
242        return $this->offsetExists($name);
243    }
245    public function __set(string $name, mixed $value): void
246    {
247        $this->offsetSet($name, $value);
248    }
250    public function __unset(string $name): void
251    {
252        $this->offsetUnset($name);
253    }
255    public function __clone()
256    {
257        foreach ($this as $key => $property) {
258            if (is_object($property)) {
259                $this[$key] = clone $property;
260            }
261        }
262    }
268    public function addData(array|object $mergeData): static
269    {
270        foreach ($mergeData as $key => $item) {
271            if (isset($this[$key])) {
272                if ($this[$key] instanceof Entity) {
273                    $this[$key]->setResolveLevel(($this->getResolveLevel() ?? 0) - 1);
274                    $this[$key]->addData($item);
275                } elseif ($this[$key] instanceof \BO\Zmsentities\Collection\Base) {
276                    $this[$key]->exchangeArray([]);
277                    $this[$key]->setResolveLevel(($this->getResolveLevel() ?? 0) - 1);
278                    $this[$key]->addData($item);
279                } elseif (is_array($this[$key])) {
280                    $this[$key] = array_replace_recursive($this[$key], $item);
281                } else {
282                    $this[$key] = $item;
283                }
284            } else {
285                $this[$key] = $item;
286            }
287        }
288        return $this;
289    }
294    public function withData(mixed $mergeData): static
295    {
296        $entity = clone $this;
297        $entity->addData($mergeData);
298        return $entity;
299    }
301    public function hasId(): bool
302    {
303        return (false !== $this->getId()) ? true : false;
304    }
306    public function getId(): mixed
307    {
308        $idName = $this::PRIMARY;
309        return ($this->offsetExists($idName) && $this[$idName]) ? $this[$idName] : false;
310    }
317    public function toProperty()
318    {
319        return new \BO\Zmsentities\Helper\Property($this);
320    }
322    public function hasProperty(mixed $propertyName): mixed
323    {
324        return $this->toProperty()->{$propertyName}->isAvailable();
325    }
327    public function getProperty(string $propertyName, mixed $default = ''): mixed
328    {
329        return $this->toProperty()->{$propertyName}->get($default);
330    }
335    public function withProperty(mixed $propertyName, mixed $newValue): static
336    {
337        $entity = clone $this;
338        $entity[$propertyName] = $newValue;
339        return $entity;
340    }
357    public function withCleanedUpFormData()
358    {
359        $entity = clone $this;
360        if (isset($entity['save'])) {
361            unset($entity['save']);
362        }
363        if (isset($entity['removeImage'])) {
364            unset($entity['removeImage']);
365        }
366        return $entity;
367    }
372    public function getResolveLevel()
373    {
374        return $this->resolveLevel;
375    }
381    public function setResolveLevel($resolveLevel)
382    {
383        $this->resolveLevel = $resolveLevel;
384        return $this;
385    }
393    public function withResolveLevel($resolveLevel): self|array
394    {
395        if ($resolveLevel >= 0) {
396            $entity = clone $this;
397            foreach ($entity as $key => $value) {
398                if ($value instanceof Entity || $value instanceof \BO\Zmsentities\Collection\Base) {
399                    $entity[$key] = $value->withResolveLevel($resolveLevel - 1);
400                } else {
401                    $entity[$key] = $value;
402                }
403            }
404            $entity->setResolveLevel($resolveLevel);
405            return $entity;
406        } else {
407            return $this->withReference();
408        }
409    }
417    public function withReference($additionalData = []): self|array
418    {
419        if (isset($this[$this::PRIMARY])) {
420            $additionalData['$ref'] =
421                $this::$schemaRefPrefix . $this->getEntityName() . '/' . $this[$this::PRIMARY] . '/';
422            return $additionalData;
423        } else {
424            return $this->withResolveLevel(0);
425        }
426    }