<?php
/**
 * Base HTTP transport
 *
 * @package Requests\Transport
 */

namespace WpOrg\Requests;

/**
 * Base HTTP transport
 *
 * @package Requests\Transport
 */
interface Transport {
    /**
     * Perform a request
     *
     * @param string $url URL to request
     * @param array $headers Associative array of request headers
     * @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD
     * @param array $options Request options, see {@see \WpOrg\Requests\Requests::response()} for documentation
     * @return string Raw HTTP result
     */
    public function request($url, $headers = [], $data = [], $options = []);

    /**
     * Send multiple requests simultaneously
     *
     * @param array $requests Request data (array of 'url', 'headers', 'data', 'options') as per {@see \WpOrg\Requests\Transport::request()}
     * @param array $options Global options, see {@see \WpOrg\Requests\Requests::response()} for documentation
     * @return array Array of \WpOrg\Requests\Response objects (may contain \WpOrg\Requests\Exception or string responses as well)
     */
    public function request_multiple($requests, $options);

    /**
     * Self-test whether the transport can be used.
     *
     * The available capabilities to test for can be found in {@see \WpOrg\Requests\Capability}.
     *
     * @param array<string, bool> $capabilities Optional. Associative array of capabilities to test against, i.e. `['<capability>' => true]`.
     * @return bool Whether the transport can be used.
     */
    public static function test($capabilities = []);
}