platform/api/laravel/Redis/Connectors/PhpRedisConnector.yaml
2024-09-02 10:44:11 -07:00

139 lines
2.8 KiB
YAML

name: PhpRedisConnector
class_comment: null
dependencies:
- name: Connector
type: class
source: Illuminate\Contracts\Redis\Connector
- name: PhpRedisClusterConnection
type: class
source: Illuminate\Redis\Connections\PhpRedisClusterConnection
- name: PhpRedisConnection
type: class
source: Illuminate\Redis\Connections\PhpRedisConnection
- name: Arr
type: class
source: Illuminate\Support\Arr
- name: RedisFacade
type: class
source: Illuminate\Support\Facades\Redis
- name: Str
type: class
source: Illuminate\Support\Str
- name: LogicException
type: class
source: LogicException
- name: Redis
type: class
source: Redis
- name: RedisCluster
type: class
source: RedisCluster
properties: []
methods:
- name: connect
visibility: public
parameters:
- name: config
- name: options
comment: '# * Create a new connection.
# *
# * @param array $config
# * @param array $options
# * @return \Illuminate\Redis\Connections\PhpRedisConnection'
- name: connectToCluster
visibility: public
parameters:
- name: config
- name: clusterOptions
- name: options
comment: '# * Create a new clustered PhpRedis connection.
# *
# * @param array $config
# * @param array $clusterOptions
# * @param array $options
# * @return \Illuminate\Redis\Connections\PhpRedisClusterConnection'
- name: buildClusterConnectionString
visibility: protected
parameters:
- name: server
comment: '# * Build a single cluster seed string from an array.
# *
# * @param array $server
# * @return string'
- name: createClient
visibility: protected
parameters:
- name: config
comment: '# * Create the Redis client instance.
# *
# * @param array $config
# * @return \Redis
# *
# * @throws \LogicException'
- name: establishConnection
visibility: protected
parameters:
- name: client
- name: config
comment: '# * Establish a connection with the Redis host.
# *
# * @param \Redis $client
# * @param array $config
# * @return void'
- name: createRedisClusterInstance
visibility: protected
parameters:
- name: servers
- name: options
comment: '# * Create a new redis cluster instance.
# *
# * @param array $servers
# * @param array $options
# * @return \RedisCluster'
- name: formatHost
visibility: protected
parameters:
- name: options
comment: '# * Format the host using the scheme if available.
# *
# * @param array $options
# * @return string'
traits:
- Illuminate\Contracts\Redis\Connector
- Illuminate\Redis\Connections\PhpRedisClusterConnection
- Illuminate\Redis\Connections\PhpRedisConnection
- Illuminate\Support\Arr
- Illuminate\Support\Str
- LogicException
- Redis
- RedisCluster
interfaces:
- Connector