forked from virtuozzo/OnApp-PHP-Wrapper-External
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ResourceLimit.php
295 lines (269 loc) · 10 KB
/
ResourceLimit.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
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Resource Limit
*
* With OnApp you can assign resource limits to users. This will prevent users from exceeding the resources you specify.
*
* @category API wrapper
* @package OnApp
* @author Andrew Yatskovets
* @copyright © 2011 OnApp
* @link http://www.onapp.com/
* @see OnApp
*/
/**
* Manages Resource Limit
*
* This class represents the resource limits set to users.
*
* The OnApp_ResourceLimit class uses the following basic methods:
* {@link load}, {@link save} and {@link getList}.
*
* For full fields reference and curl request details visit: ( http://help.onapp.com/manual.php?m=2 )
*/
class OnApp_ResourceLimit extends OnApp {
/**
* root tag used in the API request
*
* @var string
*/
var $_tagRoot = 'resource_limit';
/**
* alias processing the object data
*
* @var string
*/
var $_resource = 'resource_limit';
/**
* 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':
$this->fields = array(
'id' => array(
ONAPP_FIELD_MAP => '_id',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true
),
'cpu_shares' => array(
ONAPP_FIELD_MAP => '_cpu_shares',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_REQUIRED => true,
ONAPP_FIELD_DEFAULT_VALUE => ''
),
'cpus' => array(
ONAPP_FIELD_MAP => '_cpus',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_REQUIRED => true,
ONAPP_FIELD_DEFAULT_VALUE => ''
),
'created_at' => array(
ONAPP_FIELD_MAP => '_created_at',
ONAPP_FIELD_TYPE => 'datetime',
ONAPP_FIELD_READ_ONLY => true,
),
'disk_size' => array(
ONAPP_FIELD_MAP => '_disk_size',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_REQUIRED => true,
ONAPP_FIELD_DEFAULT_VALUE => ''
),
'memory' => array(
ONAPP_FIELD_MAP => '_memory',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_REQUIRED => true,
ONAPP_FIELD_DEFAULT_VALUE => ''
),
'updated_at' => array(
ONAPP_FIELD_MAP => '_updated_at',
ONAPP_FIELD_TYPE => 'datetime',
ONAPP_FIELD_READ_ONLY => true,
),
'user_id' => array(
ONAPP_FIELD_MAP => '_user_id',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
),
'storage_disk_size' => array(
ONAPP_FIELD_MAP => '_storage_disk_size',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_REQUIRED => true,
ONAPP_FIELD_DEFAULT_VALUE => ''
),
'virtual_machines_count' => array(
ONAPP_FIELD_MAP => '_virtual_machines_count',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_REQUIRED => true,
ONAPP_FIELD_DEFAULT_VALUE => ''
),
);
break;
case 2.2:
case 2.3:
$this->fields = $this->initFields( 2.1 );
$this->fields[ 'ip_address_count' ] = array(
ONAPP_FIELD_MAP => 'ip_address_count',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
);
$this->fields[ 'ip_address_mask' ] = array(
ONAPP_FIELD_MAP => 'ip_address_mask',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
);
$this->fields[ 'backups_templates_count' ] = array(
ONAPP_FIELD_MAP => 'backups_templates_count',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
);
$this->fields[ 'rate' ] = array(
ONAPP_FIELD_MAP => 'rate',
ONAPP_FIELD_TYPE => 'integer',
ONAPP_FIELD_READ_ONLY => true,
);
$fields = array(
'id'
);
$this->unsetFields( $fields );
break;
case 3.0:
case 3.1:
case 3.2:
case 3.3:
$this->fields = $this->initFields( 2.3 );
break;
}
parent::initFields( $version, __CLASS__ );
return $this->fields;
}
/**
* Returns the URL Alias of the API Class that inherits the OnApp class
*
* @return string API resource
* @access public
*/
function getResource( $action = ONAPP_GETRESOURCE_DEFAULT ) {
switch( $action ) {
case ONAPP_GETRESOURCE_DEFAULT:
case ONAPP_GETRESOURCE_EDIT:
/**
* ROUTE :
*
* @name user_resource_limit
* @method GET
* @alias /users/:user_id/resource_limit(.:format)
* @format {:controller=>"resource_limits", :action=>"show"}
*/
/**
* ROUTE :
*
* @name user_resource_limit
* @method GET
* @alias /users/:user_id/resource_limit(.:format)
* @format {:controller=>"resource_limits", :action=>"update"}
*/
if( is_null( $this->_user_id ) && is_null( $this->_obj->_user_id ) ) {
$this->logger->error(
"getResource($action): argument _user_id not set.",
__FILE__,
__LINE__
);
}
else {
if( is_null( $this->_user_id ) ) {
$this->_user_id = $this->_obj->_user_id;
}
}
$resource = 'users/' . $this->_user_id . '/' . $this->_resource;
break;
case ONAPP_GETRESOURCE_LOAD:
$resource = $this->getResource();
break;
default:
$resource = parent::getResource( $action );
break;
}
$actions = array(
ONAPP_GETRESOURCE_DEFAULT,
ONAPP_GETRESOURCE_LOAD,
ONAPP_GETRESOURCE_EDIT,
);
if( in_array( $action, $actions ) ) {
$this->logger->debug( 'getResource( ' . $action . ' ): return ' . $resource );
}
return $resource;
}
/**
* 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 Object id
*
* @return object serialized Object instance from API
* @access public
*/
function load( $user_id = null ) {
if( is_null( $user_id ) && ! is_null( $this->_user_id ) ) {
$user_id = $this->_user_id;
}
if( is_null( $user_id ) &&
isset( $this->_obj ) &&
! is_null( $this->_obj->_user_id )
) {
$user_id = $this->_obj->_user_id;
}
$this->logger->add( 'load: Load class ( id => ' . $user_id . ').' );
if( ! is_null( $user_id ) ) {
$this->_user_id = $user_id;
$this->setAPIResource( $this->getResource( ONAPP_GETRESOURCE_LOAD ) );
$response = $this->sendRequest( ONAPP_REQUEST_METHOD_GET );
$result = $this->_castResponseToClass( $response );
$this->_obj = $result;
$this->_user_id = $this->_obj->_user_id;
return $result;
}
else {
$this->logger->error(
'load: argument _user_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->_user_id ) ) {
$obj = $this->_edit();
if( isset( $obj ) && ! isset( $obj->errors ) ) {
$this->load();
}
}
}
function activate( $action_name ) {
switch( $action_name ) {
case ONAPP_ACTIVATE_DELETE:
exit( 'Call to undefined method ' . __CLASS__ . '::' . $action_name . '()' );
break;
}
}
}