L’extension DOM vous permet d’utiliser des documents XML via l’API DOM de PHP 5.

Pour PHP 4, utilisez l’extension DOM XML.

Il n’y pas d’installation nécessaire pour utiliser ces fonctions, elles font parties du coeur de PHP.

L’API de ce module suit, autant que possible, les standards niveau 3 de DOM. En conséquent, l’API est pleinement orientée objets. Il est bien d’avoir les standards DOM sous la main lors de l’utilisation de cette extension.

Ce module définit plusieurs classes, qui sont expliquées dans les tableaux suivants. Les classes avec un équivalent dans les standards sont nommées DOMxxx.

Étend DOMNode. L’interface DOMAttr représente un attribut dans l’objet DOMElement.

• DOMAttr->__construct() - construit un nouvel objet DOMAttr

• DOMAttr->isId() - Vérifie si un attribut est un ID défini

Tableau 1.

Étend DOMNode.

• DOMCharacterData->appendData() - Ajoute une chaîne à la fin des données du noeud
• DOMCharacterData->deleteData() - Efface une rangée de caractères du noeud
• DOMCharacterData->insertData() - Insère une chaîne à une position 16-bit spécifiée
• DOMCharacterData->replaceData() - Remplace une sous-chaîne d’un noeud DOMCharacterData
• DOMCharacterData->substringData() - Extrait une rangée de données depuis le noeud

Tableau 2.

Étend DOMCharacterData.

• DOMComment->__construct() - construit un nouvel objet DOMComment

Étend DOMNode.

• DOMDocument->__construct() - construit un nouvel objet DOMDocument

• DOMDocument->createAttribute() - Crée un nouvel attribut
• DOMDocument->createAttributeNS() - Crée un nouvel noeud d’attribut avec un espace de nom associé
• DOMDocument->createCDATASection() - Crée un nouveau noeud cdata
• DOMDocument->createComment() - Crée un nouveau noeud de commentaire
• DOMDocument->createDocumentFragment() - Crée un nouveau fragment de document
• DOMDocument->createElement() - Crée un nouvel élément
• DOMDocument->createElementNS() - Crée un nouvel élément avec un espace de noms associé
• DOMDocument->createEntityReference() - Crée une nouvelle entité de référence
• DOMDocument->createProcessingInstruction() - Crée un nouveau noeud PI
• DOMDocument->createTextNode() - Crée un nouveau noeud de texte
• DOMDocument->getElementById() - Recherche un élément avec un ID précis
• DOMDocument->getElementsByTagName() - Recherche tous les éléments ayant un tag portant un nom donné
• DOMDocument->getElementsByTagNameNS() - Recherche tous les éléments ayant un tag portant un nom donné dans un espace de noms spécifié
• DOMDocument->importNode() - Importe un noeud dans le document courant
• DOMDocument->load() - Charge du XML depuis un fichier
• DOMDocument->loadHTML() - Charge du HTML depuis une chaîne de caractères
• DOMDocument->loadHTMLFile() - Charge du HTML depuis un fichier
• DOMDocument->loadXML() - Charge du XML depuis une chaîne de caractères
• DOMDocument->normalizeDocument() - Normalise un document
• DOMDocument->relaxNGValidate() - Effectue une validation relaxNG sur le document
• DOMDocument->relaxNGValidateSource() - Effectue une validation relaxNG sur le document
• DOMDocument->registerNodeClass() - Enregistre une classe étendue utilisée pour créer un type d’un noeud de base (non standard DOM)
• DOMDocument->save() - Sauvegarde l’arbre interne XML dans un fichier
• DOMDocument->saveHTML() - Sauvegarde le document interne dans une chaîne de caractères en utilisant un formatage HTML
• DOMDocument->saveHTMLFile() - Sauvegarde le document interne dans un fichier en utilisant un formatage HTML
• DOMDocument->saveXML() - Sauvegarde l’arbre interne XML dans une chaîne de caractères
• DOMDocument->schemaValidate() - Valide un document basé sur un schéma
• DOMDocument->schemaValidateSource() - Valide un document basé sur un schéma
• DOMDocument->validate() - Valide un document en se basant sur sa DTD
• DOMDocument->xinclude() - Remplace les XIncludes dans un objet DOMDocument

