| Methods |
public
|
__construct(
string $name,
bool $isBound = false,
bool $isComposable = false,
?TypeInterface $returnType = null,
bool $returnsCollection = false,
bool $isReturnTypeNullable = true,
list<FunctionParameterInterface> $parameters = [],
?EntitySetPathInterface $entitySetPath = null,
list<AnnotationInterface> $annotations = [],
)
|
#
|
public
|
getName(): string
The unqualified name of this element within its parent scope.
The unqualified name of this element within its parent scope.
Must conform to the OData SimpleIdentifier production rule:
a non-empty string of at most 128 characters, starting with
a letter or underscore, followed by letters, digits, or underscores.
Implements
|
#
|
public
|
isBound(): bool
Whether this overload is bound to a specific type or set.
Whether this overload is bound to a specific type or set.
When true, the first parameter is the binding parameter and
constrains the context in which the function may be invoked.
Implements
|
#
|
public
|
isComposable(): bool
Whether the result of this function may be further composed
with URL path segments, system query options, or operations.
Whether the result of this function may be further composed
with URL path segments, system query options, or operations.
A composable function returning a collection can be followed
by $filter, $orderby, and similar; a composable function
returning a single entity can be followed by navigation
property segments.
Implements
|
#
|
public
|
getReturnType(): ?TypeInterface
The return type of this function. Null only when the function
is declared without a return type, which the spec permits…
The return type of this function. Null only when the function
is declared without a return type, which the spec permits but
is unusual for well-formed services.
Implements
|
#
|
public
|
returnsCollection(): bool
Whether the return type is a collection.
Whether the return type is a collection.
Implements
|
#
|
public
|
isReturnTypeNullable(): bool
Whether a null return value is permitted.
Whether a null return value is permitted.
Implements
|
#
|
public
|
getParameters(): array
All parameters of this function overload, in declaration order.
All parameters of this function overload, in declaration order.
For bound functions the binding parameter is at index 0.
Implements
|
#
|
public
|
getParameter(string $name): ?FunctionParameterInterface
Returns the parameter with the given name, or null if absent.
Returns the parameter with the given name, or null if absent.
Implements
|
#
|
public
|
getEntitySetPath(): ?EntitySetPathInterface
For bound functions, the entity set path that identifies which
entity set in the container holds the return values, or…
For bound functions, the entity set path that identifies which
entity set in the container holds the return values, or null
when not applicable or not declared.
Use the returned object's typed accessors to resolve the path
programmatically against the container's navigation property
bindings during query plan generation.
Implements
|
#
|