https://github.com/cycle/schema-renderer
https://github.com/cycle/schema-renderer
hacktoberfest
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cycle/schema-renderer
- Owner: cycle
- License: mit
- Created: 2021-08-31T08:45:39.000Z (almost 5 years ago)
- Default Branch: 1.x
- Last Pushed: 2022-12-15T16:20:47.000Z (over 3 years ago)
- Last Synced: 2024-09-19T08:39:14.637Z (almost 2 years ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 65.4 KB
- Stars: 10
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cycle ORM Schema renderer
[](https://packagist.org/packages/cycle/schema-renderer)
[](https://github.com/cycle/schema-renderer/actions/workflows/main.yml)
[](https://github.com/cycle/schema-renderer/actions/workflows/static.yml)
[](https://scrutinizer-ci.com/g/cycle/schema-renderer/?branch=1.x)
[](https://codecov.io/gh/cycle/schema-renderer/)
This package may be used to render Cycle ORM Schema in a terminal or generate php representation.
## Installation
The preferred way to install this package is through [Composer](https://getcomposer.org/download/):
```bash
composer require cycle/schema-renderer
```
## Example
### Convert schema to array
```php
$schema = new Schema([...]);
$converter = new \Cycle\Schema\Renderer\SchemaToArrayConverter();
$schemaArray = $converter->convert($schema);
```
If passed `SchemaInterface` doesn't contain `toArray()` method then the `SchemaToArrayConverter` will convert
only common properties from `Cycle\ORM\SchemaInterface`. Null values will be skipped also.
In this case Iif you want to use custom properties you can pass them to the constructor
```php
$converter = new \Cycle\Schema\Renderer\SchemaToArrayConverter();
$schemaArray = $converter->convert($schema, [
42,
CustomClass::CUSTOM_PROPERTY,
...
]);
```
### Render schema to a terminal
```php
use Cycle\Schema\Renderer\OutputSchemaRenderer;
$output = new \Symfony\Component\Console\Output\ConsoleOutput();
$renderer = new OutputSchemaRenderer(colorize: true);
$output->write($renderer->render($schemaArray));
```
By default, `DefaultSchemaOutputRenderer` renders in template only common properties and relations.
Custom properties will be rendered as is in separated block.
If you want to extend default rendering template you can create custom renderers and add them to the Output renderer.
```php
use Cycle\Schema\Renderer\ConsoleRenderer\Renderer;
use Cycle\Schema\Renderer\ConsoleRenderer\Formatter;
use Cycle\Schema\Renderer\OutputSchemaRenderer;
class CustomPropertyRenderer implements Renderer {
public function render(Formatter $formatter, array $schema, string $role): string
{
$data = $schema['my_custom_property'] ?? null;
return \sprintf(
'%s: %s',
$formatter->title($this->title),
$data === null ? $formatter->error('not defined') : $formatter->typecast($data)
);
}
}
$renderer = new OutputSchemaRenderer();
$renderer->addRenderer(
new CustomPropertyRenderer(),
new PropertyRenderer('my_custom_property', 'My super property')
);
$output->write($renderer->render($schemaArray))
```
### Store schema in a PHP file
```php
use Cycle\Schema\Renderer\PhpSchemaRenderer;
$path = __DIR__. '/schema.php'
$renderer = new PhpSchemaRenderer();
\file_put_contents($path, $renderer->render($schemaArray));
```
The Renderer generates valid PHP code, in which constants from Cycle ORM classes are substituted
for better readability.
## License:
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
Maintained by [Spiral Scout](https://spiralscout.com).