README

A library that implements the php-extended/php-json-schema-generator-interface interface library.

Installation

The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.

• Download composer.phar from their website.
• Then run the following command to install this library as dependency :
• php composer.phar php-extended/php-json-schema-generator-object ^8

Building the library

To add a new string parsed format, we use the following to build json schemas :

{
    "properties": {
        "<field_name>": {
            "type": "string",
            "description": "<description>",
            "format": "<new_type_to_be_parsed>"
        }
    }
}

Then, the new type should be added into the JsonSchemaDefaultVisitor, the JsonSchemaCalculatedVisitor, the JsonSchemaTypeVisitor, and the JsonSchemaTestUsesVisitor with an adequate test case should be created for it to pass the 100% coverage.

Actually, the parseable types as strings are as follow :

• accept-language-chain : yields a PhpExtended\AcceptLanguage\AcceptLanguageChainInterface
• date : yields a \DateTimeImmutable
• date : yields a \DateTimeImmutable
• email : yields a PhpExtended\EmailAddress\EmailAddressInterface
• email-list : yields a PhpExtended\Email\EmailAddressListInterface
• mailbox : yields a PhpExtended\Email\MailboxInterface
• mailbox-list : yields a PhpExtended\Email\MailboxListInterface
• time : yields a \DateTimeImmutable
• siren : yields a PhpExtended\Siret\SirenInterface
• siret : yields a PhpExtended\Siret\SiretInterface
• uri : yields a Psr\Http\Message\UriInterface
• uri-reference : yields a Psr\Http\Message\UriInterface
• uri-template : yields a Psr\Http\Message\UriInterface
• iri : yields a Psr\Http\Message\UriInterface
• iri-reference : yields a Psr\Http\Message\UriInterface
• uuid : yields a PhpExtended\Uri\UriInterface
• version : yields a PhpExtended\Version\VersionInterface

Basic Usage

This library may be used the following way :

use PhpExtended\JsonSchema\JsonSchemaFileGeneratorPhp74;
use PhpExtended\JsonSchema\JsonSchemaFileWriter;
use PhpExtended\JsonSchema\JsonSchemaProvider;
use PhpExtended\JsonSchema\NamespaceHolder;

/** @var $logger Psr\Logger\LoggerInterface */

$jsonSchemaProvider = new JsonSchemaProvider();
$jsonSchema = $jsonSchemaProvider->provideFromFile('</path/to/file/json-schema.json>');

$namespaces = new NamespaceHolder('NS\\Interfaces', 'NS\\Classes', 'NS\\Tests');
$generator = new JsonSchemaFileGeneratorPhp74($namespaces, 'interface/composer-package-name', 'classes/composer-package-name', 'tests/composer-package-name', $logger);
$fileCollection = $generator->generate($jsonSchema);

$fileWriter = new JsonSchemaFileWriter($logger, '/path/to/interfaces/src', '/path/to/classes/src', '/path/to/tests/src');
$fileWrite->write($fileCollection);

License

MIT (See license file).