trait ValueExtractorTrait
Provides functionality to extract the value of a property or method from an object.
Hierarchy
- trait \Ramsey\Collection\Tool\ValueExtractorTrait
1 file declares its use of ValueExtractorTrait
- AbstractCollection.php in vendor/
ramsey/ collection/ src/ AbstractCollection.php
File
-
vendor/
ramsey/ collection/ src/ Tool/ ValueExtractorTrait.php, line 29
Namespace
Ramsey\Collection\ToolView source
trait ValueExtractorTrait {
/**
* Extracts the value of the given property, method, or array key from the
* element.
*
* If `$propertyOrMethod` is `null`, we return the element as-is.
*
* @param mixed $element The element to extract the value from.
* @param string | null $propertyOrMethod The property or method for which the
* value should be extracted.
*
* @return mixed the value extracted from the specified property, method,
* or array key, or the element itself.
*
* @throws InvalidPropertyOrMethod
* @throws UnsupportedOperationException
*/
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));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ValueExtractorTrait::extractValue | protected | function | Extracts the value of the given property, method, or array key from the element. |