【Laravel】構造化マークアップを動的に埋め込む方法｜サービスとファサードを使ってOrganization,WebPage,BreadCrumbsの構造化例

<?php

namespace App\Services;

class JsonLd
{
    //構造化データを入れる変数を定義
    private $collection;

    //空のコレクションを格納
    public function __construct() {
        $this->collection = collect([]);
    }

    //Collectionへの追加
    public function pushCollection($item) {
        if (is_array($item)) {
            $item = collect($item);
        }

        $this->collection->push($item);
        return $this;
    }

    //Websiteの構造化データ
    public function putWebSite() {
      return self::pushCollection([
          '@type' => 'WebSite',
          'name' => 'サイト名',
          'alternateName' => 'サイトの別名（英語表記など）',
          'url' => 'https://example.com/',
          'description' => 'サイトの説明',
          'image' => [
              '@type' => 'ImageObject',
              'url' => 'サイトロゴのURL'
          ]
      ]);
    }

  //Organizatioの構造化データ
  public function putOrganization() {
    return self::pushCollection([
        '@type' => 'Organization',
        'name'  => '組織名',
        'url' => 'https://example.com/',
        'address' => [
            '@context' => 'https://schema.org',
            '@type' => 'PostalAddress',
            'addressLocality' => '新宿区',
            'addressRegion' => '東京都',
            'postalCode' => '111-1234',
            'streetAddress' => '1-11-111, 新宿駅３F',
            'addressCountry' => 'JP'
        ],
        'foundingDate' => '2022-01-01（創立日）',
        'founder' => '社長名',
        'member' => '役員名',
        'parentOrganization' =>  [
            '@type' => 'Organization',
            'name' => '親会社名',
            'url' => '親会社のURL',
        ],
        'description'  => 'サイトの説明',
        'telephone'  => '+81-11-1111-1111',
        'logo'  => [
            '@type' => 'ImageObject',
            'url'   => '会社のロゴURL',
        ],
    ]);
   }

    //パンくずの構造化データ
    public function putBreadcrumbList($breadcrumbs) {
        return self::pushCollection([
            '@type' => 'BreadcrumbList',
            'itemListElement' => $breadcrumbs->map(function($breadcrumb, $i) {
                return ['@type'=>'ListItem','position'=>$i+1, 'name'=> $breadcrumb->title, 'item'=>$breadcrumb->url ];
            }),
        ]);
    }

    //記事の構造化データ
    public function putArticle($items) {
        return self::pushCollection([
            '@type' => 'Article',
            'mainEntityOfPage' => [
                '@type' => 'WebPage',
                '@id'   => '記事のURL',
            ],
            'headline'      => 'タイトル',
            'image'         => 'キービジュアルのURL',
            'description'   => '説明',
            'datePublished' => '発行日',
            'dateModified'  => '更新日',
            'author'        => '著者',
            'publisher'     => [
                '@type' => 'Organization',
                'name'  => '組織名',
                'logo'  => [
                    '@type' => 'ImageObject',
                    'url'   => '組織のロゴURL',
                ],
            ],
        ]);
    }


    //コレクションをJsonに変換
    public function renderJson() {
        return json_encode($this->collection->map(function($item){
            $item['@context'] = 'http://schema.org';
            return $item;
        });
    }
}

    //構造化データを入れる変数を定義
    private $collection;

    //空のコレクションを格納
    public function __construct() {
        $this->collection = collect([]);
    }

    //Collectionへの追加
    public function pushCollection($item) {
        if (is_array($item)) {
            $item = collect($item);
        }

        $this->collection->push($item);
        return $this;
    }

    //コレクションをJsonに変換
    public function renderJson() {
        return json_encode($this->collection->map(function($item){
            $item['@context'] = 'http://schema.org';
            return $item;
        })->values());
    }
}

    public function register()
    {
        $this->app->singleton('サービス名', function ($app) {
            処理;
        });
    }

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use App\Services\JsonLd;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton('JsonLd', function () {
            return new JsonLd();
        });
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

}

<?php

namespace App\Facades;

use Illuminate\Support\Facades\Facade;

class JsonLdFacade extends Facade
{
    protected static function getFacadeAccessor()
    {
        return 'JsonLd';
    }
}

    'aliases' => [

        //省略
        'JsonLd' => App\Facades\JsonLdFacade::class,
    ],

<?php

if (! function_exists('ヘルパ名')) {
    function ヘルパ名(引数)
    {
        //処理;
    }
}

if(! function_exists( "structured_markup" )){
    function structured_markup($breadcrumbs){        
        //パンくず構造化マークアップ
        JsonLd::putBreadcrumbList($breadcrumbs);
    }
}

    "autoload": {
        "files": [
            "app/helpers.php"
        ],
    }

$ composer dump-autoload

@php
//Websiteの構造化データを追加
\JsonLd::putWebSite();

//Organizationの構造化データを追加
\JsonLd::putOrganization();

//パンくずの生成
$currentRoute = route()->getName();
$breadcrumbsHtml = Breadcrumbs::render( $currentRoute );
$breadcrumbs = Breadcrumbs::generate( $currentRoute );

//Breadcrumbsの構造化データ生成
structured_markup($breadcrumbs);
@endphp

<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="description" content="説明">
    <meta name="keywords" content="キーワード">
    <title>タイトル</title>

    {{-- Structured Markup --}}
     <script type="application/ld+json">
        {!! JsonLd::renderJson() !!}
    </script>

</head>
<body">
    @include('layouts.header')
    {{ $breadcrumbsHtml }}
    <div class="@yield('contentClass')">
        @yield('content')
    </div>
    @include('layouts.footer')
</body>
</html>