forked from cebe/php-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWriter.php
More file actions
65 lines (58 loc) · 2.13 KB
/
Writer.php
File metadata and controls
65 lines (58 loc) · 2.13 KB
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
<?php
/**
* @copyright Copyright (c) 2018 Carsten Brandt <mail@cebe.cc> and contributors
* @license https://github.com/cebe/php-openapi/blob/master/LICENSE
*/
namespace cebe\openapi;
use cebe\openapi\exceptions\IOException;
use cebe\openapi\spec\OpenApi;
use Symfony\Component\Yaml\Yaml;
/**
* Utility class to simplify writing JSON or YAML OpenAPI specs.
*
*/
class Writer
{
/**
* Convert OpenAPI spec object to JSON data.
* @param SpecObjectInterface|OpenApi $object the OpenApi object instance.
* @return string JSON string.
*/
public static function writeToJson(SpecObjectInterface $object): string
{
return json_encode($object->getSerializableData(), JSON_PRETTY_PRINT);
}
/**
* Convert OpenAPI spec object to YAML data.
* @param SpecObjectInterface|OpenApi $object the OpenApi object instance.
* @return string YAML string.
*/
public static function writeToYaml(SpecObjectInterface $object): string
{
return Yaml::dump($object->getSerializableData(), 256, 2, Yaml::DUMP_OBJECT_AS_MAP | Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE);
}
/**
* Write OpenAPI spec object to JSON file.
* @param SpecObjectInterface|OpenApi $object the OpenApi object instance.
* @param string $fileName file name to write to.
* @throws IOException when writing the file fails.
*/
public static function writeToJsonFile(SpecObjectInterface $object, string $fileName): void
{
if (file_put_contents($fileName, static::writeToJson($object)) === false) {
throw new IOException("Failed to write file: '$fileName'");
}
}
/**
* Write OpenAPI spec object to YAML file.
* @param SpecObjectInterface|OpenApi $object the OpenApi object instance.
* @param string $fileName file name to write to.
* @throws IOException when writing the file fails.
*/
public static function writeToYamlFile(SpecObjectInterface $object, string $fileName): void
{
if (file_put_contents($fileName, static::writeToYaml($object)) === false) {
throw new IOException("Failed to write file: '$fileName'");
}
}
}