SEO Tools

https://github.com/artesaos/seotools
Admin
SEO Tools is a Laravel and Lumen package that provides helpers for common SEO techniques including...
Tokens:56,668
Snippets:332
Trust Score:6.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install SEOTools via Composer

Source: https://github.com/artesaos/seotools/blob/master/README.md

Run this command to install the package and update composer.json. Required before configuring providers or facades.

```shell
composer require artesaos/seotools
```

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

### Add OpenGraph audio and place properties

Source: https://github.com/artesaos/seotools/blob/master/README.md

Shows how to add OpenGraph audio and place properties using the OpenGraph facade. The audio example includes secure_url and type options, while the place example sets title, description, type, and location coordinates. Ends with returning a view.

```php
// og:audio
        OpenGraph::addAudio('http://example.com/sound.mp3', [
                'secure_url' => 'https://secure.example.com/sound.mp3',
                'type' => 'audio/mpeg'
            ]);

        // og:place
        OpenGraph::setTitle('Place')
             ->setDescription('Some Place')
            ->setType('place')
            ->setPlace([
                'location:latitude' => 'float',
                'location:longitude' => 'float',
            ]);

        return view('myshow', compact('post'));
```

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

### JsonLd example: set title, description, type, image, and author

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Shows how to use the JsonLd facade to set common properties and generate the JSON-LD script. The output is a single-line JSON-LD script tag.

```php
use Artesaos\SEOTools\Facades\JsonLd;

JsonLd::setTitle('Homepage');
JsonLd::setDescription('This is my page description');
JsonLd::setType('Article');
JsonLd::addImage('https://codecasts.com.br/img/logo.jpg');
JsonLd::addValue('author', ['@type' => 'Organization', 'name' => 'Artesaos']);

echo JsonLd::generate();
// <script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","name":"Homepage","description":"This is my page description","image":"https://codecasts.com.br/img/logo.jpg","author":{"@type":"Organization","name":"Artesaos"}}</script>
```

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

### Configure SEOTools Facade Aliases in config/app.php

Source: https://github.com/artesaos/seotools/blob/master/README.md

Add short-version aliases for the SEOTools facades in the 'aliases' array of config/app.php. This example shows aliases for SEOMeta, OpenGraph, Twitter, JsonLd, JsonLdMulti, and the combined SEOTools facade.

```php
<?php

return [
    // ...
    'aliases' => [
        'SEOMeta'       => Artesaos\SEOTools\Facades\SEOMeta::class,
        'OpenGraph'     => Artesaos\SEOTools\Facades\OpenGraph::class,
        'Twitter'       => Artesaos\SEOTools\Facades\TwitterCard::class,
        'JsonLd'        => Artesaos\SEOTools\Facades\JsonLd::class,
        'JsonLdMulti'   => Artesaos\SEOTools\Facades\JsonLdMulti::class,
        // or
        'SEO' => Artesaos\SEOTools\Facades\SEOTools::class,
        // ...
    ],
    // ...
];
```

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

### Usage example for SEOTools facades

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/facades.md

Shows how to use the SEOMeta, OpenGraph, TwitterCard, JsonLd, and SEOTools facades to set various SEO properties and generate output. The SEOTools::setTitle call fans out to all containers. The 'SEO' alias is defined in composer.json to point to Facades\SEOTools.

```php
use Artesaos\SEOTools\Facades\SEOMeta;
use Artesaos\SEOTools\Facades\OpenGraph;
use Artesaos\SEOTools\Facades\TwitterCard;
use Artesaos\SEOTools\Facades\JsonLd;
use Artesaos\SEOTools\Facades\SEOTools;

SEOMeta::setTitle('Home');
SEOMeta::addMeta('author', 'John Doe');
OpenGraph::setType('article');
TwitterCard::setSite('@LuizVinicius73');
JsonLd::setType('Article');
SEOTools::setTitle('Aggregated'); // fans out to all containers

echo SEOMeta::generate();
echo SEO::generate(true); // composer.json alias 'SEO' -> Facades\SEOTools
```

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

### Microdata HTML markup example (not supported)

Source: https://github.com/artesaos/seotools/blob/master/README.md

Example of microdata HTML markup that the package does not generate. The package does not provide microdata markup generation; you need to handle it yourself. Note that microdata is considered outdated and JSON-LD is recommended instead.

```html
<div itemscope>
 <p>My name is
  <span itemprop="name">Elizabeth</span>.</p>
</div>
```

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

### Controller usage with SEOTools facades

Source: https://github.com/artesaos/seotools/blob/master/README.md

Example of using SEOTools facades in a controller to set meta tags, OpenGraph, Twitter Card, and JsonLd data. Includes both individual facades and the SEOTools facade with alternative methods.