Tableau 3.

Étend DOMNode.

Étend DOMNode

Chaque DOMDocument a un attribut “doctype” de valeur soit “NULL”, soit un objet DOMDocumentType.

Tableau 4.

Étend DOMNode.

• DOMElement->__construct() - construit un nouvel objet DOMElement

• DOMElement->getAttribute() - Retourne la valeur d’un attribut
• DOMElement->getAttributeNode() - Retourne le noeud d’un attribut
• DOMElement->getAttributeNodeNS() - Retourne le noeud d’un attribut
• DOMElement->getAttributeNS() - Retourne la valeur d’un attribut
• DOMElement->getElementsByTagName() - Récupère les éléments par le nom de leurs tags
• DOMElement->getElementsByTagNameNS() - Récupère les éléments par leur namespaceURI et leur localName
• DOMElement->hasAttribute() - Vérifie si un attribut existe
• DOMElement->hasAttributeNS() - Vérifie si un attribut existe
• DOMElement->removeAttribute() - Supprime un attribut
• DOMElement->removeAttributeNode() - Supprime un attribut
• DOMElement->removeAttributeNS() - Supprime un attribut
• DOMElement->setAttribute() - Ajoute un nouvel attribut
• DOMElement->setAttributeNode() - Ajoute un nouvel attribut à un élément
• DOMElement->setAttributeNodeNS() - Ajoute un nouvel attribut à un élément
• DOMElement->setAttributeNS() - Ajoute un nouvel attribut
• DOMElement->setIdAttribute() - Déclare l’attribut ID
• DOMElement->setIdAttributeNode() - Déclare l’attribut ID
• DOMElement->setIdAttributeNS() - Déclare l’attribut ID

Tableau 5.

Étend DOMNode

Cette interface représente une entité connue, analysée ou non, du document XML.

Tableau 6.

Étend DOMNode.

• DOMEntityReference->__construct() - construit un nouvel objet DOMEntityReference

Les opérations DOM lancent des exceptions sous des circonstances particulières, i.e., lorsqu’une opération est impossible à effectuer pour des raisons de logique.

Voir aussi Chapitre 20.

Tableau 7.

L’interface DOMImplementation fournit un nombre de méthodes pour effectuer des opérations qui sont indépendant de toute instance du model objet du document.

• DOMImplementation->__construct() - construit un nouvel objet DOMImplementation

• DOMImplementation->createDocument() - Crée un objet DOM Document du type spécifié avec ces éléments
• DOMImplementation->createDocumentType() - Crée un objet DOMDocumentType vide
• DOMImplementation->hasFeature() - Test si l’implémentation DOM implémente une fonctionnalité spécifique

• DOMNode->appendChild() - Ajoute un nouvel enfant à la fin des enfants
• DOMNode->cloneNode() - Clone un noeud
• DOMNode->hasAttributes() - Vérifie si un noeud possède des attributs
• DOMNode->hasChildNodes() - Vérifie si un noeud possède des enfants
• DOMNode->insertBefore() - Ajoute un nouvel enfant juste avant un noeud référencé
• DOMNode->isDefaultNamespace() - Vérifie si l’URI de l’espace de noms spécifiée est l’espace de noms par défaut
• DOMNode->isSameNode() - Indique si deux noeuds sont identiques
• DOMNode->isSupported() - Vérifie si une fonctionnalité est supporté par une version spécifique
• DOMNode->lookupNamespaceURI() - Retourne l’URI de l’espace de noms du noeud basé sur le préfixe
• DOMNode->lookupPrefix() - Retourne le préfixe de l’espace de noms d’un noeud, basé sur l’URI de l’espace de noms
• DOMNode->normalize() - Normalise le noeud
• DOMNode->removeChild() - Supprime un enfant de la liste des enfants
• DOMNode->replaceChild() - Remplace un enfant

Tableau 8.

• DOMNodelist->item() - Retrieves a node specified by index

Tableau 9.

Étend DOMNode

Tableau 10.

Étend DOMNode.

• DOMProcessingInstruction->__construct() - construit un nouvel objet DOMProcessingInstruction

Tableau 11.

Étend DOMCharacterData.

• DOMText->__construct() - construit un nouvel objet DOMText

