Use Spaties library instead of our own implementation of structured data objects

Author: loevgaard

src/DataMapper/OnlineStore/CompositeOnlineStoreDataMapper.php

@@ -5,7 +5,7 @@
 namespace Setono\SyliusSEOPlugin\DataMapper\OnlineStore;
 
 use Setono\SyliusSEOPlugin\DataMapper\AbstractDataMapper;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Organization\OnlineBusiness\OnlineStore;
+use Spatie\SchemaOrg\OnlineStore;
 use Sylius\Component\Core\Model\ChannelInterface;
 
 /**

src/DataMapper/OnlineStore/OnlineStoreDataMapper.php

@@ -4,8 +4,8 @@
 
 namespace Setono\SyliusSEOPlugin\DataMapper\OnlineStore;
 
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Intangible\StructuredValue\ContactPoint;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Organization\OnlineBusiness\OnlineStore;
+use Spatie\SchemaOrg\OnlineStore;
+use Spatie\SchemaOrg\Schema;
 use Sylius\Component\Core\Model\ChannelInterface;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
@@ -17,24 +17,28 @@ public function __construct(private readonly UrlGeneratorInterface $urlGenerator
 
     public function map(ChannelInterface $channel, OnlineStore $onlineStore): void
     {
-        $onlineStore->name = $channel->getName();
-        $onlineStore->vatID = $channel->getShopBillingData()?->getTaxId();
-        $onlineStore->contactPoint = new ContactPoint([
-            'email' => $channel->getContactEmail(),
-            'telephone' => $channel->getContactPhoneNumber(),
-        ]);
-        $onlineStore->address = new ContactPoint\PostalAddress([
-            'streetAddress' => $channel->getShopBillingData()?->getStreet(),
-            'addressLocality' => $channel->getShopBillingData()?->getCity(),
-            'addressCountry' => $channel->getShopBillingData()?->getCountryCode(),
-            'postalCode' => $channel->getShopBillingData()?->getPostcode(),
-        ]);
+        $onlineStore
+            ->name((string) $channel->getName())
+            ->vatID((string) $channel->getShopBillingData()?->getTaxId())
+            ->contactPoint(
+                Schema::contactPoint()
+                    ->email((string) $channel->getContactEmail())
+                    ->telephone((string) $channel->getContactPhoneNumber()),
+            )
+            ->address(
+                Schema::postalAddress()
+                    ->streetAddress((string) $channel->getShopBillingData()?->getStreet())
+                    ->addressLocality((string) $channel->getShopBillingData()?->getCity())
+                    ->addressCountry((string) $channel->getShopBillingData()?->getCountryCode())
+                    ->postalCode((string) $channel->getShopBillingData()?->getPostcode()),
+            )
+        ;
 
         $hostname = $channel->getHostname();
         if (null === $hostname) {
-            $onlineStore->url = $this->urlGenerator->generate(name: 'sylius_shop_homepage', referenceType: UrlGeneratorInterface::ABSOLUTE_URL);
+            $onlineStore->url($this->urlGenerator->generate(name: 'sylius_shop_homepage', referenceType: UrlGeneratorInterface::ABSOLUTE_URL));
         } else {
-            $onlineStore->url = sprintf('https://%s', $hostname);
+            $onlineStore->url(sprintf('https://%s', $hostname));
         }
     }
 }

src/DataMapper/OnlineStore/OnlineStoreDataMapperInterface.php

@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusSEOPlugin\DataMapper\OnlineStore;
 
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Organization\OnlineBusiness\OnlineStore;
+use Spatie\SchemaOrg\OnlineStore;
 use Sylius\Component\Core\Model\ChannelInterface;
 
 interface OnlineStoreDataMapperInterface

src/DataMapper/Product/CompositeProductDataMapper.php

@@ -5,7 +5,7 @@
 namespace Setono\SyliusSEOPlugin\DataMapper\Product;
 
 use Setono\SyliusSEOPlugin\DataMapper\AbstractDataMapper;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product;
+use Spatie\SchemaOrg\Product;
 use Sylius\Component\Core\Model\ProductVariantInterface;
 
 /**

src/DataMapper/Product/ImageProductDataMapper.php

@@ -5,7 +5,7 @@
 namespace Setono\SyliusSEOPlugin\DataMapper\Product;
 
 use Liip\ImagineBundle\Imagine\Cache\CacheManager;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product;
+use Spatie\SchemaOrg\Product;
 use Sylius\Component\Core\Model\ImageInterface;
 use Sylius\Component\Core\Model\ProductInterface;
 use Sylius\Component\Core\Model\ProductVariantInterface;
@@ -20,7 +20,7 @@ public function __construct(
 
     public function map(ProductVariantInterface $productVariant, Product $product): void
     {
-        if (null !== $product->image) {
+        if ($product->getProperty('image') !== null) {
             return;
         }
 
@@ -34,7 +34,7 @@ public function map(ProductVariantInterface $productVariant, Product $product):
             return;
         }
 
-        $product->image = $this->cacheManager->getBrowserPath($path, $this->filter);
+        $product->image($this->cacheManager->getBrowserPath($path, $this->filter));
     }
 
     private static function getImage(ProductVariantInterface $productVariant): ?ImageInterface

src/DataMapper/Product/OffersProductDataMapper.php

@@ -5,11 +5,10 @@
 namespace Setono\SyliusSEOPlugin\DataMapper\Product;
 
 use function Setono\SyliusSEOPlugin\formatAmount;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Intangible\Enumeration\ItemAvailability;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Intangible\Offer;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Intangible\Offer\AggregateOffer;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product;
 use Setono\SyliusSEOPlugin\UrlGenerator\ProductVariantUrlGeneratorInterface;
+use Spatie\SchemaOrg\ItemAvailability;
+use Spatie\SchemaOrg\Product;
+use Spatie\SchemaOrg\Schema;
 use Sylius\Component\Channel\Context\ChannelContextInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Model\ProductVariantInterface;
@@ -34,14 +33,13 @@ public function map(ProductVariantInterface $productVariant, Product $product):
             return;
         }
 
-        $aggregateOffer = new AggregateOffer();
-        $aggregateOffer->addOffer(new Offer([
-            'url' => $this->productVariantUrlGenerator->generate($productVariant),
-            'priceCurrency' => $channel->getBaseCurrency()?->getCode(),
-            'price' => formatAmount($channelPricing->getPrice()),
-            'availability' => $this->availabilityChecker->isStockAvailable($productVariant) ? ItemAvailability::InStock : ItemAvailability::OutOfStock,
-        ]));
-
-        $product->offers = $aggregateOffer;
+        /** @psalm-suppress InvalidArgument */
+        $product->offers(Schema::aggregateOffer()->offers(
+            Schema::offer()
+                ->url($this->productVariantUrlGenerator->generate($productVariant))
+                ->priceCurrency((string) $channel->getBaseCurrency()?->getCode())
+                ->price(formatAmount($channelPricing->getPrice()))
+                ->availability($this->availabilityChecker->isStockAvailable($productVariant) ? ItemAvailability::InStock : ItemAvailability::OutOfStock),
+        ));
     }
 }