```php
<?php

namespace App\Http\Controllers;

use Artesaos\SEOTools\Facades\SEOMeta;
use Artesaos\SEOTools\Facades\OpenGraph;
use Artesaos\SEOTools\Facades\TwitterCard;
use Artesaos\SEOTools\Facades\JsonLd;
// OR with multi
use Artesaos\SEOTools\Facades\JsonLdMulti;

// OR
use Artesaos\SEOTools\Facades\SEOTools;

class CommonController extends Controller
{
    public function index()
    {
        SEOMeta::setTitle('Home');
        SEOMeta::setDescription('This is my page description');
        SEOMeta::setCanonical('https://codecasts.com.br/lesson');

        OpenGraph::setDescription('This is my page description');
        OpenGraph::setTitle('Home');
        OpenGraph::setUrl('http://current.url.com');
        OpenGraph::addProperty('type', 'articles');

        TwitterCard::setTitle('Homepage');
        TwitterCard::setSite('@LuizVinicius73');

        JsonLd::setTitle('Homepage');
        JsonLd::setDescription('This is my page description');
        JsonLd::addImage('https://codecasts.com.br/img/logo.jpg');

        // OR

        SEOTools::setTitle('Home');
        SEOTools::setDescription('This is my page description');
        SEOTools::opengraph()->setUrl('http://current.url.com');
        SEOTools::setCanonical('https://codecasts.com.br/lesson');
        SEOTools::opengraph()->addProperty('type', 'articles');
        SEOTools::twitter()->setSite('@LuizVinicius73');
        SEOTools::jsonLd()->addImage('https://codecasts.com.br/img/logo.jpg');

        $posts = Post::all();

        return view('myindex', compact('posts'));
    }

    public function show($id)
    {
        $post = Post::find($id);

        SEOMeta::setTitle($post->title);
        SEOMeta::setDescription($post->resume);
        SEOMeta::addMeta('article:published_time', $post->published_date->toW3CString(), 'property');
        SEOMeta::addMeta('article:section', $post->category, 'property');
        SEOMeta::addKeyword(['key1', 'key2', 'key3']);

        OpenGraph::setDescription($post->resume);
        OpenGraph::setTitle($post->title);
        OpenGraph::setUrl('http://current.url.com');
        OpenGraph::addProperty('type', 'article');
        OpenGraph::addProperty('locale', 'pt-br');
        OpenGraph::addProperty('locale:alternate', ['pt-pt', 'en-us']);

        OpenGraph::addImage($post->cover->url);
        OpenGraph::addImage($post->images->list('url'));
        OpenGraph::addImage(['url' => 'http://image.url.com/cover.jpg', 'size' => 300]);
        OpenGraph::addImage('http://image.url.com/cover.jpg', ['height' => 300, 'width' => 300]);

        JsonLd::setTitle($post->title);
        JsonLd::setDescription($post->resume);
        JsonLd::setType('Article');
        JsonLd::addImage($post->images->list('url'));

        // OR with multi

    }
}
```

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

### Basic usage with automatic first group and conditional new group

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonldmulti.md

Shows how to use JsonLdMulti facade: the first group is created automatically, set type/title/image, conditionally start a new group, and generate output. The output is two script tags for the Article and WebPage groups.

```php
use Artesaos\SEOTools\Facades\JsonLdMulti;

// first group is created automatically
JsonLdMulti::setType('Article');
JsonLdMulti::setTitle('Post title');
JsonLdMulti::addImage('https://example.com/img/cover.jpg');

if (!JsonLdMulti::isEmpty()) {
    JsonLdMulti::newJsonLd();          // start a second group
    JsonLdMulti::setType('WebPage');
}

echo JsonLdMulti::generate();
// <script type="application/ld+json">{...Article...}</script>
// <script type="application/ld+json">{...WebPage...}</script>
```

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

### Example generated SEO meta tags HTML

Source: https://github.com/artesaos/seotools/blob/master/README.md

Example HTML output generated by the SEO tools, showing meta tags for description, keywords, OpenGraph, Twitter, and JSON-LD. Includes multiple og:image tags and a JSON-LD script for Article type, with an alternative multi JSON-LD output.

```html
<html>
<head>
    <title>Title - Over 9000 Thousand!</title>
    <meta name='description' itemprop='description' content='description...'>
    <meta name='keywords' content='key1, key2, key3'>
    <meta property='article:published_time' content='2015-01-31T20:30:11-02:00'>
    <meta property='article:section' content='news'>

    <meta property="og:description" content="description...">
    <meta property="og:title" content="Title">
    <meta property="og:url" content="http://current.url.com">
    <meta property="og:type" content="article">
    <meta property="og:locale" content="pt-br">
    <meta property="og:locale:alternate" content="pt-pt">
    <meta property="og:locale:alternate" content="en-us">
    <meta property="og:site_name" content="name">
    <meta property="og:image" content="http://image.url.com/cover.jpg">
    <meta property="og:image" content="http://image.url.com/img1.jpg">
    <meta property="og:image" content="http://image.url.com/img2.jpg">
    <meta property="og:image" content="http://image.url.com/img3.jpg">
    <meta property="og:image:url" content="http://image.url.com/cover.jpg">
    <meta property="og:image:size" content="300">

    <meta name="twitter:card"content="summary">
    <meta name="twitter:title"content="Title">
    <meta name="twitter:site"content="@LuizVinicius73">

    <script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","name":"Title - Over 9000 Thousand!"}</script>
    <!-- OR with multi -->
    <script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","name":"Title - Over 9000 Thousand!"}</script>
    <script type="application/ld+json">{"@context":"https://schema.org","@type":"WebPage","name":"Title - Over 9000 Thousand!"}</script>
</head>
<body>

</body>
</html>
```

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

