MongoDB::update() - Code Metrics - alkemann/h2l - Measure and Improve Code Quality continuously with Scrutinizer

MongoDB::update() A
last analyzed 2022-04-08 19:01 UTC

↳ Parent: MongoDB

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	4
dl	0
loc	9
rs	10
c	0
b	0
f	0

<?php

namespace alkemann\h2l\data;

use alkemann\h2l\exceptions\ConnectionError;
use alkemann\h2l\interfaces\Source;
use alkemann\h2l\Log;
use Exception;
use Generator;
use MongoDB\BSON\ObjectId;
use MongoDB\Client;
use MongoDB\Collection;
use MongoDB\Driver\Exception\RuntimeException;
use MongoDB\Model\BSONDocument;

/**
 * Class MongoDb
 *
 * @package alkemann\h2l\data
 */
class MongoDB implements Source
{
    /**
     * @var string[]
     */
    public static array $operators = [
        '$all',
        '$gt',
        '$gte',
        '$in',
        '$lt',
        '$lte',
        '$ne',
        '$nin',
        '$or',
        '$and',
        '$not',
        '$nor',
        '$exists',
        '$mod',
        'type',
        '$elemMatch',
        '$size'
    ];

    /** @var array<string, mixed> */
    protected array $config = [];
    /** @var null|Client */
    protected $client = null;

    /**
     * @param array $config
     */
    public function __construct(array $config = [])
    {
        $defaults = [
            'host' => 'localhost',
            'port' => 27017,
            'db' => 'default',
            'check_connections' => false,
        ];
        $this->config = $config + $defaults;
    }

    /**
     * @param string $collection
     * @return Collection
     * @throws ConnectionError un unable to connect
     */
    private function collection(string $collection): Collection
    {
        $db = $this->config['db'];
        if ($this->client == null) {
            $host = $this->config['host'];
            $port = $this->config['port'];
            $options = $this->config;
            unset($options['host']);
            unset($options['port']);
            unset($options['db']);
            try {
                $this->client = new Client("mongodb://{$host}:{$port}/{$db}", $options);
                if ($this->config['check_connections'] === true) {
                    $this->client->selectDatabase($this->config['db'])->listCollections();
                }
            } catch (RuntimeException $e) {
                throw new ConnectionError("Unable to connect to {$host}:{$port} : " . $e->getMessage());
            }
        }
        return $this->client->selectCollection($db, $collection);
    }

    /**
     * @param string $id
     * @return ObjectId
     */
    public static function id(string $id): ObjectId
    {
        return new ObjectId($id);
    }

    /**
     * @param mixed $query
     * @param array $params
     * @throws Exception if called as not implemented
     */
    public function query($query, array $params = []): void
    {
        throw new Exception("Query method is not implemented for MongDB");
    }

    /**
     * @param string $collection_name
     * @param array $conditions
     * @param array $options
     * @return array|null
     */
    public function one(string $collection_name, array $conditions, array $options = []): ?array
    {
        $collection = $this->collection($collection_name);
        $conditions = $this->idReplaceConditions($conditions);
        $result = $collection->findOne($conditions, $options);
        if ($result === null) {
            return null;
        }
        return $result instanceof BSONDocument ? $this->out($result) : (array) $result;
    }

    /**
     * @param array $conditions
     * @return array
     */
    private function idReplaceConditions(array $conditions): array
    {
        if (array_key_exists('id', $conditions)) {
            $id = new ObjectId($conditions['id']);
            unset($conditions['id']);
            $conditions['_id'] = $id;
        }
        return $conditions;
    }

    /**
     * @TODO keep the BSON object?
     * @param array|BSONDocument $document
     * @return array
     */
    private function out(array|BSONDocument $document): array
    {
        if (is_array($document)) {

            if (isset($document['_id'])) {
                $document['id'] = $document['_id'];
                unset($document['_id']);
            }
            return $document;
        }
        $a = $document->getArrayCopy();
        if (isset($document->_id)) {
            $a['id'] = "{$document->_id}";
            unset($a['_id']);
        }
        return $a;
    }

