Honeystone SEO Configurator for Laravel

https://github.com/honeystone/laravel-seo
Admin
Laravel package for configuring SEO metadata including general metadata, Twitter Cards, Open Graph,...
Tokens:60,631
Snippets:505
Trust Score:6.4
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage Example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/TwitterCards.md

Example of using AppProperties and PlayerProperties with the seo() helper.

```APIDOC
## Usage Example

### Description
Example of using AppProperties and PlayerProperties with the seo() helper.

### Code
```php
use Honeystone\Seo\Twitter\AppProperties;
use Honeystone\Seo\Twitter\PlayerProperties;

seo()->twitterCard(new PlayerProperties(
    player: 'https://example.com/video/player',
    width: '640',
    height: '360',
    stream: 'https://example.com/video/stream.m3u8',
));

seo()->twitterCard(new AppProperties(
    iphoneName: 'My App',
    iphoneId: '123456789',
    iphoneUrl: 'myapp://',
    country: 'GB',
));
```
```

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

### Usage example with PlayerProperties and AppProperties

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/TwitterCards.md

Shows how to pass PlayerProperties and AppProperties instances to seo()->twitterCard(). The PlayerProperties example uses named arguments for player, width, height, and stream. The AppProperties example uses named arguments for iphoneName, iphoneId, iphoneUrl, and country.

```php
use Honeystone\Seo\Twitter\AppProperties;
use Honeystone\Seo\Twitter\PlayerProperties;

seo()->twitterCard(new PlayerProperties(
    player: 'https://example.com/video/player',
    width: '640',
    height: '360',
    stream: 'https://example.com/video/stream.m3u8',
));

seo()->twitterCard(new AppProperties(
    iphoneName: 'My App',
    iphoneId: '123456789',
    iphoneUrl: 'myapp://',
    country: 'GB',
));
```

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

### Install honeystone/laravel-seo with Composer

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Install the Honeystone SEO package via Composer.

```shell
composer require honeystone/laravel-seo
```

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

### Setting keywords

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Example of setting multiple keywords.

```php
seo()->keywords('foo', 'bar', 'baz');
```

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

### register() usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Registry.md

Shows how to manually register a generator instance with the registry.

```php
$registry->register('my-generator', new MyGenerator());
```

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

### Registry usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Registry.md

Shows manual resolution of the registry and iteration over all generators, plus retrieving a specific generator.

```php
use Honeystone\Seo\Registry;
use Honeystone\Seo\Contracts\GeneratesMetadata;

// Resolving manually (normally the service container handles this)
$registry = app(Registry::class);

foreach ($registry->all() as $name => $generator) {
    echo $name; // meta, twitter, open-graph, json-ld
}

$meta = $registry->get('meta'); // GeneratesMetadata for MetaGenerator
```

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

### Example published config for laravel-seo

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/configuration.md

Example configuration file for the laravel-seo package. Shows the default settings for each generator (Meta, Twitter, OpenGraph, JsonLd) and the sync options. Note the 'place-on-graph' key for JsonLd and the 'sync' section for canonical URL and keywords tags.

```php
<?php

declare(strict_types=1);

use Honeystone\Seo\Generators;

return [

    'generators' => [
        Generators\MetaGenerator::class => [
            'title' => env('APP_NAME'),
            'titleTemplate' => '{title} - '.env('APP_NAME'),
            'description' => '',
            'keywords' => [],
            'canonicalEnabled' => true,
            'canonical' => null, // null to use current url
            'robots' => [],
            'custom' => [],
        ],
        Generators\TwitterGenerator::class => [
            'enabled' => true,
            'site' => '', // @twitterUsername
            'card' => 'summary_large_image',
            'creator' => '',
            'creatorId' => '',
            'title' => '',
            'description' => '',
            'image' => '',
            'imageAlt' => '',
        ],
        Generators\OpenGraphGenerator::class => [
            'enabled' => true,
            'site' => env('APP_NAME'),
            'type' => 'website',
            'title' => '',
            'description' => '',
            'images' => [],
            'audio' => [],
            'videos' => [],
            'determiner' => '',
            'url' => null, // null to use current url
            'locale' => '',
            'alternateLocales' => [],
            'custom' => [],
        ],
        Generators\JsonLdGenerator::class => [
            'enabled' => true,
            'pretty' => env('APP_DEBUG'),
            'type' => 'WebPage',
            'name' => '',
            'description' => '',
            'images' => [],
            'url' => null, // null to use current url
            'custom' => [],

            // determines if the configured json-ld is automatically placed on the graph
            'place-on-graph' => true,
        ],
    ],

    'sync' => [
        'url-canonical' => true,
        'keywords-tags' => false,
    ],
];
```

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

### Using expect() and checkIn() together

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Example showing how to declare expected components in a controller and check them in from a view composer.

```php
// controller
seo()->jsonLdExpect('featured-tags', 'gallery', 'contact');

// view composer
seo()->jsonLdCheckIn('gallery');
```

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

### Typical application flow - controller

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/helpers.md

Example of calling the seo() helper from a controller to set metadata for a page.

