ClassBasedTrait::checkClass() - Code Metrics - Inspection of "Add storage engine component" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#407)

by Kirill

created 2021-05-05 16:30 UTC

ClassBasedTrait::checkClass() A

↳ Parent: ClassBasedTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * This file is part of Spiral Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Spiral\Storage\Config\DTO\Traits;

use Spiral\Storage\Exception\StorageException;

/**
 * Trait for dto based on class usage
 */
trait ClassBasedTrait
{
    /**
     * @var string|null
     */
    protected $class = null;

    public function getClass(): string
    {
        return $this->class;
    }

    /**
     * Set class for DTO and check if class exists
     *
     * @param string $class
     * @param string|null $exceptionMsg
     *
     * @return static
     *
     * @throws StorageException
     */
    public function setClass(string $class, ?string $exceptionMsg = null): self
    {
        $this->checkClass($class, $exceptionMsg ?: '');

        $this->class = $class;

        return $this;
    }

    /**
     * Check if class exists
     *
     * @param string $class
     * @param string $errorPostfix
     *
     * @throws StorageException
     */
    protected function checkClass(string $class, string $errorPostfix): void
    {
        if (!class_exists($class)) {
            throw new StorageException(
                \sprintf('Class `%s` not exists. %s', $class, $errorPostfix)
            );
        }
    }
}


1			<?php
2
3			/**
4			* This file is part of Spiral Framework package.
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			declare(strict_types=1);
11
12			namespace Spiral\Storage\Config\DTO\Traits;
13
14			use Spiral\Storage\Exception\StorageException;
15
16			/**
17			* Trait for dto based on class usage
18			*/
19			trait ClassBasedTrait
20			{
21			/**
22			* @var string\|null
23			*/
24			protected $class = null;
25
26			public function getClass(): string
27			{
28			return $this->class;
29			}
30
31			/**
32			* Set class for DTO and check if class exists
33			*
34			* @param string $class
35			* @param string\|null $exceptionMsg
36			*
37			* @return static
38			*
39			* @throws StorageException
40			*/
41			public function setClass(string $class, ?string $exceptionMsg = null): self
42			{
43			$this->checkClass($class, $exceptionMsg ?: '');
44
45			$this->class = $class;
46
47			return $this;
48			}
49
50			/**
51			* Check if class exists
52			*
53			* @param string $class
54			* @param string $errorPostfix
55			*
56			* @throws StorageException
57			*/
58			protected function checkClass(string $class, string $errorPostfix): void
59			{
60			if (!class_exists($class)) {
61			throw new StorageException(
62			\sprintf('Class `%s` not exists. %s', $class, $errorPostfix)
63			);
64			}
65			}
66			}
67

spiral / framework

Pull Request — master (#407)

ClassBasedTrait::checkClass() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like