Test Failed
Pull Request — master (#34)
by Anatoly
02:07
created

Response::getReferenceName()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 1
c 0
b 0
f 0
dl 0
loc 3
rs 10
cc 1
nc 1
nop 0
1
<?php declare(strict_types=1);
2
3
/**
4
 * It's free open-source software released under the MIT License.
5
 *
6
 * @author Anatoly Fenric <[email protected]>
7
 * @copyright Copyright (c) 2018, Anatoly Fenric
8
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
9
 * @link https://github.com/sunrise-php/http-router
10
 */
11
12
namespace Sunrise\Http\Router\Annotation\OpenApi;
13
14
/**
15
 * Import classes
16
 */
17
use Sunrise\Http\Router\OpenApi\ComponentObjectInterface;
18
19
/**
20
 * Import functions
21
 */
22
use function spl_object_hash;
23
24
/**
25
 * @Annotation
26
 *
27
 * @Target({"ALL"})
28
 *
29
 * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#response-object
30
 */
31
final class Response extends AbstractAnnotation implements ResponseInterface, ComponentObjectInterface
32
{
33
34
    /**
35
     * {@inheritDoc}
36
     */
37
    protected const IGNORE_FIELDS = ['refName'];
38
39
    /**
40
     * @var string
41
     */
42
    public $refName;
43
44
    /**
45
     * @Required
46
     *
47
     * @var string
48
     *
49
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-responsedescription
50
     */
51
    public $description;
52
53
    /**
54
     * @var array<\Sunrise\Http\Router\Annotation\OpenApi\HeaderInterface>
55
     *
56
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-responseheaders
57
     */
58
    public $headers;
59
60
    /**
61
     * @var array<\Sunrise\Http\Router\Annotation\OpenApi\MediaTypeInterface>
62
     *
63
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-responsecontent
64
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#media-types
65
     */
66
    public $content;
67
68
    /**
69
     * @var array<\Sunrise\Http\Router\Annotation\OpenApi\LinkInterface>
70
     *
71
     * @link https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#user-content-responselinks
72
     */
73
    public $links;
74
75
    /**
76
     * {@inheritDoc}
77
     */
78
    public function getComponentName() : string
79
    {
80
        return 'responses';
81
    }
82
83
    /**
84
     * {@inheritDoc}
85
     */
86
    public function getReferenceName() : string
87
    {
88
        return $this->refName ?? spl_object_hash($this);
89
    }
90
}
91