```php
// app/Http/Controllers/PageController.php
public function __invoke(Page $page)
{
    $page->seo()
        ->title($page->title)
        ->description($page->meta_description);

    return view('page', ['page' => $page]);
}
```

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

### seo() helper usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/helpers.md

Shows chaining metadata methods and generating output. Because the binding is a singleton, repeated seo() calls share state.

```php
seo()
    ->title('A fantastic blog post', 'My Awesome Website!')
    ->description('Theres really a lot of great stuff in here...')
    ->images(
        'https://mywebsite.com/images/blog-1/cover-image.webp',
    );

echo seo()->generate();
```

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

### Using getConfig to check sync.keywords-tags

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Example of checking a config flag with getConfig. If the flag is true, keywords are synced to Open Graph tags.

```php
if (seo()->getConfig('sync.keywords-tags', false)) {
    // keywords are synced to Open Graph tags
}
```

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

### Usage Examples

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Shows how to use the OpenGraph property classes with the seo() helper to set Open Graph meta tags.

```APIDOC
## Usage

### Description
Demonstrates creating OpenGraph property objects and passing them to the seo() helper.

### Example
```php
use Honeystone\Seo\OpenGraph\ArticleProperties;
use Honeystone\Seo\OpenGraph\BookProperties;
use Honeystone\Seo\OpenGraph\ImageProperties;
use Honeystone\Seo\OpenGraph\ProfileProperties;

seo()->openGraphType(new ArticleProperties(
    publishedTime: new DateTime('now'),
    author: new ProfileProperties(username: 'PiranhaGeorge'),
    section: 'Foo',
    tag: 'Bar',
));

seo()->openGraphImage(new ImageProperties(
    url: 'http://foo.bar/img.png',
    alt: 'Foo',
    width: '800',
    height: '450',
    secureUrl: 'https://foo.bar/img.png',
    type: 'image/png',
));

seo()->openGraphType(new BookProperties(
    author: [new ProfileProperties(firstName: 'Erich', lastName: 'Gamma')],
    isbn: '978-0201633610',
    releaseDate: new DateTime('14 March 1995'),
    tag: ['1st', 'GoF'],
));
```
```

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

### Alternative to helper - type-hint MetadataDirector

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/helpers.md

Alternative to the seo() helper: type-hint the MetadataDirector to get the same singleton instance.

```php
// resources/views/page.blade.php — or a layout component
use Honeystone\Seo\MetadataDirector;

// Alternative to the helper: type-hint the director (same singleton)
public function render(MetadataDirector $seo): string
{
    return (string) $seo->generate();
}
```

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

### generate() usage examples

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Generates HTML for all or only named generators. The examples show calling generate() with no arguments, with one generator name, and with multiple generator names.

```php
echo seo()->generate();           // all generators
echo seo()->generate('meta');     // only the meta generator
echo seo()->generate('meta', 'twitter');
```

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

### toArray() method signature and return array example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetaGenerator.md

Returns ['custom' => array<string,...>] + getData(). The example shows the structure of the returned array.

```php
public function toArray(): array
```

```php
[
    'config' => [...],        // merged generator config (when set)
    'custom' => [...],        // custom meta tags
    'title' => '...',
    'titleTemplate' => '...',
    'description' => '...',
    'keywords' => [...],
    'canonical' => '...',
    'canonicalEnabled' => true,
    'robots' => [...],
]
```

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

### Usage examples for OpenGraph properties

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Shows how to use the seo() helper to set OpenGraph type, image, and book properties with ArticleProperties, ImageProperties, and BookProperties. Includes imports for the property classes.

```php
use Honeystone\Seo\OpenGraph\ArticleProperties;
use Honeystone\Seo\OpenGraph\BookProperties;
use Honeystone\Seo\OpenGraph\ImageProperties;
use Honeystone\Seo\OpenGraph\ProfileProperties;

seo()->openGraphType(new ArticleProperties(
    publishedTime: new DateTime('now'),
    author: new ProfileProperties(username: 'PiranhaGeorge'),
    section: 'Foo',
    tag: 'Bar',
));

seo()->openGraphImage(new ImageProperties(
    url: 'http://foo.bar/img.png',
    alt: 'Foo',
    width: '800',
    height: '450',
    secureUrl: 'https://foo.bar/img.png',
    type: 'image/png',
));

seo()->openGraphType(new BookProperties(
    author: [new ProfileProperties(firstName: 'Erich', lastName: 'Gamma')],
    isbn: '978-0201633610',
    releaseDate: new DateTime('14 March 1995'),
    tag: ['1st', 'GoF'],
));
```

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

### Using jsonLdGraph() to build a graph

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Example usage of the graph() method via the seo() helper to add an organization with name and legalName.

```php
seo()->jsonLdGraph()
    ->organization('honeystone')
        ->name('Honeystone')
        ->legalName('Honeystone Consulting Ltd.');
```

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

### config() usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Merges configuration data into the director's config and propagates the relevant per-generator config slice to all registered generators.

