How does Magento 2 validate XML configuration files with XSD schema?

dmitry_fedyuk (Dmitrii Fediuk) November 15, 2015, 6:50am 1

Magento 2 does XML schema validation in the Developer mode only:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/lib/internal/Magento/Framework/App/Arguments/ValidationState.php#L30-L33


public function isValidationRequired()
{
    return $this->_appMode == \Magento\Framework\App\State::MODE_DEVELOPER;
}

The first validation is per-file:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/lib/internal/Magento/Framework/Config/Dom.php#L366-L367


if ($this->validationState->isValidationRequired() && $this->schema) {
    $errors = $this->validateDomDocument($dom, $this->schema, $this->errorFormat);

The second validation is for the merged composite file:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/lib/internal/Magento/Framework/Config/Reader/Filesystem.php#L146-L148


if ($this->validationState->isValidationRequired()) {
    $errors = [];
    if ($configMerger && !$configMerger->validate($this->_schemaFile, $errors)) {

\Magento\Config\Model\Config\Structure\Reader overrides the \Magento\Framework\Config\Reader\Filesystem::_readFiles method, but does the similar validation:

github.com

magento/magento2/blob/2335247d4ae2dc1e0728ee73022b0a244ccd7f4c/app/code/Magento/Config/Model/Config/Structure/Reader.php#L103-L105


if ($this->validationState->isValidationRequired()) {
    $errors = [];
    if ($configMerger && !$configMerger->validate($this->_schemaFile, $errors)) {

See also: Magento 2 ignores XML schema location in the etc/adminhtml/system.xml documents and always uses the Magento/Config/etc/system_file.xsd schema instead.

Magento 2 ignores XML schema location in the etc/adminhtml/system.xml documents and always uses the Magento/Config/etc/system_file.xsd schema instead