class ViolationPath implements IteratorAggregate, PropertyPathInterface
Methods
| __construct(string $violationPath) Creates a new violation path from a string. | ||
| string | __toString() Returns the string representation of the property path. | |
| int | getLength() Returns the length of the property path, i.e. the number of elements. | |
| PropertyPath | getParent() Returns the parent property path. | |
| array | getElements() Returns the elements of the property path as array. | |
| string | getElement(int $index) Returns the element at the given index in the property path. | |
| bool | isProperty(int $index) Returns whether the element at the given index is a property. | |
| bool | isIndex(int $index) Returns whether the element at the given index is an array index. | |
| bool | mapsForm(int $index) Returns whether an element maps directly to a form. | |
| ViolationPathIterator | getIterator() Returns a new iterator for this path. |
Details
__construct(string $violationPath)
Creates a new violation path from a string.
string __toString()
Returns the string representation of the property path.
int getLength()
Returns the length of the property path, i.e. the number of elements.
PropertyPath getParent()
Returns the parent property path.
The parent property path is the one that contains the same items as this one except for the last one.
If this property path only contains one item, null is returned.
array getElements()
Returns the elements of the property path as array.
string getElement(int $index)
Returns the element at the given index in the property path.
bool isProperty(int $index)
Returns whether the element at the given index is a property.
bool isIndex(int $index)
Returns whether the element at the given index is an array index.
bool mapsForm(int $index)
Returns whether an element maps directly to a form.
Consider the following violation path:
children[address].children[office].data.street
In this example, "address" and "office" map to forms, while "street does not.
ViolationPathIterator getIterator()
Returns a new iterator for this path.
Please login to continue.