```php
seo()->config(['sync' => ['url-canonical' => true]]);
```

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

### tag() method signature and usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetaGenerator.md

Appends a custom <meta name="$property" content="…"> tag. Each property => content pair is pushed onto $this->custom. Array content renders one <meta> per value. The example shows usage with seo()->metaTag().

```php
/**
 * @param string|array<string> $content
 *
 * @return $this
 */
public function tag(string $property, string|array $content): self
```

```php
seo()->metaTag('google-site-verification', 'xxx');
```

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

### Build JSON-LD graph with spatie/schema-org

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Use jsonLdGraph() or jsonLdMulti() to build a schema using the spatie/schema-org fluent interface. Requires installing the spatie/schema-org package.

```php
    //graph
    seo()->jsonLdGraph()
        ->organization('honeystone')
            ->name('Honeystone')
            ->legalName('Honeystone Consulting Ltd.');

    //or a MultiTypedEntity
    seo()->jsonLdMulti()
        ->organization('honeystone')
            ->name('Honeystone')
            ->legalName('Honeystone Consulting Ltd.');
```

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

### Setting title with template and disabling template

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Two examples: one sets a title with a template, the other disables the template for the home page.

```php
// Template enabled
seo()->title('A fantastic blog post', '🔥🔥 {title} 🔥🔥');

// Home page: disable the template
seo()->title('My Awesome Website!', template: false);
```

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

### get() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Registry.md

Returns the generator registered under the given name. Throws a PHP Error for unknown names.

```php
public function get(string $name): GeneratesMetadata
```

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

### Generated Open Graph HTML with ArticleProperties and ImageProperties

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Example HTML output generated when using ArticleProperties and ImageProperties. Shows the resulting Open Graph meta tags, including article-specific tags and image details.

```html
<!-- Open Graph -->
<meta property="og:site_name" content="My Website" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2024-07-25T21:39:40+00:00" />
<meta property="article:modified_time" content="2024-07-25T21:39:40+00:00" />
<meta property="article:author:username" content="PiranhaGeorge" />
<meta property="article:section" content="Foo" />
<meta property="article:tag" content="Bar" />
<meta property="og:title" content="A fantastic blog post" />
<meta property="og:description" content="Theres really a lot of great stuff in here..." />
<meta property="og:image" content="http://foo.bar/img.png" />
<meta property="og:image:alt" content="Foo" />
<meta property="og:image:width" content="800" />
<meta property="og:image:height" content="450" />
<meta property="og:image:secure_url" content="https://foo.bar/img.png" />
<meta property="og:image:type" content="image/png" />
<meta property="og:url" content="https://mywebsite.com" />
<meta property="og:determiner" content="a" />
<meta property="og:locale" content="en_GB" />
<meta property="og:locale:alternate" content="en_US" />
<meta property="custom:property" content="💀" />
```

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

### Rendered metadata HTML output

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Example output of seo()->generate() showing title, meta description, canonical, Twitter Cards, Open Graph, and JSON-LD tags.

```html
<title>A fantastic blog post - My Awesome Website!</title>
<meta name="description" content="Theres really a lot of great stuff in here..." />
<link rel="canonical" href="https://mywebsite.com/blog/a-fantastic-blog-post" />

<!-- Twitter Cards -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="A fantastic blog post" />
<meta name="twitter:description" content="Theres really a lot of great stuff in here..." />
<meta name="twitter:image" content="https://mywebsite.com/images/blog-1/cover-image.webp" />

<!-- Open Graph -->
<meta property="og:type" content="website" />
<meta property="og:title" content="A fantastic blog post" />
<meta property="og:description" content="Theres really a lot of great stuff in here..." />
<meta property="og:image" content="https://mywebsite.com/images/blog-1/cover-image.webp" />
<meta property="og:image" content="https://mywebsite.com/images/blog-1/another-image.webp" />
<meta property="og:url" content="https://mywebsite.com/blog/a-fantastic-blog-post" />

<!-- JSON-LD -->
<script type="application/ld+json">
    {
        "@context": "https://schema.org",
        "@type": "WebPage",
        "name": "A fantastic blog post",
        "description": "Theres really a lot of great stuff in here...",
        "image": [
            "https://mywebsite.com/images/blog-1/cover-image.webp",
            "https://mywebsite.com/images/blog-1/another-image.webp"
        ],
        "url": "https://mywebsite.com"
    }
</script>
```

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

### Register Inertia middleware in HandleInertiaRequests.php

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Middleware.md

Shows how to add one or both middleware classes to the Inertia middleware stack. The example comments indicate which share each class adds.

```php
// app/Http/Middleware/HandleInertiaRequests.php
use Honeystone\Seo\Http\Middleware\GenerateInertiaMetadata;
use Honeystone\Seo\Http\Middleware\GenerateInertiaMetadataReact;

protected $middleware = [
    // ...
    GenerateInertiaMetadata::class,      // shares $page.props.seo (HTML)
    GenerateInertiaMetadataReact::class, // shares $page.props.seoPayload (array)
];
```

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

