A Fluent Builder For Schema.org Types And ld+json Generator
spatie/schema-org provides a fluent builder for all Schema.org types and their properties. The code in src is generated from Schema.org's JSON-LD standards file, so it provides objects and methods for the entire core vocabulary. The classes and methods are also fully documented as a quick reference.
use Spatie\SchemaOrg\Schema;
$localBusiness = Schema::localBusiness()
->name('Spatie')
->email('[email protected]')
->contactPoint(Schema::contactPoint()->areaServed('Worldwide'));
echo $localBusiness->toScript();<script type="application/ld+json">
{
"@context": "https:\/\/schema.org",
"@type": "LocalBusiness",
"name": "Spatie",
"email": "[email protected]",
"contactPoint": {
"@type": "ContactPoint",
"areaServed": "Worldwide"
}
}
</script>Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/schema-orgUsage
All types can be instantiated through the Spatie\SchemaOrg\Schema factory class, or with the new keyword.
$localBusiness = Schema::localBusiness()->name('Spatie');
// Is equivalent to:
$localBusiness = new LocalBusiness();
$localBusiness->name('Spatie');All types also accept arrays of the expected data type, for example
sameAsaccepts a string or an array of strings.
All types also implement the SPL's ArrayAccess for accessing the properties via array notation:
$anotherLocalBusiness = new LocalBusiness();
var_dump(isset($anotherLocalBusiness['name'])); // => false
$anotherLocalBusiness['name'] = 'Spatie';
var_dump(isset($anotherLocalBusiness['name'])); // => true
var_dump($anotherLocalBusiness['name']); // => 'Spatie'
unset($anotherLocalBusiness['name']);
var_dump(isset($anotherLocalBusiness['name'])); // => falseTypes can be converted to an array or rendered to a script.
$localBusiness->toArray();
echo $localBusiness->toScript();
echo $localBusiness; // Same output as `toScript()`Additionally, all types can be converted to a plain JSON string by just calling json_encode() with your object:
echo json_encode($localBusiness);I recommend double checking your structured data with Google's structured data testing tool.
Enumerations
As of v1.6.0, all Enumeration child types are available as classes with constants.
Schema::book()->bookFormat(Spatie\SchemaOrg\BookFormatType::Hardcover);There's no full API documentation for types and properties. You can refer to the source or to the schema.org website.
If you don't want to break the chain of a large schema object, you can use the if method to conditionally modify the schema.
use Spatie\SchemaOrg\LocalBusiness;
use Spatie\SchemaOrg\Schema;
$business = ['name' => 'Spatie'];
$localBusiness = Schema::localBusiness()
->name($business['name'])
->if(isset($business['email']), function (LocalBusiness $schema) use ($business) {
$schema->email($business['email']);
});Identifier
As of v2.6.0 the identifier key is replaced by @id for simple string identifiers. This is due to the definition for the ld+json syntax.
All schema.org syntaxes already have built-in representation for URIs and URLs, e.g. in Microdata 'itemid', in RDFa 1.1, 'resource', in JSON-LD, '@id'.
โ schema.org/docs // PR#102 // PR#157
Advanced Usage
If you'd need to set a custom property, you can use the setProperty method.
$localBusiness->setProperty('foo', 'bar');If you'd need to retrieve a property, you can use the getProperty method. You can optionally pass in a second parameter to provide a default value.
$localBusiness->getProperty('name'); // 'Spatie'
$localBusiness->getProperty('bar'); // null
$localBusiness->getProperty('bar', 'baz'); // 'baz'All properties can be retrieved as an array with the getProperties method.
$localBusiness->getProperties(); // ['name' => 'Spatie', ...]Multiple properties can be set at once using the addProperties method.
$localBusiness->addProperties(['name' => 'value', 'foo' => 'bar']);Context and type can be retrieved with the getContext and getType methods.
$localBusiness->getContext(); // 'https://schema.org'
$localBusiness->getType(); // 'LocalBusiness'Graph - multiple items
The Graph has a lot of methods and utilities - the type-safe and simplest way is to use the overloaded methods of the Spatie\SchemaOrg\Schema class itself. These methods will get an already created or new instance of the requested schema.
$graph = new Graph();
// Create a product and prelink organization
$graph
->product()
->name('My cool Product')
->brand($graph->organization());
// Hide the organization from the created script tag
$graph->hide(\Spatie\SchemaOrg\Organization::class);
// Somewhere else fill out the organization
$graph
->organization()
->name('My awesome Company');
// Render graph to script tag
echo $graph;With these tools the graph is a collection of all available schemas, can link these schemas with each other and prevent helper schemas from being rendered in the script-tag.
Graph Node identifiers
Sometimes you have to keep track of multiple Graph nodes of the same type - for example multiple Person nodes for different people in your Organization.
To do so you are able to use node identifiers on your graph instance.
If you don't provide an identifier a reserved keyword default identifier will be used.
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Person;
$graph = new Graph();
// add a Person using chaining
$graph->person('freekmurze')
->givenName('Freek')
->familyName('Van der Herten')
->alternateName('freekmurze');
// add a Person using closure
$graph->person('sebastiandedeyne', function(Person $sebastian, Graph $graph): void {
$sebastian
->givenName('Sebastian')
->familyName('De Deyne')
->alternateName('sebastiandedeyne');
});
// add a person using closure and second call with same identifier
$graph->person(
'gummibeer',
fn(Person $gummibeer) => $gummibeer->alternateName('gummibeer')
);
$graph->person('gummibeer')
->givenName('Tom')
->familyName('Witkowski');
$graph->person('random')->name('Random Person');
// hide the random person from Graph
$graph->hide(Person::class, 'random');
echo json_encode($graph);{
"@context":"https:\/\/schema.org",
"@graph":[
{
"@type":"Person",
"givenName":"Freek",
"familyName":"Van der Herten",
"alternateName":"freekmurze"
},
{
"@type":"Person",
"givenName":"Sebastian",
"familyName":"De Deyne",
"alternateName":"sebastiandedeyne"
},
{
"@type":"Person",
"alternateName":"gummibeer",
"givenName":"Tom",
"familyName":"Witkowski"
}
]
}Multi Typed Entities
Schema.org allows multi typed entities - to use them with this package you can use the MultiTypedEntity class - which works similar to the graph.
$mte = new MultiTypedEntity();
$mte->hotelRoom()->name('The Presidential Suite');
$mte->product()->offers(
Schema::offer()
->name('One Night')
->price(100000.00)
->priceCurrency('USD')
);
$mte->product(function (Product $product) {
$product->aggregateRating(
Schema::aggregateRating()
->bestRating(5)
->worstRating(4)
);
});
echo json_encode($mte);{
"@context":"https:\/\/schema.org",
"@type":[
"HotelRoom",
"Product"
],
"name":"The Presidential Suite",
"offers":{
"@type":"Offer",
"name":"One Night",
"price":100000,
"priceCurrency":"USD"
},
"aggregateRating":{
"@type":"AggregateRating",
"bestRating":5,
"worstRating":4
}
}There isn't a real rule in place how the properties are merged. It only uses array_merge() behind the scenes. So you should avoid defining the same property on different types in the MTE or be sure that all properties hold the same value that it's not important which property is used at the end.
Known Issues
- The
Floattype isn't available since it's a reserved keyword in PHP - The
Physiciantype isn't available since it extends a type from thehealthextension spec
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer testContributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
License
The MIT License (MIT). Please see License File for more information.