Database::getName() - Code Metrics - Baachi/CouchDB - Measure and Improve Code Quality continuously with Scrutinizer

Database::getName() A
last analyzed 2018-04-16 06:27 UTC

↳ Parent: Database

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	1
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace CouchDB;

use CouchDB\Encoder\JSONEncoder;
use CouchDB\Exception\Exception;
use GuzzleHttp\ClientInterface;

/**
 * @author Markus Bachmann <[email protected]>
 */
class Database
{
    /**
     * @var Connection
     */
    private $conn;

    /**
     * @var string
     */
    private $name;

    /**
     * @var ClientInterface
     */
    private $client;

    /**
     * @param string          $name   The database name.
     * @param Connection      $conn   The current connection.
     * @param ClientInterface $client The client
     */
    public function __construct($name, Connection $conn, ClientInterface $client)
    {
        $this->conn = $conn;
        $this->name = $name;
        $this->client = $client;
    }

    /**
     * Gets the current connection.
     *
     * @return Connection
     */
    public function getConnection()
    {
        return $this->conn;
    }

    /**
     * Find a document by a id.
     *
     * @param string $id
     *
     * @throws Exception If the document doesn't exists.
     *
     * @return mixed
     */
    public function find($id)
    {
        $response = $this->client->request('GET', sprintf('/%s/%s', $this->name, $id));
        $json = (string) $response->getBody();

        if (404 === $response->getStatusCode()) {
            throw new Exception('Document does not exist');
        }

        return JSONEncoder::decode($json);
    }

    /**
     * Find all documents from the database.
     *
     * @param int|null    $limit
     * @param string|null $startKey
     *
     * @return mixed
     */
    public function findAll($limit = null, $startKey = null)
    {
        $path = "/{$this->name}/_all_docs?include_docs=true";

        if (null !== $limit) {
            $path .= '&limit='.(integer) $limit;
        }
        if (null !== $startKey) {
            $path .= '&startkey='.(string) $startKey;
        }

        $json = (string) $this->client->request('GET', $path)->getBody();
        $docs = JSONEncoder::decode($json);

        return $docs;
    }

    /**
     * Find a documents by a id.
     *
     * @param array    $ids
     * @param null|int $limit
     * @param null|int $offset
     *
     * @return array|null
     */
    public function findDocuments(array $ids, $limit = null, $offset = null)
    {
        $path = "/{$this->name}/_all_docs?include_docs=true";

        if (null !== $limit) {
            $path .= '&limit='.(integer) $limit;
        }
        if (null !== $offset) {
            $path .= '&skip='.(integer) $offset;
        }

        $response = $this->client->request('POST', $path, [
            'body'    => JSONEncoder::encode(['keys' => $ids]),
            'headers' => ['Content-Type'             => 'application/json'],
        ]);

        return JSONEncoder::decode((string) $response->getBody());
    }

    /**
     * Insert a new document.
     *
     * @param array $doc
     *
     * @deprecated To update a document use Database::update, it will be removed in version 2
     *
     * @throws Exception
     */
    public function insert(array &$doc)
    {
        if (isset($doc['_id'])) {
            $clone = $doc;
            unset($clone['_id']);

            $response = $this->client->request('PUT', "/{$this->name}/{$doc['_id']}", [
                'body'    => JSONEncoder::encode($clone),
                'headers' => ['Content-Type' => 'application/json'],
            ]);
        } else {
            $response = $this->client->request('POST', "/{$this->name}/", [
                'body'    => JSONEncoder::encode($doc),
                'headers' => ['Content-Type' => 'application/json'],
            ]);
        }

        if (201 !== $response->getStatusCode()) {
            throw new Exception('Unable to save document');
        }

        $value = JSONEncoder::decode((string) $response->getBody());

        $doc['_id'] = $value['id'];
        $doc['_rev'] = $value['rev'];
    }

    /**
     * Updates a document.
     *
     * @param string $id  The id from the document
     * @param array  $doc A reference from the document
     *
     * @throws Exception
     */
    public function update($id, array &$doc)
    {
        $json = JSONEncoder::encode($doc);

        $response = $this->client->request('PUT', "/{$this->name}/{$id}", [
            'body'    => $json,
            'headers' => ['Content-Type' => 'application/json'],
        ]);

        if (201 !== $response->getStatusCode()) {
            throw new Exception('Unable to save document');
        }

        $value = JSONEncoder::decode((string) $response->getBody());

        $doc['_id'] = $value['id'];
        $doc['_rev'] = $value['rev'];
    }