    /**
     * @param string $collection_name
     * @param array $conditions
     * @param array $options
     * @return Generator
     */
    public function find(string $collection_name, array $conditions, array $options = []): Generator
    {
        $collection = $this->collection($collection_name);
        $conditions = $this->idReplaceConditions($conditions);
        $cursor = $collection->find($conditions, $options);
        foreach ($cursor as $document) {
            yield $this->out($document);
        }
    }

    /**
     * @param string $collection_name
     * @param array $conditions
     * @param array $data
     * @param array $options
     * @return int
     */
    public function update(string $collection_name, array $conditions, array $data, array $options = []): int
    {
        $collection = $this->collection($collection_name);
        $result = $collection->updateMany($conditions, $data, $options);
        if ($result->isAcknowledged() === false) {
            // Throw exception or error?
            return 0;
        }
        return $result->getModifiedCount() ?? 0;
    }

    /**
     * @param string $collection_name
     * @param array $data
     * @param array $options
     * @return null|ObjectId
     */
    public function insert(string $collection_name, array $data, array $options = []): ?ObjectId
    {
        $collection_name = $this->collection($collection_name);
        $result = $collection_name->insertOne($data, $options);
        if ($result->isAcknowledged() === false) {
            // Throw exception or error?
            return null;
        }
        if ($result->getInsertedCount() != 1) {
            Log::error("Failed to insert!");
            return null;
        }
        $id = $result->getInsertedId();
        return $id instanceof ObjectId ? $id : null;
    }

    /**
     * @param string $collection_name
     * @param array $conditions
     * @param array $options
     * @return int
     */
    public function delete(string $collection_name, array $conditions, array $options = []): int
    {
        $collection_name = $this->collection($collection_name);
        $result = $collection_name->deleteMany($conditions, $options);
        if ($result->isAcknowledged() === false) {
            // Throw exception or error?
            return 0;
        }
        return $result->getDeletedCount();
    }
}


