Spatie Schema.org

https://github.com/spatie/schema-org
Admin
A PHP library providing a fluent builder for all Schema.org types and their properties, facilitating...
Tokens:31,851
Snippets:304
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### ArrayAccess usage example

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Shows how to use the ArrayAccess methods with array notation on a LocalBusiness instance. Demonstrates isset, setting, and getting a property.

```php
$anotherLocalBusiness = new LocalBusiness();
var_dump(isset($anotherLocalBusiness['name'])); // => false
$anotherLocalBusiness['name'] = 'Spatie';
var_dump($anotherLocalBusiness['name']); // => 'Spatie'
unset($anotherLocalBusiness['name']);
```

--------------------------------

### Install spatie/schema-org via Composer

Source: https://github.com/spatie/schema-org/blob/main/README.md

Install the package via Composer.

```bash
composer require spatie/schema-org
```

--------------------------------

### Definitions constructor with core source

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/configuration.md

Example of creating a Definitions instance with a core source URL.

```php
new Definitions([
    'core' => 'https://raw.githubusercontent.com/schemaorg/schemaorg/main/data/releases/30.0/schemaorg-all-https.jsonld',
])
```

--------------------------------

### Contract Interfaces Code Examples

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/contracts.md

Code examples from the contract interfaces documentation.

```php
interface ThingContract
{
    public function additionalType($additionalType);

    public function alternateName($alternateName);

    public function description($description);

    public function disambiguatingDescription($disambiguatingDescription);

    public function identifier($identifier);

    public function url($url);
}
```

```php
interface LocalBusinessContract
{
    public function acceptedPaymentMethod($acceptedPaymentMethod);

    public function actionableFeedbackPolicy($actionableFeedbackPolicy);

    // ... (abridged)
}
```

```php
use Spatie\SchemaOrg\Schema;
use Spatie\SchemaOrg\Contracts\OrganizationContract;
use Spatie\SchemaOrg\Contracts\PersonContract;

function shipTo($party): void
{
    if ($party instanceof OrganizationContract) {
        // ...
    } elseif ($party instanceof PersonContract) {
        // ...
    }
}

$organization = Schema::organization()->name('Spatie');
$person = Schema::person()->givenName('Freek');

shipTo($organization);
shipTo($person);
```

```php
use Spatie\SchemaOrg\Contracts\LocalBusinessContract;

function fillContactDetails(LocalBusinessContract $business): void
{
    $business
        ->name('Spatie')
        ->email('info@spatie.be')
        ->telephone('+32 3 250 64 00');
}

fillContactDetails(Schema::localBusiness());
```

--------------------------------

### toArray() output example

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Example JSON-LD structure returned by toArray().

```json
{ "@context": "https://schema.org", "@type": "LocalBusiness", "...properties": "..." }
```

--------------------------------

### Graph constructor with array context

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/configuration.md

Example of constructing a Graph with an array context and outputting the script tag.

```php
$graph = new Graph([
    '@vocab' => 'https://schema.org/',
    '@base'  => 'https://domain.com/',
]);

echo $graph->toScript();
// {"@context":"https://schema.org","@graph":[...]}
```

--------------------------------

### Get all properties with getProperties

Source: https://github.com/spatie/schema-org/blob/main/README.md

Retrieve all properties as an array using getProperties.

```php
$localBusiness->getProperties(); // ['name' => 'Spatie', ...]
```

--------------------------------

### toArray() output example

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Example output of toArray() showing the @context, deduplicated @type array, and merged properties.

```json
{
  "@context": "https://schema.org",
  "@type": ["HotelRoom", "Product"],
  "...merged properties": "..."
}
```

--------------------------------

### Usage: Basic MTE

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Example of creating a MultiTypedEntity with multiple schema types and serializing it to JSON.

```APIDOC
## Usage: Basic MTE

### Description
Demonstrates how to create a MultiTypedEntity, add multiple schema types, and serialize to JSON.

### Example
```php
use Spatie\SchemaOrg\MultiTypedEntity;
use Spatie\SchemaOrg\Schema;

$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",...}
```
```

--------------------------------

### Error handling

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Demonstrates catching TypeAlreadyInGraph when adding a node with a taken identifier, and TypeNotInGraph when getting a non-existent node.

```php
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Organization;
use Spatie\SchemaOrg\Exceptions\TypeAlreadyInGraph;
use Spatie\SchemaOrg\Exceptions\TypeNotInGraph;

$graph = new Graph();
$graph->organization(); // creates node

try {
    $graph->add(new Organization()); // default identifier already taken
} catch (TypeAlreadyInGraph) {
    // rethrow or ignore
}

try {
    $graph->get('Spatie\SchemaOrg\Organization', 'missing');
} catch (TypeNotInGraph) {
    // node does not exist with this identifier
}
```

--------------------------------

### Access properties with ArrayAccess

Source: https://github.com/spatie/schema-org/blob/main/README.md

Demonstrates ArrayAccess implementation for accessing properties via array notation. Shows isset, set, get, and unset operations.

```php
$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'])); // => false
```

--------------------------------

### Usage: Error Handling

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Example of handling exceptions when adding a type that already exists or retrieving a type that is not present.

