Jaxon\Annotations\Annotation\UploadAnnotation

Complexity

Total Complexity

6

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

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

<?php

/**
 * UploadAnnotation.php
 *
 * Jaxon annotation for file upload.
 *
 * @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\Annotation;
use mindplay\annotations\AnnotationException;

use function count;
use function is_string;

/**
 * Specifies an upload form field id.
 *
 * @usage('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 UploadAnnotation extends AbstractAnnotation
{
    /**
     * The name of the upload field
     *
     * @var string
     */
    protected $sField = '';

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getValue()
    {
        return "'" . $this->sField . "'" ; // The field id is surrounded with simple quotes.
    }

Expected 2 blank lines after function; 0 found

}