Class ClientResolver
Methods Summary
-
static
getDefaultArguments ( )
Gets an array of default client arguments, each argument containing a hash of the following:
- __construct ( array $argDefinitions )
-
resolve ( array $args, Aws\HandlerList $list )
Resolves client configuration options and attached event listeners. Check for missing keys in passed arguments
- static _apply_retries ( $value, array & $args, Aws\HandlerList $list )
- static _apply_defaults ( $value, array & $args, Aws\HandlerList $list )
- static _apply_credentials ( $value, array & $args )
- static _default_credential_provider ( array $args )
- static _apply_token ( $value, array & $args )
- static _default_token_provider ( array $args )
- static _apply_csm ( $value, array & $args, Aws\HandlerList $list )
- static _apply_api_provider ( callable $value, array & $args )
- static _apply_endpoint_provider ( $value, array & $args )
- static _apply_endpoint_discovery ( $value, array & $args )
- static _default_endpoint_discovery_provider ( array $args )
- static _apply_use_fips_endpoint ( $value, array & $args )
- static _default_use_fips_endpoint ( array & $args )
- static _apply_use_dual_stack_endpoint ( $value, array & $args )
- static _default_use_dual_stack_endpoint ( array & $args )
- static _apply_debug ( $value, array & $args, Aws\HandlerList $list )
- static _apply_stats ( $value, array & $args, Aws\HandlerList $list )
- static _apply_profile ( $_, array & $args )
- static _apply_validate ( $value, array & $args, Aws\HandlerList $list )
- static _apply_handler ( $value, array & $args, Aws\HandlerList $list )
- static _default_handler ( array & $args )
- static _apply_http_handler ( $value, array & $args, Aws\HandlerList $list )
- static _apply_user_agent ( $inputUserAgent, array & $args, Aws\HandlerList $list )
- static _apply_endpoint ( $value, array & $args, Aws\HandlerList $list )
- static _apply_idempotency_auto_fill ( $value, array & $args, Aws\HandlerList $list )
- static _apply_suppress_php_deprecation_warning ( $suppressWarning, array & $args )
- static _default_endpoint_provider ( array $args )
- static _default_serializer ( array $args )
- static _default_signature_provider ( )
- static _default_signature_version ( array & $args )
- static _default_signing_name ( array & $args )
- static _default_signing_region ( array & $args )
- static _missing_version ( array $args )
- static _missing_region ( array $args )
Methods Details
static array getDefaultArguments ( )
Gets an array of default client arguments, each argument containing a hash of the following:
- type: (string, required) option type described as follows: - value: The default option type. - config: The provided value is made available in the client's getConfig() method.
- valid: (array, required) Valid PHP types or class names. Note: null is not an allowed type.
- required: (bool, callable) Whether or not the argument is required. Provide a function that accepts an array of arguments and returns a string to provide a custom error message.
- default: (mixed) The default value of the argument if not provided. If a function is provided, then it will be invoked to provide a default value. The function is provided the array of options and is expected to return the default value of the option. The default value can be a closure and can not be a callable string that is not part of the defaultArgs array.
- doc: (string) The argument documentation string.
- fn: (callable) Function used to apply the argument. The function accepts the provided value, array of arguments by reference, and an event emitter.
Note: Order is honored and important when applying arguments.
Returns
| array |
__construct ( array $argDefinitions )
Parameters
| array | $argDefinitions | Client arguments. |
array
resolve (
array
$args,
Aws\HandlerList
$list
)
Resolves client configuration options and attached event listeners. Check for missing keys in passed arguments
Parameters
| array | $args | Provided constructor arguments. |
Aws\HandlerList |
$list | Handler list to augment. |
Returns
| array Returns the array of provided options. |
Exceptions
| InvalidArgumentException |
See
Aws\AwsClient::__construct for a list of available options.