### Add Open Graph video

Source: https://github.com/artesaos/seotools/blob/master/README.md

Adds an Open Graph video with a secure URL, MIME type, width, and height. The example uses a Flash movie URL.

```php
// og:video
OpenGraph::addVideo('http://example.com/movie.swf', [
        'secure_url' => 'https://example.com/movie.swf',
        'type' => 'application/x-shockwave-flash',
        'width' => 400,
        'height' => 300
    ]);
```

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

### Generating Inertia-style SEO HTML

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/service-provider.md

Example of generating SEO HTML with Inertia style when the config option 'seotools.inertia' is true. The output includes tags with the 'inertia' attribute.

```php
// config('seotools.inertia') === true
$html = SEOTools::generate(); // <title inertia>Home</title> ... <meta inertia name="description" ...>
```

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

### Use SEOToolsTrait in a Laravel controller

Source: https://github.com/artesaos/seotools/blob/master/README.md

Example controller using the SEOToolsTrait to set SEO meta data. The trait provides a seo() method that gives access to title, description, OpenGraph, Twitter, and JSON-LD setters. This is a typical usage pattern for Laravel controllers.

```php
<?php

namespace App\Http\Controllers;

use Artesaos\SEOTools\Traits\SEOTools as SEOToolsTrait;

class CommonController extends Controller
{
    use SEOToolsTrait;

    public function index()
    {
        $this->seo()->setTitle('Home');
        $this->seo()->setDescription('This is my page description');
        $this->seo()->opengraph()->setUrl('http://current.url.com');
        $this->seo()->opengraph()->addProperty('type', 'articles');
        $this->seo()->twitter()->setSite('@LuizVinicius73');
        $this->seo()->jsonLd()->setType('Article');

        $posts = Post::all();

        return view('myindex', compact('posts'));
    }
}
```

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

### boot method

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/service-provider.md

Declares the boot method. Loads configuration from the shipped config file, merges it under the 'seotools' key, and publishes it for Laravel or configures it for Lumen.

```php
public function boot()
```

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

### SEOToolsServiceProvider::boot

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/service-provider.md

Loads the seotools configuration file and publishes it for Laravel or configures it for Lumen.

```APIDOC
## SEOToolsServiceProvider::boot

### Description
Loads the seotools configuration file and publishes it for Laravel or configures it for Lumen.

### Method
boot

### Signature
public function boot()

### Returns
void

### Details
- Loads configuration from `src/resources/config/seotools.php`.
- For Lumen, configures the app's `seotools` config from the file.
- For Laravel, publishes the config to `config_path('seotools.php')`.
- Merges config under the `seotools` key via `mergeConfigFrom($configFile, 'seotools')`.
```

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

### Basic SEOTools facade usage with container access

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seotools.md

Shows the main facade usage: setting title, description, canonical URL, and images, then accessing individual containers (opengraph, twitter, jsonLd) to add properties. Generates the head fragment with optional minification and retrieves the title with session flag.

```php
use Artesaos\SEOTools\Facades\SEOTools;

SEOTools::setTitle('Home');
SEOTools::setDescription('This is my page description');
SEOTools::setCanonical('https://codecasts.com.br/lesson');
SEOTools::addImages(['http://image1.jpg', 'http://image2.jpg']);

// access individual containers
SEOTools::opengraph()->addProperty('type', 'articles');
SEOTools::twitter()->addValue('app:country', 'US');
SEOTools::jsonLd()->addValue('author', ['@type' => 'Organization', 'name' => 'Artesaos']);

echo SEOTools::generate();      // head fragment
echo SEOTools::generate(true);  // minified
$sessionTitle = SEOTools::getTitle(true);
```

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

### SEOMeta::__construct

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seometa.md

Constructor for the SEOMeta class, accepting a configuration repository.

```APIDOC
## Constructor

### Description
Creates a new SEOMeta instance, storing the configuration repository reference for later use.

### Method
Constructor

### Endpoint
`Artesaos\SEOTools\SEOMeta::__construct`

### Parameters
- **$config** (`Illuminate\Config\Repository`) - Required - Config repository; the provider passes `seotools.meta`, so `defaults.*` / `webmaster_tags` / `add_notranslate_class` keys are read from that section.

### Request Example
```php
$seoMeta = new SEOMeta($config);
```

### Response
#### Success Response
No return value.

```

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

### setUrl and isEmpty

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Documentation for URL setting and emptiness checking methods in the JsonLd class.

