php-opencloud-doc 1.10.0-2 / usr / share / doc / php-opencloud / api / source-class-OpenCloud.Database.Resource.Instance.html

This file is indexed.

/usr/share/doc/php-opencloud/api/source-class-OpenCloud.Database.Resource.Instance.html is in php-opencloud-doc 1.10.0-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<meta name="generator" content="ApiGen 2.8.0">
	<meta name="robots" content="noindex">

	<title>File OpenCloud/Database/Resource/Instance.php | PHP OpenCloud API</title>

	<script type="text/javascript" src="resources/combined.js?117538352"></script>
	<script type="text/javascript" src="elementlist.js?4292216789"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Namespaces</h3>
			<ul>
				<li class="active"><a href="namespace-OpenCloud.html">OpenCloud<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Autoscale.html">Autoscale<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Autoscale.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.CloudMonitoring.html">CloudMonitoring<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.CloudMonitoring.Exception.html">Exception</a>
						</li>
				<li><a href="namespace-OpenCloud.CloudMonitoring.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Common.html">Common<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Common.Collection.html">Collection</a>
						</li>
				<li><a href="namespace-OpenCloud.Common.Constants.html">Constants</a>
						</li>
				<li><a href="namespace-OpenCloud.Common.Exceptions.html">Exceptions</a>
						</li>
				<li><a href="namespace-OpenCloud.Common.Http.html">Http<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Common.Http.Message.html">Message</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Common.Log.html">Log</a>
						</li>
				<li><a href="namespace-OpenCloud.Common.Resource.html">Resource</a>
						</li>
				<li><a href="namespace-OpenCloud.Common.Service.html">Service</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Compute.html">Compute<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Compute.Constants.html">Constants</a>
						</li>
				<li><a href="namespace-OpenCloud.Compute.Exception.html">Exception</a>
						</li>
				<li><a href="namespace-OpenCloud.Compute.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li class="active"><a href="namespace-OpenCloud.Database.html">Database<span></span></a>
						<ul>
				<li class="active"><a href="namespace-OpenCloud.Database.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.DNS.html">DNS<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.DNS.Collection.html">Collection</a>
						</li>
				<li><a href="namespace-OpenCloud.DNS.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Identity.html">Identity<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Identity.Constants.html">Constants</a>
						</li>
				<li><a href="namespace-OpenCloud.Identity.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Image.html">Image<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Image.Enum.html">Enum</a>
						</li>
				<li><a href="namespace-OpenCloud.Image.Resource.html">Resource<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Image.Resource.JsonPatch.html">JsonPatch</a>
						</li>
				<li><a href="namespace-OpenCloud.Image.Resource.Schema.html">Schema</a>
						</li>
							</ul></li></ul></li>
				<li><a href="namespace-OpenCloud.LoadBalancer.html">LoadBalancer<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.LoadBalancer.Enum.html">Enum</a>
						</li>
				<li><a href="namespace-OpenCloud.LoadBalancer.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.ObjectStore.html">ObjectStore<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.ObjectStore.Constants.html">Constants</a>
						</li>
				<li><a href="namespace-OpenCloud.ObjectStore.Exception.html">Exception</a>
						</li>
				<li><a href="namespace-OpenCloud.ObjectStore.Resource.html">Resource</a>
						</li>
				<li><a href="namespace-OpenCloud.ObjectStore.Upload.html">Upload</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Orchestration.html">Orchestration</a>
						</li>
				<li><a href="namespace-OpenCloud.Queues.html">Queues<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Queues.Exception.html">Exception</a>
						</li>
				<li><a href="namespace-OpenCloud.Queues.Resource.html">Resource</a>
						</li>
							</ul></li>
				<li><a href="namespace-OpenCloud.Volume.html">Volume<span></span></a>
						<ul>
				<li><a href="namespace-OpenCloud.Volume.Resource.html">Resource</a>
						</li>
							</ul></li></ul></li>
				<li><a href="namespace-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr>


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-OpenCloud.Database.Resource.Database.html">Database</a></li>
				<li class="active"><a href="class-OpenCloud.Database.Resource.Instance.html">Instance</a></li>
				<li><a href="class-OpenCloud.Database.Resource.User.html">User</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="">
		<input type="hidden" name="ie" value="UTF-8">
		<input type="text" name="q" class="text">
		<input type="submit" value="Search">
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-OpenCloud.Database.Resource.html" title="Summary of OpenCloud\Database\Resource"><span>Namespace</span></a>
			</li>
			<li>
				<a href="class-OpenCloud.Database.Resource.Instance.html" title="Summary of OpenCloud\Database\Resource\Instance"><span>Class</span></a>
			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
			<li>
				<a href="php-opencloud-api-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
			</li>
		</ul>
	</div>