```APIDOC
## Usage: Error Handling

### Description
Demonstrates how to handle exceptions when adding a type that already exists or retrieving a type that is not present.

### Example
```php
use Spatie\SchemaOrg\MultiTypedEntity;
use Spatie\SchemaOrg\HotelRoom;
use Spatie\SchemaOrg\Exceptions\TypeAlreadyInMultiTypedEntity;
use Spatie\SchemaOrg\Exceptions\TypeNotInMultiTypedEntity;

$mte = new MultiTypedEntity();
$mte->hotelRoom();

try {
    $mte->add(new HotelRoom()); // already present
} catch (TypeAlreadyInMultiTypedEntity) {
    // handle duplicate
}

try {
    $mte->get('Spatie\SchemaOrg\Product');
} catch (TypeNotInMultiTypedEntity) {
    // node absent
}
```
```

--------------------------------

### Get context and type with getContext and getType

Source: https://github.com/spatie/schema-org/blob/main/README.md

Retrieve the context and type of a schema object using getContext and getType.

```php
$localBusiness->getContext(); // 'https://schema.org'
$localBusiness->getType(); // 'LocalBusiness'
```

--------------------------------

### Catching InvalidProperty

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/errors.md

Example of catching the InvalidProperty exception when serializing a type containing an unsupported object.

```pie
use Spatie\SchemaOrg\Exceptions\InvalidProperty;
use Spatie\SchemaOrg\Schema;

$type = Schema::localBusiness()->setProperty('attachment', new SomeObject());

try {
    $type->toArray();
    // won't get here: SomeObject has no __toString and is not a Type
} catch (InvalidProperty) {
    // convert the object to a string or a Type before serializing
}
```

--------------------------------

### get(string $type): Type

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Retrieves the stored node of the given type. Throws an exception if the type is not present.

```APIDOC
## get(string $type): Type

### Description
Retrieves the stored node of the given type. Throws an exception if the type is not present.

### Method
get

### Parameters
- `$type` (string) - Required - Fully qualified class name.

### Returns
`Type` - The stored node.

### Throws
- `TypeNotInMultiTypedEntity` when the type is absent.
```

--------------------------------

### Catching TypeNotInMultiTypedEntity

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/errors.md

Example of handling the TypeNotInMultiTypedEntity exception when a requested type is absent from the MultiTypedEntity.

```pie
use Spatie\SchemaOrg\MultiTypedEntity;
use Spatie\SchemaOrg\Exceptions\TypeNotInMultiTypedEntity;

$mte = new MultiTypedEntity();

try {
    $mte->get('Spatie\SchemaOrg\Product');
} catch (TypeNotInMultiTypedEntity) {
    // node absent
}
```

--------------------------------

### MultiTypedEntity error handling with TypeAlreadyInMultiTypedEntity and TypeNotInMultiTypedEntity

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Demonstrates error handling: adding a type that already exists throws TypeAlreadyInMultiTypedEntity, and getting a type not present throws TypeNotInMultiTypedEntity. Both exceptions are caught and handled.

```php
use Spatie\SchemaOrg\MultiTypedEntity;
use Spatie\SchemaOrg\HotelRoom;
use Spatie\SchemaOrg\Exceptions\TypeAlreadyInMultiTypedEntity;
use Spatie\SchemaOrg\Exceptions\TypeNotInMultiTypedEntity;

$mte = new MultiTypedEntity();
$mte->hotelRoom();

try {
    $mte->add(new HotelRoom()); // already present
} catch (TypeAlreadyInMultiTypedEntity) {
    // handle duplicate
}

try {
    $mte->get('Spatie\SchemaOrg\Product');
} catch (TypeNotInMultiTypedEntity) {
    // node absent
}
```

--------------------------------

### Catching TypeAlreadyInGraph Exception

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/errors.md

Example of catching the TypeAlreadyInGraph exception. Note that Graph::set() overwrites existing items instead of throwing this exception.

```php
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Organization;
use Spatie\SchemaOrg\Exceptions\TypeAlreadyInGraph;

$graph = new Graph();
$graph->add(new Organization());

try {
    $graph->add(new Organization(), 'default'); // already taken
} catch (TypeAlreadyInGraph) {
    // use a different identifier or set() to overwrite
}
```

--------------------------------

### get(string $type, string $identifier = self::IDENTIFIER_DEFAULT): Type

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Returns the stored node (Type). Throws TypeNotInGraph when absent.

```php
public function get(string $type, string $identifier = self::IDENTIFIER_DEFAULT): Type
{
    if (! $this->has($type, $identifier)) {
        throw new TypeNotInGraph(sprintf('The graph does not have an item of type "%s" with identifier "%s".', $type, $identifier));
    }

    return $this->nodes[$type][$identifier];
}
```

--------------------------------

### get(string $type): Type

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Returns the stored node for the given fully qualified class name. Throws TypeNotInMultiTypedEntity when absent.

```php
public function get(string $type): Type
{
    if (! $this->has($type)) {
        throw new TypeNotInMultiTypedEntity(sprintf('The multi typed entity does not have an item of type "%s".', $type));
    }

    return $this->nodes[$type];
}
```

--------------------------------

### generate.php entry point

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generator.md

Bootstraps the autoloader (own vendor/ or workspace root) and runs the console application.

```php
#!/usr/bin/env php
<?php

if (file_exists(__DIR__.'/vendor/autoload.php')) {
    require __DIR__.'/vendor/autoload.php';
} else {
    require __DIR__.'/../../autoload.php';
}

$application = new Spatie\SchemaOrg\Generator\Console\Application();

$application->run();
```

