Lines 94.36% 201 / 213
Methods 83.33% 20 / 24
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readEntity 90.19% 46 / 51 0.00% 0 / 1 9.08
 readScopeSlotTimes 95.00% 19 / 20 0.00% 0 / 1 6
 normalizeScopeIds 85.71% 6 / 7 0.00% 0 / 1 3.03
 readSubjectList 100.00% 13 / 13 100.00% 1 / 1 2
 readPeriodList 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] __construct 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] init 100.00% 2 / 2 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] getWriter 100.00% 4 / 4 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] getReader 100.00% 5 / 5 100.00% 1 / 1 3
 [BO\Zmsbackend\Base] fetchPreparedStatement 100.00% 9 / 9 100.00% 1 / 1 3
 [BO\Zmsbackend\Base] startExecute 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] pdoExceptionHandler 100.00% 13 / 13 100.00% 1 / 1 4
 [BO\Zmsbackend\Base] fetchStatement 100.00% 3 / 3 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchOne 100.00% 7 / 7 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] fetchRow 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchValue 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchAll 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchHandle 100.00% 5 / 5 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchList 100.00% 8 / 8 100.00% 1 / 1 2
 [BO\Zmsbackend\Base] writeItem 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] deleteItem 100.00% 1 / 1 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] perform 100.00% 7 / 7 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] fetchAffected 100.00% 8 / 8 100.00% 1 / 1 1
 [BO\Zmsbackend\Base] readResolvedReferences n/a 0 / 0 n/a 0 / 0 1
 [BO\Zmsbackend\Base] hashStringValue 50.00% 5 / 10 0.00% 0 / 1 8.12