src/DataMapper/Product/ProductDataMapper.php

@@ -4,26 +4,16 @@
 
 namespace Setono\SyliusSEOPlugin\DataMapper\Product;
 
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product;
+use Spatie\SchemaOrg\Product;
 use Sylius\Component\Core\Model\ProductVariantInterface;
 
 final class ProductDataMapper implements ProductDataMapperInterface
 {
     public function map(ProductVariantInterface $productVariant, Product $product): void
     {
-        $name = self::getName($productVariant);
-        $product->name = null === $name ? null : trim(strip_tags($name));
-
-        $product->sku = $productVariant->getCode();
-    }
-
-    private static function getName(ProductVariantInterface $productVariant): ?string
-    {
-        $name = $productVariant->getName();
-        if (null !== $name && '' !== $name) {
-            return $name;
-        }
-
-        return $productVariant->getProduct()?->getName();
+        $product
+            ->name(trim(strip_tags((string) ($productVariant->getName() ?? $productVariant->getProduct()?->getName()))))
+            ->sku((string) $productVariant->getCode())
+        ;
     }
 }

src/DataMapper/Product/ProductDataMapperInterface.php

@@ -4,7 +4,7 @@
 
 namespace Setono\SyliusSEOPlugin\DataMapper\Product;
 
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product;
+use Spatie\SchemaOrg\Product;
 use Sylius\Component\Core\Model\ProductVariantInterface;
 
 interface ProductDataMapperInterface

src/DataMapper/ProductGroup/CompositeProductGroupDataMapper.php

@@ -5,7 +5,7 @@
 namespace Setono\SyliusSEOPlugin\DataMapper\ProductGroup;
 
 use Setono\SyliusSEOPlugin\DataMapper\AbstractDataMapper;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product\ProductGroup;
+use Spatie\SchemaOrg\ProductGroup;
 use Sylius\Component\Core\Model\ProductInterface;
 
 /**

src/DataMapper/ProductGroup/HasVariantProductGroupDataMapper.php

@@ -5,8 +5,8 @@
 namespace Setono\SyliusSEOPlugin\DataMapper\ProductGroup;
 
 use Setono\SyliusSEOPlugin\DataMapper\Product\ProductDataMapperInterface;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product;
-use Setono\SyliusSEOPlugin\StructuredData\Thing\Product\ProductGroup;
+use Spatie\SchemaOrg\ProductGroup;
+use Spatie\SchemaOrg\Schema;
 use Sylius\Component\Core\Model\ProductInterface;
 use Sylius\Component\Core\Model\ProductVariantInterface;
 
@@ -18,12 +18,16 @@ public function __construct(private readonly ProductDataMapperInterface $product
 
     public function map(ProductInterface $product, ProductGroup $productGroup): void
     {
+        $hasVariant = [];
+
         /** @var ProductVariantInterface $variant */
         foreach ($product->getEnabledVariants() as $variant) {
-            $p = new Product();
+            $p = Schema::product();
             $this->productDataMapper->map($variant, $p);
 
-            $productGroup->hasVariant[] = $p;
+            $hasVariant[] = $p;
         }
+
+        $productGroup->hasVariant($hasVariant);
     }
 }