Http 客户端¶

use Cake\Http\Client\FormData;

$data = new FormData();

// Create an XML part
$xml = $data->newPart('xml', $xmlString);
// Set the content type.
$xml->type('application/xml');
$data->add($xml);

// Create a file upload with addFile()
// This will append the file to the form data as well.
$file = $data->addFile('upload', fopen('/some/file.txt', 'r'));
$file->contentId('abc123');
$file->disposition('attachment');

// Send the request.
$response = $http->post(
    'http://example.com/api',
    (string)$data,
    ['headers' => ['Content-Type' => $data->contentType()]]
);

$http = new Client();
$response = $http->get('http://example.com/profile/1', [], [
  'auth' => ['username' => 'mark', 'password' => 'secret'],
]);

$http = new Client();
$response = $http->get('http://example.com/profile/1', [], [
    'auth' => [
        'type' => 'digest',
        'username' => 'mark',
        'password' => 'secret',
        'realm' => 'myrealm',
        'nonce' => 'onetimevalue',
        'qop' => 1,
        'opaque' => 'someval',
    ],
]);

$http = new Client();
$response = $http->get('http://example.com/profile/1', [], [
    'auth' => [
        'type' => 'oauth',
        'consumerKey' => 'bigkey',
        'consumerSecret' => 'secret',
        'token' => '...',
        'tokenSecret' => '...',
        'realm' => 'tickets',
    ],
]);

$http = new Client([
    'headers' => ['Authorization' => 'Bearer ' . $accessToken],
]);
$response = $http->get('https://example.com/api/profile/1');

$http = new Client();
$response = $http->get('http://example.com/test.php', [], [
    'proxy' => [
        'username' => 'mark',
        'password' => 'testing',
        'proxy' => '127.0.0.1:8080',
    ],
]);

// Read the entire response as a string.
$response->getStringBody();

// Get a Psr\Http\Message\StreamInterface containing the response body
$stream = $response->getBody();

// Read a stream 100 bytes at a time.
while (!$stream->eof()) {
    echo $stream->read(100);
}

// Get some XML
$http = new Client();
$response = $http->get('http://example.com/test.xml');
$xml = $response->getXml();

// Get some JSON
$http = new Client();
$response = $http->get('http://example.com/test.json');
$json = $response->getJson();

// Get all the headers as an associative array.
$response->getHeaders();

// Get a single header as an array.
$response->getHeader('content-type');

// Get a header as a string
$response->getHeaderLine('content-type');

// Get the response encoding
$response->getEncoding();

// Get all cookies (full data)
$response->getCookies();

// Get a single cookie's value.
$response->getCookie('session_id');

// Get a the complete data for a single cookie
// includes value, expires, path, httponly, secure keys.
$response->getCookieData('session_id');

// Was the response a 20x
$response->isOk();

// Was the response a 30x
$response->isRedirect();

// Get the status code
$response->getStatusCode();

// Somewhere before calling one of the HTTP client's methods which makes a request
$http->getEventManager()->on(
    'HttpClient.beforeSend',
    function (
        \Cake\Http\Client\ClientEvent $event,
        \Cake\Http\Client\Request $request,
        array $adapterOptions,
        int $redirects
    ) {
        // Modify the request
        $event->setRequest(....);
        // Modify the adapter options
        $event->setAdapterOptions(....);

        // Skip making the actual request by returning a response.
        // You can use $event->setResult($response) to achieve the same.
        return new \Cake\Http\Client\Response(body: 'something');
    }
);

// Somewhere before calling one of the HTTP client's methods which makes a request
$http->getEventManager()->on(
    'HttpClient.afterSend',
    function (
        \Cake\Http\Client\ClientEvent $event,
        \Cake\Http\Client\Request $request,
        array $adapterOptions,
        int $redirects,
        bool $requestSent // Indicates whether the request was actually sent
                          // or response returned from ``beforeSend`` event
    ) {
        // Get the response
        $response = $event->getResponse();

        // Return a new/modified response.
        // You can use $event->setResult($response) to achieve the same.
        return new \Cake\Http\Client\Response(body: 'something');
    }
);