--------------------------------

### Basic fluent build with Schema factory

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows how to build a LocalBusiness schema using the Schema factory and output it in various formats.

```php
use Spatie\SchemaOrg\Schema;

$localBusiness = Schema::localBusiness()
    ->name('Spatie')
    ->email('info@spatie.be')
    ->contactPoint(Schema::contactPoint()->areaServed('Worldwide'));

echo $localBusiness->toArray();
echo $localBusiness->toScript();
echo $localBusiness; // same as toScript()
echo json_encode($localBusiness); // JsonSerializable: same structure as toArray()
```

--------------------------------

### Equivalence of Schema::localBusiness() and new LocalBusiness()

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/schema.md

Demonstrates that Schema::localBusiness() is equivalent to instantiating LocalBusiness directly.

```php
use Spatie\SchemaOrg\LocalBusiness;

$localBusiness = Schema::localBusiness()->name('Spatie');
$same = (new LocalBusiness())->name('Spatie');
```

--------------------------------

### Basic usage of Schema facade and toScript()

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/type-interface.md

Shows how to create schema types with the Schema facade and render them as JSON-LD script tags using toScript().

```php
use Spatie\SchemaOrg\Type;
use Spatie\SchemaOrg\Schema;

function dump(Type $schema): void {
    echo $schema->toScript();
}

dump(Schema::localBusiness()->name('Spatie'));
dump(Schema::offer()->price(9.99));
```

--------------------------------

### Instantiate schema types with Schema::localBusiness() or new LocalBusiness()

Source: https://github.com/spatie/schema-org/blob/main/README.md

Instantiate schema types using the Schema factory class or the new keyword. Both approaches are equivalent.

```php
$localBusiness = Schema::localBusiness()->name('Spatie');

// Is equivalent to:

$localBusiness = new LocalBusiness();
$localBusiness->name('Spatie');
```

--------------------------------

### Catching InvalidType Exception

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/errors.md

Example of how to catch the InvalidType exception when providing an invalid class name to the Graph.

```php
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Exceptions\InvalidType;

$graph = new Graph();

try {
    $graph->getOrCreate('Some\Class\That\Is\Not\AType');
} catch (InvalidType) {
    // handle invalid type name
}
```

--------------------------------

### Basic construction with Schema::localBusiness()

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/schema.md

Basic construction of a LocalBusiness object using the Schema factory, chaining methods and outputting the result as a script tag.

```php
use Spatie\SchemaOrg\Schema;

$localBusiness = Schema::localBusiness()
    ->name('Spatie')
    ->email('info@spatie.be')
    ->contactPoint(Schema::contactPoint()->areaServed('Worldwide'));

echo $localBusiness->toScript();
```

--------------------------------

### Create a MultiTypedEntity with HotelRoom and Product and output JSON

Source: https://github.com/spatie/schema-org/blob/main/README.md

Creates a MultiTypedEntity combining HotelRoom and Product types, adds properties via chaining and closures, and outputs the JSON representation. Properties are merged using array_merge() behind the scenes, so avoid defining the same property on different types unless the value is identical.

```php
$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);
```

```json
{
   "@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
   }
}
```

--------------------------------

### Create and render a Graph with linked product and organization

Source: https://github.com/spatie/schema-org/blob/main/README.md

Creates a Graph, adds a product with a linked organization, hides the organization from the rendered script tag, fills in the organization later, and outputs the graph as a script tag. Use this when you need to link multiple schema types and prevent helper schemas from being rendered.

```php
$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;
```

--------------------------------

### Basic graph with prelinked helper node

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Creates a Graph, adds a product with a prelinked organization, hides the organization from rendering, and fills it out later. The organization is still linked via @id.

```php
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Organization;

$graph = new Graph();

// Create a product and prelink the organization
$graph
    ->product()
    ->name('My cool Product')
    ->brand($graph->organization());

// Hide the organization from the rendered script tag
$graph->hide(Organization::class);

// Somewhere else fill out the organization
$graph
    ->organization()
    ->name('My awesome Company');

echo $graph; // only the Product is rendered; the Organization is still linked via @id
```

--------------------------------

### ArrayAccess + advanced property management

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows how to use ArrayAccess and property management methods on a LocalBusiness instance.

```php
use Spatie\SchemaOrg\LocalBusiness;

$localBusiness = (new LocalBusiness());

$localBusiness['name'] = 'Spatie';              // offsetSet
var_dump(isset($localBusiness['name']));        // offsetExists => true
var_dump($localBusiness['name']);               // offsetGet => 'Spatie'

$localBusiness->setProperty('foo', 'bar');       // custom property
$localBusiness->addProperties(['a' => 1, 'b' => 2]);
var_dump($localBusiness->getProperty('foo'));    // 'bar'
var_dump($localBusiness->getProperty('missing', 'fallback')); // 'fallback'
var_dump($localBusiness->getProperties());       // whole map

$localBusiness->if(true, function (LocalBusiness $schema) {
    $schema->email('info@spatie.be');
});

unset($localBusiness['name']);                   // offsetUnset
```

--------------------------------

### Basic array and script serialization

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Shows how to create a LocalBusiness instance, set properties, and output as array, script tag, and JSON. The toScript() output is a JSON-LD script tag, and json_encode($localBusiness) is identical to the toScript() payload.

