Jaxon\Annotations\Annotation\DataBagAnnotation

Complexity

Total Complexity

7

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	initAnnotation()	0	7	4
A	getName()	0	3	1
A	getValue()	0	8	2

<?php

/**
 * DataBagAnnotation.php
 *
 * Jaxon annotation for data bags.
 *
 * @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_array;
use function is_string;

/**
 * Specifies a data bag stored in the browser and included in ajax requests to a method.
 *
 * @usage('class' => true, 'method'=>true, 'multiple'=>true, 'inherited'=>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 DataBagAnnotation extends AbstractAnnotation
{
    /**
     * The data bag name
     *
     * @var string
     */
    protected $sName = '';

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) != 1 || !isset($properties['name']) || !is_string($properties['name']))
        {
            throw new AnnotationException('The @databag annotation requires a property "name" of type string');
        }
        $this->sName = $properties['name'];
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getValue()
    {
        if(is_array($this->xPrevValue))
        {
            $this->xPrevValue[] = $this->sName; // Append the current value to the array
            return $this->xPrevValue;
        }
        return [$this->sName]; // Return the current value in an array
    }

Expected 2 blank lines after function; 0 found

}