Merge pull request #34 from plesk/18.0.60

Update stubs with 18.0.60 SDK
plesk · Apr 4, 2024 · 589949e · 589949e
2 parents 3362a63 + 2f25607
commit 589949e
Show file tree

Hide file tree

Showing 123 changed files with 348 additions and 130 deletions.
diff --git a/SDK/Certificate.php b/SDK/Certificate.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros International GmbH. All rights reserved.
 namespace Plesk\SDK\Hook;
 
 abstract class ExternalDns implements \Plesk\SDK\Hook\HookInterface

diff --git a/SDK/Hook/Home.php b/SDK/Hook/Home.php
@@ -0,0 +1,19 @@
+<?php
+// Copyright 1999-2024. WebPros International GmbH. All rights reserved.
+namespace Plesk\SDK\Hook;
+/**
+ * Hook for embedding custom blocks into administrator's Home page in SPV
+ *
+ * @since 18.0.60
+ */
+abstract class Home implements \Plesk\SDK\Hook\HookInterface
+{
+
+    /**
+     * Retrieve blocks for Home page in SPV
+     *
+     * @return Home\Block[]
+     */
+    abstract public function getBlocks(): array;
+
+}
diff --git a/SDK/Hook/Home/Block.php b/SDK/Hook/Home/Block.php
@@ -0,0 +1,130 @@
+<?php
+// Copyright 1999-2024. WebPros International GmbH. All rights reserved.
+namespace Plesk\SDK\Hook\Home;
+/**
+ * Custom block to be embedded into administrator's Home page in SPV
+ *
+ * @since 18.0.60
+ */
+abstract class Block
+{
+
+    public const SECTION_PLESK = 'plesk';
+
+    public const SECTION_SERVER = 'server';
+
+    public const SECTION_SECURITY = 'security';
+
+    /**
+     * Define block unique ID
+     *
+     * Classname by default.
+     *
+     * @return string
+     */
+    public function getId(): string { }
+
+    /**
+     * Define block title
+     *
+     * Attention: unescaped HTML. Extension title by default.
+     *
+     * @return string
+     */
+    public function getTitle(): string { }
+
+    /**
+     * Define block content
+     *
+     * Attention: unescaped HTML. Extension description by default.
+     *
+     * @return string
+     */
+    public function getContent(): string { }
+
+    /**
+     * Define column the block should be placed to
+     *
+     * Possible values: 0, 1, 2. Last column by default.
+     *
+     * @return int
+     */
+    public function getColumn(): int { }
+
+    /**
+     * Define order within the column the block should be placed to
+     *
+     * Last block in column by default.
+     *
+     * @return int
+     */
+    public function getOrder(): int { }
+
+    /**
+     * Define if the block content should be loaded asynchronously
+     *
+     * True by default.
+     *
+     * @return bool
+     */
+    public function isAsyncLoaded(): bool { }
+
+    /**
+     * Define size of the skeleton (content placeholder) to be shown while content is loaded
+     *
+     * Applied only to asynchronously loaded blocks.
+     * 2 by default.
+     *
+     * @return int
+     */
+    public function getSkeletonSize(): int { }
+
+    /**
+     * Define if the block is enabled by default
+     *
+     * true by default.
+     *
+     * @return bool
+     */
+    public function isEnabled(): bool { }
+
+    /**
+     * Define section the block belongs to
+     *
+     * To be shown when customizing Home page.
+     * SECTION_PLESK by default.
+     *
+     * @return string
+     */
+    public function getSection(): string { }
+
+    /**
+     * Define order within the section the block should be placed to
+     *
+     * To be shown when customizing Home page.
+     * Last block in section by default.
+     *
+     * @return int
+     */
+    public function getSectionOrder(): int { }
+
+    /**
+     * Define block name
+     *
+     * To be shown when customizing Home page.
+     * Extension title by default.
+     *
+     * @return string
+     */
+    public function getName(): string { }
+
+    /**
+     * Define block icon
+     *
+     * To be shown when customizing Home page.
+     *
+     * @return string
+     */
+    public function getIcon(): string { }
+
+}
diff --git a/SDK/Hook/HookInterface.php b/SDK/Hook/HookInterface.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros International GmbH. All rights reserved.
 /**
  * Wrapper for ActionLog.
  *
@@ -18,14 +18,14 @@ class pm_ActionLog
      *
      * @param int|null $objectId ID of the object mentioned in the event. 0 if not applicable (singleton object like 'admin').
      *
-     * @param array|null $oldValues
+     * @param string[] $oldValues
      * @example array('contact_name' => 'John Smith', 'email' => '[email protected]', 'login_name' => 'user1')
-     * @param array|null $newValues
+     * @param string[] $newValues
      * @example array('contact_name' => 'John Smith', 'email' => '[email protected]', 'login_name' => 'user1')
      * @return void
      *
      * @throws Exception
      */
-    public static function submit($actionId, $objectId = null, $oldValues = null, $newValues = null) { }
+    public static function submit($actionId, $objectId = null, $oldValues = [], $newValues = []) { }
 
 }
diff --git a/pm/ApiCli.php b/pm/ApiCli.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright 1999-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros 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-2024. Plesk International GmbH. All rights reserved.
+// Copyright 1999-2024. WebPros International GmbH. All rights reserved.
 /**
  * Class for initialization Plesk objects
  *