\Symfony\Component\PropertyAccessPropertyPath

__construct()

__construct(\Symfony\Component\PropertyAccess\PropertyPath|string  $propertyPath) 

Constructs a property path from a string.

Parameters

Throws

\Symfony\Component\PropertyAccess\Exception\InvalidArgumentException

If the given path is not a string

\Symfony\Component\PropertyAccess\Exception\InvalidPropertyPathException

If the syntax of the property path is not valid

__toString()

__toString() : string

Returns the string representation of the property path.

Returns

The path as string

getLength()

getLength() : integer

Returns the length of the property path, i.e. the number of elements.

Returns

The path length

getParent()

getParent() : \Symfony\Component\PropertyAccess\PropertyPath

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.

Returns

The parent path or null

getIterator()

getIterator() : \Symfony\Component\PropertyAccess\PropertyPathIteratorInterface

Returns a new iterator for this path.

Returns

getElements()

getElements() : array

Returns the elements of the property path as array.

Returns

An array of property/index names

getElement()

getElement(integer  $index) : string

Returns the element at the given index in the property path.

Parameters

Returns

A property or index name

isProperty()

isProperty(integer  $index) : boolean

Returns whether the element at the given index is a property.

Parameters

Returns

Whether the element at this index is a property

isIndex()

isIndex(integer  $index) : boolean

Returns whether the element at the given index is an array index.

Parameters

Returns

Whether the element at this index is an array index