ProfileOption
in package
implements
OptionInterface
Configures the server profile to be used by the client to create command instances depending on the specified version of the Redis server.
Tags
Interfaces, Classes and Traits
- OptionInterface
- Defines an handler used by Predis\Configuration\Options to filter, validate or return default values for a given option.
Table of Contents
- filter() : mixed
- Filters and validates the passed value.
- getDefault() : mixed
- Returns the default value for the option.
- setProcessors() : mixed
- Sets the commands processors that need to be applied to the profile.
Methods
filter()
Filters and validates the passed value.
public
filter(OptionsInterface $options, mixed $value) : mixed
Parameters
- $options : OptionsInterface
-
Options container.
- $value : mixed
-
Input value.
Return values
mixed —getDefault()
Returns the default value for the option.
public
getDefault(OptionsInterface $options) : mixed
Parameters
- $options : OptionsInterface
-
Options container.
Return values
mixed —setProcessors()
Sets the commands processors that need to be applied to the profile.
protected
setProcessors(OptionsInterface $options, ProfileInterface $profile) : mixed
Parameters
- $options : OptionsInterface
-
Client options.
- $profile : ProfileInterface
-
Server profile.