RedisArray

class RedisArray (View source)

Helper autocomplete for php redis extension

Methods

__construct(string|array $hosts, array|null $opts = null)

Constructor

bool|array
_continuum()

No description

bool|callable
_distributor()

No description

bool|callable
_function()

No description

bool|array
_hosts()

No description

bool|null|Redis
_instance(string $host)

No description

bool|null
_rehash(callable $fn = null)

Use this function when a new node is added and keys need to be rehashed.

bool|string|null
_target(string $key)

No description

bool|RedisArray
multi(string $host, int $mode = Redis::MULTI)

No description

bool|array
info()

Returns a hosts array of associative array of strings and integers, with the following keys:

  • redis_version
  • redis_git_sha1
  • redis_git_dirty
  • redis_build_id
  • redis_mode
  • os
  • arch_bits
  • multiplexing_api
  • atomicvar_api
  • gcc_version
  • process_id
  • run_id
  • tcp_port
  • uptime_in_seconds
  • uptime_in_days
  • hz
  • lru_clock
  • executable
  • config_file
  • connected_clients
  • client_longest_output_list
  • client_biggest_input_buf
  • blocked_clients
  • used_memory
  • used_memory_human
  • used_memory_rss
  • used_memory_rss_human
  • used_memory_peak
  • used_memory_peak_human
  • used_memory_peak_perc
  • used_memory_peak
  • used_memory_overhead
  • used_memory_startup
  • used_memory_dataset
  • used_memory_dataset_perc
  • total_system_memory
  • total_system_memory_human
  • used_memory_lua
  • used_memory_lua_human
  • maxmemory
  • maxmemory_human
  • maxmemory_policy
  • mem_fragmentation_ratio
  • mem_allocator
  • active_defrag_running
  • lazyfree_pending_objects
  • mem_fragmentation_ratio
  • loading
  • rdb_changes_since_last_save
  • rdb_bgsave_in_progress
  • rdb_last_save_time
  • rdb_last_bgsave_status
  • rdb_last_bgsave_time_sec
  • rdb_current_bgsave_time_sec
  • rdb_last_cow_size
  • aof_enabled
  • aof_rewrite_in_progress
  • aof_rewrite_scheduled
  • aof_last_rewrite_time_sec
  • aof_current_rewrite_time_sec
  • aof_last_bgrewrite_status
  • aof_last_write_status
  • aof_last_cow_size
  • changes_since_last_save
  • aof_current_size
  • aof_base_size
  • aof_pending_rewrite
  • aof_buffer_length
  • aof_rewrite_buffer_length
  • aof_pending_bio_fsync
  • aof_delayed_fsync
  • loading_start_time
  • loading_total_bytes
  • loading_loaded_bytes
  • loading_loaded_perc
  • loading_eta_seconds
  • total_connections_received
  • total_commands_processed
  • instantaneous_ops_per_sec
  • total_net_input_bytes
  • total_net_output_bytes
  • instantaneous_input_kbps
  • instantaneous_output_kbps
  • rejected_connections
  • maxclients
  • sync_full
  • sync_partial_ok
  • sync_partial_err
  • expired_keys
  • evicted_keys
  • keyspace_hits
  • keyspace_misses
  • pubsub_channels
  • pubsub_patterns
  • latest_fork_usec
  • migrate_cached_sockets
  • slave_expires_tracked_keys
  • active_defrag_hits
  • active_defrag_misses
  • active_defrag_key_hits
  • active_defrag_key_misses
  • role
  • master_replid
  • master_replid2
  • master_repl_offset
  • second_repl_offset
  • repl_backlog_active
  • repl_backlog_size
  • repl_backlog_first_byte_offset
  • repl_backlog_histlen
  • master_host
  • master_port
  • master_link_status
  • master_last_io_seconds_ago
  • master_sync_in_progress
  • slave_repl_offset
  • slave_priority
  • slave_read_only
  • master_sync_left_bytes
  • master_sync_last_io_seconds_ago
  • master_link_down_since_seconds
  • connected_slaves
  • min-slaves-to-write
  • min-replicas-to-write
  • min_slaves_good_slaves
  • used_cpu_sys
  • used_cpu_user
  • used_cpu_sys_children
  • used_cpu_user_children
  • cluster_enabled

