1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. PropertyAccess
  7. \
  8. PropertyPathInterface

PropertyPathInterface

interface PropertyPathInterface implements Traversable

A sequence of property names or array indices.

Methods

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.

Details

string __toString()

Returns the string representation of the property path.

Return Value

string The path as string

int getLength()

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

Return Value

int The path length

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.

Return Value

PropertyPath The parent path or null

array getElements()

Returns the elements of the property path as array.

Return Value

array An array of property/index names

string getElement(int $index)

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

Parameters

int $index The index key

Return Value

string A property or index name

Exceptions

OutOfBoundsException If the offset is invalid

bool isProperty(int $index)

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

Parameters

int $index The index in the property path

Return Value

bool Whether the element at this index is a property

Exceptions

OutOfBoundsException If the offset is invalid

bool isIndex(int $index)

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

Parameters

int $index The index in the property path

Return Value

bool Whether the element at this index is an array index

Exceptions

OutOfBoundsException If the offset is invalid