```php
use Spatie\SchemaOrg\LocalBusiness;

$localBusiness = (new LocalBusiness())->name('Spatie')->email('info@spatie.be');
echo $localBusiness->toArray();
// ["@context" => "https://schema.org", "@type" => "LocalBusiness", "name" => "Spatie", "email" => "info@spatie.be"]

echo $localBusiness->toScript();
// <script type="application/ld+json">{"@context":"https://schema.org",...}</script>

echo json_encode($localBusiness); // identical to toScript() payload
```

--------------------------------

### PHP generate script help

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generator.md

Shows Symfony console help for the 'generate' command.

```bash
php ./generate.php --help    # Symfony console help for the 'generate' command
```

--------------------------------

### Basic MultiTypedEntity usage with HotelRoom and Product

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Shows basic usage of MultiTypedEntity: create an instance, add types via magic methods (hotelRoom, product), and chain properties. The output is a JSON-LD object with an @type array containing both types.

```php
use Spatie\SchemaOrg\MultiTypedEntity;
use Spatie\SchemaOrg\Schema;

$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",...}
```

--------------------------------

### Build and output a LocalBusiness schema with toScript()

Source: https://github.com/spatie/schema-org/blob/main/README.md

Build a LocalBusiness schema object with the fluent builder and output it as a JSON-LD script tag. The PHP code creates the object and calls toScript(), producing the HTML script shown.

```php
use Spatie\SchemaOrg\Schema;

$localBusiness = Schema::localBusiness()
    ->name('Spatie')
    ->email('info@spatie.be')
    ->contactPoint(Schema::contactPoint()->areaServed('Worldwide'));

echo $localBusiness->toScript();
```

```html
<script type="application/ld+json">
{
    "@context": "https:\/\/schema.org",
    "@type": "LocalBusiness",
    "name": "Spatie",
    "email": "info@spatie.be",
    "contactPoint": {
        "@type": "ContactPoint",
        "areaServed": "Worldwide"
    }
}
</script>
```

--------------------------------

### Using Schema methods with MultiTypedEntity

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/schema.md

Shows how Schema methods are used with MultiTypedEntity to create a combined entity with multiple types.

```php
use Spatie\SchemaOrg\MultiTypedEntity;

$mte = new MultiTypedEntity();
$mte->hotelRoom()->name('The Presidential Suite');
$mte->product()->offers(
    Schema::offer()->name('One Night')->price(100000.00)->priceCurrency('USD')
);
echo json_encode($mte);
```

--------------------------------

### Using Schema methods with Graph

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/schema.md

Shows how Schema static methods are consumed by Graph::__call, allowing magic methods on Graph instances.

```php
use Spatie\SchemaOrg\Graph;

$graph = new Graph();
$graph->product()->name('My cool Product')->brand($graph->organization());
$graph->organization()->name('My awesome Company');
echo $graph;
```

--------------------------------

### Run tests with composer test

Source: https://github.com/spatie/schema-org/blob/main/README.md

Runs the package's test suite using Composer. Use this command in the project root to execute all tests.

```bash
$ composer test
```

--------------------------------

### Show method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Controls visibility of graph nodes. If identifier is null, all nodes of the type are shown. If identifier is provided, only that node is shown while others remain hidden.

```php
public function show(string $type, ?string $identifier = self::IDENTIFIER_DEFAULT): self
{
    // show all
    if ($identifier === null) {
        unset($this->hidden[$type]);

        return $this;
    }

    // show single one if nothing configured
    if (! isset($this->hidden[$type])) {
        $this->hidden[$type][$identifier] = false;

        return $this;
    }

    // ignore if everything is shown
    if ($this->hidden[$type] === false) {
        return $this;
    }

    // show single one if identifier configuration exists
    if (is_array($this->hidden[$type])) {
        $this->hidden[$type][$identifier] = false;

        return $this;
    }

    if ($this->hidden[$type] === true) {
        $this->hidden[$type] = [];

        // keep everything hidden and show only single one
        if (isset($this->nodes[$type])) {
            foreach ($this->nodes[$type] as $id => $node) {
                $this->hidden[$type][$id] = $id !== $identifier;
            }

            return $this;
        }

        // show single one if no nodes exist
        $this->hidden[$type][$identifier] = false;

        return $this;
    }

    return $this;
}
```

--------------------------------

### Typical property method from src/Thing.php:141

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows the fluent method for the 'name' property, which accepts a string or array of strings and returns static for chaining.

```php
/**
 * The name of the item.
 *
 * @param string|string[] $name
 *
 * @return static
 *
 * @see https://schema.org/name
 */
public function name($name)
{
    return $this->setProperty('name', $name);
}
```

--------------------------------

### Composer generate command

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generator.md

Downloads schema.org v30.0 JSON-LD and regenerates everything.

```bash
composer generate            # download schema.org v30.0 JSON-LD, regenerate everything
```

--------------------------------

### Set multiple properties with addProperties

Source: https://github.com/spatie/schema-org/blob/main/README.md

Set multiple properties at once using addProperties.

```php
$localBusiness->addProperties(['name' => 'value', 'foo' => 'bar']);
```

--------------------------------

### getProperties Method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Returns the entire map of stored properties.

```pie
public function getProperties(): array
{
    return $this->properties;
}
```