### generator() usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Resolves a generator instance from the registry by its registration name. The example shows retrieving the 'json-ld' generator.

```php
$generator = seo()->generator('json-ld'); // Honeystone\Seo\Generators\JsonLdGenerator
```

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

### jsonLdId usage examples

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Example usage of the jsonLdId method: passing an explicit URL with an append, and calling without arguments to use the current URL.

```php
seo()->jsonLdId('https://mywebsite.com/page', '#article');
seo()->jsonLdId(); // current url
```

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

### toArray() usage examples

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Exports structured metadata as an array keyed by generator name. The examples show exporting all generators, only the 'meta' generator, and using the result with Inertia.

```php
$seo = seo()->toArray();              // ['meta' => [...], 'twitter' => [...], 'open-graph' => [...], 'json-ld' => [...]]
$metaOnly = seo()->toArray('meta');   // ['meta' => [...]]

return Inertia::render('Pages/Show', [
    'page' => $page,
    'seo' => seo()->toArray(),
]);
```

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

### Usage of MetaGenerator with director and direct instantiation

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetaGenerator.md

Shows how to use MetaGenerator, typically via the seo() director to set meta title, description, keywords, canonical, and robots. Also demonstrates direct instantiation for standalone use, noting that config and defaults are empty in that case.

```php
use Honeystone\Seo\Generators\MetaGenerator;

// Usually via the director:
seo()
    ->metaTitle('A fantastic blog post')
    ->metaTitleTemplate('🔥🔥 {title} 🔥🔥')
    ->metaDescription('Theres really a lot of great stuff in here...')
    ->metaKeywords('foo', 'bar', 'baz')
    ->metaCanonical('https://mywebsite.com/blog/a-fantastic-blog-post')
    ->metaCanonicalEnabled(true)
    ->metaRobots('🤖', '🤖', '🤖');

// Direct instantiation (for standalone use; config + defaults are empty):
$generator = new MetaGenerator();
```

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

### get()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Registry.md

Returns the generator registered under the given name. Throws a PHP Error for unknown names.

```APIDOC
## get()

### Description
Returns the generator registered under the given name. Throws a PHP Error for unknown names.

### Method
get

### Signature
public function get(string $name): GeneratesMetadata

### Parameters
- **$name** (string) - Required - The registration name of the generator.

### Returns
GeneratesMetadata
```

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

### configurePackage implementation

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/ServiceProvider.md

Configures the package with name 'honeystone-seo', sets base path to the package root, and registers a config file and views. The config file allows publishing via 'php artisan vendor:publish --tag=honeystone-seo-config' and views under the honeystone-seo:: namespace are publishable via '--tag=honeystone-seo-views'.

```php
$package
    ->name('honeystone-seo')
    ->setBasePath(dirname(__DIR__))
    ->hasConfigFile()
    ->hasViews();
```

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

### videos() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Sets multiple videos at once. Accepts an array of URL strings, VideoProperties instances, or null values.

```php
/**
 * @param array<string|VideoProperties|null> $value
 *
 * @return $this
 */
public function videos(array $value): self
```

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

### audio() method

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Sets audio, wrapped with Arr::wrap so a single value becomes a one-element array. Accepts URL strings, AudioProperties, or arrays.

```php
/**
 * @param array<string|AudioProperties|array<string|AudioProperties|null>>|null $value
 *
 * @return $this
 */
public function audio(string|AudioProperties|array|null $value): self
```

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

### Open Graph configuration usage

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Shows how to configure Open Graph meta tags using the seo() helper, including setting site, type, title, locale, and custom properties. Also demonstrates using rich type objects like ArticleProperties and ProfileProperties, and retrieving the prefix.

```php
use Honeystone\Seo\Generators\OpenGraphGenerator;
use Honeystone\Seo\OpenGraph\ArticleProperties;
use Honeystone\Seo\OpenGraph\ProfileProperties;

seo()
    ->openGraphEnabled(true)
    ->openGraphSite('My Website')
    ->openGraphType('website')
    ->openGraphTitle('A fantastic blog post')
    ->openGraphLocale('en_GB')
    ->openGraphProperty('custom:property', '💀');

// Rich type + prefix
seo()->openGraphType(new ArticleProperties(
    publishedTime: new DateTime('now'),
    author: new ProfileProperties(username: 'PiranhaGeorge'),
    section: 'Foo',
    tag: 'Bar',
));

echo seo()->openGraphPrefix(); // og: https://ogp.me/ns# article: https://ogp.me/ns/article#
```

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

### PlayerProperties::__construct()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/TwitterCards.md

Creates a new PlayerProperties instance with required parameters that map to twitter:player:* meta tags.

```APIDOC
## PlayerProperties::__construct()

### Description
Creates a new PlayerProperties instance with required parameters that map to `twitter:player:*` meta tags.

### Method
`public function __construct(string $player, string $width, string $height, ?string $stream)`

### Parameters
- **$player** (`string`) - Required - Player URL -> `twitter:player` (rendered only if non-empty).
- **$width** (`string`) - Required - -> `twitter:player:width`.
- **$height** (`string`) - Required - -> `twitter:player:height`.
- **$stream** (`?string`) - Required (positional, no default) - Stream URL -> `twitter:player:stream`; pass `null` to omit.
```

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

