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

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.     /**
  27.      * @var ResponseContext
  28.      */
  29.     private $responseContext;
  31.     /**
  32.      * @var array<Graph>
  33.      */
  34.     private $graphs = [];
  36.     public function __construct(ResponseContext $responseContext)
  37.     {
  38.         $this->responseContext = $responseContext;
  39.     }
  41.     public function getGraphForSchema(string $schema): Graph
  42.     {
  43.         $schema = rtrim($schema, '/');
  45.         if (!\array_key_exists($schema, $this->graphs)) {
  46.             $this->graphs[$schema] = new Graph($schema);
  47.         }
  49.         return $this->graphs[$schema];
  50.     }
  52.     public function getGraphs(): array
  53.     {
  54.         return $this->graphs;
  55.     }
  57.     public function collectFinalScriptFromGraphs(): string
  58.     {
  59.         $data = [];
  61.         $this->responseContext->dispatchEvent(new JsonLdEvent());
  63.         foreach ($this->getGraphs() as $graph) {
  64.             $data[] = $graph->toArray();
  65.         }
  67.         // Reset graphs
  68.         $this->graphs = [];
  70.         if (0 === \count($data)) {
  71.             return '';
  72.         }
  74.         ArrayUtil::recursiveKeySort($data);
  76.         return '<script type="application/ld+json">'."\n".json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)."\n".'</script>';
  77.     }
  79.     /**
  80.      * @throws \InvalidArgumentException
  81.      */
  82.     public function createSchemaOrgTypeFromArray(array $jsonLd): Type
  83.     {
  84.         if (!isset($jsonLd['@type'])) {
  85.             throw new \InvalidArgumentException('Must provide the @type property!');
  86.         }
  88.         $schemaClass = '\Spatie\SchemaOrg\\'.$jsonLd['@type'];
  90.         if (!class_exists($schemaClass)) {
  91.             throw new \InvalidArgumentException(sprintf('Unknown schema.org type "%s" provided!', $jsonLd['@type']));
  92.         }
  94.         $schema = new $schemaClass();
  95.         unset($jsonLd['@type']);
  97.         foreach ($jsonLd as $k => $v) {
  98.             if (\is_array($v) && isset($v['@type'])) {
  99.                 $v = $this->createSchemaOrgTypeFromArray($v);
  100.             }
  102.             $schema->setProperty($k, $v);
  103.         }
  105.         return $schema;
  106.     }
  107. }