--------------------------------

### addProperties Method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Sets multiple properties at once by iterating over an associative array.

```pie
public function addProperties(array $properties)
{
    foreach ($properties as $property => $value) {
        $this->setProperty($property, $value);
    }

    return $this;
}
```

--------------------------------

### Enumeration constants + script nonce

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows how to use an enumeration constant and set a nonce for the script tag.

```php
use Spatie\SchemaOrg\Schema;
use Spatie\SchemaOrg\BookFormatType;

$book = Schema::book()
    ->name('A Tale of Two Cities')
    ->bookFormat(BookFormatType::Hardcover)
    ->setNonce('abc123');

echo $book->toScript();
// <script type="application/ld+json" nonce="abc123">{...}</script>
```

--------------------------------

### getContext method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Returns the context string or array, defaulting to 'https://schema.org'.

```php
public function getContext(): string|array
{
    return $this->context ?? 'https://schema.org';
}
```

--------------------------------

### Constructor

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Constructor for Graph. The context parameter can be a string, array, or null. When null, getContext() returns https://schema.org. A string is used verbatim, and an array is emitted as an object under @context.

```APIDOC
public function __construct(string|array|null $context = null)
```

```APIDOC
public function __call(string $method, array $arguments)
```

--------------------------------

### getContext(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Returns the schema.org context URL, always 'https://schema.org'.

```APIDOC
## getContext(): string

### Description
Returns the schema.org context URL, always 'https://schema.org'.

### Method
getContext

### Returns
`string` - The context URL.
```

--------------------------------

### Graph constructor signature

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Shows the constructor signature for the Graph class, accepting a string, array, or null context.

```php
public function __construct(string|array|null $context = null)
```

--------------------------------

### __toString(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Magic method that returns the script tag when the object is treated as a string.

```APIDOC
## __toString(): string

### Description
Magic method that returns the script tag when the object is treated as a string.

### Method
__toString

### Return Value
- **string** - The script tag generated by toScript().

### Example
```php
public function __toString(): string
{
    return $this->toScript();
}
```
```

--------------------------------

### PHP generate script with local cache

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generator.md

Uses cached generator/temp/core.jsonld, no network access.

```bash
php ./generate.php --local   # use cached generator/temp/core.jsonld, no network access
```

--------------------------------

### __toString magic method returns toScript()

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Echoing an instance prints the script tag.

```php
public function __toString(): string
{
    return $this->toScript();
}
```

--------------------------------

### Retrieve property with getProperty

Source: https://github.com/spatie/schema-org/blob/main/README.md

Retrieve a property with getProperty. Optionally pass a default value as the second parameter.

```php
$localBusiness->getProperty('name'); // 'Spatie'
$localBusiness->getProperty('bar'); // null
$localBusiness->getProperty('bar', 'baz'); // 'baz'
```

--------------------------------

### getProperty Method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Retrieves a stored property value, returning a default value if the key is not found.

```pie
public function getProperty(string $property, $default = null)
{
    return $this->properties[$property] ?? $default;
}
```

--------------------------------

### Convert to array or render to script

Source: https://github.com/spatie/schema-org/blob/main/README.md

Convert a schema type to an array or render it as a script. Echoing the object directly produces the same output as toScript().

```php
$localBusiness->toArray();

echo $localBusiness->toScript();

echo $localBusiness; // Same output as `toScript()`
```

--------------------------------

### getContext(): string|array

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Returns the context used for the graph.

```APIDOC
## getContext(): string|array

### Description
Returns the constructor-supplied context (string or array), or `https://schema.org` when none was given.

### Returns
Returns the context.
```

--------------------------------

### Typical class declaration from src/LocalBusiness.php

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows the class declaration for LocalBusiness, which extends BaseType and implements its own contract plus contracts of all ancestor types (Organization, Place, Thing).

```php
class LocalBusiness extends BaseType implements LocalBusinessContract, OrganizationContract, PlaceContract, ThingContract
```

--------------------------------

### if Method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Executes a callback if the provided condition is truthy, allowing for conditional property setting without breaking the fluent chain.

```pie
public function if($condition, $callback)
{
    if ($condition) {
        $callback($this);
    }

    return $this;
}
```

--------------------------------

### Schema factory method pattern

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/schema.md

Shows the exact shape of every static factory method in the Schema class. Each of the 925 methods follows this pattern, returning a new instance of the corresponding generated type class.

```php
public static function localBusiness(): LocalBusiness
{
    return new LocalBusiness();
}
```

--------------------------------

### toScript(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Returns a ready-to-embed script tag containing the JSON-LD.

```APIDOC
## toScript(): string

### Description
Returns a ready-to-embed script tag containing the JSON-LD.

### Method
toScript

### Returns
- `string` - The script tag.

### Example
```html
<script type="application/ld+json" nonce="...">{"@context":"https://schema.org","@type":"LocalBusiness"}</script>
```
```

--------------------------------

### toScript(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Generates a JSON-LD script tag containing the serialized schema data, including the nonce attribute if set.

```APIDOC
## toScript(): string

### Description
Generates a JSON-LD script tag containing the serialized schema data, including the nonce attribute if set.

### Method
toScript

### Return Value
- **string** - The full script tag with JSON-LD content.

