Jaxon\Annotations\Annotation\ExcludeAnnotation

Complexity

Total Complexity

7

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	initAnnotation()	0	8	5
A	getValue()	0	3	1

<?php

/**
 * AfterAnnotation.php
 *
 * Jaxon annotation for callbacks.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @copyright 2022 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

Missing @author tag in file comment

namespace Jaxon\Annotations\Annotation;

use mindplay\annotations\AnnotationException;

use function count;
use function is_bool;

/**
 * Specifies a method to be called after the one targeted by a Jaxon request.
 *
 * @usage('class' => true, 'method'=>true)
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ExcludeAnnotation extends AbstractAnnotation
{
    /**
     * The name of the upload field
     *
     * @var bool

Expected "boolean" but found "bool" for @var tag in member variable comment

     */
    protected $bValue;

Expected 1 blank line(s) before first member var; 0 found

    /**

Parameter $properties should have a doc-comment as per coding-style.

     * @inheritDoc
     * @throws AnnotationException
     */

Missing @return tag in function comment

    public function initAnnotation(array $properties)

Expected 2 blank lines before function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return 'protected';
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getValue()
    {
        return $this->bValue;
    }

Expected 2 blank lines after function; 0 found

}