array
bgsave()

No description

bool|int
del(string|array $key, string ...$otherkeys)

No description

bool|null
discard()

No description

bool|null|array
exec()

No description

bool|array
flushall()

No description

bool|array
flushdb()

No description

bool|array
getOption(int $opt)

No description

bool|array
hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

bool|array
keys(string $pattern)

No description

bool|array
mget(array $keys)

No description

bool
mset(array $pairs)

No description

bool|array
ping()

No description

bool|array
save()

No description

bool|array
scan(null|int|string $iterator, string $node, string|null $pattern = null, int $count = 0)

No description

bool|array
select(int $index)

No description

bool|array
setOption(int $opt, string $value)

No description

bool|array
sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

bool|int
unlink(string|array $key, string ...$otherkeys)

No description

bool|null
unwatch()

No description

bool|array
zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

Details

at line 16
__construct(string|array $hosts, array|null $opts = null)

Constructor

Parameters

string|array $hosts

Name of the redis array from redis.ini or array of hosts to construct the array with
array|null $opts

Array of options

at line 21
bool|array _continuum()

No description

Return Value

bool|array

returns a list of points on continuum; may be useful with custom distributor function.

at line 26
bool|callable _distributor()

No description

Return Value

bool|callable

returns a custom distributor function.

at line 31
bool|callable _function()

No description

Return Value

bool|callable

the name of the function used to extract key parts during consistent hashing.

at line 36
bool|array _hosts()

No description

Return Value

bool|array

list of hosts for the selected array or false

at line 43
bool|null|Redis _instance(string $host)

No description

Parameters

string $host

The host you want to retrieve the instance for

Return Value

bool|null|Redis

a redis instance connected to a specific node

at line 50
bool|null _rehash(callable $fn = null)

Use this function when a new node is added and keys need to be rehashed.

Parameters

callable $fn

Return Value

bool|null

rehash result

at line 57
bool|string|null _target(string $key)

No description

Parameters

string $key

The key for which you want to lookup the host

Return Value

bool|string|null

the host to be used for a certain key

at line 65
bool|RedisArray multi(string $host, int $mode = Redis::MULTI)

No description

Parameters

string $host Host
int $mode \Redis::MULTI|\Redis::PIPELINE

Return Value

bool|RedisArray

the host to be used for a certain key

at line 207
bool|array info()

