|
1
|
|
|
<?php namespace Comodojo\RpcClient; |
|
2
|
|
|
|
|
3
|
|
|
use \Exception; |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
6
|
|
|
* Comodojo RPC client. It's able to talk in XML and JSON (2.0). |
|
7
|
|
|
* |
|
8
|
|
|
* It optionally supports a not standard encrypted transport |
|
9
|
|
|
* |
|
10
|
|
|
* @package Comodojo Spare Parts |
|
11
|
|
|
* @author Marco Giovinazzi <[email protected]> |
|
12
|
|
|
* @license MIT |
|
13
|
|
|
* |
|
14
|
|
|
* LICENSE: |
|
15
|
|
|
* |
|
16
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
17
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
18
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
19
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
20
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
21
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
|
22
|
|
|
* THE SOFTWARE. |
|
23
|
|
|
*/ |
|
24
|
|
|
|
|
25
|
|
|
class RpcRequest { |
|
26
|
|
|
|
|
27
|
|
|
private $method; |
|
28
|
|
|
|
|
29
|
|
|
private $parameters = array(); |
|
30
|
|
|
|
|
31
|
|
|
private $special_types = array(); |
|
32
|
|
|
|
|
33
|
|
|
private $id = true; |
|
34
|
|
|
|
|
35
|
|
|
private $uid; |
|
36
|
|
|
|
|
37
|
|
|
public function __construct() { |
|
38
|
|
|
|
|
39
|
|
|
$this->uid = md5(uniqid(rand(), true)); |
|
40
|
|
|
|
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
public function setMethod($method) { |
|
44
|
|
|
|
|
45
|
|
|
if ( empty($method) || !is_string($method) ) throw new Exception("Invalid RPC method"); |
|
46
|
|
|
|
|
47
|
|
|
$this->method = $method; |
|
48
|
|
|
|
|
49
|
|
|
return $this; |
|
50
|
|
|
|
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
public function setParameters($params) { |
|
54
|
|
|
|
|
55
|
|
|
if ( !is_array($params) ) throw new Exception("Invalid RPC parameters"); |
|
56
|
|
|
|
|
57
|
|
|
if ( !empty($params) ) $this->parameters = $params; |
|
58
|
|
|
|
|
59
|
|
|
return $this; |
|
60
|
|
|
|
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
public function setId($id = null) { |
|
64
|
|
|
|
|
65
|
|
|
if ( is_null($id) || is_int($id) || is_bool($id) ) { |
|
66
|
|
|
|
|
67
|
|
|
$this->id = $id; |
|
|
|
|
|
|
68
|
|
|
|
|
69
|
|
|
} else { |
|
70
|
|
|
|
|
71
|
|
|
throw new Exception("Invalid RPC id"); |
|
72
|
|
|
|
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
return $this; |
|
76
|
|
|
|
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
public function getMethod() { |
|
80
|
|
|
|
|
81
|
|
|
return $this->method; |
|
82
|
|
|
|
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
public function getParameters() { |
|
86
|
|
|
|
|
87
|
|
|
return $this->parameters; |
|
88
|
|
|
|
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
public function getId() { |
|
92
|
|
|
|
|
93
|
|
|
return $this->id; |
|
94
|
|
|
|
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
public function getUniqueId() { |
|
98
|
|
|
|
|
99
|
|
|
return $this->uid; |
|
100
|
|
|
|
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
final public function setSpecialType(&$value, $type) { |
|
104
|
|
|
|
|
105
|
|
|
$type = strtolower($type); |
|
106
|
|
|
|
|
107
|
|
|
if ( empty($value) OR !in_array($type, array("base64", "datetime", "cdata")) ) { |
|
|
|
|
|
|
108
|
|
|
|
|
109
|
|
|
throw new Exception("Invalid value type"); |
|
110
|
|
|
|
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
$this->special_types[$value] = $type; |
|
114
|
|
|
|
|
115
|
|
|
return $this; |
|
116
|
|
|
|
|
117
|
|
|
} |
|
118
|
|
|
|
|
119
|
|
|
public function getSpecialTypes() { |
|
120
|
|
|
|
|
121
|
|
|
return $this->special_types; |
|
122
|
|
|
|
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
public static function create($method, $parameters = array(), $id = true) { |
|
126
|
|
|
|
|
127
|
|
|
$request = new RpcRequest(); |
|
128
|
|
|
|
|
129
|
|
|
try { |
|
130
|
|
|
|
|
131
|
|
|
$request->setMethod($method) |
|
132
|
|
|
->setParameters($parameters) |
|
133
|
|
|
->setId($id); |
|
134
|
|
|
|
|
135
|
|
|
} catch (Exception $e) { |
|
136
|
|
|
|
|
137
|
|
|
throw $e; |
|
138
|
|
|
|
|
139
|
|
|
} |
|
140
|
|
|
|
|
141
|
|
|
return $request; |
|
142
|
|
|
|
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
|
|
} |
|
146
|
|
|
|
comodojo /
rpcclient
Loading history...
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.
For example, imagine you have a variable
$accountIdthat can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to theidproperty of an instance of theAccountclass. This class holds a proper account, so the id value must no longer be false.Either this assignment is in error or a type check should be added for that assignment.