8class ExchangeCapacityscope extends \BO\Zmsbackend\Base
9{
10    public function readEntity(
11        $subjectid,
12        ?\DateTimeInterface $datestart = null,
13        ?\DateTimeInterface $dateend = null,
14        $period = 'day'
15    ): Exchange {
16        if (trim((string) $subjectid) === '') {
17            throw new \InvalidArgumentException('Subject ID cannot be empty');
18        }
19
20        $subjectIdList = explode(',', $subjectid);
21        $firstScopeId = $subjectIdList[0];
22        $scope = (new \BO\Zmsbackend\Scope\Service\Scope())->readEntity($firstScopeId);
23        $entity = new Exchange();
24        $entity['title'] = "Terminkapazität " . $scope->contact->name . " " . $scope->shortName;
25
26        $unfiltered = $datestart === null || $dateend === null;
27        if ($unfiltered) {
28            $datestart = new \DateTimeImmutable('1970-01-01');
29            $dateend = new \DateTimeImmutable('2099-12-31');
30            $period = 'day';
31        } else {
32            $entity->setPeriod($datestart, $dateend, $period);
33        }
34
35        $entity->addDictionaryEntry('subjectid', 'string', 'Standort-ID', 'scope.id');
36        $dateDescription = $period === 'hour' ? 'Zeitpunkt' : 'Datum';
37        $entity->addDictionaryEntry('date', 'string', $dateDescription);
38        $entity->addDictionaryEntry('bookedcount', 'number', 'Gebuchte Kapazität insgesamt (Zeitschlitze)');
39        $entity->addDictionaryEntry('plannedcount', 'number', 'Geplante Kapazität insgesamt (Zeitschlitze)');
40        $entity->addDictionaryEntry('bookedminutes', 'number', 'Gebuchte Kapazität insgesamt (Minuten)');
41        $entity->addDictionaryEntry('plannedminutes', 'number', 'Geplante Kapazität insgesamt (Minuten)');
42        $entity->addDictionaryEntry('bookedcount_public', 'number', 'Gebuchte Kapazität Internet (Zeitschlitze)');
43        $entity->addDictionaryEntry('plannedcount_public', 'number', 'Geplante Kapazität Internet (Zeitschlitze)');
44        $entity->addDictionaryEntry('bookedminutes_public', 'number', 'Gebuchte Kapazität Internet (Minuten)');
45        $entity->addDictionaryEntry('plannedminutes_public', 'number', 'Geplante Kapazität Internet (Minuten)');
46
47        $entity['visualization']['xlabel'] = ["date"];
48        $entity['visualization']['ylabel'] = ["bookedcount", "plannedcount"];
49        $entity['visualization']['ylabelMinutes'] = ["bookedminutes", "plannedminutes"];
50        $entity['visualization']['ylabelPublic'] = ["bookedcount_public", "plannedcount_public"];
51        $entity['visualization']['ylabelMinutesPublic'] = ["bookedminutes_public", "plannedminutes_public"];
52        $entity['visualization']['allowCapacityChannel'] = true;
53
54        $scopeIds = $this->normalizeScopeIds($subjectIdList);
55        if ($scopeIds === []) {
56            throw new \InvalidArgumentException('Subject ID cannot be empty');
57        }
58
59        $dateStart = $unfiltered ? null : $datestart;
60        $dateEnd = $unfiltered ? null : $dateend;
61        $parameters = [];
62        $query = ExchangeCapacityscopeQuery::buildCapacityMetricsQuery(
63            $scopeIds,
64            $dateStart,
65            $dateEnd,
66            $period,
67            $parameters
68        );
69        foreach ($this->fetchAll($query, $parameters) as $entry) {
70            $entity->addDataSet(array_values($entry));
71        }
72
73        $entity['visualization']['scopeSlotTimes'] = $this->readScopeSlotTimes(
74            $scopeIds,
75            $dateStart,
76            $dateEnd
77        );
78
79        return $entity;
80    }
81
82    /**
83     * @param array<int, int> $scopeIds
84     * @return array<int, array{id: string, name: string, slotTimeInMinutes: int}>
85     */
86    private function readScopeSlotTimes(
87        array $scopeIds,
88        ?\DateTimeInterface $dateStart,
89        ?\DateTimeInterface $dateEnd
90    ): array {
91        $parameters = [];
92        $query = ExchangeCapacityscopeQuery::buildScopeSlotTimeQuery(
93            $scopeIds,
94            $dateStart,
95            $dateEnd,
96            $parameters
97        );
98        $slotTimes = [];
99        foreach ($this->fetchAll($query, $parameters) as $entry) {
100            $scopeId = (string) ($entry['subjectid'] ?? '');
101            $minutes = (int) ($entry['slotminutes'] ?? 0);
102            if ($scopeId === '' || $minutes <= 0 || isset($slotTimes[$scopeId])) {
103                continue;
104            }
105            $name = trim((string) ($entry['scopename'] ?? ''));
106            $slotTimes[$scopeId] = [
107                'id' => $scopeId,
108                'name' => $name !== '' ? $name : 'Standort ' . $scopeId,
109                'slotTimeInMinutes' => $minutes,
110            ];
111        }
112
113        return array_values($slotTimes);
114    }
115
116    /**
117     * @param array<int, string> $subjectIdList
118     * @return array<int, int>
119     */
120    private function normalizeScopeIds(array $subjectIdList): array
121    {
122        $scopeIds = [];
123        foreach ($subjectIdList as $scopeId) {
124            $scopeId = trim($scopeId);
125            if (preg_match('/^\d+$/', $scopeId) !== 1) {
126                continue;
127            }
128            $scopeIds[] = (int) $scopeId;
129        }
130
131        return array_values(array_unique($scopeIds));
132    }
133
134    public function readSubjectList(): Exchange
135    {
136        $raw = $this->getReader()->fetchAll(
137            ExchangeCapacityscopeQuery::QUERY_CAPACITY_REPORT_SCOPE_SUBJECT_LIST,
138            []
139        );
140        $entity = new Exchange();
141        $entity['title'] = "Terminkapazität ";
142        $entity->addDictionaryEntry('subject', 'string', 'Standort ID', 'scope.id');
143        $entity->addDictionaryEntry('periodstart', 'string', 'Datum von');
144        $entity->addDictionaryEntry('periodend', 'string', 'Datum bis');
145        $entity->addDictionaryEntry('description', 'string', 'Beschreibung des Standortes');
146        foreach ($raw as $entry) {
147            $entity->addDataSet(array_values($entry));
148        }
149
150        return $entity;
151    }
152
153    /**
154     * Aggregate period placeholder required by ExchangeSubject interface.
155     *
156     * @SuppressWarnings(Unused)
157     */
158    public function readPeriodList($subjectid, $period = 'day'): Exchange
159    {
160        $entity = new Exchange();
161        $entity['title'] = "Terminkapazität ";
162        $entity->addDictionaryEntry('id', 'string', 'Gesamter Zeitraum', 'useraccount.permissions.superuser');
163        $entity->addDataSet(["_"]);
164
165        return $entity;
166    }
167}