```APIDOC
## setUrl and isEmpty

### Description
`setUrl` sets the URL for the JSON-LD structured data. If `null` is passed, it resolves to the full current URL at generation time; if `'current'` is passed, it resolves to the current URL. `isEmpty` checks whether any data has been set, returning `true` only when nothing has been set.

### Method
PHP method

### Endpoint
`Artesaos\SEOTools\JsonLd::setUrl($url)`
`Artesaos\SEOTools\JsonLd::isEmpty()`

### Parameters
- `$url` (string|null) - Required - The URL to set. Use `null` to resolve to full URL, or `'current'` to resolve to current URL.

### Return Value
- `setUrl` returns `static` (`$this`).
- `isEmpty` returns `bool` - `true` when no data has been set, `false` otherwise.

### Example
```php
use Artesaos\SEOTools\Facades\JsonLd;

JsonLd::setUrl(null);      // resolved to app('url')->full() at generate() time
JsonLd::setUrl('current'); // resolved to app('url')->current()

if (JsonLd::isEmpty()) {
    // avoid emitting an empty JSON-LD block
}
```
```

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

### Lumen usage with app() helper

Source: https://github.com/artesaos/seotools/blob/master/README.md

In Lumen, facades are not supported, so use the app() helper to access SEOTools services. The behavior is the same as using facades.

```php
<?php

$seotools = app('seotools');
$metatags = app('seotools.metatags');
$twitter = app('seotools.twitter');
$opengraph = app('seotools.opengraph');
$jsonld = app('seotools.json-ld');
$jsonldMulti = app('seotools.json-ld-multi');

// The behavior is the same as the facade

echo app('seotools')->generate();
```

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

### addVideo and addAudio method signatures

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/opengraph.md

Method signatures for adding video and audio media to Open Graph. Both return static ($this) and accept a media URL and an attributes array. Valid attribute keys for addVideo are url, secure_url, type, width, height; for addAudio they are url, secure_url, type. Invalid keys are dropped.

```php
public function addVideo($source = null, $attributes = [])
public function addAudio($source = null, $attributes = [])
```

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

### JsonLd facade API methods

Source: https://github.com/artesaos/seotools/blob/master/README.md

Shows the JsonLd facade methods for adding values and setting type, title, site, description, URL, and image. Methods can be chained, and generate() outputs the HTML tags.

```php
<?php

use Artesaos\SEOTools\Facades\JsonLd;

JsonLd::addValue($key, $value); // value can be string or array
JsonLd::setType($type); // type of twitter card tag
JsonLd::setTitle($type); // title of twitter card tag
JsonLd::setSite($type); // site of twitter card tag
JsonLd::setDescription($type); // description of twitter card tag
JsonLd::setUrl($type); // url of twitter card tag
JsonLd::setImage($url); // add image url

// You can chain methods
JsonLd::addValue($key, $value)
    ->setType($type)
    ->setImage($url)
    ->setTitle($title)
    ->setDescription($description)
    ->setUrl($url)
    ->setSite($name);

// Generate html tags
JsonLd::generate();
```

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

### SEOMeta facade API methods

Source: https://github.com/artesaos/seotools/blob/master/README.md

Lists the available SEOMeta facade methods for setting, chaining, retrieving, and generating meta tags. Use this as a reference for configuring title, description, keywords, canonical URLs, and alternate languages. The generate() method outputs the HTML tags.

```php
<?php

use Artesaos\SEOTools\Facades\SEOMeta;

SEOMeta::addKeyword($keyword);
SEOMeta::addMeta($meta, $value = null, $name = 'name');
SEOMeta::addAlternateLanguage($lang, $url);
SEOMeta::addAlternateLanguages(array $languages);
SEOMeta::setAlternateLanguage($lang, $url);
SEOMeta::setAlternateLanguages(array $languages);
SEOMeta::setTitleSeparator($separator);
SEOMeta::setTitle($title);
SEOMeta::setTitleDefault($default);
SEOMeta::setDescription($description);
SEOMeta::setKeywords($keywords);
SEOMeta::setRobots($robots);
SEOMeta::setCanonical($url);
SEOMeta::setPrev($url);
SEOMeta::setNext($url);
SEOMeta::removeMeta($key);

// You can chain methods
SEOMeta::setTitle($title)
            ->setDescription($description)
            ->setKeywords($keywords)
            ->addKeyword($keyword)
            ->addMeta($meta, $value);

// Retrieving data
SEOMeta::getTitle();
SEOMeta::getTitleSession();
SEOMeta::getTitleSeparator();
SEOMeta::getKeywords();
SEOMeta::getDescription();
SEOMeta::getCanonical($url);
SEOMeta::getPrev($url);
SEOMeta::getNext($url);
SEOMeta::getRobots();
SEOMeta::reset();

SEOMeta::generate();
```

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

### Lumen equivalent using app('seotools')

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seotools.md

Lumen equivalent without facades: resolves the 'seotools' service from the container and uses the same methods. Behavior is identical to the facade version.

```php
$seotools = app('seotools');
$seotools->setTitle('Home');
$seotools->opengraph()->setUrl('http://current.url.com');
echo $seotools->generate();
```

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

### Publish config with artisan vendor:publish

Source: https://github.com/artesaos/seotools/blob/master/README.md

Run this command in the terminal to publish the SEOTools configuration file. Use the --provider flag to specify the SEOTools service provider. Lumen does not support this command; instead, copy the config file manually.

