lengthofrope/create-jsonld

Simple PHP library to create JSON-LD output.

1.1.2 2024-12-05 16:21 UTC

Requires

• php: >=8.1

Requires (Dev)

• twig/twig: ~3.0

MIT

• Bas de Kort

• JSON-LD
• jsonld

README

Simple PHP library to create JSON-LD output.

Usage:

use \LengthOfRope\JSONLD;
use \LengthOfRope\JSONLD\DataType;
use \LengthOfRope\JSONLD\Schema;

$Create = JSONLD\Create::factory()->add(
    Schema\Person::factory()
        ->setId("https://www.lengthofrope.nl/authors/#john-doe")
        ->setName(
            DataType\Text::factory()
                ->setValue("John Doe")
        )
        ->setEmail("[e-mail]")
)->add(
    Schema\Book::factory()
        ->setAuthor(
            Schema\Person::factory()
                ->setName("John Doe")
                ->setEmail("[e-mail]")
        )
        ->setAbout("PHP")
        ->setName("Superb PHP Book")
        ->setAlternateName("Book one of three")
)->add(
    Schema\Book::factory()
        ->setAuthor(
            Schema\Person::factory()
                ->setId("https://www.lengthofrope.nl/authors/#john-doe")
        )
        ->setAbout("PHP")
        ->setName("Superb PHP Book with a linked author")
        ->setAlternateName("Book two of three")
)->add(
    Schema\Book::factory()
        ->setAuthor(
            Schema\Person::factory()
                ->setId("https://www.lengthofrope.nl/authors/#john-doe")
        )
        ->setAbout("PHP")
        ->setName("A less known but still superb PHP Book with a linked author")
        ->setAlternateName("Book three of three")
)->add(
    Schema\Organization::factory()
        ->setAddress(
            Schema\PostalAddress::factory()
                ->setPostalCode("1234 AA")
                ->setStreetAddress("Somewhere 12")
                ->setAddressCountry("NL")
                ->setAddressLocality("Amersfoort")
                ->setEmail("[e-mail]")
                ->setTelephone("033-1234567")
                ->setAddressRegion("Utrecht")
        )
        ->setName("Devver Company")
        ->setDescription("Just another developer")
);

// Validate
if ($Create->validate()) {
    echo $Create->getJSONLDScript();
}

// Or try catch
try {
    echo $Create->getJSONLDScript();
} catch(TypeError $e) {
    echo $e->getMessage();
}

Version history

1.1.2

• Fix missing dataypes
• Allow adding nested Create objects to simulate arrays and keep validation working
• Add additional validation checks for new datatypes

1.1.1

• Add typehinting
• Add support for retuning arrays with objects

1.1.0

• Add basic validation for the introduced DataTypes
• Updated the example
• Remove obsolete development dependencies

1.0.2

• Add support for linking with the @id property
• Updated the example in readme.md

1.0.1

• Restructured comments
• Added @see with link to schema.org

1.0.0

• Removed Schema word from all classes breaking change!
• Added underscores to classes that have a reserved name or start with a number

0.9.X

• Initial development versions