-
Notifications
You must be signed in to change notification settings - Fork 926
/
DataType.php
146 lines (130 loc) · 3.74 KB
/
DataType.php
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
<?php
namespace Swagger\Annotations;
/**
* @license http://www.apache.org/licenses/LICENSE-2.0
* Copyright [2014] [Robert Allen]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @package
* @category
* @subpackage
*/
use Swagger\Annotations\AbstractAnnotation;
use Swagger\Annotations\Items;
use Swagger\Logger;
use Swagger\Swagger;
/**
* Baseclass for the @SWG\Parameter & @SWG\Property annotations.
* https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#43-data-types
*
* @package
* @category
* @subpackage
*
* @Annotation
* @link https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#43-data-types
*/
abstract class DataType extends AbstractAnnotation
{
/**
* @var string
*/
public $name;
/**
* The human-readable description.
* @var string
*/
public $description;
/**
* @var string
*/
public $type;
/**
* Fine-tuned primitive type definition
* @var string
*/
public $format;
/**
* The type definition of the values in the container.
* @var Items
*/
public $items;
/**
* A flag to note whether the container allows duplicate values or not.
* @var bool
*/
public $uniqueItems;
/**
* @var bool
*/
public $required;
/**
* The minimum valid value for the type, inclusive.
* @var mixed
*/
public $minimum;
/**
* The maximum valid value for the type, inclusive.
* @var mixed
*/
public $maximum;
/**
* A fixed list of possible values.
* @var array
*/
public $enum;
/**
* The default value to be used for the field.
* @var mixed
*/
public $defaultValue;
protected static $mapAnnotations = array(
'\Swagger\Annotations\Items' => 'items'
);
public function __construct(array $values = array())
{
parent::__construct($values);
Swagger::checkDataType($this->type, $this->_context);
if (is_string($this->enum)) {
$values = $this->decode($this->enum);
if (is_object($values)) {
$this->enum = array();
foreach ($values as $key => $value) {
$this->enum[] = $key.'-'.$value;
}
} else {
$this->enum = $values;
}
}
}
public function validate()
{
if (is_string($this->required)) {
$required = filter_var($this->required, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
if ($required === null) {
Logger::notice('Invalid `required="'.$this->required.'"` for '.$this->identity().' expecting `required=true` or `required=false` in '.$this->_context);
} else {
Logger::notice('Expecting a boolean, got a string `required="'.$this->required.'"` instead of `required='.($required ? 'true': 'false').'` for '.$this->identity().' in '.$this->_context);
$this->required = $required;
}
}
Items::validateContainer($this);
return true;
}
public function identity()
{
$array = explode('\\', get_class($this));
return '@SWG\\'.array_pop($array).'(name="'.$this->name.'")';
}
}