<pre><code><span id="1" class="l"><a class="l" href="#1">  1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2">  2: </a><span class="php-comment">/**
</span></span><span id="3" class="l"><a class="l" href="#3">  3: </a><span class="php-comment"> * Copyright 2012-2014 Rackspace US, Inc.
</span></span><span id="4" class="l"><a class="l" href="#4">  4: </a><span class="php-comment"> *
</span></span><span id="5" class="l"><a class="l" href="#5">  5: </a><span class="php-comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
</span></span><span id="6" class="l"><a class="l" href="#6">  6: </a><span class="php-comment"> * you may not use this file except in compliance with the License.
</span></span><span id="7" class="l"><a class="l" href="#7">  7: </a><span class="php-comment"> * You may obtain a copy of the License at
</span></span><span id="8" class="l"><a class="l" href="#8">  8: </a><span class="php-comment"> *
</span></span><span id="9" class="l"><a class="l" href="#9">  9: </a><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> *
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * See the License for the specific language governing permissions and
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * limitations under the License.
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> */</span>
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a>
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">namespace</span> OpenCloud\Database\Resource;
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a>
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-keyword1">use</span> OpenCloud\Common\Http\Message\Formatter;
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-keyword1">use</span> OpenCloud\Common\Lang;
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-keyword1">use</span> OpenCloud\Common\Exceptions;
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-keyword1">use</span> OpenCloud\Common\Resource\NovaResource;
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">use</span> OpenCloud\Compute\Resource\Flavor;
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-keyword1">use</span> OpenCloud\Database\Service;
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a>
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment">/**
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * Instance represents an instance of DbService, similar to a Server in a
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * Compute service
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> */</span>
</span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-keyword1">class</span> <a id="Instance" href="#Instance">Instance</a> <span class="php-keyword1">extends</span> NovaResource
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a>{
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$id" href="#$id">$id</a></span>;
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$name" href="#$name">$name</a></span>;
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$status" href="#$status">$status</a></span>;
</span><span id="36" class="l"><a class="l" href="#36"> 36: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$links" href="#$links">$links</a></span>;
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$hostname" href="#$hostname">$hostname</a></span>;
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$volume" href="#$volume">$volume</a></span>;
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$created" href="#$created">$created</a></span>;
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$updated" href="#$updated">$updated</a></span>;
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a>    <span class="php-keyword1">public</span> <span class="php-var"><a id="$flavor" href="#$flavor">$flavor</a></span>;
</span><span id="42" class="l"><a class="l" href="#42"> 42: </a>
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a>    <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$json_name" href="#$json_name">$json_name</a></span> = <span class="php-quote">'instance'</span>;
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a>    <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$url_resource" href="#$url_resource">$url_resource</a></span> = <span class="php-quote">'instances'</span>;
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a>
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a>    <span class="php-keyword1">private</span> <span class="php-var"><a id="$_databases" href="#$_databases">$_databases</a></span>; <span class="php-comment">// used to Create databases simultaneously</span>
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a>    <span class="php-keyword1">private</span> <span class="php-var"><a id="$_users" href="#$_users">$_users</a></span>; <span class="php-comment">// used to Create users simultaneously</span>
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a>    <span class="php-comment">/**
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment">     * Creates a new instance object
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment">     *
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment">     * This could use the default constructor, but we want to make sure that
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment">     * the volume attribute is an object.
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment">     *
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment">     * @param \OpenCloud\DbService $service the DbService object associated
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">     *                                      with this
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment">     * @param mixed                $info    the ID or array of info for the object
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment">     */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(Service <span class="php-var">$service</span>, <span class="php-var">$info</span> = <span class="php-keyword1">null</span>)
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a>    {
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a>        <span class="php-var">$this</span>-&gt;volume = <span class="php-keyword1">new</span> \stdClass;
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a>
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a>        <span class="php-keyword1">return</span> parent::__construct(<span class="php-var">$service</span>, <span class="php-var">$info</span>);
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a>    }
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a>    <span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment">     * Updates a database instance (not permitted)
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment">     *
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment">     * Update() is not supported by database instances; thus, this always
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment">     * throws an exception.
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">     *
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment">     * @throws InstanceUpdateError always
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment">     */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_update" href="#_update">update</a>(<span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a>    {
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;noUpdate();
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a>    }
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a>    <span class="php-comment">/**
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment">     * Restarts the database instance
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">     *
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment">     * @api
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment">     * @returns \OpenCloud\HttpResponse
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment">     */</span>
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_restart" href="#_restart">restart</a>()
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a>    {
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;action(<span class="php-var">$this</span>-&gt;restartJson());
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a>    }
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a>
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>    <span class="php-comment">/**
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment">     * Resizes the database instance (sets RAM)
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment">     *
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment">     * @api
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment">     * @param \OpenCloud\Compute\Flavor $flavor a flavor object
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment">     * @returns \OpenCloud\HttpResponse
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">     */</span>
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_resize" href="#_resize">resize</a>(Flavor <span class="php-var">$flavor</span>)
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a>    {
</span><span id="99" class="l"><a class="l" href="#99"> 99: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;action(<span class="php-var">$this</span>-&gt;resizeJson(<span class="php-var">$flavor</span>-&gt;id));
</span><span id="100" class="l"><a class="l" href="#100">100: </a>    }
</span><span id="101" class="l"><a class="l" href="#101">101: </a>
</span><span id="102" class="l"><a class="l" href="#102">102: </a>    <span class="php-comment">/**
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment">     * Resizes the volume associated with the database instance (disk space)
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment">     *
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment">     * @api
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">     * @param integer $newvolumesize the size of the new volume, in gigabytes
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment">     * @return \OpenCloud\HttpResponse
</span></span><span id="108" class="l"><a class="l" href="#108">108: </a><span class="php-comment">     */</span>
</span><span id="109" class="l"><a class="l" href="#109">109: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_resizeVolume" href="#_resizeVolume">resizeVolume</a>(<span class="php-var">$newvolumesize</span>)
</span><span id="110" class="l"><a class="l" href="#110">110: </a>    {
</span><span id="111" class="l"><a class="l" href="#111">111: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;action(<span class="php-var">$this</span>-&gt;resizeVolumeJson(<span class="php-var">$newvolumesize</span>));
</span><span id="112" class="l"><a class="l" href="#112">112: </a>    }
</span><span id="113" class="l"><a class="l" href="#113">113: </a>
</span><span id="114" class="l"><a class="l" href="#114">114: </a>    <span class="php-comment">/**
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment">     * Enables the root user for the instance
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">     *
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment">     * @api
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment">     * @return User the root user, including name and password
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment">     * @throws InstanceError if HTTP response is not Success
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment">     */</span>
</span><span id="121" class="l"><a class="l" href="#121">121: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_enableRootUser" href="#_enableRootUser">enableRootUser</a>()
</span><span id="122" class="l"><a class="l" href="#122">122: </a>    {
</span><span id="123" class="l"><a class="l" href="#123">123: </a>        <span class="php-var">$response</span> = <span class="php-var">$this</span>-&gt;getClient()-&gt;post(<span class="php-var">$this</span>-&gt;getUrl(<span class="php-quote">'root'</span>))-&gt;send();
</span><span id="124" class="l"><a class="l" href="#124">124: </a>        <span class="php-var">$body</span> = Formatter::decode(<span class="php-var">$response</span>);
</span><span id="125" class="l"><a class="l" href="#125">125: </a>
</span><span id="126" class="l"><a class="l" href="#126">126: </a>        <span class="php-keyword1">return</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$body</span>-&gt;user)) ? <span class="php-keyword1">new</span> User(<span class="php-var">$this</span>, <span class="php-var">$body</span>-&gt;user) : <span class="php-keyword1">false</span>;
</span><span id="127" class="l"><a class="l" href="#127">127: </a>    }
</span><span id="128" class="l"><a class="l" href="#128">128: </a>
</span><span id="129" class="l"><a class="l" href="#129">129: </a>    <span class="php-comment">/**
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment">     * Returns TRUE if the root user is enabled
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">     *
</span></span><span id="132" class="l"><a class="l" href="#132">132: </a><span class="php-comment">     * @api
</span></span><span id="133" class="l"><a class="l" href="#133">133: </a><span class="php-comment">     * @return boolean TRUE if the root user is enabled; FALSE otherwise
</span></span><span id="134" class="l"><a class="l" href="#134">134: </a><span class="php-comment">     * @throws InstanceError if HTTP status is not Success
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment">     */</span>
</span><span id="136" class="l"><a class="l" href="#136">136: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_isRootEnabled" href="#_isRootEnabled">isRootEnabled</a>()
</span><span id="137" class="l"><a class="l" href="#137">137: </a>    {
</span><span id="138" class="l"><a class="l" href="#138">138: </a>        <span class="php-var">$response</span> = <span class="php-var">$this</span>-&gt;getClient()-&gt;get(<span class="php-var">$this</span>-&gt;url(<span class="php-quote">'root'</span>))-&gt;send();
</span><span id="139" class="l"><a class="l" href="#139">139: </a>        <span class="php-var">$body</span> = Formatter::decode(<span class="php-var">$response</span>);
</span><span id="140" class="l"><a class="l" href="#140">140: </a>
</span><span id="141" class="l"><a class="l" href="#141">141: </a>        <span class="php-keyword1">return</span> !<span class="php-keyword1">empty</span>(<span class="php-var">$body</span>-&gt;rootEnabled);
</span><span id="142" class="l"><a class="l" href="#142">142: </a>    }
</span><span id="143" class="l"><a class="l" href="#143">143: </a>
</span><span id="144" class="l"><a class="l" href="#144">144: </a>    <span class="php-comment">/**
</span></span><span id="145" class="l"><a class="l" href="#145">145: </a><span class="php-comment">     * Returns a new Database object
</span></span><span id="146" class="l"><a class="l" href="#146">146: </a><span class="php-comment">     *
</span></span><span id="147" class="l"><a class="l" href="#147">147: </a><span class="php-comment">     * @param string $name the database name
</span></span><span id="148" class="l"><a class="l" href="#148">148: </a><span class="php-comment">     * @return Database
</span></span><span id="149" class="l"><a class="l" href="#149">149: </a><span class="php-comment">     */</span>
</span><span id="150" class="l"><a class="l" href="#150">150: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_database" href="#_database">database</a>(<span class="php-var">$name</span> = <span class="php-quote">''</span>)
</span><span id="151" class="l"><a class="l" href="#151">151: </a>    {
</span><span id="152" class="l"><a class="l" href="#152">152: </a>        <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> Database(<span class="php-var">$this</span>, <span class="php-var">$name</span>);
</span><span id="153" class="l"><a class="l" href="#153">153: </a>    }
</span><span id="154" class="l"><a class="l" href="#154">154: </a>
</span><span id="155" class="l"><a class="l" href="#155">155: </a>    <span class="php-comment">/**
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment">     * Returns a new User object
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment">     *
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment">     * @param string $name      the user name
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment">     * @param array  $databases a simple array of database names
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment">     * @return User
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment">     */</span>
</span><span id="162" class="l"><a class="l" href="#162">162: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_user" href="#_user">user</a>(<span class="php-var">$name</span> = <span class="php-quote">''</span>, <span class="php-var">$databases</span> = <span class="php-keyword1">array</span>())
</span><span id="163" class="l"><a class="l" href="#163">163: </a>    {
</span><span id="164" class="l"><a class="l" href="#164">164: </a>        <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> User(<span class="php-var">$this</span>, <span class="php-var">$name</span>, <span class="php-var">$databases</span>);
</span><span id="165" class="l"><a class="l" href="#165">165: </a>    }
</span><span id="166" class="l"><a class="l" href="#166">166: </a>
</span><span id="167" class="l"><a class="l" href="#167">167: </a>    <span class="php-comment">/**
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment">     * Returns a Collection of all databases in the instance
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment">     *
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment">     * @return OpenCloud\Common\Collection\PaginatedIterator
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment">     */</span>
</span><span id="172" class="l"><a class="l" href="#172">172: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_databaseList" href="#_databaseList">databaseList</a>()
</span><span id="173" class="l"><a class="l" href="#173">173: </a>    {
</span><span id="174" class="l"><a class="l" href="#174">174: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;getService()-&gt;resourceList(<span class="php-quote">'Database'</span>, <span class="php-var">$this</span>-&gt;getUrl(<span class="php-quote">'databases'</span>), <span class="php-var">$this</span>);
</span><span id="175" class="l"><a class="l" href="#175">175: </a>    }
</span><span id="176" class="l"><a class="l" href="#176">176: </a>
</span><span id="177" class="l"><a class="l" href="#177">177: </a>    <span class="php-comment">/**
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment">     * Returns a Collection of all users in the instance
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment">     *
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment">     * @return OpenCloud\Common\Collection\PaginatedIterator
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment">     */</span>
</span><span id="182" class="l"><a class="l" href="#182">182: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_userList" href="#_userList">userList</a>()
</span><span id="183" class="l"><a class="l" href="#183">183: </a>    {
</span><span id="184" class="l"><a class="l" href="#184">184: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;getService()-&gt;resourceList(<span class="php-quote">'User'</span>, <span class="php-var">$this</span>-&gt;getUrl(<span class="php-quote">'users'</span>), <span class="php-var">$this</span>);
</span><span id="185" class="l"><a class="l" href="#185">185: </a>    }
</span><span id="186" class="l"><a class="l" href="#186">186: </a>
</span><span id="187" class="l"><a class="l" href="#187">187: </a>    <span class="php-comment">/**
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment">     * Generates the JSON string for Create()
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment">     *
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment">     * @return \stdClass
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment">     */</span>
</span><span id="192" class="l"><a class="l" href="#192">192: </a>    <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_createJson" href="#_createJson">createJson</a>()
</span><span id="193" class="l"><a class="l" href="#193">193: </a>    {
</span><span id="194" class="l"><a class="l" href="#194">194: </a>        <span class="php-keyword1">if</span> (<span class="php-keyword1">empty</span>(<span class="php-var">$this</span>-&gt;flavor) || !<span class="php-keyword2">is_object</span>(<span class="php-var">$this</span>-&gt;flavor)) {
</span><span id="195" class="l"><a class="l" href="#195">195: </a>            <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exceptions\InstanceFlavorError(
</span><span id="196" class="l"><a class="l" href="#196">196: </a>                Lang::translate(<span class="php-quote">'The `flavor` attribute is required and must be a Flavor object'</span>)
</span><span id="197" class="l"><a class="l" href="#197">197: </a>            );
</span><span id="198" class="l"><a class="l" href="#198">198: </a>        }
</span><span id="199" class="l"><a class="l" href="#199">199: </a>
</span><span id="200" class="l"><a class="l" href="#200">200: </a>        <span class="php-keyword1">if</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>-&gt;name)) {
</span><span id="201" class="l"><a class="l" href="#201">201: </a>            <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exceptions\InstanceError(
</span><span id="202" class="l"><a class="l" href="#202">202: </a>                Lang::translate(<span class="php-quote">'Instance name is required'</span>)
</span><span id="203" class="l"><a class="l" href="#203">203: </a>            );
</span><span id="204" class="l"><a class="l" href="#204">204: </a>        }
</span><span id="205" class="l"><a class="l" href="#205">205: </a>
</span><span id="206" class="l"><a class="l" href="#206">206: </a>        <span class="php-keyword1">return</span> (object) <span class="php-keyword1">array</span>(
</span><span id="207" class="l"><a class="l" href="#207">207: </a>            <span class="php-quote">'instance'</span> =&gt; (object) <span class="php-keyword1">array</span>(
</span><span id="208" class="l"><a class="l" href="#208">208: </a>                    <span class="php-quote">'flavorRef'</span> =&gt; <span class="php-var">$this</span>-&gt;flavor-&gt;links[<span class="php-num">0</span>]-&gt;href,
</span><span id="209" class="l"><a class="l" href="#209">209: </a>                    <span class="php-quote">'name'</span>      =&gt; <span class="php-var">$this</span>-&gt;name,
</span><span id="210" class="l"><a class="l" href="#210">210: </a>                    <span class="php-quote">'volume'</span>    =&gt; <span class="php-var">$this</span>-&gt;volume
</span><span id="211" class="l"><a class="l" href="#211">211: </a>                )
</span><span id="212" class="l"><a class="l" href="#212">212: </a>        );
</span><span id="213" class="l"><a class="l" href="#213">213: </a>    }
</span><span id="214" class="l"><a class="l" href="#214">214: </a>
</span><span id="215" class="l"><a class="l" href="#215">215: </a>    <span class="php-comment">/**
</span></span><span id="216" class="l"><a class="l" href="#216">216: </a><span class="php-comment">     * Generates the JSON object for Restart
</span></span><span id="217" class="l"><a class="l" href="#217">217: </a><span class="php-comment">     */</span>
</span><span id="218" class="l"><a class="l" href="#218">218: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_restartJson" href="#_restartJson">restartJson</a>()
</span><span id="219" class="l"><a class="l" href="#219">219: </a>    {
</span><span id="220" class="l"><a class="l" href="#220">220: </a>        <span class="php-keyword1">return</span> (object) <span class="php-keyword1">array</span>(<span class="php-quote">'restart'</span> =&gt; <span class="php-keyword1">new</span> \stdClass);
</span><span id="221" class="l"><a class="l" href="#221">221: </a>    }
</span><span id="222" class="l"><a class="l" href="#222">222: </a>
</span><span id="223" class="l"><a class="l" href="#223">223: </a>    <span class="php-comment">/**
</span></span><span id="224" class="l"><a class="l" href="#224">224: </a><span class="php-comment">     * Generates the JSON object for Resize
</span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment">     */</span>
</span><span id="226" class="l"><a class="l" href="#226">226: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_resizeJson" href="#_resizeJson">resizeJson</a>(<span class="php-var">$flavorRef</span>)
</span><span id="227" class="l"><a class="l" href="#227">227: </a>    {
</span><span id="228" class="l"><a class="l" href="#228">228: </a>        <span class="php-keyword1">return</span> (object) <span class="php-keyword1">array</span>(
</span><span id="229" class="l"><a class="l" href="#229">229: </a>            <span class="php-quote">'resize'</span> =&gt; (object) <span class="php-keyword1">array</span>(<span class="php-quote">'flavorRef'</span> =&gt; <span class="php-var">$flavorRef</span>)
</span><span id="230" class="l"><a class="l" href="#230">230: </a>        );
</span><span id="231" class="l"><a class="l" href="#231">231: </a>    }
</span><span id="232" class="l"><a class="l" href="#232">232: </a>
</span><span id="233" class="l"><a class="l" href="#233">233: </a>    <span class="php-comment">/**
</span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment">     * Generates the JSON object for ResizeVolume
</span></span><span id="235" class="l"><a class="l" href="#235">235: </a><span class="php-comment">     */</span>
</span><span id="236" class="l"><a class="l" href="#236">236: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_resizeVolumeJson" href="#_resizeVolumeJson">resizeVolumeJson</a>(<span class="php-var">$size</span>)
</span><span id="237" class="l"><a class="l" href="#237">237: </a>    {
</span><span id="238" class="l"><a class="l" href="#238">238: </a>        <span class="php-keyword1">return</span> (object) <span class="php-keyword1">array</span>(
</span><span id="239" class="l"><a class="l" href="#239">239: </a>            <span class="php-quote">'resize'</span> =&gt; (object) <span class="php-keyword1">array</span>(
</span><span id="240" class="l"><a class="l" href="#240">240: </a>                    <span class="php-quote">'volume'</span> =&gt; (object) <span class="php-keyword1">array</span>(<span class="php-quote">'size'</span> =&gt; <span class="php-var">$size</span>)
</span><span id="241" class="l"><a class="l" href="#241">241: </a>                )
</span><span id="242" class="l"><a class="l" href="#242">242: </a>        );
</span><span id="243" class="l"><a class="l" href="#243">243: </a>    }
</span><span id="244" class="l"><a class="l" href="#244">244: </a>}
</span><span id="245" class="l"><a class="l" href="#245">245: </a></span></code></pre>

	<div id="footer">
		PHP OpenCloud API API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.