function ValueExtractorTrait::extractValue

Extracts the value of the given property, method, or array key from the element.

If `$propertyOrMethod` is `null`, we return the element as-is.

Parameters

mixed $element The element to extract the value from.:

string | null $propertyOrMethod The property or method for which the: value should be extracted.

Return value

mixed the value extracted from the specified property, method, or array key, or the element itself.

Throws

InvalidPropertyOrMethod

UnsupportedOperationException

3 calls to ValueExtractorTrait::extractValue()

AbstractCollection::column in vendor/ramsey/collection/src/AbstractCollection.php

@inheritDoc

AbstractCollection::sort in vendor/ramsey/collection/src/AbstractCollection.php

AbstractCollection::where in vendor/ramsey/collection/src/AbstractCollection.php

File

vendor/ramsey/collection/src/Tool/ValueExtractorTrait.php, line 47

Class

ValueExtractorTrait

Provides functionality to extract the value of a property or method from an object.

Namespace

Ramsey\Collection\Tool

Code

protected function extractValue(mixed $element, ?string $propertyOrMethod) : mixed {
    if ($propertyOrMethod === null) {
        return $element;
    }
    if (!is_object($element) && !is_array($element)) {
        throw new UnsupportedOperationException(sprintf('The collection type "%s" does not support the $propertyOrMethod parameter', $this->getType()));
    }
    if (is_array($element)) {
        return $element[$propertyOrMethod] ?? throw new InvalidPropertyOrMethod(sprintf('Key or index "%s" not found in collection elements', $propertyOrMethod));
    }
    if (property_exists($element, $propertyOrMethod)) {
        return $element->{$propertyOrMethod};
    }
    if (method_exists($element, $propertyOrMethod)) {
        return $element->{$propertyOrMethod}();
    }
    throw new InvalidPropertyOrMethod(sprintf('Method or property "%s" not defined in %s', $propertyOrMethod, $element::class));
}