@@ -35,6 +35,9 @@ |
||
| 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); |
@@ -69,6 +69,10 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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])) { |
@@ -41,6 +41,9 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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; |
@@ -81,6 +81,10 @@ |
||
| 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; |
@@ -51,10 +51,10 @@ discard block |
||
| 51 | 51 | */ |
| 52 | 52 | private $title = null; |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @var bool |
|
| 56 | - */ |
|
| 57 | - private $readOnly = null; |
|
| 54 | + /** |
|
| 55 | + * @var bool |
|
| 56 | + */ |
|
| 57 | + private $readOnly = null; |
|
| 58 | 58 | |
| 59 | 59 | /** |
| 60 | 60 | * @var \SwaggerGen\Swagger\Type\AbstractType |
@@ -118,7 +118,7 @@ discard block |
||
| 118 | 118 | return self::arrayFilterNull(array_merge($this->type->toArray(), array( |
| 119 | 119 | 'title' => empty($this->title) ? null : $this->title, |
| 120 | 120 | 'description' => empty($this->description) ? null : $this->description, |
| 121 | - 'readOnly' => $this->readOnly |
|
| 121 | + 'readOnly' => $this->readOnly |
|
| 122 | 122 | ), parent::toArray())); |
| 123 | 123 | } |
| 124 | 124 | |
@@ -127,9 +127,9 @@ discard block |
||
| 127 | 127 | return __CLASS__; |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - public function setReadOnly() |
|
| 131 | - { |
|
| 132 | - $this->readOnly = true; |
|
| 133 | - } |
|
| 130 | + public function setReadOnly() |
|
| 131 | + { |
|
| 132 | + $this->readOnly = true; |
|
| 133 | + } |
|
| 134 | 134 | |
| 135 | 135 | } |
@@ -49,11 +49,17 @@ |
||
| 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]); |
@@ -337,23 +337,23 @@ |
||
| 337 | 337 | . ',"tags":[{"name":"Test"}]}', json_encode($array, JSON_NUMERIC_CHECK)); |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | - public function testObjectPropertiesReadOnly() |
|
| 341 | - { |
|
| 342 | - $object = new \SwaggerGen\SwaggerGen(); |
|
| 343 | - $array = $object->getSwagger(array(' |
|
| 340 | + public function testObjectPropertiesReadOnly() |
|
| 341 | + { |
|
| 342 | + $object = new \SwaggerGen\SwaggerGen(); |
|
| 343 | + $array = $object->getSwagger(array(' |
|
| 344 | 344 | api Test |
| 345 | 345 | endpoint /test |
| 346 | 346 | method GET something |
| 347 | 347 | response 200 object(a!:array(A),b:array(B)) |
| 348 | 348 | ')); |
| 349 | 349 | |
| 350 | - $this->assertSame('{"swagger":2,"info":{"title":"undefined","version":0}' |
|
| 351 | - . ',"paths":{"\/test":{"get":{"tags":["Test"],"summary":"something"' |
|
| 352 | - . ',"responses":{"200":{"description":"OK","schema":{"type":"object","required":["b"]' |
|
| 353 | - . ',"properties":{"a":{"type":"array","items":{"$ref":"#\/definitions\/A"}}' |
|
| 354 | - . ',"b":{"type":"array","items":{"$ref":"#\/definitions\/B"}}}}}}}}}' |
|
| 355 | - . ',"tags":[{"name":"Test"}]}', json_encode($array, JSON_NUMERIC_CHECK)); |
|
| 356 | - } |
|
| 350 | + $this->assertSame('{"swagger":2,"info":{"title":"undefined","version":0}' |
|
| 351 | + . ',"paths":{"\/test":{"get":{"tags":["Test"],"summary":"something"' |
|
| 352 | + . ',"responses":{"200":{"description":"OK","schema":{"type":"object","required":["b"]' |
|
| 353 | + . ',"properties":{"a":{"type":"array","items":{"$ref":"#\/definitions\/A"}}' |
|
| 354 | + . ',"b":{"type":"array","items":{"$ref":"#\/definitions\/B"}}}}}}}}}' |
|
| 355 | + . ',"tags":[{"name":"Test"}]}', json_encode($array, JSON_NUMERIC_CHECK)); |
|
| 356 | + } |
|
| 357 | 357 | |
| 358 | 358 | public function testDeepObjectProperties() |
| 359 | 359 | { |
@@ -81,20 +81,20 @@ |
||
| 81 | 81 | ), $object->toArray()); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * @covers \SwaggerGen\Swagger\Type\PropertyType::__construct |
|
| 86 | - */ |
|
| 87 | - public function testConstructReadOnly() |
|
| 88 | - { |
|
| 89 | - $object = new SwaggerGen\Swagger\Type\Property($this->parent, 'string', 'Some words here', true); |
|
| 90 | - $this->assertInstanceOf('\SwaggerGen\Swagger\Type\Property', $object); |
|
| 91 | - |
|
| 92 | - $this->assertSame(array( |
|
| 93 | - 'type' => 'string', |
|
| 94 | - 'description' => 'Some words here', |
|
| 95 | - 'readOnly' => true |
|
| 96 | - ), $object->toArray()); |
|
| 97 | - } |
|
| 84 | + /** |
|
| 85 | + * @covers \SwaggerGen\Swagger\Type\PropertyType::__construct |
|
| 86 | + */ |
|
| 87 | + public function testConstructReadOnly() |
|
| 88 | + { |
|
| 89 | + $object = new SwaggerGen\Swagger\Type\Property($this->parent, 'string', 'Some words here', true); |
|
| 90 | + $this->assertInstanceOf('\SwaggerGen\Swagger\Type\Property', $object); |
|
| 91 | + |
|
| 92 | + $this->assertSame(array( |
|
| 93 | + 'type' => 'string', |
|
| 94 | + 'description' => 'Some words here', |
|
| 95 | + 'readOnly' => true |
|
| 96 | + ), $object->toArray()); |
|
| 97 | + } |
|
| 98 | 98 | |
| 99 | 99 | /** |
| 100 | 100 | * @covers \SwaggerGen\Swagger\Type\PropertyType::__construct |
@@ -48,10 +48,10 @@ discard block |
||
| 48 | 48 | */ |
| 49 | 49 | private $description; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Whether property is read only |
|
| 53 | - * @var bool |
|
| 54 | - */ |
|
| 51 | + /** |
|
| 52 | + * Whether property is read only |
|
| 53 | + * @var bool |
|
| 54 | + */ |
|
| 55 | 55 | private $readOnly; |
| 56 | 56 | |
| 57 | 57 | /** |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | * @param \SwaggerGen\Swagger\AbstractObject $parent |
| 66 | 66 | * @param string $definition Either a built-in type or a definition name |
| 67 | 67 | * @param string $description description of the property |
| 68 | - * @param bool $readOnly Whether the property is read only |
|
| 68 | + * @param bool $readOnly Whether the property is read only |
|
| 69 | 69 | * @throws \SwaggerGen\Exception |
| 70 | 70 | */ |
| 71 | 71 | public function __construct(\SwaggerGen\Swagger\AbstractObject $parent, $definition, $description = null, $readOnly = null) |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | |
| 131 | 131 | return self::arrayFilterNull(array_merge($valueType, array( |
| 132 | 132 | 'description' => empty($this->description) ? null : $this->description, |
| 133 | - 'readOnly' => $this->readOnly |
|
| 133 | + 'readOnly' => $this->readOnly |
|
| 134 | 134 | ), parent::toArray())); |
| 135 | 135 | } |
| 136 | 136 | |