### Example
```php
public function toScript(): string
{
    return '<script type="application/ld+json"'.$this->nonceAttr().'>'.json_encode($this, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_HEX_TAG).'</script>';
}
```
```

--------------------------------

### toScript(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Renders the graph as a script tag with JSON-LD.

```APIDOC
## toScript(): string

### Description
Renders the graph as `<script type="application/ld+json">...json...</script>` using `json_encode` with flags.

### Returns
Returns the HTML script tag as a string.
```

--------------------------------

### Catching TypeNotInGraph Exception

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/errors.md

Demonstrates how to catch the TypeNotInGraph exception when attempting to retrieve a non-existent node from the graph.

```php
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Exceptions\TypeNotInGraph;

$graph = new Graph();

try {
    $graph->get('Spatie\SchemaOrg\Person');
} catch (TypeNotInGraph) {
    // create the node first: $graph->person()…
}
```

--------------------------------

### MultiTypedEntity core methods: nonceAttr, toScript, jsonSerialize, __toString

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Defines the core methods of MultiTypedEntity: nonceAttr() returns a nonce attribute string, toScript() generates a JSON-LD script tag, jsonSerialize() returns the array representation, and __toString() returns the script. These methods follow the same conventions as BaseType and Graph.

```php
public function nonceAttr(): string
{
    if ($this->nonce) {
        $attr = ' nonce="'.$this->nonce.'"';
    } else {
        $attr = '';
    }

    return $attr;
}

public function toScript(): string
{
    return '<script type="application/ld+json"'.$this->nonceAttr().'>'.json_encode($this, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_HEX_TAG).'</script>';
}

public function jsonSerialize(): mixed
{
    return $this->toArray();
}

public function __toString(): string
{
    return $this->toScript();
}
```

--------------------------------

### toScript(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Returns a ready-to-embed <script type="application/ld+json"> tag containing the JSON-LD, encoded with JSON_UNESCAPED_UNICODE, JSON_UNESCAPED_SLASHES, and JSON_HEX_TAG flags.

```php
public function toScript(): string
{
    return '<script type="application/ld+json"'.$this->nonceAttr().'>'.json_encode($this->toArray(), JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_HEX_TAG).'</script>';
}
```

--------------------------------

### Error handling: object that cannot be serialized

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows how to handle an InvalidProperty exception when a property cannot be serialized.

```php
use Spatie\SchemaOrg\LocalBusiness;
use Spatie\SchemaOrg\Exceptions\InvalidProperty;

$localBusiness = (new LocalBusiness())->setProperty('weird', new MyUnserializableObject());

try {
    $localBusiness->toArray();
} catch (InvalidProperty) {
    // BaseType::serializeProperty: plain objects (no Type, no DateTimeInterface, no __toString)
}
```

--------------------------------

### show(string $type, ?string $identifier = self::IDENTIFIER_DEFAULT): self

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Shows a type or a single identifier within a type. Pass null to show all nodes of the type, or an identifier to reveal only that node while keeping others hidden as configured.

```APIDOC
## show(string $type, ?string $identifier = self::IDENTIFIER_DEFAULT): self

### Description
Shows a type (all nodes of the type) or a single identifier within it. If `$identifier` is `null`, the entire type is shown. Otherwise, it reveals the specified identifier, even if the whole type was previously hidden.

### Parameters
- `type` (string) - Required - Fully qualified class name of the schema type.
- `identifier` (string|null) - Optional - Default `'default'`. `null` shows all; otherwise reveals a single identifier, keeping the rest hidden if the type was fully hidden.

### Returns
Returns `$this` for chaining.
```

--------------------------------

### toScript method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Renders the graph as a JSON-LD script tag with nonce and proper JSON flags.

```php
public function toScript(): string
{
    return '<script type="application/ld+json"'.$this->nonceAttr().'>'.json_encode($this, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_HEX_TAG).'</script>';
}
```

--------------------------------

### Exception Class Definitions

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/errors.md

The custom exception classes defined in src/Exceptions/*.php.

```pie
class InvalidProperty extends Exception {}

class InvalidType extends InvalidArgumentException {}

class TypeAlreadyInGraph extends InvalidArgumentException {}

class TypeNotInGraph extends InvalidArgumentException {}

class TypeAlreadyInMultiTypedEntity extends InvalidArgumentException {}

class TypeNotInMultiTypedEntity extends InvalidArgumentException {}
```

--------------------------------

### Set custom property with setProperty

Source: https://github.com/spatie/schema-org/blob/main/README.md

Set a custom property using the setProperty method.

```php
$localBusiness->setProperty('foo', 'bar');
```

--------------------------------

### ArrayAccess methods: offsetExists, offsetGet, offsetSet, offsetUnset

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Implements the SPL ArrayAccess interface for property access. offsetExists checks if a property key is set, offsetGet retrieves via getProperty, offsetSet sets via setProperty, and offsetUnset removes the key.

```php
public function offsetExists($offset): bool
{
    return array_key_exists($offset, $this->properties);
}

public function offsetGet($offset): mixed
{
    return $this->getProperty($offset);
}

public function offsetSet($offset, $value): void
{
    $this->setProperty($offset, $value);
}

