Skip to content

Commit

Permalink
deploy: 3362a63
Browse files Browse the repository at this point in the history
  • Loading branch information
xgin committed Jan 8, 2024
1 parent 8b73a58 commit 8c94bf9
Show file tree
Hide file tree
Showing 126 changed files with 1,031 additions and 154 deletions.
2 changes: 1 addition & 1 deletion SDK/Certificate.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Hook/Dns/Dnssec.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Hook/ExternalDns.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Hook/HookInterface.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Hook/Repair/Mail.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Hook/Webmail.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Mailname.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Access/Client.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Access/Cors.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Access/Csrf.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Access/Domain.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Access/Session.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Access/UserRole.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Auth/ApiKey.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Auth/Basic.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/ErrorHandler.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/HttpsRedirect.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Server/ApiAllowed.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Server/ApiEnabled.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Middleware/Server/Initialized.php
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion SDK/Repair/Context.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Server/Components.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion SDK/Webmail.php
Original file line number Diff line number Diff line change
@@ -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
Expand Down
82 changes: 68 additions & 14 deletions docs/classes/pm-Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,13 @@ <h3 id="toc">
</dt>
<dd>Delete all custom client settings</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/pm-Client.html#method_getAdmin">getAdmin()</a>
<span>
&nbsp;: <a href="classes/pm-Client.html"><abbr title="\pm_Client">pm_Client</abbr></a> </span>
</dt>
<dd>Retrieve admin client.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/pm-Client.html#method_getAll">getAll()</a>
<span>
Expand Down Expand Up @@ -285,7 +292,7 @@ <h4 class="phpdocumentor-element__name" id="method_deleteSettings">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<span class="phpdocumentor-element-found-in__line">119</span>

</aside>

Expand Down Expand Up @@ -330,6 +337,53 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
&mdash;


</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_getAdmin">
getAdmin()
<a href="classes/pm-Client.html#method_getAdmin" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>

</aside>

<p class="phpdocumentor-summary">Retrieve admin client.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">getAdmin</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/pm-Client.html"><abbr title="\pm_Client">pm_Client</abbr></a></span></code>




<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">18.0.56</span>


</dd>
</dl>

<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/pm-Client.html"><abbr title="\pm_Client">pm_Client</abbr></a></span>
&mdash;


</article>
<article
class="phpdocumentor-element
Expand All @@ -344,7 +398,7 @@ <h4 class="phpdocumentor-element__name" id="method_getAll">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
<span class="phpdocumentor-element-found-in__line">44</span>

</aside>

Expand Down Expand Up @@ -505,7 +559,7 @@ <h4 class="phpdocumentor-element__name" id="method_getId">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">72</span>

</aside>

Expand Down Expand Up @@ -538,7 +592,7 @@ <h4 class="phpdocumentor-element__name" id="method_getLogin">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
<span class="phpdocumentor-element-found-in__line">80</span>

</aside>

Expand Down Expand Up @@ -585,7 +639,7 @@ <h4 class="phpdocumentor-element__name" id="method_getProperty">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
<span class="phpdocumentor-element-found-in__line">88</span>

</aside>

Expand Down Expand Up @@ -628,7 +682,7 @@ <h4 class="phpdocumentor-element__name" id="method_getSetting">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">90</span>
<span class="phpdocumentor-element-found-in__line">98</span>

</aside>

Expand Down Expand Up @@ -696,7 +750,7 @@ <h4 class="phpdocumentor-element__name" id="method_hasAccessToDomain">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">120</span>
<span class="phpdocumentor-element-found-in__line">128</span>

</aside>

Expand Down Expand Up @@ -753,7 +807,7 @@ <h4 class="phpdocumentor-element__name" id="method_hasAccessToPlan">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">151</span>
<span class="phpdocumentor-element-found-in__line">159</span>

</aside>

Expand Down Expand Up @@ -810,7 +864,7 @@ <h4 class="phpdocumentor-element__name" id="method_hasCorePermission">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">141</span>
<span class="phpdocumentor-element-found-in__line">149</span>

</aside>

Expand Down Expand Up @@ -878,7 +932,7 @@ <h4 class="phpdocumentor-element__name" id="method_hasPermission">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
<span class="phpdocumentor-element-found-in__line">138</span>

</aside>

Expand Down Expand Up @@ -946,7 +1000,7 @@ <h4 class="phpdocumentor-element__name" id="method_isAdmin">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
<span class="phpdocumentor-element-found-in__line">51</span>

</aside>

Expand Down Expand Up @@ -979,7 +1033,7 @@ <h4 class="phpdocumentor-element__name" id="method_isClient">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">57</span>
<span class="phpdocumentor-element-found-in__line">65</span>

</aside>

Expand Down Expand Up @@ -1012,7 +1066,7 @@ <h4 class="phpdocumentor-element__name" id="method_isReseller">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
<span class="phpdocumentor-element-found-in__line">58</span>

</aside>

Expand Down Expand Up @@ -1045,7 +1099,7 @@ <h4 class="phpdocumentor-element__name" id="method_setSetting">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="pm/Client.php"><a href="files/pm-client.html"><abbr title="pm/Client.php">Client.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
<span class="phpdocumentor-element-found-in__line">109</span>

</aside>

Expand Down
Loading

0 comments on commit 8c94bf9

Please sign in to comment.