Returns a hosts array of associative array of strings and integers, with the following keys:

  • redis_version
  • redis_git_sha1
  • redis_git_dirty
  • redis_build_id
  • redis_mode
  • os
  • arch_bits
  • multiplexing_api
  • atomicvar_api
  • gcc_version
  • process_id
  • run_id
  • tcp_port
  • uptime_in_seconds
  • uptime_in_days
  • hz
  • lru_clock
  • executable
  • config_file
  • connected_clients
  • client_longest_output_list
  • client_biggest_input_buf
  • blocked_clients
  • used_memory
  • used_memory_human
  • used_memory_rss
  • used_memory_rss_human
  • used_memory_peak
  • used_memory_peak_human
  • used_memory_peak_perc
  • used_memory_peak
  • used_memory_overhead
  • used_memory_startup
  • used_memory_dataset
  • used_memory_dataset_perc
  • total_system_memory
  • total_system_memory_human
  • used_memory_lua
  • used_memory_lua_human
  • maxmemory
  • maxmemory_human
  • maxmemory_policy
  • mem_fragmentation_ratio
  • mem_allocator
  • active_defrag_running
  • lazyfree_pending_objects
  • mem_fragmentation_ratio
  • loading
  • rdb_changes_since_last_save
  • rdb_bgsave_in_progress
  • rdb_last_save_time
  • rdb_last_bgsave_status
  • rdb_last_bgsave_time_sec
  • rdb_current_bgsave_time_sec
  • rdb_last_cow_size
  • aof_enabled
  • aof_rewrite_in_progress
  • aof_rewrite_scheduled
  • aof_last_rewrite_time_sec
  • aof_current_rewrite_time_sec
  • aof_last_bgrewrite_status
  • aof_last_write_status
  • aof_last_cow_size
  • changes_since_last_save
  • aof_current_size
  • aof_base_size
  • aof_pending_rewrite
  • aof_buffer_length
  • aof_rewrite_buffer_length
  • aof_pending_bio_fsync
  • aof_delayed_fsync
  • loading_start_time
  • loading_total_bytes
  • loading_loaded_bytes
  • loading_loaded_perc
  • loading_eta_seconds
  • total_connections_received
  • total_commands_processed
  • instantaneous_ops_per_sec
  • total_net_input_bytes
  • total_net_output_bytes
  • instantaneous_input_kbps
  • instantaneous_output_kbps
  • rejected_connections
  • maxclients
  • sync_full
  • sync_partial_ok
  • sync_partial_err
  • expired_keys
  • evicted_keys
  • keyspace_hits
  • keyspace_misses
  • pubsub_channels
  • pubsub_patterns
  • latest_fork_usec
  • migrate_cached_sockets
  • slave_expires_tracked_keys
  • active_defrag_hits
  • active_defrag_misses
  • active_defrag_key_hits
  • active_defrag_key_misses
  • role
  • master_replid
  • master_replid2
  • master_repl_offset
  • second_repl_offset
  • repl_backlog_active
  • repl_backlog_size
  • repl_backlog_first_byte_offset
  • repl_backlog_histlen
  • master_host
  • master_port
  • master_link_status
  • master_last_io_seconds_ago
  • master_sync_in_progress
  • slave_repl_offset
  • slave_priority
  • slave_read_only
  • master_sync_left_bytes
  • master_sync_last_io_seconds_ago
  • master_link_down_since_seconds
  • connected_slaves
  • min-slaves-to-write
  • min-replicas-to-write
  • min_slaves_good_slaves
  • used_cpu_sys
  • used_cpu_user
  • used_cpu_sys_children
  • used_cpu_user_children
  • cluster_enabled

Return Value

bool|array

Examples

<pre>
$redis->info();
</pre>

at line 209
array bgsave()

No description

Return Value

array

at line 211
bool|int del(string|array $key, string ...$otherkeys)

No description

Parameters

string|array $key
string ...$otherkeys

Return Value

bool|int

at line 213
bool|null discard()

No description

Return Value

bool|null

at line 215
bool|null|array exec()

No description

Return Value

bool|null|array

at line 217
bool|array flushall()

No description

Return Value

bool|array

at line 219
bool|array flushdb()

No description

Return Value

bool|array

at line 221
bool|array getOption(int $opt)

No description

Parameters

int $opt

Return Value

bool|array

at line 223
bool|array hscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

Parameters

string $key
null|int|string $iterator
string|null $pattern
int $count

Return Value

bool|array

at line 225
bool|array keys(string $pattern)

No description

Parameters

string $pattern

Return Value

bool|array

at line 227
bool|array mget(array $keys)

No description

Parameters

array $keys

Return Value

bool|array

at line 229
bool mset(array $pairs)

No description

Parameters

array $pairs

Return Value

bool

at line 231
bool|array ping()

No description

Return Value

bool|array

at line 233
bool|array save()

No description

Return Value

bool|array

at line 235
bool|array scan(null|int|string $iterator, string $node, string|null $pattern = null, int $count = 0)

No description

Parameters

null|int|string $iterator
string $node
string|null $pattern
int $count

Return Value

bool|array

at line 237
bool|array select(int $index)

No description

Parameters

int $index

Return Value

bool|array

at line 239
bool|array setOption(int $opt, string $value)

No description

Parameters

int $opt
string $value

Return Value

bool|array

at line 241
bool|array sscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

Parameters

string $key
null|int|string $iterator
string|null $pattern
int $count

Return Value

bool|array

No description

Parameters

string|array $key
string ...$otherkeys

Return Value

bool|int

at line 245
bool|null unwatch()

No description

Return Value

bool|null

at line 247
bool|array zscan(string $key, null|int|string $iterator, string|null $pattern = null, int $count = 0)

No description

Parameters

string $key
null|int|string $iterator
string|null $pattern
int $count

Return Value

bool|array