UploadAnnotation::initAnnotation() - Code Metrics - Inspection of "Added missing standard annotation declaration." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 818b3e...c1bcf5 )

by Thierry

created 2022-04-14 13:49 UTC

UploadAnnotation::initAnnotation() A

↳ Parent: UploadAnnotation

Complexity

Conditions	4
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	3
c	1
b	0
f	0
dl	0
loc	7
rs	10
cc	4
nc	2
nop	1

<?php

/**
 * UploadAnnotation.php
 *
 * Jaxon annotation for file upload.
 *
 * @package jaxon-core

 * @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-core
 */


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)
 */

class UploadAnnotation extends AbstractAnnotation
{
    /**
     * The name of the upload field
     *
     * @var string
     */
    protected $sField = '';


    /**

     * @inheritDoc
     * @throws AnnotationException
     */

    public function initAnnotation(array $properties)

    {
        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'];
    }


    /**
     * @inheritDoc
     */

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


    /**
     * @inheritDoc
     */

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

}


1			<?php
2
3			/**
4			* UploadAnnotation.php
5			*
6			* Jaxon annotation for file upload.
7			*
8			* @package jaxon-core
			0 ignored issues – show Coding Style introduced 2019-12-07 05:11 UTC by Report Bug Copy Issue Report Package name "jaxon-core" is not valid; consider "Jaxoncore" instead Loading history...
9			* @copyright 2022 Thierry Feuzeu <[email protected]>
10			* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
11			* @link https://github.com/jaxon-php/jaxon-core
12			*/
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history...
13
14			namespace Jaxon\Annotations\Annotation;
15
16			use mindplay\annotations\Annotation;
17			use mindplay\annotations\AnnotationException;
18
19			use function count;
20			use function is_string;
21
22			/**
23			* Specifies an upload form field id.
24			*
25			* @usage('method'=>true)
26			*/
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
27			class UploadAnnotation extends AbstractAnnotation
28			{
29			/**
30			* The name of the upload field
31			*
32			* @var string
33			*/
34			protected $sField = '';
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Expected 1 blank line(s) before first member var; 0 found Loading history...
35
36			/**
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Parameter `$properties` should have a doc-comment as per coding-style. Loading history...
37			* @inheritDoc
38			* @throws AnnotationException
39			*/
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
40			public function initAnnotation(array $properties)
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history...
41			{
42			if(count($properties) != 1 \|\| !isset($properties['field']) \|\| !is_string($properties['field']))
43			{
44			throw new AnnotationException('The @upload annotation requires a property "field" of type string');
45			}
46			$this->sField = $properties['field'];
47			}
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
48
49			/**
50			* @inheritDoc
51			*/
			0 ignored issues – show Coding Style introduced 2022-04-06 21:26 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
52			public function getName(): string
53			{
54			return 'upload';
55			}
			0 ignored issues – show Coding Style introduced 2022-04-06 21:26 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history...
56
57			/**
58			* @inheritDoc
59			*/
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
60			public function getValue()
61			{
62			return "'" . $this->sField . "'" ; // The field id is surrounded with simple quotes.
63			}
			0 ignored issues – show Coding Style introduced 2022-04-14 13:52 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history...
64			}
65

jaxon-php / jaxon-core

Push — master ( 818b3e...c1bcf5 )

UploadAnnotation::initAnnotation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like