```shell
php artisan vendor:publish
```

```shell
php artisan vendor:publish --provider="Artesaos\SEOTools\Providers\SEOToolsServiceProvider"
```

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

### Selecting a previous group and chaining

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonldmulti.md

Demonstrates selecting a previous group with select(0), mutating it, checking emptiness, and generating output. Shows that select does not throw for out-of-range indices and that isEmpty checks the current group.

```php
use Artesaos\SEOTools\Facades\JsonLdMulti;

JsonLdMulti::addValue('author', ['@type' => 'Organization', 'name' => 'Artesaos']);

JsonLdMulti::newJsonLd()->setType('Product');   // group 1
JsonLdMulti::select(0);                          // back to group 0
JsonLdMulti::setTitle('Edited title');           // mutates group 0

// group-level emptiness check before rendering:
if (JsonLdMulti::isEmpty()) {
    // current (group 0) has no data
}
echo JsonLdMulti::generate(true);
```

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

### Constructor

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/twittercards.md

Initializes the TwitterCards generator with optional default key-value pairs.

```APIDOC
## Constructor

### Description
Initializes the TwitterCards generator with optional default key-value pairs.

### Method
Constructor

### Endpoint
`__construct(array $defaults = [])`

### Parameters
- **$defaults** (array) - Optional - Default key-value pairs preloaded into the generator.

### Request Example
```php
$twitterCards = new TwitterCards(['site' => '@example']);
```

### Response
No return value.

```

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

### provides method

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/service-provider.md

Declares the provides method. Returns an array of all resolvable bindings: six contract interfaces and six string keys.

```php
public function provides()
```

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

### JsonLd URL resolution and isEmpty guard

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Demonstrates how setUrl handles null and 'current' values, and how isEmpty can be used to avoid emitting an empty JSON-LD block. No exceptions are thrown by the class.

```php
use Artesaos\SEOTools\Facades\JsonLd;

JsonLd::setUrl(null);      // resolved to app('url')->full() at generate() time
JsonLd::setUrl('current'); // resolved to app('url')->current()

if (JsonLd::isEmpty()) {           // true only when nothing was set
    // avoid emitting an empty JSON-LD block
}
echo JsonLd::generate();
```

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

### SEOMeta constructor signature

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seometa.md

Constructor for SEOMeta, accepting an Illuminate\Config\Repository instance. The service provider passes the 'seotools.meta' config section, so defaults, webmaster_tags, and add_notranslate_class keys are read from that section. State is per-instance and persists across requests unless reset() is called.

```php
public function __construct(Config $config)
```

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

### OpenGraph facade API methods

Source: https://github.com/artesaos/seotools/blob/master/README.md

Shows the OpenGraph facade methods for adding properties, images, and setting title, description, URL, and site name. Methods can be chained, and generate() outputs the HTML tags.

```php
<?php

use Artesaos\SEOTools\Facades\OpenGraph;

OpenGraph::addProperty($key, $value); // value can be string or array
OpenGraph::addImage($url); // add image url
OpenGraph::addImages($url); // add an array of url images
OpenGraph::setTitle($title); // define title
OpenGraph::setDescription($description);  // define description
OpenGraph::setUrl($url); // define url
OpenGraph::setSiteName($name); //define site_name

// You can chain methods
OpenGraph::addProperty($key, $value)
            ->addImage($url)
            ->addImages($url)
            ->setTitle($title)
            ->setDescription($description)
            ->setUrl($url)
            ->setSiteName($name);

// Generate html tags
OpenGraph::generate();
```

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

### Facade accessor method

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/facades.md

Returns the service container binding key 'seotools' for the SEOTools facade.

```php
protected static function getFacadeAccessor()   // returns 'seotools'
```

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

### isEmpty method

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Returns true when values, type, title, description, url, and images are all empty.

```php
public function isEmpty()
```

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

### setType, setTitle, setSite, setDescription, setUrl

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Sets various properties of the JSON-LD node.

```APIDOC
## `setType`, `setTitle`, `setSite`, `setDescription`, `setUrl`

### Description
Sets various properties of the JSON-LD node.

### Methods
- `setType($type)`
- `setTitle($title)`
- `setSite($site)`
- `setDescription($description)`
- `setUrl($url)`

### Parameters
- `$type` (string) - Required - schema.org type, e.g. `Article`, `WebPage` (config default: `WebPage`)
- `$title` (string) - Required - Node name
- `$site` (string) - Required - Sets the node `url` (alias of `setUrl`)
- `$description` (string) - Required - Node description
- `$url` (string|null|bool) - Required - Node URL; accepts `string`, `null`, `bool` semantics as described in `convertToArray` (`false` = omit, `null`/`'full'`/`'current'` = resolved automatically)

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

```

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

### Facades\SEOMeta

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/facades.md

Static methods for managing SEO meta tags, including title, description, keywords, canonical URLs, and alternate languages.

