1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* # # ###### ##### ##### |
5
|
|
|
* # # # ###### ##### # # # # # # |
6
|
|
|
* # # # # # # # # # # |
7
|
|
|
* # # # ##### ##### # # # # #### |
8
|
|
|
* # # # # # # # # # # # |
9
|
|
|
* # # # # # # # # # # # # |
10
|
|
|
* ## ## ###### ##### ###### ##### ##### |
11
|
|
|
*/ |
12
|
|
|
|
13
|
|
|
namespace Webdcg\Redis\Traits; |
14
|
|
|
|
15
|
|
|
trait Introspection |
16
|
|
|
{ |
17
|
|
|
/** |
18
|
|
|
* A method to determine if a phpredis object thinks it's connected to a |
19
|
|
|
* server. |
20
|
|
|
* |
21
|
|
|
* @return boolean Returns TRUE if phpredis thinks it's connected |
22
|
|
|
* and FALSE if not. |
23
|
|
|
*/ |
24
|
|
|
public function isConnected(): bool |
25
|
|
|
{ |
26
|
|
|
return $this->redis->isConnected(); |
|
|
|
|
27
|
|
|
} |
28
|
|
|
|
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* Retrieve our host or unix socket that we're connected to |
32
|
|
|
* |
33
|
|
|
* @return mixed|string|bool The host or unix socket we're connected to |
34
|
|
|
* or FALSE if we're not connected. |
35
|
|
|
*/ |
36
|
|
|
public function getHost() |
37
|
|
|
{ |
38
|
|
|
return $this->redis->getHost(); |
39
|
|
|
} |
40
|
|
|
|
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* Get the port we're connected to |
44
|
|
|
* |
45
|
|
|
* @return mixed|int|bool Returns the port we're connected to or |
46
|
|
|
* FALSE if we're not connected. |
47
|
|
|
*/ |
48
|
|
|
public function getPort() |
49
|
|
|
{ |
50
|
|
|
return $this->redis->getPort(); |
51
|
|
|
} |
52
|
|
|
|
53
|
|
|
|
54
|
|
|
/** |
55
|
|
|
* Get the database number phpredis is pointed to |
56
|
|
|
* |
57
|
|
|
* @return mixed|int|bool Returns the database number (LONG) |
58
|
|
|
* phpredis thinks it's pointing to or |
59
|
|
|
* FALSE if we're not connected. |
60
|
|
|
*/ |
61
|
|
|
public function getDbNum() |
62
|
|
|
{ |
63
|
|
|
return $this->redis->getDbNum(); |
64
|
|
|
} |
65
|
|
|
|
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* Get the (write) timeout in use for phpredis |
69
|
|
|
* |
70
|
|
|
* @return mixed|float|bool The timeout (DOUBLE) specified in our |
71
|
|
|
* connect call or FALSE if we're not |
72
|
|
|
* connected. |
73
|
|
|
*/ |
74
|
|
|
public function getTimeout() |
75
|
|
|
{ |
76
|
|
|
return $this->redis->getTimeout(); |
77
|
|
|
} |
78
|
|
|
|
79
|
|
|
|
80
|
|
|
/** |
81
|
|
|
* Get the read timeout specified to phpredis or FALSE if we're not connected |
82
|
|
|
* |
83
|
|
|
* @return mixed|int|bool Returns the read timeout (which can be set |
84
|
|
|
* using setOption and Redis::OPT_READ_TIMEOUT) |
85
|
|
|
* or FALSE if we're not connected. |
86
|
|
|
*/ |
87
|
|
|
public function getReadTimeout() |
88
|
|
|
{ |
89
|
|
|
return $this->redis->getReadTimeout(); |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* Gets the persistent ID that phpredis is using. |
95
|
|
|
* |
96
|
|
|
* @return mixed|int|null|bool Returns the persistent id phpredis is using |
97
|
|
|
* (which will only be set if connected with |
98
|
|
|
* pconnect), NULL if we're not using a |
99
|
|
|
* persistent ID, and FALSE if we're not |
100
|
|
|
* connected. |
101
|
|
|
*/ |
102
|
|
|
public function getPersistentID() |
103
|
|
|
{ |
104
|
|
|
return $this->redis->getPersistentID(); |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* Get the password used to authenticate the phpredis connection. |
110
|
|
|
* |
111
|
|
|
* @return mixed|string|null|bool Returns the password used to authenticate |
112
|
|
|
* a phpredis session or NULL if none was |
113
|
|
|
* used, and FALSE if we're not connected. |
114
|
|
|
*/ |
115
|
|
|
public function getAuth() |
116
|
|
|
{ |
117
|
|
|
return $this->redis->getAuth(); |
118
|
|
|
} |
119
|
|
|
} |
120
|
|
|
|
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: