DocumentNotFoundEventArgs::__construct() - Code Metrics - Inspection of "Merge branch '1.3.x'" - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 09b86b...ba0798 )

by Andreas

created 2019-04-15 11:30 UTC

DocumentNotFoundEventArgs::__construct() A

↳ Parent: DocumentNotFoundEventArgs

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0185

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	5
cts	6
cp	0.8333
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	3
crap	2.0185

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Event;

use Doctrine\ODM\MongoDB\DocumentManager;
use const E_USER_DEPRECATED;
use function sprintf;
use function trigger_error;

/**
 * Provides event arguments for the documentNotFound event.
 *
 * @final
 */
class DocumentNotFoundEventArgs extends LifecycleEventArgs
{
    /** @var mixed */
    private $identifier;

    /** @var bool */
    private $disableException = false;

    /**
     * @param mixed $identifier
     */
    public function __construct(object $document, DocumentManager $dm, $identifier)
    {
        if (self::class !== static::class) {
            @trigger_error(sprintf('The class "%s" extends "%s" which will be final in MongoDB ODM 2.0.', static::class, self::class), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
        parent::__construct($document, $dm);
        $this->identifier = $identifier;
    }

    /**
     * Retrieve associated identifier.
     *
     * @return mixed
     */
    public function getIdentifier()
    {
        return $this->identifier;
    }

    /**
     * Indicates whether the proxy initialization exception is disabled.
     */
    public function isExceptionDisabled() : bool
    {
        return $this->disableException;
    }

    /**
     * Disable the throwing of an exception
     *
     * This method indicates to the proxy initializer that the missing document
     * has been handled and no exception should be thrown. This can't be reset.
     */
    public function disableException(bool $disableException = true) : void
    {
        $this->disableException = $disableException;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\ODM\MongoDB\Event;
6
7		use Doctrine\ODM\MongoDB\DocumentManager;
8		use const E_USER_DEPRECATED;
9		use function sprintf;
10		use function trigger_error;
11
12		/**
13		* Provides event arguments for the documentNotFound event.
14		*
15		* @final
16		*/
17		class DocumentNotFoundEventArgs extends LifecycleEventArgs
18		{
19		/** @var mixed */
20		private $identifier;
21
22		/** @var bool */
23		private $disableException = false;
24
25		/**
26		* @param mixed $identifier
27		*/
28	9	public function __construct(object $document, DocumentManager $dm, $identifier)
29		{
30	9	if (self::class !== static::class) {
31		@trigger_error(sprintf('The class "%s" extends "%s" which will be final in MongoDB ODM 2.0.', static::class, self::class), E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2019-04-15 11:50 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
32		}
33	9	parent::__construct($document, $dm);
34	9	$this->identifier = $identifier;
35	9	}
36
37		/**
38		* Retrieve associated identifier.
39		*
40		* @return mixed
41		*/
42		public function getIdentifier()
43		{
44		return $this->identifier;
45		}
46
47		/**
48		* Indicates whether the proxy initialization exception is disabled.
49		*/
50	9	public function isExceptionDisabled() : bool
51		{
52	9	return $this->disableException;
53		}
54
55		/**
56		* Disable the throwing of an exception
57		*
58		* This method indicates to the proxy initializer that the missing document
59		* has been handled and no exception should be thrown. This can't be reset.
60		*/
61	1	public function disableException(bool $disableException = true) : void
62		{
63	1	$this->disableException = $disableException;
64	1	}
65		}
66

doctrine / mongodb-odm

Push — master ( 09b86b...ba0798 )

DocumentNotFoundEventArgs::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like