Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swaggest/php-code-builder
JSON Schema enabled PHP code building abstraction for PHP
https://github.com/swaggest/php-code-builder
code-generator json-schema php
Last synced: 7 days ago
JSON representation
JSON Schema enabled PHP code building abstraction for PHP
- Host: GitHub
- URL: https://github.com/swaggest/php-code-builder
- Owner: swaggest
- License: mit
- Created: 2017-04-28T06:35:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-19T17:20:52.000Z (11 months ago)
- Last Synced: 2024-12-30T00:10:10.011Z (14 days ago)
- Topics: code-generator, json-schema, php
- Language: PHP
- Homepage:
- Size: 557 KB
- Stars: 74
- Watchers: 2
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Swaggest JSON-schema enabled PHP code builder
[](https://travis-ci.org/swaggest/php-code-builder)
[](https://scrutinizer-ci.com/g/swaggest/php-code-builder/?branch=master)
[](https://codeclimate.com/github/swaggest/php-code-builder)
[](https://codecov.io/gh/swaggest/php-code-builder)
This library generates PHP mapping structures defined by [JSON schema](http://json-schema.org/)
using [`swaggest/json-schema`](https://github.com/swaggest/php-json-schema).
## Example
[Generated code](tests/src/Tmp/Example)
You need to add `swaggest/json-schema` to your dependencies.
```php
setNamespaceRoot($appNs, '.');
$builder = new \Swaggest\PhpCodeBuilder\JsonSchema\PhpBuilder();
$builder->buildSetters = true;
$builder->makeEnumConstants = true;
$builder->classCreatedHook = new \Swaggest\PhpCodeBuilder\JsonSchema\ClassHookCallback(
function (\Swaggest\PhpCodeBuilder\PhpClass $class, $path, $schema) use ($app, $appNs) {
$desc = '';
if ($schema->title) {
$desc = $schema->title;
}
if ($schema->description) {
$desc .= "\n" . $schema->description;
}
if ($fromRefs = $schema->getFromRefs()) {
$desc .= "\nBuilt from " . implode("\n" . ' <- ', $fromRefs);
}
$class->setDescription(trim($desc));
$class->setNamespace($appNs);
if ('#' === $path) {
$class->setName('User'); // Class name for root schema
} elseif (strpos($path, '#/definitions/') === 0) {
$class->setName(\Swaggest\PhpCodeBuilder\PhpCode::makePhpClassName(
substr($path, strlen('#/definitions/'))));
}
$app->addClass($class);
}
);
$builder->getType($swaggerSchema);
$app->clearOldFiles($appPath);
$app->store($appPath);
```
Creating and exporting an instance
```php
$user = new \Swaggest\PhpCodeBuilder\Tests\Tmp\Example\User();
$user->name = "John";
$user->info = (new \Swaggest\PhpCodeBuilder\Tests\Tmp\Example\Info())
->setLastName("Doe")
->setBirthDate("1980-01-01")
->setOptions(
(new \Swaggest\PhpCodeBuilder\Tests\Tmp\Example\Options())
->setRememberSession(true)
->setAllowNotifications(false)
);
// No exception on exporting valid data
$jsonData = \Swaggest\PhpCodeBuilder\Tests\Tmp\Example\User::export($user);
// {"name":"John","info":{"lastName":"Doe","birthDate":"1980-01-01","options":{"rememberSession":true,"allowNotifications":false}}}
echo json_encode($jsonData);
// Setting invalid value (integer instead of string)
$user->name = 123;
// Exception: String expected, 123 received at #->$ref[#]->properties:name
$jsonData = \Swaggest\PhpCodeBuilder\Tests\Tmp\Example\User::export($user);
```
Creating class instance from raw data
```php
// Importing raw data to entity class instance will do validation and mapping
$user = \Swaggest\PhpCodeBuilder\Tests\Tmp\Example\User::import(
json_decode('{"name":"John","info":{"lastName":"Doe","birthDate":"1980-01-01","options":{"rememberSession":true,"allowNotifications":false}}}')
);
var_dump($user->info->options->allowNotifications); // bool(false)
```
## CLI Tool
You can use [json-cli](https://github.com/swaggest/json-cli#genphp) to render JSON Schema into PHP classes from command line.