MissingAnnotationArgumentException::getClassName() - Code Metrics - Inspection of "[Fix] Sanitize Reader code" - neimheadh/SonataAnnotationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 01015e...01f497 )

by Mathieu

created 2023-02-27 16:05 UTC

MissingAnnotationArgumentException::getClassName() A

↳ Parent: MissingAnnotationArgumentException

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	6
c	0
b	0
f	0
dl	0
loc	13
rs	10
cc	4
nc	4
nop	1

<?php

namespace KunicMarko\SonataAnnotationBundle\Exception;

use InvalidArgumentException;
use KunicMarko\SonataAnnotationBundle\Annotation\AnnotationInterface;
use ReflectionClass;

/**
 * A mandatory argument is missing on an annotation.
 */
class MissingAnnotationArgumentException extends InvalidArgumentException
{

    /**
     * @param AnnotationInterface|string  $annotation   Annotation object or
     *                                                  class.
     * @param string                      $argumentName Argument name.
     * @param ReflectionClass|string|null $class        Class using the
     *                                                  annotation.
     */
    public function __construct(
        $annotation,
        string $argumentName,
        $class = null
    ) {
        if (is_object($annotation)) {
            $annotation = get_class($annotation);
        }

        $class = $this->getClassName($class);
        if ($class) {
            $message = sprintf(
                'Argument "%s" is mandatory for annotation %s on %s.',
                $argumentName,
                $annotation,
                $class
            );
        } else {
            $message = sprintf(
                'Argument "%s" is mandatory for annotation %s.',
                $argumentName,
                $annotation,
            );
        }

        parent::__construct($message);
    }

    /**
     * Get given class name.
     *
     * @param string|object|null $class Class.
     *
     * @return string|null
     */
    private function getClassName($class): ?string
    {
        if ($class instanceof ReflectionClass) {
            $class = $class->getName();
        }

        if ($class !== null && !is_string($class)) {
            throw new InvalidArgumentException(
                'Invalid class (string|ReflectionClass|null) attribute.',
            );
        }

        return $class;
    }

}

1			<?php
2
3			namespace KunicMarko\SonataAnnotationBundle\Exception;
4
5			use InvalidArgumentException;
6			use KunicMarko\SonataAnnotationBundle\Annotation\AnnotationInterface;
7			use ReflectionClass;
8
9			/**
10			* A mandatory argument is missing on an annotation.
11			*/
12			class MissingAnnotationArgumentException extends InvalidArgumentException
13			{
14
15			/**
16			* @param AnnotationInterface\|string $annotation Annotation object or
17			* class.
18			* @param string $argumentName Argument name.
19			* @param ReflectionClass\|string\|null $class Class using the
20			* annotation.
21			*/
22			public function __construct(
23			$annotation,
24			string $argumentName,
25			$class = null
26			) {
27			if (is_object($annotation)) {
28			$annotation = get_class($annotation);
29			}
30
31			$class = $this->getClassName($class);
32			if ($class) {
33			$message = sprintf(
34			'Argument "%s" is mandatory for annotation %s on %s.',
35			$argumentName,
36			$annotation,
37			$class
38			);
39			} else {
40			$message = sprintf(
41			'Argument "%s" is mandatory for annotation %s.',
42			$argumentName,
43			$annotation,
44			);
45			}
46
47			parent::__construct($message);
48			}
49
50			/**
51			* Get given class name.
52			*
53			* @param string\|object\|null $class Class.
54			*
55			* @return string\|null
56			*/
57			private function getClassName($class): ?string
58			{
59			if ($class instanceof ReflectionClass) {
60			$class = $class->getName();
61			}
62
63			if ($class !== null && !is_string($class)) {
64			throw new InvalidArgumentException(
65			'Invalid class (string\|ReflectionClass\|null) attribute.',
66			);
67			}
68
69			return $class;
70			}
71
72			}

neimheadh / SonataAnnotationBundle

Push — develop ( 01015e...01f497 )

MissingAnnotationArgumentException::getClassName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like