```APIDOC
## Facades\SEOMeta

### Description
Provides static methods to generate and manage SEO meta tags, including title, description, keywords, canonical URLs, and alternate languages.

### Methods

- `generate(bool $minify = false)` - Generate the meta tags HTML.
- `setTitle(string $title, bool $appendDefault = true)` - Set the page title.
- `setTitleDefault(string $default)` - Set the default title.
- `setTitleSeparator(string $separator)` - Set the title separator.
- `setDescription(string $description)` - Set the meta description.
- `setKeywords(string|array $keywords)` - Set the meta keywords.
- `addKeyword(string|array $keyword)` - Add a keyword or multiple keywords.
- `removeMeta(string $key)` - Remove a meta tag by key.
- `addMeta(string|array $meta, string|null $value = null, string $name = 'name')` - Add a custom meta tag.
- `setCanonical(string $url)` - Set the canonical URL.
- `setPrev(string $url)` - Set the previous URL.
- `setNext(string $url)` - Set the next URL.
- `addAlternateLanguage(string $lang, string $url)` - Add an alternate language URL.
- `addAlternateLanguages(array $languages)` - Add multiple alternate language URLs.
- `setAlternateLanguage(string $lang, string $url)` - Set an alternate language URL.
- `setAlternateLanguages(array $languages)` - Set multiple alternate language URLs.
- `getTitle()` - Get the current title.
- `getTitleSession()` - Get the title session.
- `getTitleSeparator()` - Get the title separator.
- `getMetatags()` - Get all meta tags.
- `getKeywords()` - Get the keywords.
- `getDescription()` - Get the description.
- `getCanonical()` - Get the canonical URL.
- `getPrev()` - Get the previous URL.
- `getNext()` - Get the next URL.
- `getAlternateLanguages()` - Get the alternate languages.
- `getDefaultTitle()` - Get the default title.
- `reset()` - Reset all meta data.

### Facade Accessor
- `getFacadeAccessor()` returns `'seotools.metatags'`.
```

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

### setImages, addImage, setImage

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Documentation for the image management methods in the JsonLd class.

```APIDOC
## setImages, addImage, setImage

### Description
These methods manage the list of images associated with the JSON-LD structured data. `setImages` clears the existing list and appends the provided images, `addImage` appends a single image or merges an array of images, and `setImage` replaces the entire list with a single image.

### Method
PHP method

### Endpoint
`Artesaos\SEOTools\JsonLd::setImages($images)`
`Artesaos\SEOTools\JsonLd::addImage($image)`
`Artesaos\SEOTools\JsonLd::setImage($image)`

### Parameters
- `$image` / `$images` (string|array) - Required - The image URL(s) to set or add.

### Return Value
- `static` (`$this`) - Returns the current instance for method chaining.

### Example
```php
use Artesaos\SEOTools\Facades\JsonLd;

JsonLd::addImage('https://codecasts.com.br/img/logo.jpg');
```
```

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

### SEOToolsServiceProvider::provides

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/service-provider.md

Returns the list of bindings the provider can resolve.

```APIDOC
## SEOToolsServiceProvider::provides

### Description
Returns the list of bindings the provider can resolve.

### Method
provides

### Signature
public function provides()

### Returns
array - List of bindings: all six contract interfaces plus the six string keys `seotools`, `seotools.metatags`, `seotools.opengraph`, `seotools.twitter`, `seotools.json-ld`, `seotools.json-ld-multi`.
```

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

### SEOTools facade API for accessing all SEO providers

Source: https://github.com/artesaos/seotools/blob/master/README.md

Shows the SEOTools facade that facilitates access to all SEO providers: metatags, twitter, opengraph, and jsonLd. Includes methods to set/get title, set description, set canonical URL, and add images.

```php
<?php

use Artesaos\SEOTools\Facades\SEOTools;

SEOTools::metatags();
SEOTools::twitter();
SEOTools::opengraph();
SEOTools::jsonLd();

SEOTools::setTitle($title);
SEOTools::getTitle($session = false);
SEOTools::setDescription($description);
SEOTools::setCanonical($url);
SEOTools::addImages($urls);
```

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

### Facades\JsonLd

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/facades.md

Provides static methods to configure and generate JSON-LD structured data.

```APIDOC
## Facades\JsonLd

### Description
Provides static methods to configure and generate JSON-LD structured data.

### Methods
- `generate(bool $minify = false)` - Generates the JSON-LD script tag.
- `isEmpty()` - Checks if the JSON-LD is empty.
- `addValue(string $key, string|array $value)` - Adds a custom value to the JSON-LD.
- `addValues(array $values)` - Adds multiple values to the JSON-LD.
- `setType(string $type)` - Sets the JSON-LD type.
- `setTitle(string $title)` - Sets the JSON-LD title.
- `setSite(string $site)` - Sets the JSON-LD site.
- `setDescription(string $description)` - Sets the JSON-LD description.
- `setUrl(string|null|bool $url)` - Sets the JSON-LD URL.
- `addImage(string|array $image)` - Adds an image to the JSON-LD.
- `setImages(string|array $images)` - Sets the images for the JSON-LD.

### Facade Accessor
Returns `'seotools.json-ld'`.
```

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

