|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* JsCall.php - A javascript function call, with its parameters. |
|
5
|
|
|
* |
|
6
|
|
|
* @package jaxon-core |
|
|
|
|
|
|
7
|
|
|
* @author Jared White |
|
|
|
|
|
|
8
|
|
|
* @author J. Max Wilson |
|
|
|
|
|
|
9
|
|
|
* @author Joseph Woolley |
|
|
|
|
|
|
10
|
|
|
* @author Steffen Konerow |
|
|
|
|
|
|
11
|
|
|
* @author Thierry Feuzeu |
|
|
|
|
|
|
12
|
|
|
* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson |
|
|
|
|
|
|
13
|
|
|
* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson |
|
|
|
|
|
|
14
|
|
|
* @copyright 2016 Thierry Feuzeu <[email protected]> |
|
15
|
|
|
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License |
|
16
|
|
|
* @link https://github.com/jaxon-php/jaxon-core |
|
17
|
|
|
*/ |
|
|
|
|
|
|
18
|
|
|
|
|
19
|
|
|
namespace Jaxon\Request\Call; |
|
20
|
|
|
|
|
21
|
|
|
use JsonSerializable; |
|
22
|
|
|
|
|
23
|
|
|
use function array_map; |
|
24
|
|
|
|
|
25
|
|
|
class JsCall implements JsonSerializable |
|
|
|
|
|
|
26
|
|
|
{ |
|
27
|
|
|
/** |
|
28
|
|
|
* The name of the javascript function |
|
29
|
|
|
* |
|
30
|
|
|
* @var string |
|
31
|
|
|
*/ |
|
32
|
|
|
private $sFunction; |
|
|
|
|
|
|
33
|
|
|
|
|
34
|
|
|
/** |
|
35
|
|
|
* @var string |
|
36
|
|
|
*/ |
|
37
|
|
|
private $sQuoteCharacter = "'"; |
|
|
|
|
|
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* @var array<ParameterInterface> |
|
41
|
|
|
*/ |
|
42
|
|
|
protected $aParameters = []; |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* Convert the parameter value to integer |
|
46
|
|
|
* |
|
47
|
|
|
* @var bool |
|
|
|
|
|
|
48
|
|
|
*/ |
|
49
|
|
|
protected $bToInt = false; |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* The constructor. |
|
53
|
|
|
* |
|
54
|
|
|
* @param string $sFunction The javascript function |
|
|
|
|
|
|
55
|
|
|
*/ |
|
56
|
|
|
public function __construct(string $sFunction) |
|
|
|
|
|
|
57
|
|
|
{ |
|
58
|
|
|
$this->sFunction = $sFunction; |
|
59
|
|
|
} |
|
|
|
|
|
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* @return JsCall |
|
63
|
|
|
*/ |
|
64
|
|
|
public function toInt(): JsCall |
|
65
|
|
|
{ |
|
66
|
|
|
$this->bToInt = true; |
|
67
|
|
|
return $this; |
|
68
|
|
|
} |
|
|
|
|
|
|
69
|
|
|
|
|
70
|
|
|
/** |
|
71
|
|
|
* Clear the parameter list associated with this request |
|
72
|
|
|
* |
|
73
|
|
|
* @return JsCall |
|
74
|
|
|
*/ |
|
75
|
|
|
public function clearParameters(): JsCall |
|
76
|
|
|
{ |
|
77
|
|
|
$this->aParameters = []; |
|
78
|
|
|
return $this; |
|
79
|
|
|
} |
|
|
|
|
|
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* Set the value of the parameter at the given position |
|
83
|
|
|
* |
|
84
|
|
|
* @param ParameterInterface $xParameter The value to be used |
|
|
|
|
|
|
85
|
|
|
* |
|
86
|
|
|
* @return JsCall |
|
87
|
|
|
*/ |
|
88
|
|
|
public function pushParameter(ParameterInterface $xParameter): JsCall |
|
89
|
|
|
{ |
|
90
|
|
|
$this->aParameters[] = $xParameter; |
|
91
|
|
|
return $this; |
|
92
|
|
|
} |
|
|
|
|
|
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* Add a parameter value to the parameter list for this request |
|
96
|
|
|
* |
|
97
|
|
|
* @param string $sType The type of the value to be used |
|
|
|
|
|
|
98
|
|
|
* @param string $sValue The value to be used |
|
|
|
|
|
|
99
|
|
|
* |
|
100
|
|
|
* Types should be one of the following <Parameter::FORM_VALUES>, <Parameter::QUOTED_VALUE>, <Parameter::NUMERIC_VALUE>, |
|
|
|
|
|
|
101
|
|
|
* <Parameter::JS_VALUE>, <Parameter::INPUT_VALUE>, <Parameter::CHECKED_VALUE>, <Parameter::PAGE_NUMBER>. |
|
|
|
|
|
|
102
|
|
|
* The value should be as follows: |
|
|
|
|
|
|
103
|
|
|
* - <Parameter::FORM_VALUES> - Use the ID of the form you want to process. |
|
|
|
|
|
|
104
|
|
|
* - <Parameter::QUOTED_VALUE> - The string data to be passed. |
|
|
|
|
|
|
105
|
|
|
* - <Parameter::JS_VALUE> - A string containing valid javascript |
|
|
|
|
|
|
106
|
|
|
* (either a javascript variable name that will be in scope at the time of the call or |
|
|
|
|
|
|
107
|
|
|
* a javascript function call whose return value will become the parameter). |
|
|
|
|
|
|
108
|
|
|
* |
|
109
|
|
|
* @return JsCall |
|
110
|
|
|
*/ |
|
111
|
|
|
public function addParameter(string $sType, string $sValue): JsCall |
|
112
|
|
|
{ |
|
113
|
|
|
$this->pushParameter(new Parameter($sType, $sValue)); |
|
114
|
|
|
return $this; |
|
115
|
|
|
} |
|
|
|
|
|
|
116
|
|
|
|
|
117
|
|
|
/** |
|
118
|
|
|
* Add a set of parameters to this request |
|
119
|
|
|
* |
|
120
|
|
|
* @param array $aParameters The parameters |
|
|
|
|
|
|
121
|
|
|
* |
|
122
|
|
|
* @return JsCall |
|
123
|
|
|
*/ |
|
124
|
|
|
public function addParameters(array $aParameters): JsCall |
|
125
|
|
|
{ |
|
126
|
|
|
foreach($aParameters as $xParameter) |
|
127
|
|
|
{ |
|
128
|
|
|
$this->pushParameter(Parameter::make($xParameter)); |
|
129
|
|
|
} |
|
130
|
|
|
return $this; |
|
131
|
|
|
} |
|
|
|
|
|
|
132
|
|
|
|
|
133
|
|
|
/** |
|
134
|
|
|
* Convert this call to array |
|
135
|
|
|
* |
|
136
|
|
|
* @return array |
|
137
|
|
|
*/ |
|
138
|
|
|
public function toArray(): array |
|
139
|
|
|
{ |
|
140
|
|
|
$aCalls = [[ |
|
141
|
|
|
'_type' => 'func', |
|
142
|
|
|
'_name' => $this->sFunction, |
|
143
|
|
|
'params' => array_map(function(Parameter $xParam) { |
|
144
|
|
|
return $xParam->forArray(); |
|
145
|
|
|
}, $this->aParameters), |
|
146
|
|
|
]]; |
|
|
|
|
|
|
147
|
|
|
if($this->bToInt) |
|
148
|
|
|
{ |
|
149
|
|
|
$aCalls[] = [ |
|
150
|
|
|
'_type' => 'func', |
|
151
|
|
|
'_name' => 'jaxon.utils.string.toInt', |
|
152
|
|
|
'params' => [[ '_type' => '_', '_name' => 'this' ]], |
|
153
|
|
|
]; |
|
154
|
|
|
} |
|
155
|
|
|
return [ |
|
156
|
|
|
'_type' => 'expr', |
|
157
|
|
|
'calls' => $aCalls, |
|
158
|
|
|
]; |
|
159
|
|
|
} |
|
|
|
|
|
|
160
|
|
|
|
|
161
|
|
|
/** |
|
162
|
|
|
* Convert this call to string, when converting the response into json. |
|
163
|
|
|
* |
|
164
|
|
|
* This is a method of the JsonSerializable interface. |
|
165
|
|
|
* |
|
166
|
|
|
* @return array |
|
167
|
|
|
*/ |
|
168
|
|
|
public function jsonSerialize(): array |
|
169
|
|
|
{ |
|
170
|
|
|
return $this->toArray(); |
|
171
|
|
|
} |
|
|
|
|
|
|
172
|
|
|
} |
|
173
|
|
|
|
jaxon-php /
jaxon-core
Loading history...