-
Notifications
You must be signed in to change notification settings - Fork 4
/
YiiNodeSocketFrameBasic.php
248 lines (221 loc) · 5.36 KB
/
YiiNodeSocketFrameBasic.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<?php
namespace digitv\yii2sockets;
use Yii;
use yii\base\Component;
use yii\web\IdentityInterface;
/**
* Message class basic
* @var array|string $_body
* @var string $_sessionId
* @var string $_channel
* @var string $_callback
* @var integer|array $_userId
* @var boolean $_broadcast
*/
class YiiNodeSocketFrameBasic extends Component {
protected $_channel;
protected $_sessionId;
protected $_userId;
protected $_avoidUserId;
protected $_socketId;
protected $_broadcast = false;
protected $_body;
protected $_callback;
public $errors = [];
/**
* Set message body
* @param $body mixed
* @return $this
*/
public function setBody($body) {
$this->_body = $body;
return $this;
}
/**
* Set message body param
* @param $key
* @param $data
* @return $this
*/
public function setBodyParam($key, $data) {
if(!isset($this->_body)) $this->_body = [];
if(is_array($this->_body)) $this->_body[$key] = $data;
return $this;
}
/**
* Set channel name
* @param $channel string
* @return $this
*/
public function setChannel($channel) {
$this->_channel = $channel;
return $this;
}
/**
* Do not send channel message to user with specified ID
* @param integer $userId
* @return $this
*/
public function avoidUser($userId) {
$this->_avoidUserId = $userId;
return $this;
}
/**
* Set session ID
* @param $sessionId string
* @return $this
*/
public function setSession($sessionId) {
$this->_sessionId = $sessionId;
return $this;
}
/**
* Set user ID
* @param $userId integer|object
* @return $this
*/
public function setUser($userId) {
if($userId instanceof IdentityInterface) { $userId = $userId->getId(); }
$this->_userId = $userId;
return $this;
}
public function setSocketId($socketId) {
$this->_socketId = $socketId;
return $this;
}
/**
* Set callback method name
* @param $callback string
* @return $this
*/
public function setCallback($callback) {
$this->_callback = $callback;
return $this;
}
/**
* Set message broadcast flag
* @return $this
*/
public function broadcast() {
$this->_broadcast = true;
return $this;
}
/**
* Get message body
* @return mixed
*/
public function getBody() {
return $this->_body;
}
/**
* Get channel name
* @return mixed
*/
public function getChannel() {
return $this->_channel;
}
/**
* Get session ID
* @return mixed
*/
public function getSession() {
return $this->_sessionId;
}
/**
* Get user ID
* @return mixed
*/
public function getUser() {
return $this->_userId;
}
/**
* Check if message is broadcast
* @return bool
*/
public function isBroadcast() {
return $this->_broadcast;
}
/**
* Get callback method name
* @return mixed
*/
public function getCallback() {
return $this->_callback;
}
/**
* Send frame
* @return bool|mixed
*/
public function send()
{
if ($this->validate()) {
/* @var $nodeSockets YiiNodeSocket */
$data = $this->composeData();
return Yii::$app->nodeSockets->sendMessage($data);
}
return false;
}
/**
* Send frame to current user socketId
* useful on ajax requests
*
* @return bool|mixed
*/
public function sendToThis()
{
$socketId = Yii::$app->nodeSockets->userSocketId;
if (! $socketId) {
return false;
}
$this->setSocketId($socketId);
return $this->send();
}
/**
* Validate input
* @return bool
*/
protected function validate() {
$valid = true;
$this->errors = [];
if(!isset($this->_userId) && !isset($this->_sessionId) && !isset($this->_socketId) && !isset($this->_channel) && !$this->isBroadcast()) {
$valid = false;
$this->errors[] = 'There are no recipient for this message';
}
if(!isset($this->_body)) {
$valid = false;
$this->errors[] = 'Message body is empty';
}
return $valid;
}
/**
* Get data array for YiiNodeSocket
*
* @return array
*/
protected function composeData()
{
$data = [];
//grab addressee
if ($this->isBroadcast()) {
$data['broadcast'] = true;
} elseif (isset($this->_channel)) {
$data['channel'] = $this->_channel;
} elseif (isset($this->_userId)) {
$data['userId'] = $this->_userId;
} elseif (isset($this->_sessionId)) {
$data['sessionId'] = $this->_sessionId;
} elseif (isset($this->_socketId)) {
$data['socketId'] = $this->_socketId;
}
//check callback
if (isset($this->_callback)) {
$data['callback'] = $this->_callback;
}
if (isset($this->_avoidUserId)) {
$data['avoidUserId'] = $this->_avoidUserId;
}
//add body
$data['body'] = $this->_body;
return $data;
}
}