XmlFileLoader
extends FileLoader
in package
Loads validation metadata from an XML file.
Tags
Table of Contents
Constants
- DEFAULT_NAMESPACE = '\\Symfony\\Component\\Validator\\Constraints\\'
- The namespace to load constraints from by default.
Properties
- $classes : array<string|int, SimpleXMLElement>|null
- The XML nodes of the mapping file.
- $file : mixed
- $namespaces : mixed
Methods
- __construct() : mixed
- Creates a new loader.
- getMappedClasses() : array<string|int, string>
- Return the names of the classes mapped in this file.
- loadClassMetadata() : bool
- {@inheritdoc}
- addNamespaceAlias() : mixed
- Adds a namespace alias.
- newConstraint() : Constraint
- Creates a new constraint instance for the given constraint name.
- parseConstraints() : array<string|int, Constraint>
- Parses a collection of "constraint" XML nodes.
- parseFile() : SimpleXMLElement
- Loads the XML class descriptions from the given file.
- parseOptions() : array<string|int, mixed>
- Parses a collection of "option" XML nodes.
- parseValues() : array<string|int, mixed>
- Parses a collection of "value" XML nodes.
- loadClassesFromXml() : mixed
- loadClassMetadataFromXml() : mixed
Constants
DEFAULT_NAMESPACE
The namespace to load constraints from by default.
public
mixed
DEFAULT_NAMESPACE
= '\\Symfony\\Component\\Validator\\Constraints\\'
Properties
$classes
The XML nodes of the mapping file.
protected
array<string|int, SimpleXMLElement>|null
$classes
$file
protected
mixed
$file
$namespaces
protected
mixed
$namespaces
= []
Methods
__construct()
Creates a new loader.
public
__construct(string $file) : mixed
Parameters
- $file : string
-
The mapping file to load
Tags
getMappedClasses()
Return the names of the classes mapped in this file.
public
getMappedClasses() : array<string|int, string>
Return values
array<string|int, string>loadClassMetadata()
{@inheritdoc}
public
loadClassMetadata(ClassMetadata $metadata) : bool
Parameters
- $metadata : ClassMetadata
Return values
booladdNamespaceAlias()
Adds a namespace alias.
protected
addNamespaceAlias(string $alias, string $namespace) : mixed
The namespace alias can be used to reference constraints from specific namespaces in :
$this->addNamespaceAlias('mynamespace', '\\Acme\\Package\\Constraints\\');
$constraint = $this->newConstraint('mynamespace:NotNull');
Parameters
- $alias : string
- $namespace : string
newConstraint()
Creates a new constraint instance for the given constraint name.
protected
newConstraint(string $name[, mixed $options = null ]) : Constraint
Parameters
- $name : string
-
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 .
- $options : mixed = null
-
The constraint options
Tags
Return values
ConstraintparseConstraints()
Parses a collection of "constraint" XML nodes.
protected
parseConstraints(SimpleXMLElement $nodes) : array<string|int, Constraint>
Parameters
- $nodes : SimpleXMLElement
-
The XML nodes
Return values
array<string|int, Constraint>parseFile()
Loads the XML class descriptions from the given file.
protected
parseFile(string $path) : SimpleXMLElement
Parameters
- $path : string
Tags
Return values
SimpleXMLElementparseOptions()
Parses a collection of "option" XML nodes.
protected
parseOptions(SimpleXMLElement $nodes) : array<string|int, mixed>
Parameters
- $nodes : SimpleXMLElement
-
The XML nodes
Return values
array<string|int, mixed>parseValues()
Parses a collection of "value" XML nodes.
protected
parseValues(SimpleXMLElement $nodes) : array<string|int, mixed>
Parameters
- $nodes : SimpleXMLElement
-
The XML nodes
Return values
array<string|int, mixed>loadClassesFromXml()
private
loadClassesFromXml() : mixed
loadClassMetadataFromXml()
private
loadClassMetadataFromXml(ClassMetadata $metadata, SimpleXMLElement $classDescription) : mixed
Parameters
- $metadata : ClassMetadata
- $classDescription : SimpleXMLElement