    /**
     * Deletes a document.
     *
     * @param string $id
     * @param string $rev
     *
     * @throws \RuntimeException
     *
     * @return bool
     */
    public function delete($id, $rev)
    {
        $response = $this->client->request('DELETE', "/{$this->name}/{$id}?rev={$rev}");

        if (200 !== $response->getStatusCode()) {
            throw new Exception(sprintf('Unable to delete %s', $id));
        }

        return true;
    }

    /**
     * Creates a batch updater.
     *
     * @return Util\BatchUpdater
     */
    public function createBatchUpdater()
    {
        return new Util\BatchUpdater($this->client, $this);
    }

    /**
     * Return the database informations.
     *
     * @return array
     */
    public function getInfo()
    {
        $json = (string) $this->client->request('GET', "/{$this->name}/")->getBody();

        return JSONEncoder::decode($json);
    }

    /**
     * Return informations about the last changes from the database.
     *
     * @throws \RuntimeException If the request was not successfull
     *
     * @return array
     */
    public function getChanges()
    {
        $response = $this->client->request('GET', "/{$this->name}/_changes");

        if (200 !== $response->getStatusCode()) {
            throw new Exception('Request wasn\'t successfull');
        }

        return JSONEncoder::decode((string) $response->getBody());
    }

    /**
     * Return the database name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }
}


1			<?php
2
3			namespace CouchDB;
4
5			use CouchDB\Encoder\JSONEncoder;
6			use CouchDB\Exception\Exception;
7			use GuzzleHttp\ClientInterface;
8
9			/**
10			* @author Markus Bachmann <[email protected]>
11			*/
12			class Database
13			{
14			/**
15			* @var Connection
16			*/
17			private $conn;
18
19			/**
20			* @var string
21			*/
22			private $name;
23
24			/**
25			* @var ClientInterface
26			*/
27			private $client;
28
29			/**
30			* @param string $name The database name.
31			* @param Connection $conn The current connection.
32			* @param ClientInterface $client The client
33			*/
34	19		public function __construct($name, Connection $conn, ClientInterface $client)
35			{
36	19		$this->conn = $conn;
37	19		$this->name = $name;
38	19		$this->client = $client;
39	19		}
40
41			/**
42			* Gets the current connection.
43			*
44			* @return Connection
45			*/
46	1		public function getConnection()
47			{
48	1		return $this->conn;
49			}
50
51			/**
52			* Find a document by a id.
53			*
54			* @param string $id
55			*
56			* @throws Exception If the document doesn't exists.
57			*
58			* @return mixed
59			*/
60	2	View Code Duplication	public function find($id)
61			{
62	2		$response = $this->client->request('GET', sprintf('/%s/%s', $this->name, $id));
63	2		$json = (string) $response->getBody();
64
65	2		if (404 === $response->getStatusCode()) {
66	1		throw new Exception('Document does not exist');
67			}
68
69	1		return JSONEncoder::decode($json);
70			}
71
72			/**
73			* Find all documents from the database.
74			*
75			* @param int\|null $limit
76			* @param string\|null $startKey
77			*
78			* @return mixed
79			*/
80	1		public function findAll($limit = null, $startKey = null)
81			{
82	1		$path = "/{$this->name}/_all_docs?include_docs=true";
83
84	1		if (null !== $limit) {
85	1		$path .= '&limit='.(integer) $limit;
86	1		}
87	1		if (null !== $startKey) {
88	1		$path .= '&startkey='.(string) $startKey;
89	1		}
90
91	1		$json = (string) $this->client->request('GET', $path)->getBody();
92	1		$docs = JSONEncoder::decode($json);
93
94	1		return $docs;
95			}
96
97			/**
98			* Find a documents by a id.
99			*
100			* @param array $ids
101			* @param null\|int $limit
102			* @param null\|int $offset
103			*
104			* @return array\|null
105			*/
106	1		public function findDocuments(array $ids, $limit = null, $offset = null)
107			{
108	1		$path = "/{$this->name}/_all_docs?include_docs=true";
109
110	1		if (null !== $limit) {
111	1		$path .= '&limit='.(integer) $limit;
112	1		}
113	1		if (null !== $offset) {
114	1		$path .= '&skip='.(integer) $offset;
115	1		}
116
117	1		$response = $this->client->request('POST', $path, [
118	1		'body' => JSONEncoder::encode(['keys' => $ids]),
119	1		'headers' => ['Content-Type' => 'application/json'],
120	1		]);
121
122	1		return JSONEncoder::decode((string) $response->getBody());
123			}
124
125			/**
126			* Insert a new document.
127			*
128			* @param array $doc
129			*
130			* @deprecated To update a document use Database::update, it will be removed in version 2
131			*
132			* @throws Exception
133			*/
134			public function insert(array &$doc)
135			{
136			if (isset($doc['_id'])) {
137			$clone = $doc;
138			unset($clone['_id']);
139
140			$response = $this->client->request('PUT', "/{$this->name}/{$doc['_id']}", [
141			'body' => JSONEncoder::encode($clone),
142			'headers' => ['Content-Type' => 'application/json'],
143			]);
144			} else {
145			$response = $this->client->request('POST', "/{$this->name}/", [
146			'body' => JSONEncoder::encode($doc),
147			'headers' => ['Content-Type' => 'application/json'],
148			]);
149			}
150
151			if (201 !== $response->getStatusCode()) {
152			throw new Exception('Unable to save document');
153			}
154
155			$value = JSONEncoder::decode((string) $response->getBody());
156
157			$doc['_id'] = $value['id'];
158			$doc['_rev'] = $value['rev'];
159			}
160
161			/**
162			* Updates a document.
163			*
164			* @param string $id The id from the document
165			* @param array $doc A reference from the document
166			*
167			* @throws Exception
168			*/
169	2		public function update($id, array &$doc)
170			{
171	2		$json = JSONEncoder::encode($doc);
172
173	2		$response = $this->client->request('PUT', "/{$this->name}/{$id}", [
174	2		'body' => $json,
175	2		'headers' => ['Content-Type' => 'application/json'],
176	2		]);
177
178	2		if (201 !== $response->getStatusCode()) {
179	1		throw new Exception('Unable to save document');
180			}
181
182	1		$value = JSONEncoder::decode((string) $response->getBody());
183
184	1		$doc['_id'] = $value['id'];
185	1		$doc['_rev'] = $value['rev'];
186	1		}
187
188			/**
189			* Deletes a document.
190			*
191			* @param string $id
192			* @param string $rev
193			*
194			* @throws \RuntimeException
195			*
196			* @return bool
197			*/
198	2	View Code Duplication	public function delete($id, $rev)
199			{
200	2		$response = $this->client->request('DELETE', "/{$this->name}/{$id}?rev={$rev}");
201
202	2		if (200 !== $response->getStatusCode()) {
203	1		throw new Exception(sprintf('Unable to delete %s', $id));
204			}
205
206	1		return true;
207			}
208
209			/**
210			* Creates a batch updater.
211			*
212			* @return Util\BatchUpdater
213			*/
214	1		public function createBatchUpdater()
215			{
216	1		return new Util\BatchUpdater($this->client, $this);
217			}
218
219			/**
220			* Return the database informations.
221			*
222			* @return array
223			*/
224	1		public function getInfo()
225			{
226	1		$json = (string) $this->client->request('GET', "/{$this->name}/")->getBody();
227
228	1		return JSONEncoder::decode($json);
229			}
230
231			/**
232			* Return informations about the last changes from the database.
233			*
234			* @throws \RuntimeException If the request was not successfull
235			*
236			* @return array
237			*/
238	2		public function getChanges()
239			{
240	2		$response = $this->client->request('GET', "/{$this->name}/_changes");
241
242	2		if (200 !== $response->getStatusCode()) {
243	1		throw new Exception('Request wasn\'t successfull');
244			}
245
246	1		return JSONEncoder::decode((string) $response->getBody());
247			}
248
249			/**
250			* Return the database name.
251			*
252			* @return string
253			*/
254	2		public function getName()
255			{
256	2		return $this->name;
257			}
258			}
259

Baachi / CouchDB

Database::getName() A last analyzed 2018-04-16 06:27 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Database::getName() A
last analyzed 2018-04-16 06:27 UTC