1			<?php
2
3			namespace alkemann\h2l\data;
4
5			use alkemann\h2l\exceptions\ConnectionError;
6			use alkemann\h2l\interfaces\Source;
7			use alkemann\h2l\Log;
8			use Exception;
9			use Generator;
10			use MongoDB\BSON\ObjectId;
11			use MongoDB\Client;
12			use MongoDB\Collection;
13			use MongoDB\Driver\Exception\RuntimeException;
14			use MongoDB\Model\BSONDocument;
15
16			/**
17			* Class MongoDb
18			*
19			* @package alkemann\h2l\data
20			*/
21			class MongoDB implements Source
22			{
23			/**
24			* @var string[]
25			*/
26			public static array $operators = [
27			'$all',
28			'$gt',
29			'$gte',
30			'$in',
31			'$lt',
32			'$lte',
33			'$ne',
34			'$nin',
35			'$or',
36			'$and',
37			'$not',
38			'$nor',
39			'$exists',
40			'$mod',
41			'type',
42			'$elemMatch',
43			'$size'
44			];
45
46			/** @var array<string, mixed> */
47			protected array $config = [];
48			/** @var null\|Client */
49			protected $client = null;
50
51			/**
52			* @param array $config
53			*/
54			public function __construct(array $config = [])
55			{
56			$defaults = [
57			'host' => 'localhost',
58			'port' => 27017,
59			'db' => 'default',
60			'check_connections' => false,
61			];
62			$this->config = $config + $defaults;
63			}
64
65			/**
66			* @param string $collection
67			* @return Collection
68			* @throws ConnectionError un unable to connect
69			*/
70			private function collection(string $collection): Collection
71			{
72			$db = $this->config['db'];
73			if ($this->client == null) {
74			$host = $this->config['host'];
75			$port = $this->config['port'];
76			$options = $this->config;
77			unset($options['host']);
78			unset($options['port']);
79			unset($options['db']);
80			try {
81			$this->client = new Client("mongodb://{$host}:{$port}/{$db}", $options);
82			if ($this->config['check_connections'] === true) {
83			$this->client->selectDatabase($this->config['db'])->listCollections();
84			}
85			} catch (RuntimeException $e) {
86			throw new ConnectionError("Unable to connect to {$host}:{$port} : " . $e->getMessage());
87			}
88			}
89			return $this->client->selectCollection($db, $collection);
90			}
91
92			/**
93			* @param string $id
94			* @return ObjectId
95			*/
96			public static function id(string $id): ObjectId
97			{
98			return new ObjectId($id);
99			}
100
101			/**
102			* @param mixed $query
103			* @param array $params
104			* @throws Exception if called as not implemented
105			*/
106			public function query($query, array $params = []): void
107			{
108			throw new Exception("Query method is not implemented for MongDB");
109			}
110
111			/**
112			* @param string $collection_name
113			* @param array $conditions
114			* @param array $options
115			* @return array\|null
116			*/
117			public function one(string $collection_name, array $conditions, array $options = []): ?array
118			{
119			$collection = $this->collection($collection_name);
120			$conditions = $this->idReplaceConditions($conditions);
121			$result = $collection->findOne($conditions, $options);
122			if ($result === null) {
123			return null;
124			}
125			return $result instanceof BSONDocument ? $this->out($result) : (array) $result;
126			}
127
128			/**
129			* @param array $conditions
130			* @return array
131			*/
132			private function idReplaceConditions(array $conditions): array
133			{
134			if (array_key_exists('id', $conditions)) {
135			$id = new ObjectId($conditions['id']);
136			unset($conditions['id']);
137			$conditions['_id'] = $id;
138			}
139			return $conditions;
140			}
141
142			/**
143			* @TODO keep the BSON object?
144			* @param array\|BSONDocument $document
145			* @return array
146			*/
147			private function out(array\|BSONDocument $document): array
148			{
149			if (is_array($document)) {
			0 ignored issues – show introduced 2022-04-08 19:01 UTC by Report Bug Copy Issue Report The condition `is_array($document)` is always `true`. Loading history...
150			if (isset($document['_id'])) {
151			$document['id'] = $document['_id'];
152			unset($document['_id']);
153			}
154			return $document;
155			}
156			$a = $document->getArrayCopy();
157			if (isset($document->_id)) {
158			$a['id'] = "{$document->_id}";
159			unset($a['_id']);
160			}
161			return $a;
162			}
163
164			/**
165			* @param string $collection_name
166			* @param array $conditions
167			* @param array $options
168			* @return Generator
169			*/
170			public function find(string $collection_name, array $conditions, array $options = []): Generator
171			{
172			$collection = $this->collection($collection_name);
173			$conditions = $this->idReplaceConditions($conditions);
174			$cursor = $collection->find($conditions, $options);
175			foreach ($cursor as $document) {
176			yield $this->out($document);
177			}
178			}
179
180			/**
181			* @param string $collection_name
182			* @param array $conditions
183			* @param array $data
184			* @param array $options
185			* @return int
186			*/
187			public function update(string $collection_name, array $conditions, array $data, array $options = []): int
188			{
189			$collection = $this->collection($collection_name);
190			$result = $collection->updateMany($conditions, $data, $options);
191			if ($result->isAcknowledged() === false) {
192			// Throw exception or error?
193			return 0;
194			}
195			return $result->getModifiedCount() ?? 0;
196			}
197
198			/**
199			* @param string $collection_name
200			* @param array $data
201			* @param array $options
202			* @return null\|ObjectId
203			*/
204			public function insert(string $collection_name, array $data, array $options = []): ?ObjectId
205			{
206			$collection_name = $this->collection($collection_name);
207			$result = $collection_name->insertOne($data, $options);
208			if ($result->isAcknowledged() === false) {
209			// Throw exception or error?
210			return null;
211			}
212			if ($result->getInsertedCount() != 1) {
213			Log::error("Failed to insert!");
214			return null;
215			}
216			$id = $result->getInsertedId();
217			return $id instanceof ObjectId ? $id : null;
218			}
219
220			/**
221			* @param string $collection_name
222			* @param array $conditions
223			* @param array $options
224			* @return int
225			*/
226			public function delete(string $collection_name, array $conditions, array $options = []): int
227			{
228			$collection_name = $this->collection($collection_name);
229			$result = $collection_name->deleteMany($conditions, $options);
230			if ($result->isAcknowledged() === false) {
231			// Throw exception or error?
232			return 0;
233			}
234			return $result->getDeletedCount();
235			}
236			}
237

alkemann / h2l

MongoDB::update() A last analyzed 2022-04-08 19:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MongoDB::update() A
last analyzed 2022-04-08 19:01 UTC