### AppProperties::__construct()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/TwitterCards.md

Creates a new AppProperties instance with optional parameters that map to twitter:app:* meta tags.

```APIDOC
## AppProperties::__construct()

### Description
Creates a new AppProperties instance with optional parameters that map to `twitter:app:*` meta tags.

### Method
`public function __construct(?string $iphoneId = null, ?string $iphoneName = null, ?string $iphoneUrl = null, ?string $ipadId = null, ?string $ipadName = null, ?string $ipadUrl = null, ?string $googlePlayId = null, ?string $googlePlayName = null, ?string $googlePlayUrl = null, ?string $country = null)`

### Parameters
- **$iphoneId** (`?string`) - Optional - Maps to `twitter:app:id:iphone`.
- **$iphoneName** (`?string`) - Optional - Maps to `twitter:app:name:iphone`.
- **$iphoneUrl** (`?string`) - Optional - Maps to `twitter:app:url:iphone`.
- **$ipadId** (`?string`) - Optional - Maps to `twitter:app:id:ipad`.
- **$ipadName** (`?string`) - Optional - Maps to `twitter:app:name:ipad`.
- **$ipadUrl** (`?string`) - Optional - Maps to `twitter:app:url:ipad`.
- **$googlePlayId** (`?string`) - Optional - Maps to `twitter:app:id:googleplay`.
- **$googlePlayName** (`?string`) - Optional - Maps to `twitter:app:name:googleplay`.
- **$googlePlayUrl** (`?string`) - Optional - Maps to `twitter:app:url:googleplay`.
- **$country** (`?string`) - Optional - Declared but not rendered by the view for this property.
```

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

### Forwarding to JSON-LD generator via __call

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Example of calling a method on the director that forwards to the JSON-LD generator. Returns $this so chaining continues.

```php
// Forwarding to the JSON-LD generator; returns $this so chaining continues.
seo()->jsonLdExpect('featured-tags')->jsonLdGraph();
```

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

### Provide Open Graph media data with AudioProperties, ImageProperties, VideoProperties

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Provide detailed data for audio, image, and video Open Graph tags using their respective properties classes. Each class accepts url, secureUrl, type, and for images/videos also alt, width, height.

```php
use Honeystone\Seo\OpenGraph\AudioProperties;
use Honeystone\Seo\OpenGraph\ImageProperties;
use Honeystone\Seo\OpenGraph\VideoProperties;

seo()->openGraphAudio(new AudioProperties(
    url: 'http://foo.bar/song.mp3',
    secureUrl: 'https://foo.bar/song.mp3',
    type: 'audio/mpeg',
));

seo()->openGraphImage(new ImageProperties(
    url: 'http://foo.bar/img.png',
    alt: 'Foo',
    width: '800',
    height: '450',
    secureUrl: 'https://foo.bar/img.png',
    type: 'image/png',
));

seo()->openGraphVideo(new VideoProperties(
    url: 'http://foo.bar/movie.mp4',
    alt: 'Foo',
    width: '1920',
    height: '1080',
    secureUrl: 'https://foo.bar/movie.mp4',
    type: 'video/mp4',
));
```

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

### video() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Sets a single video stored under the 'videos' data key as a one-element array. Accepts a URL string or VideoProperties instance.

```php
/**
 * @return $this
 */
public function video(string|VideoProperties|null $value): self
```

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

### videos()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Sets multiple videos for the Open Graph data.

```APIDOC
## videos()

### Description
Sets multiple videos.

### Method
`videos(array $value): self`

### Parameters
- **$value** (array<string|VideoProperties|null>) - Required - An array of video URLs or VideoProperties objects.

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

### Source
`src/Generators/OpenGraphGenerator.php:156`
```

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

### images() method

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Sets multiple images. Defaults to director-level images().

```php
/**
 * @param array<string|ImageProperties|null> $value
 *
 * @return $this
 */
public function images(array $value): self
```

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

### schema() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Returns the underlying Spatie\SchemaOrg\BaseType entity built from configured data. Returns null when use-schema-org is false or the package is not installed.

```php
public function schema(): ?BaseType
```

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

### Type (Open Graph) interface

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Contracts.md

Defines methods to get the Open Graph type prefix and type. Implemented by ArticleProperties, BookProperties, and ProfileProperties.

```php
interface Type
{
    public function getPrefix(): string;

    public function getType(): string;
}
```

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

### description() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Sets the shared description default.

```php
public function description(?string $value): self
```

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

### toArray() method: returns data array

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/TwitterGenerator.md

Returns all configured data keys plus 'config' when set. With built-in defaults the array has keys: enabled, site, card, creator, creatorId, title, description, image, imageAlt.

```php
public function toArray(): array
```

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

### schema()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Returns the underlying Spatie\SchemaOrg\BaseType entity built from the configured data. Returns null when the config flag use-schema-org is false or the spatie/schema-org package is not installed.

