Skip to content

Commit f459690

Browse files
committed
Add result request, login check
1 parent 4a9b348 commit f459690

File tree

3 files changed

+539
-436
lines changed

3 files changed

+539
-436
lines changed

README.md

+80-19
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,27 @@ The result is a complete response from server.
1010

1111
[ProxmoxVE Api](https://pve.proxmox.com/pve-docs/api-viewer/)
1212

13+
Main features
14+
------------
15+
* Easy to learn
16+
* Method named
17+
* Full method generated from documentation
18+
* Comment any method and parameters
19+
* Parameters indexed eg [n] is structured in array index and value
20+
* Tree structure
21+
* $client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->data
22+
* Return data proxmox
23+
* Method result status
24+
* getReasonPhrase
25+
* getStatusCode
26+
* Method directry access
27+
* get
28+
* post
29+
* put
30+
* delete
31+
* login return bool if access
32+
* return object/array data
33+
* default object disable from client.setResultIsObject(false)
1334

1435
Installation
1536
------------
@@ -42,36 +63,56 @@ Usage
4263
require_once 'vendor/autoload.php';
4364

4465
$client = new EnterpriseVE\ProxmoxVE\Api\Client("192.168.0.24");
45-
$client->login('root','password','pam');
4666

47-
//get version from get method
48-
var_dump($client->get('/version'));
67+
//login check bool
68+
if($client->login('root','password','pam')){
69+
//get version from get method
70+
var_dump($client->get('/version'));
4971

50-
// $client->put
51-
// $client->post
52-
// $client->delete
72+
// $client->put
73+
// $client->post
74+
// $client->delete
5375

54-
//loop nodes
55-
foreach ($client->getNodes()->Index()->data as $node) {
56-
echo "\n" . $node->id;
57-
}
76+
$retPippo=$client->get("/pippo");
77+
echo "\n" . $client->getStatusCode();
78+
echo "\n" . $client->getReasonPhrase();
5879

59-
//loop vm
60-
foreach ($client->getNodes()->get("pve1")->getQemu()->Vmlist()->data as $vm) {
61-
echo "\n" . $vm->vmid ." - " .$vm->name;
62-
}
80+
//loop nodes
81+
foreach ($client->getNodes()->Index()->data as $node) {
82+
echo "\n" . $node->id;
83+
}
84+
85+
//loop vm
86+
foreach ($client->getNodes()->get("pve1")->getQemu()->Vmlist()->data as $vm) {
87+
echo "\n" . $vm->vmid ." - " .$vm->name;
88+
}
6389

64-
//loop snapshots
65-
foreach ($client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->data as $snap) {
66-
echo "\n" . $snap->name;
90+
//loop snapshots
91+
foreach ($client->getNodes()->get("pve1")->getQemu()->get(100)->getSnapshot()->snapshotList()->data as $snap) {
92+
echo "\n" . $snap->name;
93+
}
94+
95+
//return object
96+
var_dump($client->getVersion()->version());
97+
98+
//disable return object
99+
$client->setResultIsObject(false);
100+
//return array
101+
$retArr = $client->getVersion()->version();
102+
var_dump($retArr);
103+
echo "\n" . $retArr['data']['release'];
104+
105+
//eneble return objet
106+
$client->setResultIsObject(true);
67107
}
108+
68109
```
69110

70111
Sample output version request:
71112

72113
```php
73-
$result = $client->getVersion()->Version();
74-
var_dump($result);
114+
//object result
115+
var_dump($client->getVersion()->Version());
75116

76117
object(stdClass)#9 (1) {
77118
["data"]=>
@@ -86,6 +127,26 @@ object(stdClass)#9 (1) {
86127
string(8) "27769b1f"
87128
}
88129
}
130+
131+
//disable return object
132+
$client->setResultIsObject(false);
133+
134+
//array result
135+
var_dump($client->getVersion()->Version());
136+
137+
array(1) {
138+
["data"]=>
139+
array(4) {
140+
["repoid"]=>
141+
string(8) "2560e073"
142+
["release"]=>
143+
string(2) "32"
144+
["version"]=>
145+
string(3) "5.0"
146+
["keyboard"]=>
147+
string(2) "it"
148+
}
149+
}
89150
```
90151

91152
The parameter indexed end with '[n]' in documentation (method createVM in Qemu parameter ide) require array whit key and value

0 commit comments

Comments
 (0)