PHPCon Poland 2024

XMLReader::isValid

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

XMLReader::isValidУказывает, содержит ли анализируемый документ синтаксические ошибки

Описание

public XMLReader::isValid(): bool

Метод возвращает логическое значение, которое указывает, соответствует ли анализируемый документ схеме DTD, XML или RelaxNG. Метод вернёт false, если схемы нет и опцию проверки DTD не указали.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Метод возвращает true, если документ не содержит синтаксических ошибок, иначе false.

Примеры

Пример #1 Проверка правильности XML-документа

<?php

$xml
= XMLReader::open('test.xml');

// Для работы метода обязательно нужно включить
// валидацию парсера
$xml->setParserProperty(XMLReader::VALIDATE, true);

var_dump($xml->isValid());

?>

Примечания

Замечание: Метод проверяет только текущий узел, а не весь документ.

Смотрите также

add a note

User Contributed Notes 4 notes

up
3
remy dot damour at laposte dot net
15 years ago
1. If you validate against relax-ng, no need to call $xml->setParserProperty(XMLReader::VALIDATE, true);

2. Be aware that $xml->isValid() will return validity for currently active node (ie. node currently positioned using $xml->read()). It won't check validity of your entire tree at once, but rather on a step by step basis
up
2
me at lubu dot ch
2 years ago
Be aware that $xml->isValid() will return validity only for currently active node, so you have to loop trough the nodes.

Here is a example how to validate a entire XML file against a XSD schema:

<?php

$xmlReader
= new \XMLReader();
$xmlReader->open('./example.xml');
$xmlReader->setParserProperty(\XMLReader::VALIDATE, true);
$xmlReader->setSchema('./schema.xsd');

\libxml_use_internal_errors(true);

$msgs = [];

while (
$xmlReader->read()) {
if (!
$xmlReader->isValid()) {
$err = \libxml_get_last_error();
if (
$err && $err instanceof \libXMLError) {
$msgs[] = \trim($err->message) . ' on line ' . $err->line;
}
}
}

if (
$msgs) {
throw new
\Exception("XML schema validation errors:\n - " . implode("\n - ", array_unique($msgs)));
}
?>
up
0
zubin at trattonuovo dot com
14 years ago
I encountered some problems to use isValid method with xml2assoc function.
I use this way to validate the entire xml file and put it into an associative array.

$xml = new XMLReader();
if (!$xml->xml($xml_string, NULL, LIBXML_DTDVALID)) {
echo "XML not valid: load error";
exit();
}

libxml_use_internal_errors(TRUE);

$xml_array = xml2assoc($xml);

$arErrors = libxml_get_errors();
$xml_errors = "";
foreach ($arErrors AS $xmlError) $xml_errors .= $xmlError->message;
if ($xml_errors != "") {
echo "XML not valid: ".$xml_errors;
exit();
}

//all ok
up
0
anzenews at volja dot net
16 years ago
This comment is only partially correct:
"isValid() always returns false unless you enable checking for validity by $reader->setParserProperty(XMLReader::VALIDATE, true);"
This enables DTD checking, but you can also check by using RelaxNG (see setRelaxNGSchema() and setRelaxNGSchemaSource()).

And also, this is NOT correct:
"If you just need to check if XML file is well formed, successful loading into XMLReader object is usually enough."
It is not enough. Pull parsers operate on stream and if you have a large enough file they will not know it is well formed until it is read to the end. If you need to know if it is well formed or/and valid, read it till the end or validation error (you can use next() for fast reading if you don't care about contents).
To Top