```APIDOC
## schema()

### Description
Returns the underlying `Spatie\SchemaOrg\BaseType` entity built from the configured data. Returns `null` when the config flag `use-schema-org` is `false` or the `spatie/schema-org` package is not installed.

### Method
`schema()`

### Signature
```php
public function schema(): ?BaseType
```

### Source
`src/Generators/JsonLdGenerator.php:185`

### Behavior
- Resolves the type class: if the raw `type` value does not start with `'Spatie\SchemaOrg\'`, prefixes `'Spatie\SchemaOrg\'` + `Str::studly($type)` (so `'web page'` → `Spatie\SchemaOrg\WebPage`).
- **Throws** `RuntimeException("Invalid schema type `{$typeClass}`.")` if that class does not exist.
- Reuses the cached instance and applies `identifier(getRaw('id'))`, `name(...)`, `description(...)`, `image(...)`, `url(getRaw('url', url()->current()))`.

```

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

### BookProperties Constructor

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Creates a BookProperties instance to define Open Graph book metadata. Parameters map to book:author, book:isnb, book:release_date, and book:tag tags.

```APIDOC
## BookProperties Constructor

### Description
Creates a BookProperties instance to define Open Graph book metadata.

### Method
Constructor

### Parameters
- **$author** (ProfileProperties|array<ProfileProperties>|null) - Optional - Maps to `book:author:*` profile tags.
- **$isbn** (?string) - Optional - Maps to `book:isnb` (note: the view renders the property name `book:isnb`, matching the source).
- **$releaseDate** (?DateTime) - Optional - Maps to `book:release_date` (formatted `'c'`).
- **$tag** (string|array<string>|null) - Optional - Maps to `book:tag`.

### Example
```php
new BookProperties(
    author: $profile,
    isbn: '978-3-16-148410-0',
    releaseDate: new DateTime('2023-01-01'),
    tag: ['fiction', 'classic']
)
```
```

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

### Registry constructor signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Registry.md

The constructor accepts an optional config repository. When provided, it seeds the registry with generators from the 'honeystone-seo.generators' config key.

```php
public function __construct(?Repository $config = null)
```

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

### graph() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Returns the imported Spatie\SchemaOrg\Graph, creating one on first call. Requires spatie/schema-org.

```php
public function graph(): Graph
```

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

### Full config file for honeystone/laravel-seo

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Full configuration file for the package. It defines settings for the Meta, Twitter, OpenGraph, and JsonLd generators, including defaults like title template, canonical URL handling, and whether to place JSON-LD on the graph. The 'sync' section controls automatic synchronization of canonical URLs and keyword tags.

```php
<?php

declare(strict_types=1);

use Honeystone\Seo\Generators;

return [

    'generators' => [
        Generators\MetaGenerator::class => [
            'title' => env('APP_NAME'),
            'titleTemplate' => '{title} - '.env('APP_NAME'),
            'description' => '',
            'keywords' => [],
            'canonicalEnabled' => true,
            'canonical' => null, //null to use current url
            'robots' => [],
            'custom' => [
                // [
                //     'greeting' => 'Hey, thanks for checking out the source code of our website. '.
                //         'Hopefully you find what you are looking for 👍'
                // ],
                // [
                //     'google-site-verification' => 'xxx',
                // ],
            ],
        ],
        Generators\TwitterGenerator::class => [
            'enabled' => true,
            'site' => '', // @twitterUsername
            'creator' => '',
            'title' => '',
            'description' => '',
            'image' => '',
        ],
        Generators\OpenGraphGenerator::class => [
            'enabled' => true,
            'site' => env('APP_NAME'),
            'type' => 'website',
            'title' => '',
            'description' => '',
            'images' => [],
            'audio' => [],
            'videos' => [],
            'determiner' => '',
            'url' => null, // null to use current url
            'locale' => '',
            'alternateLocales' => [],
            'custom' => [],
        ],
        Generators\JsonLdGenerator::class => [
            'enabled' => true,
            'pretty' => env('APP_DEBUG'),
            'type' => 'WebPage',
            'name' => '',
            'description' => '',
            'images' => [],
            'url' => null, // null to use current url
            'custom' => [],

            // determines if the configured json-ld is automatically placed on the graph
            'place-on-graph' => true,
        ],
    ],

    'sync' => [
        'url-canonical' => true,
        'keywords-tags' => false,
    ],
];
```

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

### GeneratesMetadata interface

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Contracts.md

Base contract for all metadata generators. Defines methods for getting the registration name, merging configuration and defaults, and generating output. Implemented by MetadataDirector, MetaGenerator, TwitterGenerator, OpenGraphGenerator, and JsonLdGenerator.

```php
interface GeneratesMetadata
{
    public function getName(): string;

    /**
     * @param array<string, mixed> $data
     *
     * @return $this
     */
    public function config(array $data): self;

    /**
     * @param array<string, mixed> $data
     *
     * @return $this
     */
    public function defaults(array $data): self;