Inherited from BO\Zmsbackend\Base

38    public function __construct(?Connection\Pdo $writeConnection = null, ?Connection\Pdo $readConnection = null)
39    {
40        $this->writeDb = $writeConnection;
41        $this->readDb = $readConnection;
42    }
44    public static function init(?Connection\Pdo $writeConnection = null, ?Connection\Pdo $readConnection = null): static
45    {
46        $instance = new static($writeConnection, $readConnection);
47        return $instance;
48    }
50    public function getWriter(): Connection\Pdo
51    {
52        if (null === $this->writeDb) {
53            $this->writeDb = Connection\Select::getWriteConnection();
54            $this->readDb = $this->writeDb;
55        }
56        return $this->writeDb;
57    }
59    public function getReader(): Connection\Pdo
60    {
61        if (null !== $this->writeDb) {
62            // if readDB gets a reset, still use writeDB
63            return $this->writeDb;
64        }
65        if (null === $this->readDb) {
66            $this->readDb = Connection\Select::getReadConnection();
67        }
68        return $this->readDb;
69    }
71    public function fetchPreparedStatement(Query\Base|string $query)
72    {
73        $sql = "$query";
74        $reader = $this->getReader();
75        if (spl_object_hash($reader) != static::$preparedConnectionId) {
76            // do not use prepared statements on a different connection
77            static::$preparedCache = [];
78            static::$preparedConnectionId = spl_object_hash($reader);
79        }
80        if (!isset(static::$preparedCache[$sql])) {
81            $prepared = $this->getReader()->prepare($sql);
82            static::$preparedCache[$sql] = $prepared;
83        }
84        return static::$preparedCache[$sql];
85    }
87    public function startExecute($statement, array $parameters)
88    {
89        $statement = static::pdoExceptionHandler(function () use ($statement, $parameters) {
90            $statement->execute($parameters);
91            return $statement;
92        });
93        return $statement;
94    }
96    protected static function pdoExceptionHandler(\Closure $pdoFunction, $parameters = [])
97    {
98        try {
99            $statement = $pdoFunction($parameters);
100        } catch (\PDOException $pdoException) {
101            if (stripos($pdoException->getMessage(), 'Lock wait timeout') !== false) {
102                throw new \BO\Zmsbackend\Exception\Pdo\LockTimeout();
103            }
104            //@codeCoverageIgnoreStart
105            if (stripos($pdoException->getMessage(), 'Deadlock found') !== false) {
106                throw new \BO\Zmsbackend\Exception\Pdo\DeadLockFound();
107            }
108            //@codeCoverageIgnoreEnd
109            $message = "SQL: "
110                . " Err: "
111                . $pdoException->getMessage()
112                //. " || Statement: "
113                //.$statement->queryString
114                //." || Parameters=". var_export($parameters, true)
115                ;
116            throw new \BO\Zmsbackend\Exception\Pdo\PDOFailed($message, 0, $pdoException);
117        }
118        return $statement;
119    }
121    public function fetchStatement(Query\Base $query)
122    {
123        $parameters = $query->getParameters();
124        $statement = $this->startExecute($this->fetchPreparedStatement($query), $parameters);
125        return $statement;
126    }
133    public function fetchOne(Query\Base $query, \BO\Zmsentities\Schema\Entity $entity)
134    {
135        $statement = $this->fetchStatement($query);
136        $data = $statement->fetch(\PDO::FETCH_ASSOC);
137        if ($data) {
138            $entity->exchangeArray($query->postProcessJoins($data));
139            $entity->setResolveLevel($query->getResolveLevel());
140        }
141        $statement->closeCursor();
142        return $entity;
143    }
145    public function fetchRow(Query\Base|string $query, array|null $parameters = null)
146    {
147        return static::pdoExceptionHandler(function () use ($query, $parameters) {
148            $prepared = $this->fetchPreparedStatement($query);
149            $prepared->execute($parameters);
150            $row = $prepared->fetch(\PDO::FETCH_ASSOC);
151            $prepared->closeCursor();
152            return $row;
153        });
154    }
156    public function fetchValue(Query\Base|string $query, array|null $parameters = null)
157    {
158        return static::pdoExceptionHandler(function () use ($query, $parameters) {
159            $prepared = $this->fetchPreparedStatement($query);
160            $prepared->execute($parameters);
161            $value = $prepared->fetchColumn();
162            $prepared->closeCursor();
163            return $value;
164        });
165    }
167    public function fetchAll(Query\Base|string $query, array|null $parameters = null)
168    {
169        return static::pdoExceptionHandler(function () use ($query, $parameters) {
170            $prepared = $this->fetchPreparedStatement($query);
171            $prepared->execute($parameters);
172            $list = $prepared->fetchAll(\PDO::FETCH_ASSOC);
173            $prepared->closeCursor();
174            return $list;
175        });
176    }
178    public function fetchHandle(Query\Base|string $query, array|null $parameters = null)
179    {
180        return static::pdoExceptionHandler(function () use ($query, $parameters) {
181            $prepared = $this->fetchPreparedStatement($query);
182            $prepared->execute($parameters);
183            return $prepared;
184        });
185    }
187    public function fetchList(Query\Base $query, \BO\Zmsentities\Schema\Entity $entity, array|\ArrayAccess $resultList = [])
188    {
189        $statement = $this->fetchStatement($query);
190        while ($data = $statement->fetch(\PDO::FETCH_ASSOC)) {
191            $dataEntity = clone $entity;
192            $dataEntity->exchangeArray($query->postProcessJoins($data));
193            $dataEntity->setResolveLevel($query->getResolveLevel());
194            $resultList[] = $dataEntity;
195        }
196        $statement->closeCursor();
197        return $resultList;
198    }
206    public function writeItem(Query\Base $query)
207    {
208        return static::pdoExceptionHandler(function () use ($query) {
209            $this->getWriter(); //Switch to writer for write/delete
210            $statement = $this->fetchPreparedStatement($query);
211            $status = $statement->execute($query->getParameters());
212            $statement->closeCursor();
213            return $status;
214        });
215    }
221    public function deleteItem(Query\Base $query)
222    {
223        return $this->writeItem($query);
224    }
226    public function perform(string $sql, array|null $parameters = null)
227    {
228        return static::pdoExceptionHandler(function () use ($sql, $parameters) {
229            $this->getWriter(); //Switch to writer for perform
230            $prepared = $this->fetchPreparedStatement($sql);
231            $status = $prepared->execute($parameters);
232            $prepared->closeCursor();
233            return $status;
234        });
235    }
237    public function fetchAffected(string $sql, array|null $parameters = null)
238    {
239        return static::pdoExceptionHandler(function () use ($sql, $parameters) {
240            $this->getWriter(); //Switch to writer for perform
241            $prepared = $this->fetchPreparedStatement($sql);
242            $prepared->execute($parameters);
243            $count = $prepared->rowCount();
244            $prepared->closeCursor();
245            return $count;
246        });
247    }
256    public function readResolvedReferences(\BO\Zmsentities\Schema\Entity $entity, int $resolveReferences)
257    {
258        return $entity;
259    }
268    public function hashStringValue(string $value, ?callable $callable = null): string
269    {
270        if ($callable === null) {
271            $callable = 'sha1';
272        }
273
274        if (is_callable($callable)) {
275            $hash = $callable($value);
276
277            if (is_string($callable)) {
278                return $callable . ':' . $hash;
279            }
280            if ($callable instanceof \Closure) {
281                return 'closure:' . $hash;
282            }
283            // else
284            return 'custom:' . $hash;
285        }
286
287        throw new \InvalidArgumentException('hashStringValue() should be called with a callable as second parameter.');
288    }