Lines 97.23% 176 / 181
Methods 96.15% 25 / 26
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readResolvedEntity 100.00% 12 / 12 100.00% 1 / 1 3
 readResolvedScopes 100.00% 8 / 8 100.00% 1 / 1 3
 readResolvedScopeReferences 100.00% 3 / 3 100.00% 1 / 1 2
 readResolvedRequests 100.00% 20 / 20 100.00% 1 / 1 6
 readResolvedClusters 100.00% 6 / 6 100.00% 1 / 1 2
 readResolvedProviders 100.00% 8 / 8 100.00% 1 / 1 2
 readResolvedDays 100.00% 7 / 7 100.00% 1 / 1 3
 [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
12class Calendar extends \BO\Zmsbackend\Base
13{
14    public function readResolvedEntity(
15        Entity $calendar,
16        \DateTimeInterface $now,
17        ?bool $resolveOnlyScopes = false,
18        string $slotType = 'public',
19        int|float $slotsRequired = 0,
20        bool $resolveScopeReferences = true
21    ) {
22        $calendar['freeProcesses'] = new \BO\Zmsentities\Collection\ProcessList();
23        $calendar['scopes'] = $calendar->getScopeList();
24        $calendar = $this->readResolvedScopes($calendar);
25        $calendar = $this->readResolvedProviders($calendar);
26        $calendar = $this->readResolvedClusters($calendar);
27        $calendar = $this->readResolvedRequests($calendar);
28        if ($resolveScopeReferences) {
29            $calendar = $this->readResolvedScopeReferences($calendar);
30        }
31        if (count($calendar->scopes) < 1) {
32            throw new \BO\Zmsbackend\Calendar\Exception\CalendarWithoutScopes("No scopes resolved in $calendar");
33        }
34        $calendar = $this->readResolvedDays($calendar, $resolveOnlyScopes, $now, $slotType, $slotsRequired);
35
36        return $calendar;
37    }
38
39    /**
40     * Resolve calendar scopes
41     */
42    protected function readResolvedScopes(Entity $calendar): Entity
43    {
44        $scopeList = new \BO\Zmsentities\Collection\ScopeList();
45        $scopeReader = new \BO\Zmsbackend\Scope\Service\Scope();
46        foreach ($calendar->scopes as $scope) {
47            $scope = $scopeReader->readEntity($scope['id'], 1);
48            if ($scope) {
49                $scopeList->addEntity($scope);
50            }
51        }
52        $calendar['scopes'] = $scopeList->withUniqueScopes();
53        return $calendar;
54    }
55
56    /**
57     * Resolve Reference dayoff for departments, but do not resolve circular scope->department->scopes
58     */
59    protected function readResolvedScopeReferences(Entity $calendar): Entity
60    {
61        foreach ($calendar->scopes as $scope) {
62            $scope['dayoff'] = (new \BO\Zmsbackend\Dayoff\Service\DayOff())->readByScopeId($scope['id']);
63        }
64        return $calendar;
65    }
66
67    protected function readResolvedRequests(Entity $calendar): Entity
68    {
69        $requestReader = new \BO\Zmsbackend\Request\Service\Request();
70        $requestRelationQuery = new \BO\Zmsbackend\RequestRelation\Service\RequestRelation();
71        $providerIds = [];
72        foreach ($calendar->providers as $provider) {
73            $providerIds[(string) $provider->getId()] = true;
74        }
75        foreach ($calendar['requests'] as $key => $request) {
76            $request = new \BO\Zmsentities\Request($request);
77            $request = $requestReader->readEntity($request->getSource(), $request->getId());
78            $calendar['requests'][$key] = $request;
79            $requestRelationList = $requestRelationQuery->readListByRequestId($request->getId(), $request->getSource());
80            foreach ($requestRelationList as $requestRelationItem) {
81                $providerId = (string) $requestRelationItem->getProvider()->getId();
82                if ($providerIds !== [] && !isset($providerIds[$providerId])) {
83                    continue;
84                }
85                // we do not check multipleSlotsEnabled here, because the availability might need this information
86                // so we calculate slots as if multipleSlotsEnabled is true
87                $calendar->scopes->addRequiredSlots(
88                    $requestRelationItem->getSource(),
89                    $requestRelationItem->getProvider()->getId(),
90                    $requestRelationItem->getSlotCount()
91                );
92            }
93        }
94        return $calendar;
95    }
96
97    protected function readResolvedClusters(Entity $calendar): Entity
98    {
99        $scopeReader = new \BO\Zmsbackend\Scope\Service\Scope();
100        foreach ($calendar['clusters'] as $cluster) {
101            $cluster = new \BO\Zmsentities\Cluster($cluster);
102            $scopeList = $scopeReader->readByClusterId($cluster->getId(), 1);
103            $calendar['scopes'] = $calendar['scopes']->addList($scopeList)->withUniqueScopes();
104        }
105        return $calendar;
106    }
107
108    protected function readResolvedProviders(Entity $calendar): Entity
109    {
110        $scopeReader = new \BO\Zmsbackend\Scope\Service\Scope();
111        $providerReader = new \BO\Zmsbackend\Provider\Service\Provider();
112        foreach ($calendar['providers'] as $key => $provider) {
113            $provider = new \BO\Zmsentities\Provider($provider);
114            $calendar['providers'][$key] = $providerReader->readEntity($provider->getSource(), $provider->getId());
115            $scopeList = $scopeReader->readByProviderId($provider->getId(), 1);
116            $calendar['scopes'] = $calendar['scopes']->addList($scopeList)->withUniqueScopes();
117        }
118        return $calendar;
119    }
120
121    protected function readResolvedDays(
122        Entity $calendar,
123        ?bool $resolveOnlyScopes,
124        \DateTimeInterface $now,
125        $slotType,
126        int|float $slotsRequiredForce
127    ): Entity {
128        if (!$resolveOnlyScopes) {
129            $dayQuery = new \BO\Zmsbackend\Day\Service\Day();
130            $dayList = $dayQuery->readByCalendar($calendar, $slotsRequiredForce);
131            $calendar->days = $dayList->setStatusByType($slotType, $now);
132            $bookableEndString = $this->getReader()->fetchValue(\BO\Zmsbackend\Calendar\Repository\Calendar::QUERY_CALENDAR_BOOKABLEEND);
133            $calendar->bookableEnd = (new \DateTimeImmutable($bookableEndString === null ? '' : $bookableEndString, $now->getTimezone()))->getTimestamp();
134        }
135        return $calendar;
136    }
137}

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    }