Completed
Pull Request — master (#33)
by Martijn
02:28
created
SwaggerGen/Swagger/Operation.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -35,6 +35,9 @@
 block discarded – undo
35 35
 		return $this->consumes;
36 36
 	}
37 37
 
38
+	/**
39
+	 * @param string $summary
40
+	 */
38 41
 	public function __construct(AbstractObject $parent, $summary = null, Tag $tag = null)
39 42
 	{
40 43
 		parent::__construct($parent);
Please login to merge, or discard this patch.
SwaggerGen/Swagger/Type/ArrayType.php 1 patch
Doc Comments   +12 added lines patch added patch discarded remove patch
@@ -69,6 +69,10 @@  discard block
 block discarded – undo
69 69
 		$this->parseRange($definition, $match);
70 70
 	}
71 71
 
72
+	/**
73
+	 * @param string $definition
74
+	 * @param string[] $match
75
+	 */
72 76
 	private function parseFormat($definition, $match)
73 77
 	{
74 78
 		$type = strtolower($match[1]);
@@ -86,6 +90,10 @@  discard block
 block discarded – undo
86 90
 		$this->collectionFormat = self::$collectionFormats[$type];
87 91
 	}
88 92
 
93
+	/**
94
+	 * @param string $definition
95
+	 * @param string[] $match
96
+	 */
89 97
 	private function parseItems($definition, $match)
90 98
 	{
91 99
 		if (!empty($match[2])) {
@@ -93,6 +101,10 @@  discard block
 block discarded – undo
93 101
 		}
94 102
 	}
95 103
 
104
+	/**
105
+	 * @param string $definition
106
+	 * @param string[] $match
107
+	 */
96 108
 	private function parseRange($definition, $match)
