1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Validator
  7. \
  8. Mapping
  9. \
  10. Loader
  11. \
  12. XmlFileLoader

XmlFileLoader

class XmlFileLoader extends FileLoader

Loads validation metadata from an XML file.

Constants

DEFAULT_NAMESPACE

The namespace to load constraints from by default.

Properties

protected $namespaces from AbstractLoader
protected $file from FileLoader
protected SimpleXMLElement[]|null $classes The XML nodes of the mapping file.

Methods

addNamespaceAlias(string $alias, string $namespace)

Adds a namespace alias.

from AbstractLoader
Constraint
newConstraint(string $name, mixed $options = null)

Creates a new constraint instance for the given constraint name.

from AbstractLoader
__construct(string $file)

Creates a new loader.

from FileLoader
bool
loadClassMetadata(ClassMetadata $metadata)

Loads validation metadata into a {@link ClassMetadata} instance.

string[]
getMappedClasses()

Return the names of the classes mapped in this file.

array
parseConstraints(SimpleXMLElement $nodes)

Parses a collection of "constraint" XML nodes.

array
parseValues(SimpleXMLElement $nodes)

Parses a collection of "value" XML nodes.

array
parseOptions(SimpleXMLElement $nodes)

Parses a collection of "option" XML nodes.

SimpleXMLElement
parseFile(string $path)

Loads the XML class descriptions from the given file.

Details

protected addNamespaceAlias(string $alias, string $namespace)

Adds a namespace alias.

The namespace alias can be used to reference constraints from specific namespaces in {@link newConstraint()}:

$this->addNamespaceAlias('mynamespace', '\\Acme\\Package\\Constraints\\');

$constraint = $this->newConstraint('mynamespace:NotNull');

Parameters

string $alias The alias
string $namespace The PHP namespace

protected Constraint newConstraint(string $name, mixed $options = null)

Creates a new constraint instance for the given constraint name.

Parameters

string $name The constraint name. Either a constraint relative to the default constraint namespace, or a fully qualified class name. Alternatively, the constraint may be preceded by a namespace alias and a colon. The namespace alias must have been defined using {@link addNamespaceAlias()}.
mixed $options The constraint options

Return Value

Constraint

Exceptions

MappingException If the namespace prefix is undefined

__construct(string $file)

Creates a new loader.

Parameters

string $file The mapping file to load

Exceptions

MappingException If the file does not exist or is not readable

bool loadClassMetadata(ClassMetadata $metadata)

Loads validation metadata into a {@link ClassMetadata} instance.

Parameters

ClassMetadata $metadata

Return Value

bool Whether the loader succeeded

string[] getMappedClasses()

Return the names of the classes mapped in this file.

Return Value

string[] The classes names

protected array parseConstraints(SimpleXMLElement $nodes)

Parses a collection of "constraint" XML nodes.

Parameters

SimpleXMLElement $nodes The XML nodes

Return Value

array The Constraint instances

protected array parseValues(SimpleXMLElement $nodes)

Parses a collection of "value" XML nodes.

Parameters

SimpleXMLElement $nodes The XML nodes

Return Value

array The values

protected array parseOptions(SimpleXMLElement $nodes)

Parses a collection of "option" XML nodes.

Parameters

SimpleXMLElement $nodes The XML nodes

Return Value

array The options

protected SimpleXMLElement parseFile(string $path)

Loads the XML class descriptions from the given file.

Parameters

string $path The path of the XML file

Return Value

SimpleXMLElement The class descriptions

Exceptions

MappingException If the file could not be loaded