jsoncodegen-generator-php-psalm

jsoncodegen JSON to PHP (with Psalm) code generator.

Generates PHP classes from jsoncodegen interfaces.

Output directories

Type

Contains all the classes generated from interfaces & enums.

Builder

Contains builder classes for each interface. These ensure that all required fields are defined.

Use them like this:

$myObject = new MyObject(
  (new MyObjectBuilder())
    ->setName('Budapest')
    ->setFlag(true)
    ->setCount(3)
);

Assert

Contains assertion functions. These functions validate an object and throw an \Exception if the given object does not match the interface. They also ensure that Maps are handled correctly (wrapped into JsonMap). They can be called like this:

$myObject = getMyObjectFromSomewhere();
try {
  AssertMyObject::assert(myObject);
} catch (\Exception $e) {
  // $e indicates where the problem is
}

Util

Contains utilities used by assertions in the Assert folder.

Install

npm i -D jsoncodegen-generator-php-psalm

Config

Configuration can be put in jsoncodegen-generator-php-psalm.config.js and passed to jsoncodegen in the config parameter:

jsoncodegen --generator php-psalm --config jsoncodegen-generator-php-psalm.config.js ...

jsoncodegen-generator-php-psalm.config.js

export default {
	namespaceBase: 'MyCompany\\MyProject\\Json',
}

namespaceBase: string

Makes all namespaces use the given base. The necessary folders will not be created by this tool.

License

MIT

History

1.3.0 require → import

1.2.0 Use and support Psalm through composer only.

1.1.0 Check interface has no extra fields.

1.0.0 Initial version.