Update stubs with 18.0.58 SDK

plesk · Jan 8, 2024 · 3362a63 · 3362a63
1 parent d151019
commit 3362a63
Show file tree

Hide file tree

Showing 121 changed files with 182 additions and 122 deletions.
diff --git a/SDK/Certificate.php b/SDK/Certificate.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK;
 /**
  * Certificate wrapper

diff --git a/SDK/Hook/Dns/Dnssec.php b/SDK/Hook/Dns/Dnssec.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Hook\Dns;
 
 abstract class Dnssec implements \Plesk\SDK\Hook\HookInterface

diff --git a/SDK/Hook/ExternalDns.php b/SDK/Hook/ExternalDns.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Hook;
 
 abstract class ExternalDns implements \Plesk\SDK\Hook\HookInterface

diff --git a/SDK/Hook/HookInterface.php b/SDK/Hook/HookInterface.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Hook;
 
 interface HookInterface extends \pm_Hook_Interface

diff --git a/SDK/Hook/Repair/Mail.php b/SDK/Hook/Repair/Mail.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Hook\Repair;
 
 abstract class Mail implements \Plesk\SDK\Hook\HookInterface

diff --git a/SDK/Hook/Webmail.php b/SDK/Hook/Webmail.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Hook;
 
 abstract class Webmail implements \Plesk\SDK\Hook\HookInterface

diff --git a/SDK/Mailname.php b/SDK/Mailname.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK;
 /**
  * Mailname wrapper

diff --git a/SDK/Middleware/Access/Client.php b/SDK/Middleware/Access/Client.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Access;
 /**
  * Validates that access was performed by specified user or any user that can impersonate as this user.

diff --git a/SDK/Middleware/Access/Cors.php b/SDK/Middleware/Access/Cors.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Access;
 /**
  * Adds cross-origin resource sharing headers as configured server-wide.

diff --git a/SDK/Middleware/Access/Csrf.php b/SDK/Middleware/Access/Csrf.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Access;
 /**
  * Validates that request has proper forgery protection token.

diff --git a/SDK/Middleware/Access/Domain.php b/SDK/Middleware/Access/Domain.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Access;
 /**
  * Validates that access was performed by user that has access to the specified domain.

diff --git a/SDK/Middleware/Access/Session.php b/SDK/Middleware/Access/Session.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Access;
 /**
  * Returns HTTP 401 if no session is defined by other means like BasicAuth, or KeyHeaderAuth.

diff --git a/SDK/Middleware/Access/UserRole.php b/SDK/Middleware/Access/UserRole.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Access;
 /**
  * Validates that access was performed by user with the specified role.

diff --git a/SDK/Middleware/Auth/ApiKey.php b/SDK/Middleware/Auth/ApiKey.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Auth;
 /**
  * Initializes Plesk session from the "X-API-Key" header.

diff --git a/SDK/Middleware/Auth/Basic.php b/SDK/Middleware/Auth/Basic.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Auth;
 /**
  * Initializes Plesk session from the "Authorization: Basic" header.

diff --git a/SDK/Middleware/ErrorHandler.php b/SDK/Middleware/ErrorHandler.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware;
 /**
  * Wraps uncaught exceptions into a JSON response.

diff --git a/SDK/Middleware/HttpsRedirect.php b/SDK/Middleware/HttpsRedirect.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware;
 /**
  * Returns 301/308 in case the request was made to plain HTTP.

diff --git a/SDK/Middleware/Server/ApiAllowed.php b/SDK/Middleware/Server/ApiAllowed.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Server;
 /**
  * Validates that remote API access is allowed for the remote IP.

diff --git a/SDK/Middleware/Server/ApiEnabled.php b/SDK/Middleware/Server/ApiEnabled.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Server;
 /**
  * Validates that remote API is allowed on the server.

diff --git a/SDK/Middleware/Server/Initialized.php b/SDK/Middleware/Server/Initialized.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Middleware\Server;
 /**
  * Validates that Plesk is initialized.

diff --git a/SDK/Repair/Context.php b/SDK/Repair/Context.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Repair;
 
 class Context

diff --git a/SDK/Server/Components.php b/SDK/Server/Components.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK\Server;
 /**
  * @since 18.0.52

diff --git a/SDK/Webmail.php b/SDK/Webmail.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 namespace Plesk\SDK;
 
 final class Webmail

diff --git a/pm/ActionLog.php b/pm/ActionLog.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Wrapper for ActionLog.
  *

diff --git a/pm/ApiCli.php b/pm/ApiCli.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Gateway for execution of CLI utilities
  *

diff --git a/pm/ApiRpc.php b/pm/ApiRpc.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Wrapper to simplify execution of API-RPC calls inside modules
  *

diff --git a/pm/Application.php b/pm/Application.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Class for initialization Plesk renderers
  *

diff --git a/pm/Auth.php b/pm/Auth.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Authentication helper methods
  *

diff --git a/pm/Backup/Manager.php b/pm/Backup/Manager.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Manager of backups for extension.
  *

diff --git a/pm/Bootstrap.php b/pm/Bootstrap.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Class for initialization Plesk objects
  *

diff --git a/pm/Client.php b/pm/Client.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel client wrapper
  *
@@ -27,6 +27,14 @@ public static function getByClientId($clientId) { }
      */
     public static function getByLogin($login) { }
 