public function offsetUnset($offset): void
{
    unset($this->properties[$offset]);
}
```

--------------------------------

### Magic factory dispatch — __call

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Magic factory dispatch for creating nodes. The method name must be a static Schema factory method. The first argument can be an identifier string or a closure. If a closure is provided, it is invoked with the created node and the graph instance.

```APIDOC
$graph->product()
```

```APIDOC
$graph->product('sku-1')
```

```APIDOC
$graph->product(function (Product $product, Graph $graph) {…})
```

```APIDOC
$graph->product('sku-1', function (Product $product, Graph $graph) {…})
```

--------------------------------

### Graph __call magic factory dispatch

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Shows the implementation of the __call method that dispatches to Schema factory methods, handling identifiers and callbacks.

```php
public function __call(string $method, array $arguments)
{
    if (is_callable([Schema::class, $method])) {
        $type = (new ReflectionClass(Schema::class))->getMethod($method)->getReturnType();

        if (! $type instanceof ReflectionNamedType) {
            throw new BadMethodCallException(sprintf('The method "%s" has an invalid return type which does not resolve to "%s".', $method, ReflectionNamedType::class));
        }

        $identifier = self::IDENTIFIER_DEFAULT;

        if (isset($arguments[0])) {
            if (is_string($arguments[0])) {
                $identifier = $arguments[0];

                if (isset($arguments[1]) && is_callable($arguments[1])) {
                    $callback = $arguments[1];
                }
            } elseif (is_callable($arguments[0])) {
                $callback = $arguments[0];
            }
        }

        $schema = $this->getOrCreate($type->getName(), $identifier);

        if (isset($callback)) {
            call_user_func($callback, $schema, $this);

            return $this;
        }

        return $schema;
    }

    throw new BadMethodCallException(sprintf('The method "%s" does not exist on class "%s".', $method, get_class($this)));
}
```

--------------------------------

### jsonSerialize and __toString methods

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Implements JsonSerializable and string conversion for the graph.

```php
public function jsonSerialize(): mixed
{
    return $this->toArray();
}

public function __toString(): string
{
    return $this->toScript();
}
```

--------------------------------

### getContext(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Always returns the fixed context 'https://schema.org'. The multi-typed entity has no context option unlike Graph.

```php
public function getContext(): string
{
    return 'https://schema.org';
}
```

--------------------------------

### MultiTypedEntity class declaration

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Class declaration showing the properties used to store type nodes and a nonce.

```php
class MultiTypedEntity implements Type, JsonSerializable
{
    /** @var Type[] */
    protected $nodes = [];

    /** @var string */
    protected $nonce = '';
}
```

--------------------------------

### nonceAttr(): string

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Returns the nonce attribute string for the script tag.

```APIDOC
## nonceAttr(): string

### Description
Returns a string like `' nonce="..."'` when nonce is set, otherwise an empty string.

### Returns
Returns the nonce attribute string.
```

--------------------------------

### Relational property method from src/Organization.php

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows the contactPoint method for relational properties, accepting contract interfaces or strings, and returning static.

```php
/**
 * @param \Spatie\SchemaOrg\Contracts\ContactPointContract|\Spatie\SchemaOrg\Contracts\ContactPointContract[]|string|string[] $contactPoint
 *
 * @return static
 */
public function contactPoint($contactPoint)
{
    return $this->setProperty('contactPoint', $contactPoint);
}
```

--------------------------------

### offsetGet($offset): mixed

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Retrieves a property value by key.

```APIDOC
## offsetGet($offset): mixed

### Description
Retrieves a property value by key.

### Method
offsetGet

### Parameters
- `$offset` (mixed) - Required - Property key to retrieve.

### Returns
- `mixed` - The property value.

### Example
```php
$type = new LocalBusiness();
$type['name'] = 'Spatie';
echo $type['name']; // 'Spatie'
```
```

--------------------------------

### nonceAttr method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Builds the nonce attribute string for the script tag.

```php
public function nonceAttr(): string
{
    if ($this->nonce) {
        $attr = ' nonce="'.$this->nonce.'"';
    } else {
        $attr = '';
    }

    return $attr;
}
```

--------------------------------

### Spatie\SchemaOrg\Type interface

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/types.md

The core interface implemented by all schema types, defining methods for array conversion and script generation.

```pie
interface Type
{
    public function toArray(): array;
    public function toScript(): string;
    public function __toString(): string;
}
```

--------------------------------

### Node identifiers + closures

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Shows how to use node identifiers and closures. The closure receives the Person and Graph. Calling with the same identifier mutates the same node. Hides only one identifier.

```php
use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Person;

$graph = new Graph();

// chaining, default identifier
$graph->person('freekmurze')
    ->givenName('Freek')
    ->familyName('Van der Herten');

// closure form: callback receives (Person, Graph)
$graph->person('sebastiandedeyne', function (Person $sebastian, Graph $graph) {
    $sebastian->givenName('Sebastian')->familyName('De Deyne');
});

// second call with the same identifier MUTATES the same node
$graph->person('gummibeer')->givenName('Tom')->familyName('Witkowski');

// hide only one identifier
$graph->hide(Person::class, 'sebastiandedeyne');

echo json_encode($graph);
```

--------------------------------

### offsetSet($offset, $value): void

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Sets a property value by key.

```APIDOC
## offsetSet($offset, $value): void

### Description
Sets a property value by key.

### Method
offsetSet

### Parameters
- `$offset` (mixed) - Required - Property key to set.
- `$value` (mixed) - Required - Value to assign.

### Returns
- `void`

