Merge pull request #44 from MrKampf/0.4.4

0.4.6
MrKampf · Jun 24, 2023 · 34c670c · 34c670c
2 parents b0c858d + af89bb9
commit 34c670c
Show file tree

Hide file tree

Showing 351 changed files with 1,652 additions and 873 deletions.
diff --git a/composer.json b/composer.json
@@ -15,7 +15,7 @@
     "PHP 8",
     "PHP 7"
   ],
-  "version": "0.4.4",
+  "version": "0.4.6",
   "minimum-stability": "stable",
   "prefer-stable": true,
   "authors": [

diff --git a/src/Proxmox/API.php b/src/Proxmox/API.php
@@ -0,0 +1,275 @@
+<?php
+
+namespace Proxmox;
+
+use GuzzleHttp\Client;
+use GuzzleHttp\Cookie\CookieJar;
+use Proxmox\Api\Access;
+use Proxmox\Api\Cluster;
+use Proxmox\Api\Nodes;
+use Proxmox\Api\Pools;
+use Proxmox\Api\Storage;
+use Proxmox\Api\Version;
+use Proxmox\Helper\ApiToken;
+
+class API
+{
+
+    /**
+     * @var Client
+     */
+    private Client $httpClient;
+
+    /**
+     * @var ApiToken
+     */
+    private ApiToken $api;
+
+    /**
+     * @var CookieJar
+     */
+    private CookieJar $cookie;
+
+    /**
+     * @var string
+     */
+    private string $hostname, $apiURL, $user, $secret;
+
+    /**
+     * @var int
+     */
+    private int $port;
+
+    /**
+     * @var boolean
+     */
+    private bool $debug;
+
+    /**
+     * pve constructor.
+     * @param string $hostname
+     * @param string $user
+     * @param string $secret
+     * @param int $port
+     * @param bool $debug
+     * @param Client|null $httpClient
+     */
+    public function __construct(string $hostname, string $user, string $secret, int $port = 8006, bool $debug = false, Client|null $httpClient = null)
+    {
+        if ($httpClient === NULL) {
+            $httpClient = new Client();
+        }
+
+        $this->setHostname($hostname); //Save hostname in class variable
+        $this->setPort($port); //Save port in class variable
+        $this->setDebug($debug); //Save the debug boolean variable
+        $this->setApiURL('https://' . $this->getHostname() . ':' . $this->getPort() . '/api2/json/'); //Create the basic api url
+        $this->setApi(new ApiToken($this)); //Create the api object
+        $this->setHttpClient($httpClient); //Create a new guzzle client
+    }
+
+    /**
+     * @param string $user
+     */
+    public function setUser(string $user): void
+    {
+        $this->user = $user;
+    }
+
+    /**
+     * @param string $secret
+     */
+    public function setSecret(string $secret): void
+    {
+        $this->secret = $secret;
+    }
+
+    /**
+     * @param string $apiURL
+     */
+    public function setApiURL(string $apiURL): void
+    {
+        $this->apiURL = $apiURL;
+    }
+
+    /**
+     * @return string
+     */
+    public function getHostname(): string
+    {
+        return $this->hostname;
+    }
+
+    /**
+     * @param string $hostname
+     */
+    public function setHostname(string $hostname): void
+    {
+        $this->hostname = $hostname;
+    }
+
+    /**
+     * @return int
+     */
+    public function getPort(): int
+    {
+        return $this->port;
+    }
+
+    /**
+     * @param int $port
+     */
+    public function setPort(int $port): void
+    {
+        $this->port = $port;
+    }
+
+    /**
+     * @return ApiToken
+     */
+    public function getApi(): ApiToken
+    {
+        return $this->api;
+    }
+
+    /**
+     * @param ApiToken $api
+     */
+    public function setApi(ApiToken $api): void
+    {
+        $this->api = $api;
+    }
+
+    /**
+     * @return Client
+     */
+    public function getHttpClient(): Client
+    {
+        return $this->httpClient;
+    }
+
+    /**
+     * @param Client $httpClient
+     */
+    public function setHttpClient(Client $httpClient): void
+    {
+        $this->httpClient = $httpClient;
+    }
+
+    /**
+     * @return string
+     */
+    public function getApiURL(): string
+    {
+        return $this->apiURL;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUser(): string
+    {
+        return $this->user;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSecret(): string
+    {
+        return $this->secret;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getDebug(): bool
+    {
+        return $this->debug;
+    }
+
+    /**
+     * @param bool $debug
+     */
+    public function setDebug(bool $debug): void
+    {
+        $this->debug = $debug;
+    }
+
+    /**
+     * @return CookieJar
+     */
+    public function getCookie(): CookieJar
+    {
+        return $this->cookie;
+    }
+
+    /**
+     * @param CookieJar $cookie
+     */
+    public function setCookie(CookieJar $cookie): void
+    {
+        $this->cookie = $cookie;
+    }
+
+    /**
+     * Directory index.
+     * @link https://pve.proxmox.com/pve-docs/api-viewer/index.html#/access
+     * @return Access
+     */
+    public function access(): Access
+    {
+        return new Access($this, "");
+    }
+
+    /**
+     * Cluster index.
+     * @url https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster
+     * @return Cluster
+     */
+    public function cluster(): Cluster
+    {
+        return new Cluster($this, "");
+    }
+
+    /**
+     * Node index.
+     * @link https://pve.proxmox.com/pve-docs/api-viewer/#/nodes/{node}
+     * @return Nodes
+     */
+    public function nodes(): Nodes
+    {
+        return new Nodes($this, "");
+    }
+
+    /**
+     * Storage index.
+     * @url https://pve.proxmox.com/pve-docs/api-viewer/index.html#/storage
+     * @return Storage
+     */
+    public function storage(): Storage
+    {
+        return new Storage($this, "");
+    }
+
+    /**
+     * Pool index.
+     * @url https://pve.proxmox.com/pve-docs/api-viewer/index.html#/pools
+     * @return Pools
+     */
+    public function pools(): Pools
+    {
+        return new Pools($this, "");
+    }
+
+    /**
+     * API version details. The result also includes the global datacenter confguration.
+     * @link https://pve.proxmox.com/pve-docs/api-viewer/index.html#/version
+     * @return Version
+     */
+    public function version(): Version
+    {
+        return new Version($this, "");
+    }
+
+}
diff --git a/src/Proxmox/Api/Access.php b/src/Proxmox/Api/Access.php
@@ -18,6 +18,7 @@
 use Proxmox\Helper\Interfaces\PVEPathEndpointInterface;
 use Proxmox\Helper\PVEPathClassBase;
 use Proxmox\PVE;
+use Proxmox\API;
 
 /**
  * Class access
@@ -28,10 +29,10 @@ class Access extends PVEPathClassBase implements PVEPathEndpointInterface
 
     /**
      * Access constructor.
-     * @param PVE $pve
+     * @param PVE|API $pve
      * @param string $parentAdditional
      */
-    public function __construct(PVE $pve, string $parentAdditional)
+    public function __construct(PVE|API $pve, string $parentAdditional)
     {
         parent::__construct($pve, $parentAdditional . 'access/');
         return $this->get();

diff --git a/src/Proxmox/Api/Access/Acl.php b/src/Proxmox/Api/Access/Acl.php
@@ -8,6 +8,7 @@
 use Proxmox\Helper\Interfaces\PVEPathEndpointInterface;
 use Proxmox\Helper\PVEPathClassBase;
 use Proxmox\PVE;
+use Proxmox\API;
 
 /**
  * Class Acl
@@ -17,10 +18,10 @@ class Acl extends PVEPathClassBase implements PVEPathEndpointInterface
 {
     /**
      * Acl constructor.
-     * @param PVE $pve
+     * @param PVE|API $pve
      * @param string $parentAdditional
      */
-    public function __construct(PVE $pve, string $parentAdditional)
+    public function __construct(PVE|API $pve, string $parentAdditional)
     {
         parent::__construct($pve, $parentAdditional . "acl/");
     }

diff --git a/src/Proxmox/Api/Access/Domains.php b/src/Proxmox/Api/Access/Domains.php
@@ -9,6 +9,7 @@
 use Proxmox\Helper\Interfaces\PVEPathEndpointInterface;
 use Proxmox\Helper\PVEPathClassBase;
 use Proxmox\PVE;
+use Proxmox\API;
 
 /**
  * Class Domains
@@ -19,10 +20,10 @@ class Domains extends PVEPathClassBase implements PVEPathEndpointInterface
 
     /**
      * Domains constructor.
-     * @param PVE $pve
+     * @param PVE|API $pve
      * @param string $parentAdditional
      */
-    public function __construct(PVE $pve, string $parentAdditional)
+    public function __construct(PVE|API $pve, string $parentAdditional)
     {
         parent::__construct($pve, $parentAdditional . 'domains/');
     }

diff --git a/src/Proxmox/Api/Access/Domains/Realm.php b/src/Proxmox/Api/Access/Domains/Realm.php
@@ -9,6 +9,7 @@
 use Proxmox\Helper\Interfaces\PVEPathEndpointInterface;
 use Proxmox\Helper\PVEPathClassBase;
 use Proxmox\PVE;
+use Proxmox\API;
 
 /**
  * Class Realm
@@ -18,10 +19,10 @@ class Realm extends PVEPathClassBase implements PVEPathEndpointInterface
 {
     /**
      * Domains constructor.
-     * @param PVE $pve
+     * @param PVE|API $pve
      * @param string $parentAdditional
      */
-    public function __construct(PVE $pve, string $parentAdditional)
+    public function __construct(PVE|API $pve, string $parentAdditional)
     {
         parent::__construct($pve, $parentAdditional);
     }

diff --git a/src/Proxmox/Api/Access/Domains/Realm/Sync.php b/src/Proxmox/Api/Access/Domains/Realm/Sync.php
@@ -8,6 +8,7 @@
 use Proxmox\Helper\Interfaces\PVEPathEndpointInterface;
 use Proxmox\Helper\PVEPathClassBase;
 use Proxmox\PVE;
+use Proxmox\API;
 
 /**
  * Class Sync
@@ -17,11 +18,11 @@ class Sync extends PVEPathClassBase implements PVEPathEndpointInterface
 {
     /**
      * Domains constructor.
-     * @param PVE $pve
+     * @param PVE|API $pve
      * @param string $parentAdditional
      * @param array $params
      */
-    public function __construct(PVE $pve, string $parentAdditional, array $params = [])
+    public function __construct(PVE|API $pve, string $parentAdditional, array $params = [])
     {
         parent::__construct($pve, $parentAdditional . 'sync/');
         return $this->post($params);