Lines 95.54% 193 / 202
Methods 93.10% 27 / 29
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readByDepartmentId 100.00% 1 / 1 100.00% 1 / 1 1
 readOnlyByDepartmentId 100.00% 1 / 1 100.00% 1 / 1 1
 readCommon 100.00% 17 / 17 100.00% 1 / 1 8
 readByScopeId 100.00% 1 / 1 100.00% 1 / 1 1
 readByYear 100.00% 11 / 11 100.00% 1 / 1 4
 readCommonByYear 100.00% 12 / 12 100.00% 1 / 1 4
 writeCommonDayoffsByYear 100.00% 19 / 19 100.00% 1 / 1 5
 deleteByTimeInterval 100.00% 15 / 15 100.00% 1 / 1 2
 deleteEntity 0.00% 0 / 4 0.00% 0 / 1 2
 removeCache 100.00% 4 / 4 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
9class DayOff extends \BO\Zmsbackend\Base
10{
11    /**
12     * common DayOff like Xmas...
13     *
14     */
15    public static $commonList = null;
16
17    /**
18     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
19     */
20    public function readByDepartmentId($departmentId = 0)
21    {
22        return $this->readCommon();
23    }
24
25    /**
26     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
27     */
28    public function readOnlyByDepartmentId($departmentId = 0, bool $disableCache = false)
29    {
30        return new Collection();
31    }
32
33    public function readCommon(bool $disableCache = false)
34    {
35        $cacheKey = "dayOffs";
36
37        if (!$disableCache && App::$cache) {
38            $data = App::$cache->get($cacheKey);
39            if (!empty($data)) {
40                return $data;
41            }
42        }
43
44        $dayOffList = new Collection();
45        $query = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::SELECT);
46        $query->addEntityMapping()
47            ->addConditionCommon();
48        $result = $this->fetchList($query, new Entity());
49        if (count($result)) {
50            foreach ($result as $entity) {
51                if ($entity instanceof Entity) {
52                    $dayOffList->addEntity($entity);
53                }
54            }
55        }
56
57        if (App::$cache) {
58            App::$cache->set($cacheKey, $dayOffList);
59        }
60
61        return $dayOffList;
62    }
63
64   /**
65 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
66 */
67    public function readByScopeId($scopeId = 0, bool $disableCache = false)
68    {
69        return $this->readCommon();
70    }
71
72    public function readByYear(int $year): Collection
73    {
74        $dayOffList = new Collection();
75        $query = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::SELECT);
76        $query
77            ->addEntityMapping()
78            ->addConditionYear($year);
79        $result = $this->fetchList($query, new Entity());
80        if (count($result)) {
81            foreach ($result as $entity) {
82                if ($entity instanceof Entity) {
83                    $dayOffList->addEntity($entity);
84                }
85            }
86        }
87        return $dayOffList;
88    }
89
90    public function readCommonByYear(int $year): Collection
91    {
92        $dayOffList = new Collection();
93        $query = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::SELECT);
94        $query
95            ->addEntityMapping()
96            ->addConditionCommon()
97            ->addConditionYear($year);
98        $result = $this->fetchList($query, new Entity());
99        if (count($result)) {
100            foreach ($result as $entity) {
101                if ($entity instanceof Entity) {
102                    $dayOffList->addEntity($entity);
103                }
104            }
105        }
106        return $dayOffList;
107    }
108
109    /**
110     * create dayoff preferences of a department
111     *
112     * @param
113     *            dayoffList,
114     *            year,
115     *            drop
116     *
117     * @return \BO\Zmsentities\Collection\DayoffList
118     */
119    public function writeCommonDayoffsByYear($dayoffList, ?int $year = null, bool $drop = true)
120    {
121        if ($drop && $year) {
122            static::$commonList = null;
123            $deleteQuery = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::DELETE);
124            $deleteQuery
125                ->addConditionYear($year)
126                ->addConditionCommon();
127            $this->deleteItem($deleteQuery);
128        }
129        $query = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::INSERT);
130        foreach ($dayoffList as $dayoff) {
131            $query->addValues(
132                [
133                    'behoerdenid' => 0, //all departments
134                    'Feiertag' => $dayoff['name'],
135                    'Datum' => (new \DateTimeImmutable())->setTimestamp($dayoff['date'])->format('Y-m-d')
136                ]
137            );
138            $this->writeItem($query);
139        }
140
141        $this->removeCache();
142
143        return ($year) ? $this->readCommonByYear($year) : $dayoffList;
144    }
145
146    /**
147     * delete dayoff preferences by time interval
148     *
149     * @param
150     *            deleteInSeconds
151     *
152     * @return boolean
153     */
154    public function deleteByTimeInterval(int $deleteInSeconds)
155    {
156        $selectQuery = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::SELECT);
157        $selectQuery
158            ->addEntityMapping()
159            ->addConditionDayoffDeleteInterval($deleteInSeconds);
160        $statement = $this->fetchStatement($selectQuery);
161        while ($dayoffData = $statement->fetch(\PDO::FETCH_ASSOC)) {
162            $dayoffData = (new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::SELECT))->postProcess($dayoffData);
163            $entity = new Entity($dayoffData);
164            $deleteQuery = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::DELETE);
165            $date = (new \DateTimeImmutable())->setTimestamp($entity->date)->format('Y-m-d');
166            $deleteQuery
167                ->addConditionDate($date)
168                ->addConditionName($entity->name);
169            $this->deleteItem($deleteQuery);
170        }
171
172        $this->removeCache();
173    }
174
175    public function deleteEntity($itemId): bool
176    {
177        $query = new \BO\Zmsbackend\Dayoff\Repository\DayOff(\BO\Zmsbackend\Query\Base::DELETE);
178        $query->addConditionDayOffId($itemId);
179
180        $this->removeCache();
181
182        return ($this->deleteItem($query));
183    }
184
185    /**
186     * @return void
187     */
188    public function removeCache()
189    {
190        if (!App::$cache) {
191            return;
192        }
193
194        if (App::$cache->has("dayOffs")) {
195            App::$cache->delete("dayOffs");
196        }
197    }
198}

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    }