MongoHelper::toId() - Code Metrics - appertly/minotaur - Measure and Improve Code Quality continuously with Scrutinizer

MongoHelper::toId() A
last analyzed 2018-02-14 18:59 UTC

↳ Parent: MongoHelper

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

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

<?php
declare(strict_types=1);
/**
 * Minotaur
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2017 Appertly
 * @license   Apache-2.0
 */
namespace Minotaur\Db;

use MongoDB\BSON\ObjectID;
use MongoDB\BSON\UTCDateTime;

/**
 * Can be used by any class which accesses MongoDB.
 */
trait MongoHelper
{
    /**
     * Transforms a literal into a MongoDB ObjectId.
     *
     * @param $id - If it's an `ObjectID`, returns that, otherwise creates a new
     *              `ObjectID`.
     * @return - The ObjectID

     */
    protected function toId($id): ObjectID
    {
        return $id instanceof ObjectID ? $id : new ObjectID((string) $id);
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }

    /**
     * Transforms literals into MongoDB ObjectIds.
     *
     * @param iterable<mixed> $ids Goes through each entry, converts to `ObjectID`

     * @return array<\MongoDB\BSON\ObjectID> The ObjectIDs
     */
    protected function toIds(iterable $ids): array
    {
        $mids = [];
        foreach ($ids as $a) {
            $mids[] = $a instanceof ObjectID ? $a : new ObjectID((string) $a);
if ($x instanceof DoesNotExist) {
    // Do something.
}
        }
        return $mids;
    }

    /**
     * Gets the current time.
     *
     * @return - The current time

     * @deprecated 0.7.0:1.0.0 UTCDateTime now doesn't need an argument.
     */
    protected function now(): \MongoDB\BSON\UTCDateTime
    {
        $parts = explode(' ', microtime());
        return new \MongoDB\BSON\UTCDateTime(sprintf('%d%03d', $parts[1], $parts[0] * 1000));
    }

    /**
     * Tries to parse a date.
     *
     * @param $date - The possible string date value, a string, a
     *        `\DateTimeInterface`, or a `\MongoDB\BSON\UTCDateTime`
     * @return - The MongoDB datetime or null

     */
    protected function toDate($date): ?UTCDateTime
    {
        if ($date instanceof UTCDateTime) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $date;
        } elseif ($date instanceof \DateTimeInterface) {
            return new UTCDateTime($date);
        } else {
            $date = trim((string)$date);
            return strlen($date) > 0 ? new UTCDateTime(strtotime($date) * 1000) : null;
        }
    }

    /**
     * Makes sure a document isn't null.
     *
     * @param mixed $id The document identifier, either a `\MongoDB\BSON\ObjectID` or string
     * @param mixed $document The document to check
     * @return mixed Returns `$document`
     * @throws \Caridea\Dao\Exception\Unretrievable if the document is null
     */
    protected function ensure($id, $document)
    {
        if ($document === null) {
            throw new \Caridea\Dao\Exception\Unretrievable("Could not find document with ID $id");
        }
        return $document;
    }
}


1		<?php
2		declare(strict_types=1);
3		/**
4		* Minotaur
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License"); you may not
7		* use this file except in compliance with the License. You may obtain a copy of
8		* the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14		* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15		* License for the specific language governing permissions and limitations under
16		* the License.
17		*
18		* @copyright 2015-2017 Appertly
19		* @license Apache-2.0
20		*/
21		namespace Minotaur\Db;
22
23		use MongoDB\BSON\ObjectID;
24		use MongoDB\BSON\UTCDateTime;
25
26		/**
27		* Can be used by any class which accesses MongoDB.
28		*/
29		trait MongoHelper
30		{
31		/**
32		* Transforms a literal into a MongoDB ObjectId.
33		*
34		* @param $id - If it's an `ObjectID`, returns that, otherwise creates a new
35		* `ObjectID`.
36		* @return - The ObjectID
		0 ignored issues – show Documentation introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The doc-type `-` could not be parsed: Unknown type name "-" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
37		*/
38	1	protected function toId($id): ObjectID
39		{
40	1	return $id instanceof ObjectID ? $id : new ObjectID((string) $id);
		0 ignored issues – show Bug introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\ObjectID` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
41		}
42
43		/**
44		* Transforms literals into MongoDB ObjectIds.
45		*
46		* @param iterable<mixed> $ids Goes through each entry, converts to `ObjectID`
		0 ignored issues – show Documentation introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The doc-type `iterable<mixed>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 8. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
47		* @return array<\MongoDB\BSON\ObjectID> The ObjectIDs
48		*/
49		protected function toIds(iterable $ids): array
50		{
51		$mids = [];
52		foreach ($ids as $a) {
53		$mids[] = $a instanceof ObjectID ? $a : new ObjectID((string) $a);
		0 ignored issues – show Bug introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\ObjectID` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
54		}
55		return $mids;
56		}
57
58		/**
59		* Gets the current time.
60		*
61		* @return - The current time
		0 ignored issues – show Documentation introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The doc-type `-` could not be parsed: Unknown type name "-" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
62		* @deprecated 0.7.0:1.0.0 UTCDateTime now doesn't need an argument.
63		*/
64		protected function now(): \MongoDB\BSON\UTCDateTime
65		{
66		$parts = explode(' ', microtime());
67		return new \MongoDB\BSON\UTCDateTime(sprintf('%d%03d', $parts[1], $parts[0] * 1000));
68		}
69
70		/**
71		* Tries to parse a date.
72		*
73		* @param $date - The possible string date value, a string, a
74		* `\DateTimeInterface`, or a `\MongoDB\BSON\UTCDateTime`
75		* @return - The MongoDB datetime or null
		0 ignored issues – show Documentation introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The doc-type `-` could not be parsed: Unknown type name "-" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
76		*/
77		protected function toDate($date): ?UTCDateTime
78		{
79		if ($date instanceof UTCDateTime) {
		0 ignored issues – show Bug introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\UTCDateTime` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
80		return $date;
81		} elseif ($date instanceof \DateTimeInterface) {
82		return new UTCDateTime($date);
83		} else {
84		$date = trim((string)$date);
85		return strlen($date) > 0 ? new UTCDateTime(strtotime($date) * 1000) : null;
86		}
87		}
88
89		/**
90		* Makes sure a document isn't null.
91		*
92		* @param mixed $id The document identifier, either a `\MongoDB\BSON\ObjectID` or string
93		* @param mixed $document The document to check
94		* @return mixed Returns `$document`
95		* @throws \Caridea\Dao\Exception\Unretrievable if the document is null
96		*/
97		protected function ensure($id, $document)
98		{
99		if ($document === null) {
100		throw new \Caridea\Dao\Exception\Unretrievable("Could not find document with ID $id");
101		}
102		return $document;
103		}
104		}
105

appertly / minotaur

MongoHelper::toId() A last analyzed 2018-02-14 18:59 UTC

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

MongoHelper::toId() A
last analyzed 2018-02-14 18:59 UTC