### Example
```php
$type = new LocalBusiness();
$type['name'] = 'Spatie';
```
```

--------------------------------

### Use enumeration constants (BookFormatType::Hardcover)

Source: https://github.com/spatie/schema-org/blob/main/README.md

Use enumeration child types as classes with constants, available as of v1.6.0.

```php
Schema::book()->bookFormat(Spatie\SchemaOrg\BookFormatType::Hardcover);
```

--------------------------------

### if(bool $condition, Closure $callback)

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Conditional chaining; callback receives the graph (src/Graph.php:1020).

```php
public function if(bool $condition, Closure $callback)
{
    if ($condition) {
        $callback($this);
    }

    return $this;
}
```

--------------------------------

### MultiTypedEntity __call magic method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/multi-typed-entity.md

Magic method that dispatches calls to Schema::* factory methods. Throws BadMethodCallException for unknown methods or unresolvable return types.

```php
public function __call(string $method, array $arguments)
{
    if (is_callable([Schema::class, $method])) {
        $type = (new ReflectionClass(Schema::class))->getMethod($method)->getReturnType();

        if (! $type instanceof ReflectionNamedType) {
            throw new BadMethodCallException(sprintf('The method "%s" has an invalid return type which does not resolve to "%s".', $method, ReflectionNamedType::class));
        }

        $schema = $this->getOrCreate($type->getName());

        if (isset($arguments[0]) && is_callable($arguments[0])) {
            call_user_func($arguments[0], $schema, $this);

            return $this;
        }

        return $schema;
    }

    throw new BadMethodCallException(sprintf('The method "%s" does not exist on class "%s".', $method, get_class($this)));
}
```

--------------------------------

### Exception classes in Spatie\SchemaOrg\Exceptions

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/types.md

Custom exception classes used for handling errors within the SchemaOrg library.

```pie
class InvalidProperty extends Exception {}                                  // src/Exceptions/InvalidProperty.php
class InvalidType extends InvalidArgumentException {}                        // src/Exceptions/InvalidType.php
class TypeAlreadyInGraph extends InvalidArgumentException {}                 // src/Exceptions/TypeAlreadyInGraph.php
class TypeNotInGraph extends InvalidArgumentException {}                     // src/Exceptions/TypeNotInGraph.php
class TypeAlreadyInMultiTypedEntity extends InvalidArgumentException {}      // src/Exceptions/TypeAlreadyInMultiTypedEntity.php
class TypeNotInMultiTypedEntity extends InvalidArgumentException {}          // src/Exceptions/TypeNotInMultiTypedEntity.php
```

--------------------------------

### Methods

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/type-interface.md

Methods to convert the referenced type to an array and resolve its identifier.

```APIDOC
public function toArray(): array
{
    return [
        '@id' => $this->resolveIdentifier(),
    ];
}

protected function resolveIdentifier()
{
    if (! $this->type instanceof BaseType) {
        return $this->type->toArray()['@id'] ?? null;
    }

    $identifier = $this->type->getProperty('identifier');

    if ($identifier instanceof Type) {
        return null;
    }

    return $identifier;
}
```

--------------------------------

### Graph class signature

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/graph.md

Shows the class declaration and properties of the Graph class, including the IDENTIFIER_DEFAULT constant, nodes array, hidden array, context, and nonce.

```php
class Graph implements Type, ArrayAccess, JsonSerializable
{
    public const IDENTIFIER_DEFAULT = 'default';

    /** @var Type[] */
    protected $nodes = [];

    /** @var array */
    protected $hidden = [];

    /** @var string|null */
    protected $context;

    /** @var string */
    protected $nonce = '';
}
```

--------------------------------

### BookFormatType enumeration constants

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/generated-type-classes.md

Shows the class definition and constants for BookFormatType, exposing schema.org values as class constants.

```php
class BookFormatType extends BaseType implements BookFormatTypeContract, EnumerationContract, IntangibleContract, ThingContract
{
    public const AudiobookFormat = 'https://schema.org/AudiobookFormat';
    public const EBook = 'https://schema.org/EBook';
    public const GraphicNovel = 'https://schema.org/GraphicNovel';
    public const Hardcover = 'https://schema.org/Hardcover';
    ...
}
```

--------------------------------

### Schema Factory Methods

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/schema.md

The Schema class provides static factory methods for creating schema.org type instances. Each method returns a new instance of the corresponding generated class.

```APIDOC
public static function localBusiness(): LocalBusiness
{
    return new LocalBusiness();
}
```

```APIDOC
use Spatie\SchemaOrg\Schema;

$localBusiness = Schema::localBusiness()
    ->name('Spatie')
    ->email('info@spatie.be')
    ->contactPoint(Schema::contactPoint()->areaServed('Worldwide'));

echo $localBusiness->toScript();
```

```APIDOC
use Spatie\SchemaOrg\Graph;

$graph = new Graph();
$graph->product()->name('My cool Product')->brand($graph->organization());
$graph->organization()->name('My awesome Company');
echo $graph;
```

--------------------------------

### getType Method

Source: https://github.com/spatie/schema-org/blob/main/_autodocs/api-reference/base-type.md

Returns the short class name of the instance, used for the @type key in JSON-LD.

```pie
public function getType(): string
{
    return (new ReflectionClass($this))->getShortName();
}
```
Tokens:
Raw