### getDescription

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seometa.md

Documentation for the `getDescription` method of the SEOMeta class, which retrieves the current meta description.

```APIDOC
## `getDescription`

```php
public function getDescription()
```

### Description
Returns the current meta description, or `null` if it has been suppressed.

### Method
`getDescription`

### Signature
`public function getDescription()`

### Parameters
None.

### Return Value
`string|null` - The current description or `null`.

### Example
```php
use Artesaos\SEOTools\Facades\SEOMeta;

$desc = SEOMeta::getDescription();
```
```

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

### Register and call a runtime macro on SEOTools

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seotools.md

Registers a custom static macro on the SEOTools facade at runtime using the Macroable trait, then calls it as a regular method. The macro sets title and description on both SEOMeta and OpenGraph containers.

```php
SEOTools::macro('webPage', function (string $title, string $description) {
    SEOMeta::setTitle($title);
    SEOMeta::setDescription($description);
    OpenGraph::setTitle($title);
    OpenGraph::setDescription($description);
});

SEOTools::webPage('Page title', 'Page description'); // runtime-registered macro
```

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

### OpenGraph setType, setTitle, setDescription, setUrl, setSiteName signatures

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/opengraph.md

Method signatures for setting Open Graph metadata: type, title, description, URL, and site name. setUrl stores the URL separately and only merges it into og:url during generate() if the config default is falsy. All return static.

```php
public function setType($type = null)
public function setTitle($title = null)
public function setDescription($description = null)
public function setUrl($url)
public function setSiteName($name)
```

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

### JsonLdMulti facade API for multiple JSON-LD groups

Source: https://github.com/artesaos/seotools/blob/master/README.md

Shows the JsonLdMulti facade methods for managing multiple JSON-LD groups: create, check emptiness, select, add values, set type/title/site/description/url/image, chain methods, add another group conditionally, and generate HTML tags. The final generate() outputs a <script> tag with content="application/ld+json".

```php
<?php

use Artesaos\SEOTools\Facades\JsonLdMulti;

JsonLdMulti::newJsonLd(); // create a new JsonLd group
JsonLdMulti::isEmpty(); // check if the current JsonLd group is empty
JsonLdMulti::select($index); // choose the JsonLd group that will be edited by the methods below
JsonLdMulti::addValue($key, $value); // value can be string or array
JsonLdMulti::setType($type); // type of twitter card tag
JsonLdMulti::setTitle($type); // title of twitter card tag
JsonLdMulti::setSite($type); // site of twitter card tag
JsonLdMulti::setDescription($type); // description of twitter card tag
JsonLdMulti::setUrl($type); // url of twitter card tag
JsonLdMulti::setImage($url); // add image url

// You can chain methods
JsonLdMulti::addValue($key, $value)
    ->setType($type)
    ->setImage($url)
    ->setTitle($title)
    ->setDescription($description)
    ->setUrl($url)
    ->setSite($name);
// You can add an other group
if(! JsonLdMulti::isEmpty()) {
    JsonLdMulti::newJsonLd()
        ->setType($type)
        ->setImage($url)
        ->setTitle($title)
        ->setDescription($description)
        ->setUrl($url)
        ->setSite($name);
}
// Generate html tags
JsonLdMulti::generate();
// You will have retrieve <script content="application/ld+json"/>
```

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

### SEOTools sub-container accessors

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seotools.md

Accessor methods that return the respective service-container singleton via app('seotools.metatags'), app('seotools.opengraph'), app('seotools.twitter'), app('seotools.json-ld'), and app('seotools.json-ld-multi'). Each returns a contract instance: MetaTags, OpenGraph, TwitterCards, JsonLd, or JsonLdMulti.

```php
public function metatags()
public function opengraph()
public function twitter()
public function jsonLd()
public function jsonLdMulti()
```

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

### new JsonLdMulti(array $defaultJsonLdData = [])

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonldmulti.md

Constructor that initializes the JsonLdMulti container with optional default data applied to each new JsonLd group. It immediately creates the first group.

```APIDOC
## Constructor

### Description
Initializes a new JsonLdMulti instance. The constructor creates the first JsonLd group immediately.

### Method
Constructor

### Parameters
- **$defaultJsonLdData** (array) - Optional - Default data applied to every newly created JsonLd group.

### Request Example
```php
$jsonLdMulti = new JsonLdMulti(['@context' => 'https://schema.org']);
```

### Response
No return value.
```

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

### TwitterCard facade API methods

Source: https://github.com/artesaos/seotools/blob/master/README.md

Lists the TwitterCard facade methods for setting card type, title, site, description, URL, and image. Methods can be chained, and generate() outputs the HTML tags.

```php
<?php

use Artesaos\SEOTools\Facades\TwitterCard;

TwitterCard::addValue($key, $value); // value can be string or array
TwitterCard::setType($type); // type of twitter card tag
TwitterCard::setTitle($type); // title of twitter card tag
TwitterCard::setSite($type); // site of twitter card tag
TwitterCard::setDescription($type); // description of twitter card tag
TwitterCard::setUrl($type); // url of twitter card tag
TwitterCard::setImage($url); // add image url

// You can chain methods
TwitterCard::addValue($key, $value)
            ->setType($type)
            ->setImage($url)
            ->setTitle($title)
            ->setDescription($description)
            ->setUrl($url)
            ->setSite($name);

// Generate html tags
TwitterCard::generate();
```

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

