psx/atom

Model classes to generate an Atom specification in a type-safe way

dev-main 2023-04-07 13:47 UTC

Requires

• php: >=8.1
• psx/record: ^3.0

Requires (Dev)

• phpunit/phpunit: ^9.0
• psx/schema: ^5.0
• symfony/yaml: ^4.0|^5.0
• vimeo/psalm: ^4.0

Apache-2.0

• Christoph Kappestein

• model
• atom
• dto

README

About

This library contains model classes to generate an Atom specification in a type-safe way. The models are automatically generated based on the TypeSchema specification (s. typeschema.json). The following example shows how you can generate an Atom spec:

$person = new Person();
$person->setName('foobar');
$person->setUri('http://foo.com');
$person->setEmail('[e-mail]');

$text = new Text();
$text->setContent('foobar');

$entry = new Entry();
$entry->setAuthor([$person]);
$entry->setContent($text);
$entry->setId('http://localhost.com#1');
$entry->setTitle('Star City');
$entry->setPublished(LocalDateTime::from(new \DateTime('Tue, 10 Jun 2003 04:00:00 GMT')));

$atom = new Atom();
$atom->setId('http://localhost.com');
$atom->setTitle('Foo has bar');
$atom->setUpdated(LocalDateTime::from(new \DateTime('Tue, 10 Jun 2003 04:00:00 GMT')));
$atom->setEntry([$entry]);

echo json_encode($asyncAPI, JSON_PRETTY_PRINT);

This would result in the following JSON:

{
  "id": "http:\/\/localhost.com",
  "title": "Foo has bar",
  "updated": "2003-06-10T04:00:00Z",
  "entry": [
    {
      "author": [
        {
          "name": "foobar",
          "uri": "http:\/\/foo.com",
          "email": "[e-mail]"
        }
      ],
      "content": {
        "content": "foobar"
      },
      "id": "http:\/\/localhost.com#1",
      "published": "2003-06-10T04:00:00Z",
      "title": "Star City"
    }
  ]
}

Contribution

If you want to suggest changes please only change the typeschema.json specification and then run the php gen.php script to regenerate all model classes.