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

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 the graphs
  65. $this->graphs = [];
  67. if (0 === \count($data)) {
  68. return '';
  69. }
  71. ArrayUtil::recursiveKeySort($data);
  73. $return = [];
  75. // Create one <script> block per JSON-LD context (see #6401)
  76. foreach ($data as $context) {
  77. $return[] = sprintf(
  78. "<script type=\"application/ld+json\">\n%s\n</script>",
  79. json_encode($context, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)
  80. );
  81. }
  83. return implode("\n", $return);
  84. }
  86. /**
  87. * @throws \InvalidArgumentException
  88. */
  89. public function createSchemaOrgTypeFromArray(array $jsonLd): Type
  90. {
  91. if (!isset($jsonLd['@type'])) {
  92. throw new \InvalidArgumentException('Must provide the @type property!');
  93. }
  95. $schemaClass = '\Spatie\SchemaOrg\\'.$jsonLd['@type'];
  97. if (!class_exists($schemaClass)) {
  98. throw new \InvalidArgumentException(sprintf('Unknown schema.org type "%s" provided!', $jsonLd['@type']));
  99. }
  101. $schema = new $schemaClass();
  102. unset($jsonLd['@type']);
  104. foreach ($jsonLd as $k => $v) {
  105. if (\is_array($v) && isset($v['@type'])) {
  106. $v = $this->createSchemaOrgTypeFromArray($v);
  107. }
  109. $schema->setProperty($k, $v);
  110. }
  112. return $schema;
  113. }
  114. }