forked from virtuozzo/OnApp-PHP-Wrapper-External
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IpAddress.php
366 lines (337 loc) · 12.2 KB
/
IpAddress.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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Managing IP Addresses
*
* @category API wrapper
* @package OnApp
* @author Vitaliy Kondratyuk
* @copyright © 2011 OnApp
* @link http://www.onapp.com/
* @see OnApp
*/
/**
* IP Addresses
*
* The OnApp_IpAddress class uses the following basic methods:
* {@link load}, {@link save}, {@link delete}, and {@link getList}.
*
* For full fields reference and curl request details visit: ( http://help.onapp.com/manual.php?m=2 )
*/
class OnApp_IpAddress extends OnApp {
/**
* root tag used in the API request
*
* @var string
*/
var $_tagRoot = 'ip_address';
/**
* alias processing the object data
*
* @var string
*/
var $_resource = 'ip_addresses';
/**
* API Fields description
*
* @param string|float $version OnApp API version
* @param string $className current class' name
*
* @return array
*/
public function initFields( $version = null, $className = '' ) {
switch ( $version ) {
case '2.0':
case '2.1':
case 2.2:
$this->fields = array(
'id' => array(
ONAPP_FIELD_MAP => '_id',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
),
'created_at' => array(
ONAPP_FIELD_MAP => '_created_at',
ONAPP_FIELD_TYPE => 'datetime',
ONAPP_FIELD_READ_ONLY => true,
),
'updated_at' => array(
ONAPP_FIELD_MAP => '_updated_at',
ONAPP_FIELD_TYPE => 'datetime',
ONAPP_FIELD_READ_ONLY => true,
),
'address' => array(
ONAPP_FIELD_MAP => '_address',
ONAPP_FIELD_REQUIRED => true,
),
'netmask' => array(
ONAPP_FIELD_MAP => '_netmask',
ONAPP_FIELD_REQUIRED => true,
),
'broadcast' => array(
ONAPP_FIELD_MAP => '_broadcast',
ONAPP_FIELD_REQUIRED => true,
),
'network_address' => array(
ONAPP_FIELD_MAP => '_network_address',
ONAPP_FIELD_REQUIRED => true,
),
'gateway' => array(
ONAPP_FIELD_MAP => '_gateway',
ONAPP_FIELD_REQUIRED => true,
),
'network_id' => array(
ONAPP_FIELD_MAP => '_network_id',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
),
'free' => array(
ONAPP_FIELD_MAP => '_free',
ONAPP_FIELD_TYPE => 'boolean',
ONAPP_FIELD_READ_ONLY => true,
),
'disallowed_primary' => array(
ONAPP_FIELD_MAP => '_disallowed_primary',
ONAPP_FIELD_TYPE => 'boolean',
ONAPP_FIELD_READ_ONLY => true,
)
);
break;
case 2.3:
$this->fields = $this->initFields( 2.2 );
$this->fields['user_id'] = array(
ONAPP_FIELD_MAP => '_user_id',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
);
break;
case 3.0:
case 3.1:
case 3.2:
case 3.3:
case 3.4:
case 3.5:
case 4.0:
case 4.1:
case 4.2:
$this->fields = $this->initFields( 2.3 );
$this->fields['customer_network_id'] = array(
ONAPP_FIELD_MAP => '_customer_network_id',
ONAPP_FIELD_TYPE => 'string',
);
$this->fields['hypervisor_id'] = array(
ONAPP_FIELD_MAP => '_hypervisor_id',
ONAPP_FIELD_TYPE => 'string',
);
$this->fields['ip_address_pool_id'] = array(
ONAPP_FIELD_MAP => '_ip_address_pool_id',
ONAPP_FIELD_TYPE => 'string',
);
$this->fields['pxe'] = array(
ONAPP_FIELD_MAP => '_pxe',
ONAPP_FIELD_TYPE => 'string',
);
break;
case 4.3:
case 5.0:
$this->fields = $this->initFields( 4.2 );
break;
case 5.1:
$this->fields = $this->initFields( 5.0 );
break;
case 5.2:
$this->fields = $this->initFields( 5.1 );
break;
case 5.3:
$this->fields = $this->initFields( 5.2 );
break;
case 5.4:
$this->fields = $this->initFields( 5.3 );
$this->fields['ip_range_id'] = array(
ONAPP_FIELD_MAP => '_ip_range_id',
ONAPP_FIELD_TYPE => 'string',
);
$this->fields['ipv4'] = array(
ONAPP_FIELD_MAP => '_ipv4',
ONAPP_FIELD_TYPE => 'string',
);
$this->fields['prefix'] = array(
ONAPP_FIELD_MAP => '_prefix',
ONAPP_FIELD_TYPE => 'string',
);
break;
case 5.5:
$this->fields = $this->initFields( 5.4 );
break;
case 6.0:
$this->fields = $this->initFields( 5.5 );
break;
}
parent::initFields( $version, __CLASS__ );
return $this->fields;
}
/**
* Returns the URL Alias of the API Class that inherits the OnApp class
*
* @param string $action action name
*
* @return string API resource
* @access public
*/
function getResource( $action = ONAPP_GETRESOURCE_DEFAULT ) {
switch ( $action ) {
case ONAPP_GETRESOURCE_DEFAULT:
/**
* ROUTE :
*
* @name network_ip_addresses
* @method GET
* @alias /settings/networks/:network_id/ip_addresses(.:format)
* @format {:controller=>"ip_addresses", :action=>"index"}
*/
/**
* ROUTE :
*
* @name network_ip_address
* @method GET
* @alias /settings/networks/:network_id/ip_addresses/:id(.:format)
* @format {:controller=>"ip_addresses", :action=>"show"}
*/
/**
* ROUTE :
*
* @name
* @method POST
* @alias /settings/networks/:network_id/ip_addresses(.:format)
* @format {:controller=>"ip_addresses", :action=>"create"}
*/
/**
* ROUTE :
*
* @name
* @method PUT
* @alias /settings/networks/:network_id/ip_addresses/:id(.:format)
* @format {:controller=>"ip_addresses", :action=>"update"}
*/
/**
* ROUTE :
*
* @name
* @method DELETE
* @alias /settings/networks/:network_id/ip_addresses/:id(.:format)
* @format {:controller=>"ip_addresses", :action=>"destroy"}
*/
if ( is_null( $this->_network_id ) && is_null( $this->_obj->_network_id ) ) {
$this->logger->error(
"getResource($action): argument _network_id not set.",
__FILE__,
__LINE__
);
} else {
if ( is_null( $this->_network_id ) ) {
$this->_network_id = $this->_obj->_network_id;
}
}
$resource = 'settings/networks/' . $this->_network_id . '/' . $this->_resource;
$this->logger->debug( 'getResource( ' . $action . ' ): return ' . $resource );
break;
default:
$resource = parent::getResource( $action );
break;
}
return $resource;
}
/**
* Sends an API request to get the Objects. After requesting,
* unserializes the received response into the array of Objects
*
* @param integer $network_id Network ID
*
* @return mixed an array of Object instances on success. Otherwise false
* @access public
*/
function getList( $network_id = null, $url_args = null ) {
if ( is_null( $network_id ) && ! is_null( $this->_network_id ) ) {
$network_id = $this->_network_id;
}
if ( ! is_null( $network_id ) ) {
$this->_network_id = $network_id;
return parent::getList();
} else {
$this->logger->error(
'getList: argument _network_id not set.',
__FILE__,
__LINE__
);
}
}
/**
* Sends an API request to get the Object after sending,
* unserializes the response into an object
*
* The key field Parameter ID is used to load the Object. You can re-set
* this parameter in the class inheriting OnApp class.
*
* @param integer $id IP Address Join id
* @param integer $virtual_machine_id Virtual Machine id
*
* @return mixed serialized Object instance from API
* @access public
*/
function load( $id = null, $network_id = null ) {
if ( is_null( $network_id ) && ! is_null( $this->_network_id ) ) {
$network_id = $this->_network_id;
}
if ( is_null( $id ) && ! is_null( $this->_id ) ) {
$id = $this->_id;
}
if ( is_null( $id ) &&
isset( $this->_obj ) &&
! is_null( $this->_obj->_id )
) {
$id = $this->_obj->_id;
}
$this->logger->add( "load: Load class ( id => '$id')." );
if ( ! is_null( $id ) && ! is_null( $network_id ) ) {
$this->_id = $id;
$this->_network_id = $network_id;
$this->setAPIResource( $this->getResource( ONAPP_GETRESOURCE_LOAD ) );
$response = $this->sendRequest( ONAPP_REQUEST_METHOD_GET );
$result = $this->_castResponseToClass( $response );
$this->_obj = $result;
return $result;
} else {
if ( is_null( $id ) ) {
$this->logger->error(
'load: argument _id not set.',
__FILE__,
__LINE__
);
} else {
$this->logger->error(
'load: argument _network_id not set.',
__FILE__,
__LINE__
);
}
}
}
/**
* The method saves an Object to your account
*
* After sending an API request to create an object or change the data in
* the existing object, the method checks the response and loads the
* exisitng object with the new data.
*
* @return void
* @access public
*/
function save() {
if ( isset( $this->_id ) ) {
$obj = $this->_edit();
if ( isset( $obj ) && ! isset( $obj->errors ) ) {
$this->load();
}
}
}
}