+    /**
+     * Retrieve admin client.
+     *
+     * @return pm_Client
+     * @since 18.0.56
+     */
+    public static function getAdmin() { }
+
     /**
      * Retrieve all clients
      *

diff --git a/pm/Config.php b/pm/Config.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Configuration settings reader (panel.ini settings)
  *

diff --git a/pm/Context.php b/pm/Context.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Define module constants and setup context
  *

diff --git a/pm/Controller/Action.php b/pm/Controller/Action.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Abstract class for all extensions controllers
  *

diff --git a/pm/Crypt.php b/pm/Crypt.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Class for data encryption/decryption using AES-128 CBC (symmetric encryption algorithm)
  *

diff --git a/pm/Dns/Record.php b/pm/Dns/Record.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel dns wrapper
  *

diff --git a/pm/Dns/SoaRecord.php b/pm/Dns/SoaRecord.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel dns wrapper
  *

diff --git a/pm/Dns/Template.php b/pm/Dns/Template.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel dns wrapper
  *

diff --git a/pm/Dns/Template/Record.php b/pm/Dns/Template/Record.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel dns wrapper
  *

diff --git a/pm/Dns/Template/SoaRecord.php b/pm/Dns/Template/SoaRecord.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel dns wrapper
  *

diff --git a/pm/Dns/Zone.php b/pm/Dns/Zone.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Panel dns wrapper
  *

diff --git a/pm/Domain.php b/pm/Domain.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Domain wrapper
  *

diff --git a/pm/DomainAlias.php b/pm/DomainAlias.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Domain alias wrapper
  *

diff --git a/pm/Exception.php b/pm/Exception.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Exception raised in case of modules API problems
  *

diff --git a/pm/Exception/InvalidArgumentException.php b/pm/Exception/InvalidArgumentException.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Exception raised in case of invalid arguments passed in SDK methods
  *

diff --git a/pm/Exception/ResultException.php b/pm/Exception/ResultException.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Exception raised in case of non-zero exit code of utilities
  *

diff --git a/pm/Extension.php b/pm/Extension.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Extension wrapper
  *

diff --git a/pm/FileManager.php b/pm/FileManager.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Manager of hosted files for module (webspace level).
  *

diff --git a/pm/FileManager/Action.php b/pm/FileManager/Action.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Content action for FileManager
  *

diff --git a/pm/Form/Simple.php b/pm/Form/Simple.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Base form
  *

diff --git a/pm/Form/SubForm.php b/pm/Form/SubForm.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Sub Form
  *

diff --git a/pm/Hook/ActionLog.php b/pm/Hook/ActionLog.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Hook for registering events
  *

diff --git a/pm/Hook/ActiveList.php b/pm/Hook/ActiveList.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Abstract class for injection into active lists
  *

diff --git a/pm/Hook/ApiCli.php b/pm/Hook/ApiCli.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Hook for processing remote API-CLI requests
  *

diff --git a/pm/Hook/ApiRest.php b/pm/Hook/ApiRest.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2023. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
 /**
  * Hook for getting REST API metadata
  *