    public function generate(): View|string|null;
}
```

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

### images() usage example

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetadataDirector.md

Sets the shared images default with one or more image URLs. The first image feeds TwitterGenerator's image alias; all images feed Open Graph and JSON-LD images.

```php
seo()->images(
    'https://mywebsite.com/images/blog-1/cover-image.webp',
    'https://mywebsite.com/images/blog-1/another-image.webp',
);
```

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

### Publish honeystone-seo-config with Artisan

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Publish the package configuration file using the honeystone-seo-config tag.

```shell
php artisan vendor:publish --tag=honeystone-seo-config
```

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

### VideoProperties Constructor

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Creates a VideoProperties instance to define Open Graph video metadata. All parameters are optional and map to specific og:video meta tags.

```APIDOC
## VideoProperties

### Description
Defines Open Graph video properties for a page.

### Constructor
`new VideoProperties(?string $url = null, ?string $alt = null, ?string $width = null, ?string $height = null, ?string $secureUrl = null, ?string $type = null)`

### Parameters
- **$url** (?string) - Optional - Maps to `og:video`.
- **$alt** (?string) - Optional - Maps to `og:video:alt`.
- **$width** (?string) - Optional - Maps to `og:video:width`.
- **$height** (?string) - Optional - Maps to `og:video:height`.
- **$secureUrl** (?string) - Optional - Maps to `og:video:secure_url`.
- **$type** (?string) - Optional - Maps to `og:video:type` (e.g. `'video/mp4'`).

### Usage
Passed to `OpenGraphGenerator::video()` / `videos()` (also accepts plain URL strings).
```

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

### ProfileProperties methods

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Method signatures for ProfileProperties: getPrefix returns 'profile: https://ogp.me/ns/profile#' and getType returns 'profile'.

```php
public function getPrefix(): string   // 'profile: https://ogp.me/ns/profile#'
public function getType(): string     // 'profile'
```

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

### Blade layout using openGraphPrefix and metadata directives

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/ServiceProvider.md

Example Blade layout that sets the head prefix and outputs metadata via the @metadata directive. The @metadata directive can be called without arguments to generate all metadata.

```blade
{{-- layout.blade.php --}}
<head prefix="@openGraphPrefix">
    @metadata
</head>
```

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

### Catch RuntimeException from jsonLdExpect()->generate()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/errors.md

Wrap a JSON-LD generation call in a try/catch to handle the RuntimeException thrown by checkExpectations() when expected components fail to check in. The example shows the exact error message format for a single missing component.

```php
try {
    seo()->jsonLdExpect('gallery')->generate();
} catch (RuntimeException $e) {
    // "The following (1) expected JSON-LD components failed to check-in: gallery"
}
```

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

### configurePackage method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/ServiceProvider.md

Signature of the configurePackage method that receives a Package instance for configuration.

```php
public function configurePackage(Package $package): void
```

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

### Catch PHP Error for undefined generator name in Registry

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/errors.md

Catches the PHP Error raised when Registry::get() is called with an unregistered generator name. The error is a language-level undefined-array-key Error, not a package exception, because get() performs a direct array access.

```php
use Honeystone\Seo\Contracts\RegistersGenerators;

try {
    app(RegistersGenerators::class)->get('does-not-exist');
} catch (Error $e) {
    // undefined array key
}
```

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

### Configure meta generator methods

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Lists all meta methods provided by the Honeystone\Seo\Generators\MetaGenerator class. These are also available as default methods and propagate to the meta generator. Use seo()->generate('meta') or @metadata('meta') to render only the meta generator.

```php
seo()
    ->metaTitle('A fantastic blog post')
    ->metaTitleTemplate('🔥🔥 {title} 🔥🔥')
    ->metaDescription('Theres really a lot of great stuff in here...')
    ->metaKeywords('foo', 'bar', 'baz')
    ->metaCanonical('https://mywebsite.com/blog/a-fantastic-blog-post')
    ->metaCanonicalEnabled(true)
    ->metaRobots('🤖', '🤖', '🤖');
```

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

### Publishing config and views commands

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/ServiceProvider.md

Two Artisan commands to publish the config file (tag honeystone-seo-config) and the Blade views (tag honeystone-seo-views).

```bash
# Publish config (config/honeystone-seo.php)
php artisan vendor:publish --tag=honeystone-seo-config

# Publish views (honeystone-seo::* namespace)
php artisan vendor:publish --tag=honeystone-seo-views
```

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

### Set Open Graph type with ArticleProperties, BookProperties, ProfileProperties

Source: https://github.com/honeystone/laravel-seo/blob/master/README.md

Use non-vertical supported Open Graph types: article, book, and profile. Each type uses its respective properties class (ArticleProperties, BookProperties, ProfileProperties) passed to openGraphType(). Note the profile example has a missing comma after 'PiranhaGeorge' in the source.

```php
use Honeystone\Seo\OpenGraph\ArticleProperties;
use Honeystone\Seo\OpenGraph\BookProperties;
use Honeystone\Seo\OpenGraph\ProfileProperties;