97 109
 	{
98 110
 		if (!empty($match[3])) {
Please login to merge, or discard this patch.
SwaggerGen/Swagger/Type/NumberType.php 1 patch
Doc Comments   +9 added lines patch added patch discarded remove patch
@@ -41,6 +41,9 @@  discard block
 block discarded – undo
41 41
 		$this->parseDefault($definition, $match);
42 42
 	}
43 43
 
44
+	/**
45
+	 * @param string[] $match
46
+	 */
44 47
 	private function parseFormat($definition, $match)
45 48
 	{
46 49
 		if (!isset(self::$formats[strtolower($match[1])])) {
@@ -49,6 +52,9 @@  discard block
 block discarded – undo
49 52
 		$this->format = self::$formats[strtolower($match[1])];
50 53
 	}
51 54
 
55
+	/**
56
+	 * @param string[] $match
57
+	 */
52 58
 	private function parseRange($definition, $match)
53 59
 	{
54 60
 		if (!empty($match[2])) {
@@ -67,6 +73,9 @@  discard block
 block discarded – undo
67 73
 		}
68 74
 	}
69 75
 
76
+	/**
77
+	 * @param string[] $match
78
+	 */
70 79
 	private function parseDefault($definition, $match)
71 80
 	{
72 81
 		$this->default = isset($match[6]) && $match[6] !== '' ? $this->validateDefault($match[6]) : null;
Please login to merge, or discard this patch.
SwaggerGen/Swagger/Type/IntegerType.php 1 patch
Doc Comments   +4 added lines patch added patch discarded remove patch
@@ -81,6 +81,10 @@
 block discarded – undo
81 81
 		}
82 82
 	}
83 83
 
84
+	/**
85
+	 * @param string $definition
86
+	 * @param string[] $match
87
+	 */
84 88
 	private function parseDefault($definition, $match)
85 89
 	{
86 90
 		$this->default = isset($match[6]) && $match[6] !== '' ? $this->validateDefault($match[6]) : null;
Please login to merge, or discard this patch.
SwaggerGen/Swagger/Type/AbstractRegexType.php 1 patch
Upper-Lower-Casing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -45,7 +45,7 @@  discard block
 block discarded – undo
45 45
 
46 46
 		$match = array();
47 47
 		if (preg_match(self::REGEX_START . self::REGEX_FORMAT . self::REGEX_DEFAULT_START . $this->regex . self::REGEX_DEFAULT_END . self::REGEX_END, $definition, $match) !== 1) {
48
-			throw new \SwaggerGen\Exception("Unparseable {$this->format} definition: '{$definition}'");
48
+			throw new \SwaggerGen\Exception("unparseable {$this->format} definition: '{$definition}'");
49 49
 		}
50 50
 
51 51
 		if (strtolower($match[1] !== $this->format)) {
@@ -61,7 +61,7 @@  discard block
 block discarded – undo
61 61
 		$value = parent::validateDefault($value);
62 62
 		
63 63
 		if (preg_match('/' . $this->pattern . '/', $value) !== 1) {
64
-			throw new \SwaggerGen\Exception("Invalid {$this->format} default value");
64
+			throw new \SwaggerGen\Exception("invalid {$this->format} default value");
65 65
 		}
66 66
 		
67 67
 		return $value;
Please login to merge, or discard this patch.
SwaggerGen/Swagger/Type/StringType.php 1 patch
Upper-Lower-Casing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -161,7 +161,7 @@  discard block
 block discarded – undo
161 161
 	{
162 162
 		if (empty($value)) {
163 163
 			$type = $this->format ?: ($this->enum ? 'enum' : 'string');
164
-			throw new \SwaggerGen\Exception("Empty {$type} default");
164
+			throw new \SwaggerGen\Exception("empty {$type} default");
165 165
 		}
166 166
 
167 167
 		if (!empty($this->enum) && !in_array($value, $this->enum)) {
@@ -170,12 +170,12 @@  discard block
 block discarded – undo
170 170
 
171 171
 		if ($this->maxLength !== null && mb_strlen($value) > $this->maxLength) {
172 172
 			$type = $this->format ?: ($this->enum ? 'enum' : 'string');
173
-			throw new \SwaggerGen\Exception("Default {$type} length beyond maximum: '{$value}'");
173
+			throw new \SwaggerGen\Exception("default {$type} length beyond maximum: '{$value}'");
174 174
 		}
175 175
 
176 176
 		if ($this->minLength !== null && mb_strlen($value) < $this->minLength) {
177 177
 			$type = $this->format ?: ($this->enum ? 'enum' : 'string');
178
-			throw new \SwaggerGen\Exception("Default {$type} length beyond minimum: '{$value}'");
178
+			throw new \SwaggerGen\Exception("default {$type} length beyond minimum: '{$value}'");
179 179
 		}
180 180
 
181 181
 		return $value;
Please login to merge, or discard this patch.
SwaggerGen/SwaggerGen.php 1 patch
Doc Comments   +6 added lines patch added patch discarded remove patch
@@ -49,11 +49,17 @@
 block discarded – undo
49 49
 		$this->dirs = $dirs;
50 50
 	}
51 51
 
52
+	/**
53
+	 * @param string $name
54
+	 */
52 55
 	public function define($name, $value = 1)
53 56
 	{
54 57
 		$this->defines[$name] = $value;
55 58
 	}
56 59
 
60
+	/**
61
+	 * @param string $name
62
+	 */
57 63
 	public function undefine($name)
58 64
 	{
59 65
 		unset($this->defines[$name]);
Please login to merge, or discard this patch.
tests/bootstrap.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -15,6 +15,9 @@
 block discarded – undo
15 15
 class SwaggerGen_TestCase extends PHPUnit\Framework\TestCase
16 16
 {
17 17
 
18
+	/**
19
+	 * @param string $exception
20
+	 */
18 21
 	public function expectException($exception, $message = '')
19 22
 	{
20 23
 		// while setExpectedException accepts message to assert on, expectException does not
Please login to merge, or discard this patch.
SwaggerGen/Swagger/Type/ObjectType.php 1 patch
Doc Comments   +15 added lines patch added patch discarded remove patch
@@ -57,6 +57,10 @@  discard block
 block discarded – undo
57 57
 		$this->parseRange($definition, $match);
58 58
 	}
59 59
 
60
+	/**
61
+	 * @param string $definition
62
+	 * @param string[] $match
63
+	 */
60 64
 	private function parseFormat($definition, $match)
61 65
 	{
62 66
 		if (strtolower($match[1]) !== 'object') {
@@ -76,6 +80,10 @@  discard block
 block discarded – undo
76 80
 		$this->additionalProperties = $type;
77 81
 	}
78 82
 
83
+	/**
84
+	 * @param string $definition
85
+	 * @param string[] $match
86
+	 */
79 87
 	private function parseProperties($definition, $match)
80 88
 	{
81 89
 		if (empty($match[2])) {
@@ -105,6 +113,10 @@  discard block
 block discarded – undo
105 113
 
106 114
 	}
107 115
 
116
+	/**
117
+	 * @param string $definition
118
+	 * @param string[] $match
119
+	 */
108 120
 	private function parseRange($definition, $match)
109 121
 	{
110 122
 		if (!empty($match[3])) {
@@ -125,6 +137,9 @@  discard block
 block discarded – undo
125 137
 		}
126 138
 	}
127 139
 
140
+	/**
141
+	 * @param string|false $discriminator
142
+	 */
128 143
 	private function setDiscriminator($discriminator)
129 144
 	{
130 145
 		if (!empty($this->discriminator)) {
Please login to merge, or discard this patch.