Lines 97.09% 167 / 172
Methods 96.15% 25 / 26
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readEntity 100.00% 10 / 10 100.00% 1 / 1 5
 updateEntity 100.00% 22 / 22 100.00% 1 / 1 9
 readProperty 100.00% 4 / 4 100.00% 1 / 1 2
 replaceProperty 100.00% 6 / 6 100.00% 1 / 1 3
 deleteProperty 100.00% 5 / 5 100.00% 1 / 1 3
 fetchData 100.00% 5 / 5 100.00% 1 / 1 2
 getSpecifiedValue 100.00% 3 / 3 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
8class Config extends \BO\Zmsbackend\Base
9{
10    /**
11     *
12     * @return \BO\Zmsentities\Config
13     */
14    public function readEntity(bool $disableCache = false)
15    {
16        $cacheKey = "config";
17
18        if (!$disableCache && App::$cache) {
19            $cached = App::$cache->get($cacheKey);
20            if ($cached instanceof Entity) {
21                return $cached;
22            }
23        }
24
25        $query = \BO\Zmsbackend\Config\Repository\Config::QUERY_SELECT;
26        $config = $this->fetchData($query);
27
28        if (App::$cache) {
29            App::$cache->set($cacheKey, $config);
30        }
31
32        return $config;
33    }
34
35    public function updateEntity(Entity $config): Entity|null
36    {
37        $compareEntity = $this->readEntity(true);
38        $result = false;
39        $query = new \BO\Zmsbackend\Config\Repository\Config(\BO\Zmsbackend\Query\Base::REPLACE);
40        foreach ($config as $key => $item) {
41            if (is_array($item)) {
42                foreach ($item as $itemName => $itemValue) {
43                    if ($itemValue && $compareEntity->getPreference($key, $itemName) != $itemValue) {
44                        $query->addValues(array(
45                            'name' => $key . '__' . $itemName,
46                            'value' => $this->getSpecifiedValue($itemValue),
47                            'changeTimestamp' => (new \DateTimeImmutable())->format('Y-m-d H:i:s')
48                        ));
49                        $result = $this->writeItem($query);
50                    }
51                }
52            } else {
53                $query->addValues(array(
54                    'name' => $key,
55                    'value' => $this->getSpecifiedValue($item),
56                    'changeTimestamp' => (new \DateTimeImmutable())->format('Y-m-d H:i:s')
57                ));
58                $result = $this->writeItem($query);
59            }
60        }
61
62        if (App::$cache && App::$cache->has('config')) {
63            App::$cache->delete('config');
64        }
65
66        return ($result) ? $this->readEntity(true) : null;
67    }
68
69    public function readProperty(string $property, bool $forUpdate = false)
70    {
71        $sql = \BO\Zmsbackend\Config\Repository\Config::QUERY_SELECT_PROPERTY;
72        if ($forUpdate) {
73            $sql .= " FOR UPDATE";
74        }
75        return $this->fetchValue($sql, [$property]);
76    }
77
78    public function replaceProperty(string $property, string $value)
79    {
80        if (App::$cache && App::$cache->has('config')) {
81            App::$cache->delete('config');
82        }
83
84        return $this->perform(\BO\Zmsbackend\Config\Repository\Config::QUERY_REPLACE_PROPERTY, [
85            'property' => $property,
86            'value' => $value,
87        ]);
88    }
89
90    /**
91     * remove config data
92     *
93     *
94     * @return Entity|null
95     */
96    public function deleteProperty($property)
97    {
98        $query = new \BO\Zmsbackend\Config\Repository\Config(\BO\Zmsbackend\Query\Base::DELETE);
99        $query->addConditionName($property);
100
101        if (App::$cache && App::$cache->has('config')) {
102            App::$cache->delete('config');
103        }
104
105        return $this->deleteItem($query);
106    }
107
108    protected function fetchData(string $querySql): Entity
109    {
110        $splittedHash = array();
111        $dataList = $this->getReader()->fetchAll($querySql);
112        foreach ($dataList as $data) {
113            $splittedHash[$data['name']] = $data['value'];
114        }
115        return new Entity($splittedHash);
116    }
117
118    protected function getSpecifiedValue($value): int|string
119    {
120        if (is_bool($value)) {
121            return ($value) ? 1 : 0;
122        }
123        return trim($value);
124    }
125}

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    }