//article
seo()
    ->openGraphType(new ArticleProperties(
        publishedTime: new DateTime('now'),
        modifiedTime: new DateTime('now'),
        expirationTime: null,
        author: new ProfileProperties(
            username: 'PiranhaGeorge',
        ),
        section: 'Foo',
        tag: 'Bar',
    ));

//book
seo()
    ->openGraphType(new BookProperties(
        author: [
            new ProfileProperties(
                firstName: 'Erich',
                lastName: 'Gamma',
            ),
            new ProfileProperties(
                firstName: 'Richard',
                lastName: 'Helm',
            ),
            new ProfileProperties(
                firstName: 'Ralph',
                lastName: 'Johnson',
            ),
            new ProfileProperties(
                firstName: 'John',
                lastName: 'Vlissides',
            ),
        ],
        isbn: '978-0201633610',
        releaseDate: new DateTime('14 March 1995'),
        tag: ['1st', 'GoF'],
    ));

//profile
seo()
    ->openGraphType(new ProfileProperties(
        username: 'PiranhaGeorge'
        firstName: 'George',
        lastName: 'Palmer',
        gender: 'male',
    ));
```

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

### multi() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/JsonLdGenerator.md

Returns the imported Spatie\SchemaOrg\MultiTypedEntity, creating one on first call.

```php
public function multi(): MultiTypedEntity
```

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

### Configure Twitter card metadata with fluent methods

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/TwitterGenerator.md

Enables Twitter cards and sets site, creator, title, description, and image. Title defaults to title() and image defaults to first images().

```php
use Honeystone\Seo\Twitter\PlayerProperties;

seo()
    ->twitterEnabled(true)
    ->twitterSite('@MyWebsite')
    ->twitterCreator('@MyTwitter')
    ->twitterTitle('A fantastic blog post')          // defaults to title()
    ->twitterDescription('Theres really a lot of great stuff in here...')
    ->twitterImage('https://mywebsite.com/images/blog-1/cover-image.webp'); // defaults to first images()
```

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

### ProfileProperties Constructor

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Creates a ProfileProperties instance to define Open Graph profile metadata. Parameters map to profile:first_name, profile:last_name, profile:username, and profile:gender tags.

```APIDOC
## ProfileProperties Constructor

### Description
Creates a ProfileProperties instance to define Open Graph profile metadata.

### Method
Constructor

### Parameters
- **$firstName** (?string) - Optional - Maps to `profile:first_name` (or `article:author:first_name` / `book:author:first_name` when aliased).
- **$lastName** (?string) - Optional - Maps to `profile:last_name` (or aliased).
- **$username** (?string) - Optional - Maps to `profile:username` (or aliased).
- **$gender** (?string) - Optional - Maps to `profile:gender` (or aliased).

### Example
```php
new ProfileProperties(
    firstName: 'John',
    lastName: 'Doe',
    username: 'johndoe',
    gender: 'male'
)
```
```

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

### description()

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/MetaGenerator.md

Sets the meta description. Passing `null` unsets the value.

```APIDOC
## description()

### Description
Sets the meta description. `null` unsets the value.

### Method
`public function description(?string $value): self`

### Parameters
- **$value** (`?string`) - Required - The meta description, or `null` to unset.

### Returns
- **self** - Returns `$this` for chaining.
```

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

### AudioProperties::__construct

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Constructor for the AudioProperties value object, mapping parameters to Open Graph audio meta tags.

```APIDOC
## AudioProperties

### Description
Constructs an AudioProperties value object used to define Open Graph audio metadata. Passed to `OpenGraphGenerator::audio()` (also accepts a plain URL string).

### Constructor
`new AudioProperties(?string $url = null, ?string $secureUrl = null, ?string $type = null)`

### Parameters
- **$url** (?string) - Optional - Default: `null` - Maps to `og:audio`.
- **$secureUrl** (?string) - Optional - Default: `null` - Maps to `og:audio:secure_url`.
- **$type** (?string) - Optional - Default: `null` - Maps to `og:audio:type` (e.g. `'audio/mpeg'`).

### Example
```php
new AudioProperties(
    url: 'https://example.com/audio.mp3',
    secureUrl: 'https://example.com/audio.mp3',
    type: 'audio/mpeg'
)
```
```

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

### BookProperties methods

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphProperties.md

Method signatures for BookProperties: getPrefix returns 'book: https://ogp.me/ns/book#', getType returns 'book', and defaultTag accepts a string or array of tags.

```php
public function getPrefix(): string   // 'book: https://ogp.me/ns/book#'
public function getType(): string     // 'book'
public function defaultTag(string|array $tag): void
```

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

### image() method

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/OpenGraphGenerator.md

Sets a single image, stored under the images data key as a one-element array. Accepts URL string or ImageProperties.

```php
/**
 * @return $this
 */
public function image(string|ImageProperties|null $value): self
```

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

### allNames() method signature

Source: https://github.com/honeystone/laravel-seo/blob/master/_autodocs/api-reference/Registry.md

Returns the registration names as an array of strings.

```php
public function allNames(): array
```
Tokens:
Raw