diff options
Diffstat (limited to 'server/vendor/php-opencloud/common/src/Common/Api/OperatorInterface.php')
| -rw-r--r-- | server/vendor/php-opencloud/common/src/Common/Api/OperatorInterface.php | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/server/vendor/php-opencloud/common/src/Common/Api/OperatorInterface.php b/server/vendor/php-opencloud/common/src/Common/Api/OperatorInterface.php deleted file mode 100644 index 168518b..0000000 --- a/server/vendor/php-opencloud/common/src/Common/Api/OperatorInterface.php +++ /dev/null @@ -1,54 +0,0 @@ -<?php declare(strict_types=1); - -namespace OpenCloud\Common\Api; - -use GuzzleHttp\ClientInterface; -use GuzzleHttp\Promise\PromiseInterface; -use OpenCloud\Common\Resource\ResourceInterface; -use Psr\Http\Message\ResponseInterface; - -/** - * An operator is any resource or service that can invoke and send REST operations. In other words, it - * is any class that can send requests and receive responses with a HTTP client. To do this - * it needs two things: a {@see ClientInterface} for handling HTTP transactions and an {@see ApiInterface} - * for handling how operations are created. - * - * @package OpenCloud\Common\Api - */ -interface OperatorInterface -{ - /** - * @param ClientInterface $client The HTTP client responsible for handling HTTP transactions - * @param ApiInterface $api The data API class that dictates how REST operations are structured - */ - public function __construct(ClientInterface $client, ApiInterface $api); - - /** - * A convenience method that assembles an operation and sends it to the remote API - * - * @param array $definition The data that dictates how the operation works - * @param array $userValues The user-defined values that populate the request - * - * @return \Psr\Http\Message\ResponseInterface - */ - public function execute(array $definition, array $userValues = []): ResponseInterface; - - /** - * A convenience method that assembles an operation and asynchronously sends it to the remote API - * - * @param array $definition The data that dictates how the operation works - * @param array $userValues The user-defined values that populate the request - * - * @return \GuzzleHttp\Promise\PromiseInterface - */ - public function executeAsync(array $definition, array $userValues = []): PromiseInterface; - - /** - * @param string $name The name of the model class. - * @param mixed $data Either a {@see ResponseInterface} or data array that will populate the newly - * created model class. - * - * @return \OpenCloud\Common\Resource\ResourceInterface - */ - public function model(string $name, $data = null): ResourceInterface; -} |