• DOMText->isWhitespaceInElementContent() - Indique si ce noeud de texte contient des espaces
• DOMText->splitText() - Sépare le noeud en deux noeuds à une position spécifique

Tableau 12.

• DOMXPath->__construct() - Construit un nouvel objet DOMXPath

• DOMXPath->registerNamespace() - Enregistre l’espace de noms avec l’objet DOMXpath
• DOMXPath->evaluate() - Évalue l’expression XPath donnée et retourne le résultat écrit
• DOMXPath->query() - Évalue l’expression XPath donnée

Tableau 13.

La plupart des exemples de cette référence requièrent un fichier XML. Nous utiliserons le fichier “book.xml” qui contient ce qui suit :

Ces constantes sont définies par cette extension, et ne sont disponibles que si cette extension a été compilée avec PHP, ou bien chargée au moment de l’exécution.

Tableau 14. Constantes XML

Tableau 15. Constantes DOMException

Table des matières

DOMAttr->__construct() –  Crée un nouvel objet DOMAttr DOMAttr->isId() –  Vérifie si l’attribut est un identifiant défini DOMCharacterData->appendData() –  Ajoute la chaîne à la fin des données dans le noeud DOMCharacterData->deleteData() –  Supprime une sous-chaîne dans le noeud DOMCharacterData->insertData() –  Insère une chaîne à la position spécifiée d’unité 16-bit DOMCharacterData->replaceData() –  Remplace une sous-chaîne dans le noeud DOMCharacterData node DOMCharacterData->substringData() –  Extrait un morceaux de données dans le noeud DOMComment->__construct() –  Crée un nouvel objet DOMComment DOMDocument->__construct() –  Crée un nouvel objet DOMDocument DOMDocument->createAttribute() – Crée un nouvel attributDOMDocument->createAttributeNS() –  Crée un nouvel attribut avec un espace de noms associé DOMDocument->createCDATASection() – Crée un nouveau noeud cdataDOMDocument->createComment() – Crée un nouveau noeud de commentaireDOMDocument->createDocumentFragment() – Crée un nouveau fragment de documentDOMDocument->createElement() – Crée un nouveau noeudDOMDocument->createElementNS() –  Crée un nouveau noeud avec un espace de noms associé DOMDocument->createEntityReference() – Crée un nouveau noeud de référence d’entitéDOMDocument->createProcessingInstruction() – Crée un nouveau noeud PIDOMDocument->createTextNode() – Crée un nouveau noeud de texteDOMDocument->getElementById() – Cherche un élément avec un certain identifiantDOMDocument->getElementsByTagName() – Cherche tous les éléments quit ont le nom de balise donnéDOMDocument->getElementsByTagNameNS() –  Recherche tous les éléments avec un nom de balise donné dans un espace de noms spécifié DOMDocument->importNode() – Importe un noeud dans le document courantDOMDocument->load() –  Charge du XML depuis un fichier DOMDocument->loadHTML() –  Charge du HTML à partir d’une chaîne de caractères DOMDocument->loadHTMLFile() –  Charge du HTML à partir d’un fichier DOMDocument->loadXML() –  Charge du XML depuis une chaîne de caractères DOMDocument->normalizeDocument() – Normalise le documentDOMDocument->registerNodeClass() – Enregistre la classe étendue utilisée pour créer un type de base de noeudDOMDocument->relaxNGValidate() –  Effectue une validation relaxNG sur le document DOMDocument->relaxNGValidateSource() –  Effectue une validation relaxNG sur le document DOMDocument->save() –  Sauvegarde l’arbre interne XML dans un fichier DOMDocument->saveHTML() –  Sauvegarde le document interne dans une chaîne en utilisant un formattage HTML DOMDocument->saveHTMLFile() –  Sauvegarde un document interne dans un fichier en utilisant un formattage HTML DOMDocument->saveXML() –  Sauvegarde l’arbre interne XML dans une chaîne de caractères DOMDocument->schemaValidate() –  Valide un document selon un schéma DOMDocument->schemaValidateSource() –  Valide un document selon un schéma DOMDocument->validate() –  Valide un document en se basant sur sa DTD DOMDocument->xinclude() –  Remplace les XIncludes dans un objet DOMDocument DOMDocumentFragment->appendXML() – Ajoute des données XMLDOMElement->__construct() –  Crée un nouvel objet DOMElement DOMElement->getAttribute() – Retourne la valeur d’un attributDOMElement->getAttributeNode() – Retourne le noeud d’attributDOMElement->getAttributeNodeNS() –  Retourne le noeud d’attribut DOMElement->getAttributeNS() – Retourne la valeur de l’attributDOMElement->getElementsByTagName() – Retourne les éléments par leur nom de baliseDOMElement->getElementsByTagNameNS() – Récupère les éléments par leur espace de noms et leur localNameDOMElement->hasAttribute() – Vérifie si un attribut existeDOMElement->hasAttributeNS() –  Vérifie si un attribut existe DOMElement->removeAttribute() – Efface un attributDOMElement->removeAttributeNode() – Efface un attributDOMElement->removeAttributeNS() – Efface un attributDOMElement->setAttribute() – Ajoute un nouvel attributDOMElement->setAttributeNode() – Ajoute un nouvel attribut à l’élémentDOMElement->setAttributeNodeNS() – Ajoute un nouvel attribut à l’élémentDOMElement->setAttributeNS() – Ajoute un nouvel attributDOMElement->setIdAttribute() – Déclare l’attribut spécifié par son nom à être de type IDDOMElement->setIdAttributeNode() – Déclare l’attribut spécifié par le noeud à être de type IDDOMElement->setIdAttributeNS() – Déclare l’attribut spécifié par son nom local et son espace de nom URI à être de type IDDOMEntityReference->__construct() –  Crée un nouvel objet DOMEntityReference DOMImplementation->__construct() –  Crée un nouvel objet DOMImplementation DOMImplementation->createDocument() –  Crée un objet DOM Document du type spécifié avec ses éléments DOMImplementation->createDocumentType() –  Crée un objet DOMDocumentType vide DOMImplementation->hasFeature() –  Test si l’implémentation DOM implémente une fonctionnalité spécifique DOMNamedNodeMap->getNamedItem() –  Retourne un noeud spécifié par nom nom DOMNamedNodeMap->getNamedItemNS() –  Retourne un noeud spécifié par son nom local et son espace de nom DOMNamedNodeMap->item() – Retourne un noeud selon son indexDOMNode->appendChild() –  Ajoute un nouveau fils à la fin des fils DOMNode->cloneNode() –  Clone un noeud DOMNode->hasAttributes() –  Vérifie si le noeud possède un attribut DOMNode->hasChildNodes() –  Vérifie si le noeud possède des enfants DOMNode->insertBefore() –  Ajoute un nouveau fils à la fin des enfants DOMNode->isDefaultNamespace() – Vérifie si l’espace de nom spécifié est l’espace de noms par défaut ou nonDOMNode->isSameNode() –  Indique si deux noeuds sont identiques DOMNode->isSupported() –  Vérifie si la fonctionnalité est disponible pour la version spécifiée DOMNode->lookupNamespaceURI() –  Retourne l’URI de l’espace de noms selon le préfixe DOMNode->lookupPrefix() –  Retourne le préfixe de l’espace de noms selon l’URI de l’espace de noms DOMNode->normalize() – Normalise le noeudDOMNode->removeChild() –  Supprime un fils de la liste des enfants DOMNode->replaceChild() –  Remplace un fils DOMNodelist->item() –  Retourne un noeud spécifié par son index DOMProcessingInstruction->__construct() –  Crée un nouvel objet DOMProcessingInstruction DOMText->__construct() –  Crée un nouvel objet DOMText DOMText->isWhitespaceInElementContent() –  Indique si ce noeud de texte contient des espaces blancs DOMText->splitText() –  Coupe le noeud en deux noeuds à l’endroit spécifié DOMXPath->__construct() –  Crée un nouvel objet DOMXPath DOMXPath->evaluate() –  Evalue une expression XPath donnée et retourne un résultat écrit si possible DOMXPath->query() –  Evalue l’expression XPath donnée DOMXPath->registerNamespace() –  Enregistre l’espace de noms avec l’objet DOMXPath dom_import_simplexml –  Transforme un objet DOMElement en un objet SimpleXMLElement