### OpenGraph Class Reference

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/opengraph.md

Documentation for the OpenGraph class constructor and generate method.

```APIDOC
## `OpenGraph` — Open Graph meta tags generator

Namespace: `Artesaos\SEOTools` — file: `src/SEOTools/OpenGraph.php` (class declared at line 13).

Implements `Artesaos\SEOTools\Contracts\OpenGraph`. Registered as the `seotools.opengraph` singleton, constructed with the `seotools.opengraph` config section; reachable via `Artesaos\SEOTools\Facades\OpenGraph` (see [facades.md](facades.md)) or the `Contracts\OpenGraph` DI binding.

## Constructor

```php
public function __construct(array $config = [])
```

Source: `src/SEOTools/OpenGraph.php:162`.

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `$config` | `array` | `[]` | Config array; only the `defaults` key is consumed (`setupDefaults()`) — you can add extra tags not present in the shipped config |

## `generate`

```php
public function generate($minify = false)
```

Source: `src/SEOTools/OpenGraph.php:170`.

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `$minify` | `bool` | `false` | When `true`, `PHP_EOL` line breaks are stripped from the output |

Returns `string` — `<meta property="og:..." content="...">` tags, prefixed with `og:`. `setupDefaults()` merges config defaults first, then properties render in this fixed order: general `properties` (incl. `og:type`, `og:title`, `og:description`, `og:url`...), `og:image` entries, then namespace groups `article`, `profile`, `book`, `music`, `video`, `audio`, `place`, `product`, followed by the array-style `og:video`, `og:audio` entries (the `true` marker in the internal `$props` map means "property is an array of items with numeric keys").
```

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

### setType, setTitle, setDescription, setUrl, setSiteName

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/opengraph.md

Convenience setters for common Open Graph meta tags.

```APIDOC
## `setType`, `setTitle`, `setDescription`, `setUrl`, `setSiteName`

```php
public function setType($type = null)
public function setTitle($title = null)
public function setDescription($description = null)
public function setUrl($url)
public function setSiteName($name)
```

### Description
Convenience methods to set common Open Graph properties such as type, title, description, URL, and site name. `setUrl` stores the URL separately and only merges it into `og:url` during `generate()` under certain conditions.

### Parameters
- **$type** (string/null) - Optional - `og:type` value (e.g. `article`, `book`, `profile`)
- **$title** (string/null) - Optional - `og:title` value
- **$description** (string/null) - Optional - `og:description` value; HTML-escaped with `ENT_QUOTES`, UTF-8
- **$url** (string) - Required - URL to use as `og:url`; stored in `$this->url` and merged into property during `generate()` only if config default is falsy/null
- **$name** (string) - Required - `og:site_name` value

### Return
All five methods return `static` ($this).

```

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

### register method

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/service-provider.md

Declares the register method. Registers singleton bindings for seotools.metatags, seotools.opengraph, seotools.twitter, seotools.json-ld, seotools.json-ld-multi, and seotools, plus interface bindings.

```php
public function register()
```

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

### Set and generate SEO meta tags

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/seometa.md

Shows typical usage of the SEOMeta facade: setting title, description, canonical, custom meta tags, keywords, alternate languages, and robots. The generate() method outputs the full HTML fragment, while generate(true) outputs minified HTML without line breaks.

```php
use Artesaos\SEOTools\Facades\SEOMeta;

SEOMeta::setTitle('Home');                        // -> "Home - It's Over 9000!"
SEOMeta::setDescription('This is my page description');
SEOMeta::setCanonical('https://codecasts.com.br/lesson');
SEOMeta::addMeta('article:published_time', $post->published_date->toW3CString(), 'property');
SEOMeta::addMeta('author', 'John Doe');
SEOMeta::addKeyword(['key1', 'key2', 'key3']);
SEOMeta::addAlternateLanguage('pt', 'https://codecasts.com.br/pt');
SEOMeta::setRobots('index,follow');

echo SEOMeta::generate();      // full HTML fragment
echo SEOMeta::generate(true);  // minified (no line breaks)
```

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

### JsonLd image method signatures

Source: https://github.com/artesaos/seotools/blob/master/_autodocs/api-reference/jsonld.md

Declarations for setImages, addImage, and setImage. setImages clears the list then appends; addImage appends a string or merges an array; setImage replaces the list with [$image]. All return static ($this).

```php
public function setImages($images)
public function addImage($image)
public function setImage($image)
```

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

### Use SEOTools webPage macro

Source: https://github.com/artesaos/seotools/blob/master/README.md

Calls the custom 'webPage' macro defined earlier, passing a title and description. This is used in a controller to apply the macro's SEO settings.

```php
SEOTools::webPage('Page title', 'Page description');
```
Tokens:
Raw