fix readme

ralphjsmit · May 27, 2024 · a4a3f51 · a4a3f51
1 parent af06fe4
commit a4a3f51
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -405,16 +405,12 @@ public function getDynamicSEOData(): SEOData
     return new SEOData(
         // ...
         title: "A boring title"
-        schema: SchemaCollection::make()->addArticle(function(SEOData $SEOData, ArticleSchema $article){
-            return $article->mergeRecursive([
-                'alternativeHeadline' => "Not {$SEOData->title}", // will be "Not A boring title"
-                'author' => [
-                    [
-                        '@type' => 'Person',
-                        'name' => $this->moderator,
-                    ]
-                ]
-            ]);
+        schema: SchemaCollection::make()->addArticle(function(ArticleSchema $article, SEOData $SEOData){
+            return $article
+                ->addAuthor($this->moderator)
+                ->merge([
+                    'alternativeHeadline' => "Not {$SEOData->title}", // will be "Not A boring title"
+                ]);
         }),
     );
 }
@@ -433,32 +429,18 @@ use RalphJSmit\Laravel\SEO\Support\SEOData;
 use Illuminate\Support\Collection;
 
 SchemaCollection::make()
-   ->addBreadcrumbs(function (BreadcrumbListSchema $breadcrumb, SEOData $SEOData) {
-        $items = $breadcrumb->get('itemListElement', []);
-
-        $breadcrumb->put(
-            'itemListElement',
-            [
-                [
-                    '@type' => 'ListItem',
-                    'name' => 'Homepage',
-                    'item' => 'https://example.com',
-                ],
-                [
-                    '@type' => 'ListItem',
-                    'name' => 'Category',
-                    'item' => 'https://example.com/test',
-                ],
-                ...$items,
-                [
-                    '@type' => 'ListItem',
-                    'name' => 'Subarticle',
-                    'item' => 'https://example.com/test/article/2',
-                ]
-            ],
-        );
-
-        return $breadcrumb;
+   ->addBreadcrumbs(function (BreadcrumbListSchema $breadcrumbs, SEOData $SEOData) {
+        return $breadcrumbs->prependBreadcrumbs([
+               'Homepage' => 'https://example.com',
+               'Category' => 'https://example.com/test',
+            ])
+            ->appendBreadcrumbs([
+                'Subarticle' => 'https://example.com/test/article/2',
+            ])
+            ->put(
+                // any key,
+                // any value
+            );
     });
 ```
 

diff --git a/src/SchemaCollection.php b/src/SchemaCollection.php
@@ -17,7 +17,7 @@
 class SchemaCollection extends Collection
 {
     /**
-     * @param  null|(Closure(SEOData $SEOData, ArticleSchema $article): ArticleSchema)  $builder
+     * @param  null|(Closure(ArticleSchema $article, SEOData $SEOData): ArticleSchema)  $builder
      */
     public function addArticle(null | array | Closure $builder = null): static
     {
@@ -33,7 +33,7 @@ public function addArticle(null | array | Closure $builder = null): static
     }
 
     /**
-     * @param  null|(Closure(SEOData $SEOData, BreadcrumbListSchema $breadcrumbList): BreadcrumbListSchema)  $builder
+     * @param  null|(Closure(BreadcrumbListSchema $breadcrumbList, SEOData $SEOData): BreadcrumbListSchema)  $builder
      */
     public function addBreadcrumbs(null | array | Closure $builder = null): static
     {