Public Member Functions | |
| addHeader ($header, $value) | |
| addHeaders (array $headers) | |
| getHeader ($header) | |
| getHeaderLines () | |
| getHeaders () | |
| getParams () | |
| getRawHeaders () | |
| hasHeader ($header) | |
| removeHeader ($header) | |
| setHeader ($header, $value) | |
| setHeaders (array $headers) | |
Detailed Description
Request and response message interface
Definition at line 8 of file lib/vendor/guzzle/guzzle/src/Guzzle/Http/Message/MessageInterface.php.
Member Function Documentation
◆ addHeader()
| Guzzle\Http\Message\MessageInterface::addHeader | ( | $header, | |
| $value | |||
| ) |
Add a header to an existing collection of headers.
- Parameters
-
string $header Header name to add string $value Value of the header
- Returns
- self
Implemented in Guzzle\Http\Message\AbstractMessage.
◆ addHeaders()
| Guzzle\Http\Message\MessageInterface::addHeaders | ( | array | $headers | ) |
Add and merge in an array of HTTP headers.
- Parameters
-
array $headers Associative array of header data.
- Returns
- self
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Http\Message\RequestFactory\visit_headers().
◆ getHeader()
| Guzzle\Http\Message\MessageInterface::getHeader | ( | $header | ) |
Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.
- Parameters
-
string $header Header to retrieve.
- Returns
- Header|null
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Plugin\Cache\DefaultCanCacheStrategy\canCacheRequest(), Guzzle\Plugin\Cache\CachePlugin\canResponseSatisfyFailedRequest(), Guzzle\Plugin\Cache\CachePlugin\canResponseSatisfyRequest(), Guzzle\Http\Curl\CurlHandle\factory(), Guzzle\Log\MessageFormatter\format(), and Guzzle\Plugin\Cache\DefaultRevalidation\shouldRevalidate().
◆ getHeaderLines()
| Guzzle\Http\Message\MessageInterface::getHeaderLines | ( | ) |
Get an array of message header lines (e.g. ["Host: example.com", ...])
- Returns
- array
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Stream\PhpStreamRequestFactory\addDefaultContextOptions(), and Guzzle\Http\Curl\CurlHandle\factory().
◆ getHeaders()
| Guzzle\Http\Message\MessageInterface::getHeaders | ( | ) |
Get all headers as a collection
- Returns
- \Guzzle\Http\Message\Header\HeaderCollection
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Http\Message\RequestFactory\cloneRequestWithMethod().
◆ getParams()
| Guzzle\Http\Message\MessageInterface::getParams | ( | ) |
Get application and plugin specific parameters set on the message.
- Returns
- \Guzzle\Common\Collection
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Plugin\Cache\CachePlugin\addResponseHeaders(), Guzzle\Plugin\Cache\DefaultCacheStorage\cache(), Guzzle\Plugin\Cache\CachePlugin\canResponseSatisfyRequest(), Guzzle\Http\Message\RequestFactory\cloneRequestWithMethod(), Guzzle\Http\RedirectPlugin\createRedirectRequest(), Guzzle\Plugin\Cache\DefaultCacheKeyProvider\getCacheKey(), Guzzle\Plugin\Cache\DefaultCacheStorage\getCacheKey(), Guzzle\Http\RedirectPlugin\prepareRedirection(), Guzzle\Http\Client\prepareRequest(), Guzzle\Http\Message\RequestFactory\visit_allow_redirects(), and Guzzle\Http\Message\RequestFactory\visit_params().
◆ getRawHeaders()
| Guzzle\Http\Message\MessageInterface::getRawHeaders | ( | ) |
Get the raw message headers as a string
- Returns
- string
Implemented in Guzzle\Http\Message\Response, and Guzzle\Http\Message\Request.
◆ hasHeader()
| Guzzle\Http\Message\MessageInterface::hasHeader | ( | $header | ) |
Check if the specified header is present.
- Parameters
-
string $header The header to check.
- Returns
- bool
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Stream\PhpStreamRequestFactory\addDefaultContextOptions(), Guzzle\Service\Command\LocationVisitor\Request\XmlVisitor\after(), Guzzle\Service\Command\LocationVisitor\Request\JsonVisitor\after(), Guzzle\Plugin\Cache\DefaultCanCacheStrategy\canCacheRequest(), Guzzle\Http\Curl\CurlHandle\factory(), Guzzle\Http\Client\prepareRequest(), and Guzzle\Http\Message\RequestFactory\visit_headers().
◆ removeHeader()
| Guzzle\Http\Message\MessageInterface::removeHeader | ( | $header | ) |
Remove a specific HTTP header.
- Parameters
-
string $header HTTP header to remove.
- Returns
- self
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Service\Command\LocationVisitor\Request\BodyVisitor\addExpectHeader(), Guzzle\Plugin\Cache\DefaultRevalidation\createRevalidationRequest(), Guzzle\Http\Curl\CurlHandle\factory(), and Guzzle\Plugin\Cache\DefaultCacheKeyProvider\getCacheKey().
◆ setHeader()
| Guzzle\Http\Message\MessageInterface::setHeader | ( | $header, | |
| $value | |||
| ) |
Set an HTTP header and overwrite any existing value for the header
- Parameters
-
string $header Name of the header to set. mixed $value Value to set.
- Returns
- self
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Service\Command\LocationVisitor\Request\BodyVisitor\addExpectHeader(), Guzzle\Service\Command\LocationVisitor\Request\HeaderVisitor\addPrefixedHeaders(), Guzzle\Service\Command\LocationVisitor\Request\XmlVisitor\after(), Guzzle\Service\Command\LocationVisitor\Request\JsonVisitor\after(), Guzzle\Http\Curl\CurlHandle\factory(), Guzzle\Http\Client\prepareRequest(), Guzzle\Http\Curl\CurlHandle\updateRequestFromTransfer(), Guzzle\Service\Command\LocationVisitor\Request\HeaderVisitor\visit(), Guzzle\Service\Command\LocationVisitor\Request\BodyVisitor\visit(), and Guzzle\Http\Message\RequestFactory\visit_headers().
◆ setHeaders()
| Guzzle\Http\Message\MessageInterface::setHeaders | ( | array | $headers | ) |
Overwrite all HTTP headers with the supplied array of headers
- Parameters
-
array $headers Associative array of header data.
- Returns
- self
Implemented in Guzzle\Http\Message\AbstractMessage.
Referenced by Guzzle\Http\Curl\CurlHandle\updateRequestFromTransfer().
The documentation for this interface was generated from the following file:
