Jaxon\Annotations\Annotation\UploadAnnotation

Complexity

Total Complexity

10

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	parseAnnotation()	0	4	2
A	getValue()	0	3	1
A	getName()	0	3	1
A	validateUploadField()	0	3	1
A	initAnnotation()	0	11	5

<?php

/**
 * UploadAnnotation.php
 *
 * Jaxon annotation for file upload.
 *
 * @package jaxon-annotations
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @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-annotations
 */

namespace Jaxon\Annotations\Annotation;

use mindplay\annotations\AnnotationException;

use function count;
use function is_string;
use function preg_match;
use function preg_split;

/**
 * Specifies an upload form field id.
 *
 * @usage('method'=>true)
 */
class UploadAnnotation extends AbstractAnnotation
{
    /**
     * The name of the upload field
     *
     * @var string
     */
    protected $sField = '';

    /**
     * @inheritDoc
     */
    public static function parseAnnotation($value)
    {
        $aParams = preg_split('/[\s]+/', $value, 2);
        return count($aParams) === 1 ? ['field' => $aParams[0]] : ['field' => $aParams[0], 'extra' => $aParams[1]];
    }

    /**
     * @param string $sFieldName
     *
     * @return bool
     */
    protected function validateUploadField(string $sFieldName): bool
    {
        return preg_match('/^[a-zA-Z][a-zA-Z0-9_\-\.]*$/', $sFieldName) > 0;
    }

    /**
     * @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');
        }
        if(!$this->validateUploadField($properties['field']))
        {
            throw new AnnotationException($properties['field'] . ' is not a valid "field" value for the @upload annotation');
        }
        $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.
    }
}