ExcludeAnnotation::initAnnotation() - Code Metrics - Inspection of "Tests on docblock annotations." - jaxon-php/jaxon-annotations - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( fe5adf...e99a91 )

by Thierry

created 2022-04-30 16:23 UTC

ExcludeAnnotation::initAnnotation() A

↳ Parent: ExcludeAnnotation

Complexity

Conditions	5
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	8
rs	9.6111
cc	5
nc	2
nop	1

<?php

/**
 * ExcludeAnnotation.php
 *
 * Jaxon annotation for exclude classes or methods from js export.
 *
 * @package jaxon-annotations
 * @author Thierry Feuzeu <[email protected]>
 * @copyright 2022 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-annotations
 */

namespace Jaxon\Annotations\Annotation;

use mindplay\annotations\AnnotationException;

use function count;
use function is_bool;

/**
 * Specifies if a class or method is excluded from js export.
 *
 * @usage('class' => true, 'method'=>true)
 */
class ExcludeAnnotation extends AbstractAnnotation
{
    /**
     * The name of the upload field
     *
     * @var bool
     */
    protected $bValue;

    /**
     * @inheritDoc
     */
    public static function parseAnnotation($value)
    {
        if($value === 'true')
        {
            return [true];
        }
        if($value === 'false')
        {
            return [false];
        }
        return [$value];
    }

    /**
     * @inheritDoc
     * @throws AnnotationException
     */
    public function initAnnotation(array $properties)
    {
        if(count($properties) !== 0 &&
            (count($properties) !== 1 || !isset($properties[0]) || !is_bool($properties[0])))
        {
            throw new AnnotationException('the @exclude annotation requires a single boolean or no property');
        }
        $this->bValue = $properties[0] ?? true;
    }

    /**
     * @inheritDoc
     */
    public function getName(): string
    {
        return 'protected';
    }

    /**
     * @inheritDoc
     */
    public function getValue()
    {
        return $this->bValue;
    }
}


1			<?php
2
3			/**
4			* ExcludeAnnotation.php
5			*
6			* Jaxon annotation for exclude classes or methods from js export.
7			*
8			* @package jaxon-annotations
9			* @author Thierry Feuzeu <[email protected]>
10			* @copyright 2022 Thierry Feuzeu <[email protected]>
11			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
12			* @link https://github.com/jaxon-php/jaxon-annotations
13			*/
14
15			namespace Jaxon\Annotations\Annotation;
16
17			use mindplay\annotations\AnnotationException;
18
19			use function count;
20			use function is_bool;
21
22			/**
23			* Specifies if a class or method is excluded from js export.
24			*
25			* @usage('class' => true, 'method'=>true)
26			*/
27			class ExcludeAnnotation extends AbstractAnnotation
28			{
29			/**
30			* The name of the upload field
31			*
32			* @var bool
33			*/
34			protected $bValue;
35
36			/**
37			* @inheritDoc
38			*/
39			public static function parseAnnotation($value)
40			{
41			if($value === 'true')
42			{
43			return [true];
44			}
45			if($value === 'false')
46			{
47			return [false];
48			}
49			return [$value];
50			}
51
52			/**
53			* @inheritDoc
54			* @throws AnnotationException
55			*/
56			public function initAnnotation(array $properties)
57			{
58			if(count($properties) !== 0 &&
59			(count($properties) !== 1 \|\| !isset($properties[0]) \|\| !is_bool($properties[0])))
60			{
61			throw new AnnotationException('the @exclude annotation requires a single boolean or no property');
62			}
63			$this->bValue = $properties[0] ?? true;
64			}
65
66			/**
67			* @inheritDoc
68			*/
69			public function getName(): string
70			{
71			return 'protected';
72			}
73
74			/**
75			* @inheritDoc
76			*/
77			public function getValue()
78			{
79			return $this->bValue;
80			}
81			}
82

jaxon-php / jaxon-annotations

Push — main ( fe5adf...e99a91 )

ExcludeAnnotation::initAnnotation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like