UniversalParameters
Trait UniversalParameters
This trait provides methods for executing API requests with universal parameters. It can be used to add common functionality across different endpoint classes.
Table of Contents
Methods
- execute() : object
- Execute a single API request with universal parameters.
- execute_in_parallel() : array<string|int, mixed>
- Execute multiple API requests in parallel with universal parameters.
- mergeParameters() : Parameters
- Merge method-level parameters with client default parameters.
Methods
execute()
Execute a single API request with universal parameters.
protected
execute(string $method, array<string|int, mixed> $arguments, Parameters|null $parameters) : object
Parameters
- $method : string
-
The API method to call.
- $arguments : array<string|int, mixed>
-
The arguments for the API call.
- $parameters : Parameters|null
-
Optional Parameters object for additional settings.
Return values
object —The API response as an object.
execute_in_parallel()
Execute multiple API requests in parallel with universal parameters.
protected
execute_in_parallel(array<string|int, mixed> $calls[, Parameters|null $parameters = null ][, array<string|int, mixed>|null &$failedRequests = null ]) : array<string|int, mixed>
Parameters
- $calls : array<string|int, mixed>
-
An array of method calls, each containing the method name and arguments.
- $parameters : Parameters|null = null
-
Optional Parameters object for additional settings.
- $failedRequests : array<string|int, mixed>|null = null
-
Optional by-reference array to collect failed requests instead of throwing. When provided, exceptions are stored here keyed by their call index.
Tags
Return values
array<string|int, mixed> —An array of API responses. When $failedRequests is provided, results are keyed by original call index.
mergeParameters()
Merge method-level parameters with client default parameters.
protected
mergeParameters(Parameters|null $methodParams) : Parameters
Priority order (highest to lowest):
- Method-level parameters (if provided)
- Client default parameters ($this->client->default_params)
- Default Parameters() values
Parameters
- $methodParams : Parameters|null
-
Method-level parameters, or null to use only client defaults.
Return values
Parameters —Merged parameters instance.