vendor/contao/core-bundle/src/Routing/ResponseContext/JsonLd/JsonLdManager.php line 38

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Routing\ResponseContext\JsonLd;
  15. use Contao\ArrayUtil;
  16. use Contao\CoreBundle\Event\JsonLdEvent;
  17. use Contao\CoreBundle\Routing\ResponseContext\ResponseContext;
  18. use Spatie\SchemaOrg\Graph;
  19. use Spatie\SchemaOrg\Type;
  21. class JsonLdManager
  22. {
  23.     public const SCHEMA_ORG = 'https://schema.org';
  24.     public const SCHEMA_CONTAO = 'https://schema.contao.org';
  26.     private ResponseContext $responseContext;
  28.     /**
  29.      * @var array<Graph>
  30.      */
  31.     private array $graphs = [];
  33.     public function __construct(ResponseContext $responseContext)
  34.     {
  35.         $this->responseContext = $responseContext;
  36.     }
  38.     public function getGraphForSchema(string $schema): Graph
  39.     {
  40.         $schema = rtrim($schema, '/');
  42.         if (!\array_key_exists($schema, $this->graphs)) {
  43.             $this->graphs[$schema] = new Graph($schema);
  44.         }
  46.         return $this->graphs[$schema];
  47.     }
  49.     public function getGraphs(): array
  50.     {
  51.         return $this->graphs;
  52.     }
  54.     public function collectFinalScriptFromGraphs(): string
  55.     {
  56.         $data = [];
  58.         $this->responseContext->dispatchEvent(new JsonLdEvent());
  60.         foreach ($this->getGraphs() as $graph) {
  61.             $data[] = $graph->toArray();
  62.         }
  64.         // Reset graphs
  65.         $this->graphs = [];
  67.         if (0 === \count($data)) {
  68.             return '';
  69.         }
  71.         ArrayUtil::recursiveKeySort($data);
  73.         return '<script type="application/ld+json">'."\n".json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)."\n".'</script>';
  74.     }
  76.     /**
  77.      * @throws \InvalidArgumentException
  78.      */
  79.     public function createSchemaOrgTypeFromArray(array $jsonLd): Type
  80.     {
  81.         if (!isset($jsonLd['@type'])) {
  82.             throw new \InvalidArgumentException('Must provide the @type property!');
  83.         }
  85.         $schemaClass = '\Spatie\SchemaOrg\\'.$jsonLd['@type'];
  87.         if (!class_exists($schemaClass)) {
  88.             throw new \InvalidArgumentException(sprintf('Unknown schema.org type "%s" provided!', $jsonLd['@type']));
  89.         }
  91.         $schema = new $schemaClass();
  92.         unset($jsonLd['@type']);
  94.         foreach ($jsonLd as $k => $v) {
  95.             if (\is_array($v) && isset($v['@type'])) {
  96.                 $v = $this->createSchemaOrgTypeFromArray($v);
  97.             }
  99.             $schema->setProperty($k, $v);
  100.         }
  102.         return $schema;
  103.     }
  104. }