1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?php
/**
* File AbstractParameter.php
*
* @author Edward Pfremmer <epfremme@nerdery.com>
*/
namespace Epfremme\Swagger\Entity\Parameters;
use Epfremme\Swagger\Annotations as EP;
use JMS\Serializer\Annotation as JMS;
/**
* Class AbstractParameter
*
* @EP\Discriminator(field = "class", default="body", map = {
* "body" : "Epfremme\Swagger\Entity\Parameters\BodyParameter",
* "path.string" : "Epfremme\Swagger\Entity\Parameters\PathParameter\StringType",
* "path.integer" : "Epfremme\Swagger\Entity\Parameters\PathParameter\IntegerType",
* "path.boolean" : "Epfremme\Swagger\Entity\Parameters\PathParameter\BooleanType",
* "query.string" : "Epfremme\Swagger\Entity\Parameters\QueryParameter\StringType",
* "query.number" : "Epfremme\Swagger\Entity\Parameters\QueryParameter\NumberType",
* "query.integer" : "Epfremme\Swagger\Entity\Parameters\QueryParameter\IntegerType",
* "query.boolean" : "Epfremme\Swagger\Entity\Parameters\QueryParameter\BooleanType",
* "query.array" : "Epfremme\Swagger\Entity\Parameters\QueryParameter\ArrayType",
* "header.string" : "Epfremme\Swagger\Entity\Parameters\HeaderParameter\StringType",
* "header.number" : "Epfremme\Swagger\Entity\Parameters\HeaderParameter\NumberType",
* "header.integer" : "Epfremme\Swagger\Entity\Parameters\HeaderParameter\IntegerType",
* "header.boolean" : "Epfremme\Swagger\Entity\Parameters\HeaderParameter\BooleanType",
* "header.array" : "Epfremme\Swagger\Entity\Parameters\HeaderParameter\ArrayType",
* "formData.string" : "Epfremme\Swagger\Entity\Parameters\FormParameter\StringType",
* "formData.number" : "Epfremme\Swagger\Entity\Parameters\FormParameter\NumberType",
* "formData.integer": "Epfremme\Swagger\Entity\Parameters\FormParameter\IntegerType",
* "formData.boolean": "Epfremme\Swagger\Entity\Parameters\FormParameter\BooleanType",
* "formData.array" : "Epfremme\Swagger\Entity\Parameters\FormParameter\ArrayType",
* "formData.file" : "Epfremme\Swagger\Entity\Parameters\FormParameter\FileType"
* })
*
* @package Epfremme\Swagger
* @subpackage Entity\Parameters
*/
abstract class AbstractParameter
{
// parameter in constants
const IN_BODY = 'body';
const IN_PATH = 'path';
const IN_QUERY = 'query';
const IN_HEADER = 'header';
const IN_FORM_DATA = 'formData';
/**
* @JMS\Since("2.0")
* @JMS\Type("string")
* @JMS\SerializedName("in")
* @var string
*/
protected $in;
/**
* @JMS\Since("2.0")
* @JMS\Type("string")
* @JMS\SerializedName("name")
* @var string
*/
protected $name;
/**
* @JMS\Since("2.0")
* @JMS\Type("string")
* @JMS\SerializedName("description")
* @var string
*/
protected $description;
/**
* @JMS\Since("2.0")
* @JMS\Type("boolean")
* @JMS\SerializedName("required")
* @var boolean
*/
protected $required;
/**
* @return string
*/
public function getIn()
{
return $this->in;
}
/**
* @param string $in
* @return AbstractParameter
*/
public function setIn($in)
{
$this->in = $in;
return $this;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @param string $name
* @return AbstractParameter
*/
public function setName($name)
{
$this->name = $name;
return $this;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* @param string $description
* @return AbstractParameter
*/
public function setDescription($description)
{
$this->description = $description;
return $this;
}
/**
* @return boolean
*/
public function isRequired()
{
return $this->required;
}
/**
* @param boolean $required
* @return AbstractParameter
*/
public function setRequired($required)
{
$this->required = $required;
return $this;
}
}