JSON-LD

Le document

JsonLd::encode(Graph $graph, bool $pretty = false) écrit le graphe dans un seul document JSON-LD :

{"@context":"https://schema.org","@graph":[{"@type":"WebSite","@id":"https://example.com/#website","name":"Le Gnome","url":"https://example.com/"}]}

Un graphe doté d'une langue l'écrit dans son contexte, après celui de schema.org :

{"@context":["https://schema.org",{"@language":"fr-CA"}],"@graph":[…]}

Un nœud seul est quand même écrit sous @graph : le document a une seule forme, quel que soit son contenu.

L'élément de script

JsonLd::script(Graph $graph, ?string $nonce = null) donne l'unique élément qu'une page imprime, ou un texte vide pour un graphe vide :

<script type="application/ld+json" nonce="…">{"@context":"https://schema.org","@graph":[…]}</script>

Les données ne peuvent ni terminer l'élément, ni y ouvrir un commentaire, ni dérouter un analyseur :

Le nonce est celui de la politique de sécurité du contenu de la page, fourni par l'application. C'est un texte en base64 de 1 à 256 caractères ; tout le reste est refusé plutôt qu'échappé. Un navigateur n'exécute aucun JSON-LD, mais une politique stricte ou un outil d'audit peut quand même exiger un nonce sur chaque élément de script.

JsonLd::FLAGS contient les indicateurs de json_encode() avec lesquels la bibliothèque écrit.

Relire une page

JsonLdReader lit ce que contient une page, pour le vérifier ou le comparer avec ce que l'application voulait imprimer :

Un élément est lu quand son type est application/ld+json, quelles que soient la casse et les espaces. Un élément qui n'est pas du JSON, qui n'est pas un graphe de nœuds ou qui contient ce qu'un nœud refuse est écarté et nommé dans Extraction::$errors ; les autres sont lus quand même.

Le lecteur lit des pages écrites par n'importe qui ; son travail est donc borné :

Le HTML est analysé par l'analyseur HTML5 de l'extension DOM de PHP, erreurs étouffées : une page est lue comme un navigateur la lit.