Lines 92.78% 180 / 194
Methods 85.18% 23 / 27
Classes 0.00% 0 / 1
Name Lines Methods CRAP
 readEntity 86.66% 13 / 15 0.00% 0 / 1 7.12
 readList 100.00% 11 / 11 100.00% 1 / 1 4
 readResolvedReferences 100.00% 14 / 14 100.00% 1 / 1 2
 writeEntity 94.11% 16 / 17 0.00% 0 / 1 4.00
 writeInsertRelations 100.00% 3 / 3 100.00% 1 / 1 1
 writeDeleteBySource 100.00% 6 / 6 100.00% 1 / 1 2
 writeDeleteRelations 100.00% 3 / 3 100.00% 1 / 1 1
 removeCache 25.00% 2 / 8 0.00% 0 / 1 15.55
 [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] hashStringValue 50.00% 5 / 10 0.00% 0 / 1 8.12
18class Source extends \BO\Zmsbackend\Base
19{
20    /**
21     * Fetch source from db
22     *
23     * @return \BO\Zmsentities\Source
24     */
25    public function readEntity($sourceName, int $resolveReferences = 0, bool $disableCache = false)
26    {
27        $cacheKey = "source-$sourceName-$resolveReferences";
28
29        if (!$disableCache && App::$cache && App::$cache->has($cacheKey)) {
30            $entity = App::$cache->get($cacheKey);
31        }
32
33        if (empty($entity)) {
34            $query = new \BO\Zmsbackend\Source\Repository\Source(\BO\Zmsbackend\Query\Base::SELECT);
35            $query
36                ->addEntityMapping()
37                ->addResolvedReferences($resolveReferences)
38                ->addConditionSource($sourceName);
39            $entity = $this->fetchOne($query, new Entity());
40            if (! $entity->hasId()) {
41                return null;
42            }
43
44            if (App::$cache) {
45                App::$cache->set($cacheKey, $entity);
46            }
47        }
48
49        return $this->readResolvedReferences($entity, $resolveReferences, $disableCache);
50    }
51
52    /**
53     * read a list of sources
54     *
55     * @return \BO\Zmsentities\Collection\SourceList
56     */
57    public function readList(int $resolveReferences = 0)
58    {
59        $collection = new Collection();
60        $query = new \BO\Zmsbackend\Source\Repository\Source(\BO\Zmsbackend\Query\Base::SELECT);
61        $query->addEntityMapping()
62            ->addResolvedReferences($resolveReferences);
63        $result = $this->fetchList($query, new Entity());
64        if (count($result)) {
65            foreach ($result as $entity) {
66                if ($entity instanceof Entity) {
67                    $entity = $this->readResolvedReferences($entity, $resolveReferences);
68                    $collection->addEntity($entity);
69                }
70            }
71        }
72        return $collection;
73    }
74
75    /**
76     * resolve entity references
77     *
78     * @return \BO\Zmsentities\Source
79     */
80    #[\Override]
81    public function readResolvedReferences(
82        \BO\Zmsentities\Schema\Entity $entity,
83        int $resolveReferences,
84        bool $disableCache = false
85    ) {
86        if (0 < $resolveReferences) {
87            $entity['providers'] = (new ProviderList())
88                ->addList((new \BO\Zmsbackend\Provider\Service\Provider())->readListBySource($entity->source, $resolveReferences - 1));
89            $entity['requests'] = (new RequestList())
90                ->addList((new \BO\Zmsbackend\Request\Service\Request())->readListBySource(
91                    $entity->source,
92                    $resolveReferences - 1,
93                    $disableCache
94                ));
95            $entity['requestrelation'] = (new RequestRelationList())
96                ->addList((new \BO\Zmsbackend\RequestRelation\Service\RequestRelation())->readListBySource($entity->source));
97            $entity['scopes'] = (new ScopeList())
98                ->addList((new \BO\Zmsbackend\Scope\Service\Scope())->readList($resolveReferences - 1, $disableCache));
99        }
100
101        return $entity;
102    }
103
104    /**
105     * write or update a source
106     *
107     * @return \BO\Zmsentities\Source
108     */
109    public function writeEntity(Entity $entity, int $resolveReferences = 0)
110    {
111        if (! $entity->isCompleteAndEditable()) {
112            throw new \BO\Zmsbackend\Source\Exception\SourceInvalidInput();
113        }
114        $this->writeDeleteBySource($entity->getSource());
115        $query = new \BO\Zmsbackend\Source\Repository\Source(\BO\Zmsbackend\Query\Base::INSERT);
116        $query->addValues(
117            array(
118                'source' => $entity->getSource(),
119                'label' => $entity->getLabel(),
120                'editable' => ($entity->isEditable()) ? 1 : 0,
121                'contact__name' => $entity->contact['name'],
122                'contact__email' => $entity->contact['email']
123            )
124        );
125        if ($this->writeItem($query)) {
126            $this->writeInsertRelations($entity);
127        }
128
129        $this->removeCache($entity->getSource());
130
131        return $this->readEntity($entity->getSource(), $resolveReferences, true);
132    }
133
134    /**
135     * delete provider and request relations of source
136     */
137    public function writeInsertRelations(\BO\Zmsentities\Source $entity): void
138    {
139        (new \BO\Zmsbackend\Provider\Service\Provider())->writeListBySource($entity);
140        (new \BO\Zmsbackend\Request\Service\Request())->writeListBySource($entity);
141        (new \BO\Zmsbackend\RequestRelation\Service\RequestRelation())->writeListBySource($entity);
142    }
143
144    /**
145     * delete by sourcename
146     *
147     * @return \BO\Zmsentities\Source
148     */
149    public function writeDeleteBySource($sourceName)
150    {
151        $entity = $this->readEntity($sourceName);
152        $query = new \BO\Zmsbackend\Source\Repository\Source(\BO\Zmsbackend\Query\Base::DELETE);
153        $query->addConditionSource($sourceName);
154        $this->writeDeleteRelations($sourceName);
155
156        $this->removeCache($sourceName);
157
158        return ($this->deleteItem($query)) ? $entity : null;
159    }
160
161    /**
162     * delete provider and request relations of source
163     */
164    public function writeDeleteRelations($sourceName): void
165    {
166        (new \BO\Zmsbackend\Provider\Service\Provider())->writeDeleteListBySource($sourceName);
167        (new \BO\Zmsbackend\Request\Service\Request())->writeDeleteListBySource($sourceName);
168        (new \BO\Zmsbackend\RequestRelation\Service\RequestRelation())->writeDeleteListBySource($sourceName);
169    }
170
171    /**
172     * @return void
173     */
174    public function removeCache($sourceName)
175    {
176        if (!App::$cache) {
177            return;
178        }
179
180        if (App::$cache->has("source-$sourceName-0")) {
181            App::$cache->delete("source-$sourceName-0");
182        }
183
184        if (App::$cache->has("source-$sourceName-1")) {
185            App::$cache->delete("source-$sourceName-1");
186        }
187
188        if (App::$cache->has("source-$sourceName-2")) {
189            App::$cache->delete("source-$sourceName-2");
190        }
191    }
192}

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    }
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    }