<?php /** * Extended HTTP support. Again. * * * Introduces the http namespace. * * PHP stream based message bodies. * * Encapsulated env request/response. * * Modular client support. */ namespace http; use http; use JetBrains\PhpStorm\Deprecated; /** * The HTTP client. See http\Client\Curl's [options](http/Client/Curl#Options:) which is the only driver currently supported. */ class Client implements \SplSubject, \Countable { /** * Debug callback's $data contains human readable text. */ public const DEBUG_INFO = 0; /** * Debug callback's $data contains data received. */ public const DEBUG_IN = 1; /** * Debug callback's $data contains data sent. */ public const DEBUG_OUT = 2; /** * Debug callback's $data contains headers. */ public const DEBUG_HEADER = 16; /** * Debug callback's $data contains a body part. */ public const DEBUG_BODY = 32; /** * Debug callback's $data contains SSL data. */ public const DEBUG_SSL = 64; /** * Attached observers. * * @var \SplObjectStorage */ private $observers = null; /** * Set options. * * @var array */ protected $options = null; /** * Request/response history. * * @var \http\Message */ protected $history = null; /** * Whether to record history in http\Client::$history. * * @var bool */ public $recordHistory = false; /** * Create a new HTTP client. * * Currently only "curl" is supported as a $driver, and used by default. * Persisted resources identified by $persistent_handle_id will be re-used if available. * * @param string $driver The HTTP client driver to employ. Currently only the default driver, "curl", is supported. * @param string $persistent_handle_id If supplied, created curl handles will be persisted with this identifier for later reuse. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @throws \http\Exception\RuntimeException */ public function __construct(string $driver = null, string $persistent_handle_id = null) {} /** * Add custom cookies. * See http\Client::setCookies(). * * @param array $cookies Custom cookies to add. * @throws \http\Exception\InvalidArgumentException * @return \http\Client self. */ public function addCookies(array $cookies = null) {} /** * Add specific SSL options. * See http\Client::setSslOptions(), http\Client::setOptions() and http\Client\Curl\$ssl options. * * @param array $ssl_options Add this SSL options. * @throws \http\Exception\InvalidArgumentException * @return \http\Client self. */ public function addSslOptions(array $ssl_options = null) {} /** * Implements SplSubject. Attach another observer. * Attached observers will be notified with progress of each transfer. * * @param \SplObserver $observer An implementation of SplObserver. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client self. */ public function attach(\SplObserver $observer) {} /** * Configure the client's low level options. * * ***NOTE:*** * This method has been added in v2.3.0. * * @param array $configuration Key/value pairs of low level options. * See f.e. the [configuration options for the Curl driver](http/Client/Curl#Configuration:). * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client self. */ public function configure(array $configuration) {} /** * Implements Countable. Retrieve the number of enqueued requests. * * ***NOTE:*** * The enqueued requests are counted without regard whether they are finished or not. * * @return int number of enqueued requests. */ public function count() {} /** * Dequeue the http\Client\Request $request. * * See http\Client::requeue(), if you want to requeue the request, instead of calling http\Client::dequeue() and then http\Client::enqueue(). * * @param \http\Client\Request $request The request to cancel. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @throws \http\Exception\RuntimeException * @return \http\Client self. */ public function dequeue(http\Client\Request $request) {} /** * Implements SplSubject. Detach $observer, which has been previously attached. * * @param \SplObserver $observer Previously attached instance of SplObserver implementation. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client self. */ public function detach(\SplObserver $observer) {} /** * Enable usage of an event library like libevent, which might improve performance with big socket sets. * * @param bool $enable Whether to enable libevent usage. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client self. * @see Client::configure() */ #[Deprecated('This method has been deprecated in 2.3.0. Use http\Client::configure() instead')] public function enableEvents(bool $enable = true) {} /** * Enable sending pipelined requests to the same host if the driver supports it. * * @param bool $enable Whether to enable pipelining. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client self. * @see Client::configure() */ #[Deprecated('This method has been deprecated in 2.3.0. Use http\Client::configure() instead')] public function enablePipelining(bool $enable = true) {} /** * Add another http\Client\Request to the request queue. * If the optional callback $cb returns true, the request will be automatically dequeued. * * ***Note:*** * The http\Client\Response object resulting from the request is always stored * internally to be retrieved at a later time, __even__ when $cb is used. * * If you are about to send a lot of requests and do __not__ need the response * after executing the callback, you can use http\Client::getResponse() within * the callback to keep the memory usage level as low as possible. * * See http\Client::dequeue() and http\Client::send(). * * @param \http\Client\Request $request The request to enqueue. * @param callable $cb as function(\http\Response $response) : ?bool * A callback to automatically call when the request has finished. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @throws \http\Exception\RuntimeException * @return \http\Client self. */ public function enqueue(http\Client\Request $request, callable $cb = null) {} /** * Get a list of available configuration options and their default values. * * See f.e. the [configuration options for the Curl driver](http/Client/Curl#Configuration:). * * @throws \http\Exception\InvalidArgumentException * @return array list of key/value pairs of available configuration options and their default values. */ public function getAvailableConfiguration() {} /** * List available drivers. * * @return array list of supported drivers. */ public function getAvailableDrivers() {} /** * Retrieve a list of available request options and their default values. * * See f.e. the [request options for the Curl driver](http/Client/Curl#Options:). * * @throws \http\Exception\InvalidArgumentException * @return array list of key/value pairs of available request options and their default values. */ public function getAvailableOptions() {} /** * Get priorly set custom cookies. * See http\Client::setCookies(). * * @return array custom cookies. */ public function getCookies() {} /** * Simply returns the http\Message chain representing the request/response history. * * ***NOTE:*** * The history is only recorded while http\Client::$recordHistory is true. * * @throws \http\Exception\InvalidArgumentException * @return \http\Message the request/response message chain representing the client's history. */ public function getHistory() {} /** * Returns the SplObjectStorage holding attached observers. * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \SplObjectStorage observer storage. */ public function getObservers() {} /** * Get priorly set options. * See http\Client::setOptions(). * * @return array options. */ public function getOptions() {} /** * Retrieve the progress information for $request. * * @param \http\Client\Request $request The request to retrieve the current progress information for. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return object|null object stdClass instance holding progress information. * or NULL if $request is not enqueued. */ public function getProgressInfo(http\Client\Request $request) {} /** * Retrieve the corresponding response of an already finished request, or the last received response if $request is not set. * * ***NOTE:*** * If $request is NULL, then the response is removed from the internal storage (stack-like operation). * * @param \http\Client\Request $request The request to fetch the stored response for. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client\Response|null \http\Client\Response the stored response for the request, or the last that was received. * or NULL if no more response was available to pop, when no $request was given. */ public function getResponse(http\Client\Request $request = null) {} /** * Retrieve priorly set SSL options. * See http\Client::getOptions() and http\Client::setSslOptions(). * * @return array SSL options. */ public function getSslOptions() {} /** * Get transfer related information for a running or finished request. * * @param \http\Client\Request $request The request to probe for transfer info. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return object stdClass instance holding transfer related information. */ public function getTransferInfo(http\Client\Request $request) {} /** * Implements SplSubject. Notify attached observers about progress with $request. * * @param \http\Client\Request $request The request to notify about. * @param object $progress stdClass instance holding progress information. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client self. */ public function notify(http\Client\Request $request = null, $progress = null) {} /** * Perform outstanding transfer actions. * See http\Client::wait() for the completing interface. * * @return bool true if there are more transfers to complete. */ public function once() {} /** * Requeue an http\Client\Request. * * The difference simply is, that this method, in contrast to http\Client::enqueue(), does not throw an http\Exception when the request to queue is already enqueued and dequeues it automatically prior enqueueing it again. * * @param \http\Client\Request $request The request to queue. * @param callable $cb as function(\http\Response $response) : ?bool * A callback to automatically call when the request has finished. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException * @return \http\Client self. */ public function requeue(http\Client\Request $request, callable $cb = null) {} /** * Reset the client to the initial state. * * @return \http\Client self. */ public function reset() {} /** * Send all enqueued requests. * See http\Client::once() and http\Client::wait() for a more fine grained interface. * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException * @return \http\Client self. */ public function send() {} /** * Set custom cookies. * See http\Client::addCookies() and http\Client::getCookies(). * * @param array $cookies Set the custom cookies to this array. * @throws \http\Exception\InvalidArgumentException * @return \http\Client self. */ public function setCookies(array $cookies = null) {} /** * Set client debugging callback. * * ***NOTE:*** * This method has been added in v2.6.0, resp. v3.1.0. * * @param callable $callback as function(http\Client $c, http\Client\Request $r, int $type, string $data) * The debug callback. For $type see http\Client::DEBUG_* constants. * @throws \http\Exception\InvalidArgumentException * @return \http\Client self. */ public function setDebug(callable $callback) {} /** * Set client options. * See http\Client\Curl. * * ***NOTE:*** * Only options specified prior enqueueing a request are applied to the request. * * @param array $options The options to set. * @throws \http\Exception\InvalidArgumentException * @return \http\Client self. */ public function setOptions(array $options = null) {} /** * Specifically set SSL options. * See http\Client::setOptions() and http\Client\Curl\$ssl options. * * @param array $ssl_options Set SSL options to this array. * @throws \http\Exception\InvalidArgumentException * @return \http\Client self. */ public function setSslOptions(array $ssl_options = null) {} /** * Wait for $timeout seconds for transfers to provide data. * This is the completion call to http\Client::once(). * * @param float $timeout Seconds to wait for data on open sockets. * @return bool success. */ public function wait(float $timeout = 0) {} } /** * A class representing a list of cookies with specific attributes. */ class Cookie { /** * Do not decode cookie contents. */ public const PARSE_RAW = 1; /** * The cookies' flags have the secure attribute set. */ public const SECURE = 16; /** * The cookies' flags have the httpOnly attribute set. */ public const HTTPONLY = 32; /** * Create a new cookie list. * * @param mixed $cookies The string or list of cookies to parse or set. * @param int $flags Parse flags. See http\Cookie::PARSE_* constants. * @param array $allowed_extras List of extra attribute names to recognize. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException */ public function __construct($cookies = null, int $flags = 0, array $allowed_extras = null) {} /** * String cast handler. Alias of http\Cookie::toString(). * * @return string the cookie(s) represented as string. */ public function __toString() {} /** * Add a cookie. * See http\Cookie::setCookie() and http\Cookie::addCookies(). * * @param string $cookie_name The key of the cookie. * @param string $cookie_value The value of the cookie. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function addCookie(string $cookie_name, string $cookie_value) {} /** * (Re)set the cookies. * See http\Cookie::setCookies(). * * @param array $cookies Add cookies of this array of form ["name" => "value"]. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function addCookies(array $cookies) {} /** * Add an extra attribute to the cookie list. * See http\Cookie::setExtra(). * * @param string $extra_name The key of the extra attribute. * @param string $extra_value The value of the extra attribute. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function addExtra(string $extra_name, string $extra_value) {} /** * Add several extra attributes. * See http\Cookie::addExtra(). * * @param array $extras A list of extra attributes of the form ["key" => "value"]. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function addExtras(array $extras) {} /** * Retrieve a specific cookie value. * See http\Cookie::setCookie(). * * @param string $cookie_name The key of the cookie to look up. * @return string|null string the cookie value. * or NULL if $cookie_name could not be found. */ public function getCookie(string $cookie_name) {} /** * Get the list of cookies. * See http\Cookie::setCookies(). * * @return array the list of cookies of form ["name" => "value"]. */ public function getCookies() {} /** * Retrieve the effective domain of the cookie list. * See http\Cookie::setDomain(). * * @return string the effective domain. */ public function getDomain() {} /** * Get the currently set expires attribute. * See http\Cookie::setExpires(). * * ***NOTE:*** * A return value of -1 means that the attribute is not set. * * @return int the currently set expires attribute as seconds since the epoch. */ public function getExpires() {} /** * Retrieve an extra attribute. * See http\Cookie::setExtra(). * * @param string $name The key of the extra attribute. * @return string the value of the extra attribute. */ public function getExtra(string $name) {} /** * Retrieve the list of extra attributes. * See http\Cookie::setExtras(). * * @return array the list of extra attributes of the form ["key" => "value"]. */ public function getExtras() {} /** * Get the currently set flags. * See http\Cookie::SECURE and http\Cookie::HTTPONLY constants. * * @return int the currently set flags bitmask. */ public function getFlags() {} /** * Get the currently set max-age attribute of the cookie list. * See http\Cookie::setMaxAge(). * * ***NOTE:*** * A return value of -1 means that the attribute is not set. * * @return int the currently set max-age. */ public function getMaxAge() {} /** * Retrieve the path the cookie(s) of this cookie list are effective at. * See http\Cookie::setPath(). * * @return string the effective path. */ public function getPath() {} /** * (Re)set a cookie. * See http\Cookie::addCookie() and http\Cookie::setCookies(). * * ***NOTE:*** * The cookie will be deleted from the list if $cookie_value is NULL. * * @param string $cookie_name The key of the cookie. * @param string $cookie_value The value of the cookie. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setCookie(string $cookie_name, string $cookie_value) {} /** * (Re)set the cookies. * See http\Cookie::addCookies(). * * @param array $cookies Set the cookies to this array. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setCookies(array $cookies = null) {} /** * Set the effective domain of the cookie list. * See http\Cookie::setPath(). * * @param string $value The domain the cookie(s) belong to. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setDomain(string $value = null) {} /** * Set the traditional expires timestamp. * See http\Cookie::setMaxAge() for a safer alternative. * * @param int $value The expires timestamp as seconds since the epoch. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setExpires(int $value = -1) {} /** * (Re)set an extra attribute. * See http\Cookie::addExtra(). * * ***NOTE:*** * The attribute will be removed from the extras list if $extra_value is NULL. * * @param string $extra_name The key of the extra attribute. * @param string $extra_value The value of the extra attribute. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setExtra(string $extra_name, string $extra_value = null) {} /** * (Re)set the extra attributes. * See http\Cookie::addExtras(). * * @param array $extras Set the extra attributes to this array. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setExtras(array $extras = null) {} /** * Set the flags to specified $value. * See http\Cookie::SECURE and http\Cookie::HTTPONLY constants. * * @param int $value The new flags bitmask. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setFlags(int $value = 0) {} /** * Set the maximum age the cookie may have on the client side. * This is a client clock departure safe alternative to the "expires" attribute. * See http\Cookie::setExpires(). * * @param int $value The max-age in seconds. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setMaxAge(int $value = -1) {} /** * Set the path the cookie(s) of this cookie list should be effective at. * See http\Cookie::setDomain(). * * @param string $path The URL path the cookie(s) should take effect within. * @throws \http\Exception\InvalidArgumentException * @return \http\Cookie self. */ public function setPath(string $path = null) {} /** * Get the cookie list as array. * * @return array the cookie list as array. */ public function toArray() {} /** * Retrieve the string representation of the cookie list. * See http\Cookie::toArray(). * * @return string the cookie list as string. */ public function toString() {} } namespace http\Encoding; namespace http; /** * The http\Env class provides static methods to manipulate and inspect the server's current request's HTTP environment. */ class Env { /** * Retrieve the current HTTP request's body. * * @param string $body_class_name A user class extending http\Message\Body. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Message\Body instance representing the request body */ public function getRequestBody(string $body_class_name = null) {} /** * Retrieve one or all headers of the current HTTP request. * * @param string $header_name The key of a header to retrieve. * @return string|null|array NULL if $header_name was not found * or string the compound header when $header_name was found * or array of all headers if $header_name was not specified */ public function getRequestHeader(string $header_name = null) {} /** * Get the HTTP response code to send. * * @return int the HTTP response code. */ public function getResponseCode() {} /** * Get one or all HTTP response headers to be sent. * * @param string $header_name The name of the response header to retrieve. * @return string|array|null string the compound value of the response header to send * or NULL if the header was not found * or array of all response headers, if $header_name was not specified */ public function getResponseHeader(string $header_name = null) {} /** * Retrieve a list of all known HTTP response status. * * @return array mapping of the form \[ * ... * int $code => string $status * ... * \] */ public function getResponseStatusForAllCodes() {} /** * Retrieve the string representation of specified HTTP response code. * * @param int $code The HTTP response code to get the string representation for. * @return string the HTTP response status message (may be empty, if no message for this code was found) */ public function getResponseStatusForCode(int $code) {} /** * Generic negotiator. For specific client negotiation see http\Env::negotiateContentType() and related methods. * * ***NOTE:*** * The first element of $supported serves as a default if no operand matches. * * @param string $params HTTP header parameter's value to negotiate. * @param array $supported List of supported negotiation operands. * @param string $prim_typ_sep A "primary type separator", i.e. that would be a hyphen for content language negotiation (en-US, de-DE, etc.). * @param array &$result Out parameter recording negotiation results. * @return string|null NULL if negotiation fails. * or string the closest match negotiated, or the default (first entry of $supported). */ public function negotiate(string $params, array $supported, string $prim_typ_sep = null, array &$result = null) {} /** * Negotiate the client's preferred character set. * * ***NOTE:*** * The first element of $supported character sets serves as a default if no character set matches. * * @param array $supported List of supported content character sets. * @param array &$result Out parameter recording negotiation results. * @return string|null NULL if negotiation fails. * or string the negotiated character set. */ public function negotiateCharset(array $supported, array &$result = null) {} /** * Negotiate the client's preferred MIME content type. * * ***NOTE:*** * The first element of $supported content types serves as a default if no content-type matches. * * @param array $supported List of supported MIME content types. * @param array &$result Out parameter recording negotiation results. * @return string|null NULL if negotiation fails. * or string the negotiated content type. */ public function negotiateContentType(array $supported, array &$result = null) {} /** * Negotiate the client's preferred encoding. * * ***NOTE:*** * The first element of $supported encodings serves as a default if no encoding matches. * * @param array $supported List of supported content encodings. * @param array &$result Out parameter recording negotiation results. * @return string|null NULL if negotiation fails. * or string the negotiated encoding. */ public function negotiateEncoding(array $supported, array &$result = null) {} /** * Negotiate the client's preferred language. * * ***NOTE:*** * The first element of $supported languages serves as a default if no language matches. * * @param array $supported List of supported content languages. * @param array &$result Out parameter recording negotiation results. * @return string|null NULL if negotiation fails. * or string the negotiated language. */ public function negotiateLanguage(array $supported, array &$result = null) {} /** * Set the HTTP response code to send. * * @param int $code The HTTP response status code. * @return bool Success. */ public function setResponseCode(int $code) {} /** * Set a response header, either replacing a prior set header, or appending the new header value, depending on $replace. * * If no $header_value is specified, or $header_value is NULL, then a previously set header with the same key will be deleted from the list. * * If $response_code is not 0, the response status code is updated accordingly. * * @param string $header_name * @param mixed $header_value * @param int $response_code * @param bool $replace * @return bool Success. */ public function setResponseHeader(string $header_name, $header_value = null, int $response_code = null, bool $replace = null) {} } /** * The http extension's Exception interface. * * Use it to catch any Exception thrown by pecl/http. * * The individual exception classes extend their equally named native PHP extensions, if such exist, and implement this empty interface. For example the http\Exception\BadMethodCallException extends SPL's BadMethodCallException. */ interface Exception {} /** * The http\Header class provides methods to manipulate, match, negotiate and serialize HTTP headers. */ class Header implements \Serializable { /** * None of the following match constraints applies. */ public const MATCH_LOOSE = 0; /** * Perform case sensitive matching. */ public const MATCH_CASE = 1; /** * Match only on word boundaries (according by CType alpha-numeric). */ public const MATCH_WORD = 16; /** * Match the complete string. */ public const MATCH_FULL = 32; /** * Case sensitively match the full string (same as MATCH_CASE|MATCH_FULL). */ public const MATCH_STRICT = 33; /** * The name of the HTTP header. * * @var string */ public $name = null; /** * The value of the HTTP header. * * @var mixed */ public $value = null; /** * Create an http\Header instance for use of simple matching or negotiation. If the value of the header is an array it may be compounded to a single comma separated string. * * @param string $name The HTTP header name. * @param mixed $value The value of the header. * * # Throws: */ public function __construct(string $name = null, $value = null) {} /** * String cast handler. Alias of http\Header::serialize(). * * @return string the serialized form of the HTTP header (i.e. "Name: value"). */ public function __toString() {} /** * Create a parameter list out of the HTTP header value. * * @param mixed $ps The parameter separator(s). * @param mixed $as The argument separator(s). * @param mixed $vs The value separator(s). * @param int $flags The modus operandi. See http\Params constants. * @return \http\Params instance */ public function getParams($ps = null, $as = null, $vs = null, int $flags = null) {} /** * Match the HTTP header's value against provided $value according to $flags. * * @param string $value The comparison value. * @param int $flags The modus operandi. See http\Header constants. * @return bool whether $value matches the header value according to $flags. */ public function match(string $value, int $flags = null) {} /** * Negotiate the header's value against a list of supported values in $supported. * Negotiation operation is adopted according to the header name, i.e. if the * header being negotiated is Accept, then a slash is used as primary type * separator, and if the header is Accept-Language respectively, a hyphen is * used instead. * * ***NOTE:*** * The first element of $supported serves as a default if no operand matches. * * @param array $supported The list of supported values to negotiate. * @param array &$result Out parameter recording the negotiation results. * @return string|null NULL if negotiation fails. * or string the closest match negotiated, or the default (first entry of $supported). */ public function negotiate(array $supported, array &$result = null) {} /** * Parse HTTP headers. * See also http\Header\Parser. * * @param string $header The complete string of headers. * @param string $header_class A class extending http\Header. * @return array|false array of parsed headers, where the elements are instances of $header_class if specified. * or false if parsing fails. */ public function parse(string $header, string $header_class = null) {} /** * Implements Serializable. * * @return string serialized representation of HTTP header (i.e. "Name: value") */ public function serialize() {} /** * Convenience method. Alias of http\Header::serialize(). * * @return string the serialized form of the HTTP header (i.e. "Name: value"). */ public function toString() {} /** * Implements Serializable. * * @param string $serialized The serialized HTTP header (i.e. "Name: value") */ public function unserialize($serialized) {} } /** * The message class builds the foundation for any request and response message. * * See http\Client\Request and http\Client\Response, as well as http\Env\Request and http\Env\Response. */ class Message implements \Countable, \Serializable, \Iterator { /** * No specific type of message. */ public const TYPE_NONE = 0; /** * A request message. */ public const TYPE_REQUEST = 1; /** * A response message. */ public const TYPE_RESPONSE = 2; /** * The message type. See http\Message::TYPE_* constants. * * @var int */ protected $type = \http\Message::TYPE_NONE; /** * The message's body. * * @var \http\Message\Body */ protected $body = null; /** * The request method if the message is of type request. * * @var string */ protected $requestMethod = ""; /** * The request url if the message is of type request. * * @var string */ protected $requestUrl = ""; /** * The response status phrase if the message is of type response. * * @var string */ protected $responseStatus = ""; /** * The response code if the message is of type response. * * @var int */ protected $responseCode = 0; /** * A custom HTTP protocol version. * * @var string */ protected $httpVersion = null; /** * Any message headers. * * @var array */ protected $headers = null; /** * Any parent message. * * @var \http\Message */ protected $parentMessage; /** * Create a new HTTP message. * * @param mixed $message Either a resource or a string, representing the HTTP message. * @param bool $greedy Whether to read from a $message resource until EOF. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMessageException */ public function __construct($message = null, bool $greedy = true) {} /** * Retrieve the message serialized to a string. * Alias of http\Message::toString(). * * @return string the single serialized HTTP message. */ public function __toString() {} /** * Append the data of $body to the message's body. * See http\Message::setBody() and http\Message\Body::append(). * * @param \http\Message\Body $body The message body to add. * @return \http\Message self. */ public function addBody(http\Message\Body $body) {} /** * Add an header, appending to already existing headers. * See http\Message::addHeaders() and http\Message::setHeader(). * * @param string $name The header name. * @param mixed $value The header value. * @return \http\Message self. */ public function addHeader(string $name, $value) {} /** * Add headers, optionally appending values, if header keys already exist. * See http\Message::addHeader() and http\Message::setHeaders(). * * @param array $headers The HTTP headers to add. * @param bool $append Whether to append values for existing headers. * @return \http\Message self. */ public function addHeaders(array $headers, bool $append = false) {} /** * Implements Countable. * * @return int the count of messages in the chain above the current message. */ public function count() {} /** * Implements iterator. * See http\Message::valid() and http\Message::rewind(). * * @return \http\Message the current message in the iterated message chain. */ public function current() {} /** * Detach a clone of this message from any message chain. * * @throws \http\Exception\InvalidArgumentException * @return \http\Message clone. */ public function detach() {} /** * Retrieve the message's body. * See http\Message::setBody(). * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Message\Body the message body. */ public function getBody() {} /** * Retrieve a single header, optionally hydrated into a http\Header extending class. * * @param string $header The header's name. * @param string $into_class The name of a class extending http\Header. * @return mixed|\http\Header mixed the header value if $into_class is NULL. * or \http\Header descendant. */ public function getHeader(string $header, string $into_class = null) {} /** * Retrieve all message headers. * See http\Message::setHeaders() and http\Message::getHeader(). * * @return array the message's headers. */ public function getHeaders() {} /** * Retrieve the HTTP protocol version of the message. * See http\Message::setHttpVersion(). * * @return string the HTTP protocol version, e.g. "1.0"; defaults to "1.1". */ public function getHttpVersion() {} /** * Retrieve the first line of a request or response message. * See http\Message::setInfo and also: * * * http\Message::getType() * * http\Message::getHttpVersion() * * http\Message::getResponseCode() * * http\Message::getResponseStatus() * * http\Message::getRequestMethod() * * http\Message::getRequestUrl() * * @return string|null string the HTTP message information. * or NULL if the message is neither of type request nor response. */ public function getInfo() {} /** * Retrieve any parent message. * See http\Message::reverse(). * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @return \http\Message the parent message. */ public function getParentMessage() {} /** * Retrieve the request method of the message. * See http\Message::setRequestMethod() and http\Message::getRequestUrl(). * * @return string|false string the request method. * or false if the message was not of type request. */ public function getRequestMethod() {} /** * Retrieve the request URL of the message. * See http\Message::setRequestUrl(). * * @return string|false string the request URL; usually the path and the querystring. * or false if the message was not of type request. */ public function getRequestUrl() {} /** * Retrieve the response code of the message. * See http\Message::setResponseCode() and http\Message::getResponseStatus(). * * @return int|false int the response status code. * or false if the message is not of type response. */ public function getResponseCode() {} /** * Retrieve the response status of the message. * See http\Message::setResponseStatus() and http\Message::getResponseCode(). * * @return string|false string the response status phrase. * or false if the message is not of type response. */ public function getResponseStatus() {} /** * Retrieve the type of the message. * See http\Message::setType() and http\Message::getInfo(). * * @return int the message type. See http\Message::TYPE_* constants. */ public function getType() {} /** * Check whether this message is a multipart message based on it's content type. * If the message is a multipart message and a reference $boundary is given, the boundary string of the multipart message will be stored in $boundary. * * See http\Message::splitMultipartBody(). * * @param string &$boundary A reference where the boundary string will be stored. * @return bool whether this is a message with a multipart "Content-Type". */ public function isMultipart(string &$boundary = null) {} /** * Implements Iterator. * See http\Message::current() and http\Message::rewind(). * * @return int a non-sequential integer key. */ public function key() {} /** * Implements Iterator. * See http\Message::valid() and http\Message::rewind(). */ public function next() {} /** * Prepend message(s) $message to this message, or the top most message of this message chain. * * ***NOTE:*** * The message chains must not overlap. * * @param \http\Message $message The message (chain) to prepend as parent messages. * @param bool $top Whether to prepend to the top-most parent message. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Message self. */ public function prepend(http\Message $message, bool $top = true) {} /** * Reverse the message chain and return the former top-most message. * * ***NOTE:*** * Message chains are ordered in reverse-parsed order by default, i.e. the last parsed message is the message you'll receive from any call parsing HTTP messages. * * This call re-orders the messages of the chain and returns the message that was parsed first with any later parsed messages re-parentized. * * @throws \http\Exception\InvalidArgumentException * @return \http\Message the other end of the message chain. */ public function reverse() {} /** * Implements Iterator. */ public function rewind() {} /** * Implements Serializable. * * @return string the serialized HTTP message. */ public function serialize() {} /** * Set the message's body. * See http\Message::getBody() and http\Message::addBody(). * * @param \http\Message\Body $body The new message body. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Message self. */ public function setBody(http\Message\Body $body) {} /** * Set a single header. * See http\Message::getHeader() and http\Message::addHeader(). * * ***NOTE:*** * Prior to v2.5.6/v3.1.0 headers with the same name were merged into a single * header with values concatenated by comma. * * @param string $header The header's name. * @param mixed $value The header's value. Removes the header if NULL. * @return \http\Message self. */ public function setHeader(string $header, $value = null) {} /** * Set the message headers. * See http\Message::getHeaders() and http\Message::addHeaders(). * * ***NOTE:*** * Prior to v2.5.6/v3.1.0 headers with the same name were merged into a single * header with values concatenated by comma. * * @param array $headers The message's headers. * @return \http\Message null. */ public function setHeaders(array $headers = null) {} /** * Set the HTTP protocol version of the message. * See http\Message::getHttpVersion(). * * @param string $http_version The protocol version, e.g. "1.1", optionally prefixed by "HTTP/". * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadHeaderException * @return \http\Message self. */ public function setHttpVersion(string $http_version) {} /** * Set the complete message info, i.e. type and response resp. request information, at once. * See http\Message::getInfo(). * * @param string $http_info The message info (first line of an HTTP message). * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadHeaderException * @return \http\Message self. */ public function setInfo(string $http_info) {} /** * Set the request method of the message. * See http\Message::getRequestMethod() and http\Message::setRequestUrl(). * * @param string $method The request method. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @return \http\Message self. */ public function setRequestMethod(string $method) {} /** * Set the request URL of the message. * See http\Message::getRequestUrl() and http\Message::setRequestMethod(). * * @param string $url The request URL. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @return \http\Message self. */ public function setRequestUrl(string $url) {} /** * Set the response status code. * See http\Message::getResponseCode() and http\Message::setResponseStatus(). * * ***NOTE:*** * This method also resets the response status phrase to the default for that code. * * @param int $response_code The response code. * @param bool $strict Whether to check that the response code is between 100 and 599 inclusive. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @return \http\Message self. */ public function setResponseCode(int $response_code, bool $strict = true) {} /** * Set the response status phrase. * See http\Message::getResponseStatus() and http\Message::setResponseCode(). * * @param string $response_status The status phrase. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @return \http\Message self. */ public function setResponseStatus(string $response_status) {} /** * Set the message type and reset the message info. * See http\Message::getType() and http\Message::setInfo(). * * @param int $type The desired message type. See the http\Message::TYPE_* constants. * @return \http\Message self. */ public function setType(int $type) {} /** * Splits the body of a multipart message. * See http\Message::isMultipart() and http\Message\Body::addPart(). * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @throws \http\Exception\BadMessageException * @return \http\Message a message chain of all messages of the multipart body. */ public function splitMultipartBody() {} /** * Stream the message through a callback. * * @param callable $callback The callback of the form function(http\Message $from, string $data). * @return \http\Message self. */ public function toCallback(callable $callback) {} /** * Stream the message into stream $stream, starting from $offset, streaming $maxlen at most. * * @param resource $stream The resource to write to. * @return \http\Message self. */ public function toStream($stream) {} /** * Retrieve the message serialized to a string. * * @param bool $include_parent Whether to include all parent messages. * @return string the HTTP message chain serialized to a string. */ public function toString(bool $include_parent = false) {} /** * Implements Serializable. * * @param string $data The serialized message. */ public function unserialize($data) {} /** * Implements Iterator. * See http\Message::current() and http\Message::rewind(). * * @return bool whether http\Message::current() would not return NULL. */ public function valid() {} } /** * Parse, interpret and compose HTTP (header) parameters. */ class Params implements \ArrayAccess { /** * The default parameter separator (","). */ public const DEF_PARAM_SEP = ','; /** * The default argument separator (";"). */ public const DEF_ARG_SEP = ';'; /** * The default value separator ("="). */ public const DEF_VAL_SEP = '='; /** * Empty param separator to parse cookies. */ public const COOKIE_PARAM_SEP = ''; /** * Do not interpret the parsed parameters. */ public const PARSE_RAW = 0; /** * Interpret input as default formatted parameters. */ public const PARSE_DEFAULT = 17; /** * Parse backslash escaped (quoted) strings. */ public const PARSE_ESCAPED = 1; /** * Urldecode single units of parameters, arguments and values. */ public const PARSE_URLENCODED = 4; /** * Parse sub dimensions indicated by square brackets. */ public const PARSE_DIMENSION = 8; /** * Parse URL querystring (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION). */ public const PARSE_QUERY = 12; /** * Parse [RFC5987](http://tools.ietf.org/html/rfc5987) style encoded character set and language information embedded in HTTP header params. */ public const PARSE_RFC5987 = 16; /** * Parse [RFC5988](http://tools.ietf.org/html/rfc5988) (Web Linking) tags of Link headers. */ public const PARSE_RFC5988 = 32; /** * The (parsed) parameters. * * @var array */ public $params = null; /** * The parameter separator(s). * * @var array */ public $param_sep = \http\Params::DEF_PARAM_SEP; /** * The argument separator(s). * * @var array */ public $arg_sep = \http\Params::DEF_ARG_SEP; /** * The value separator(s). * * @var array */ public $val_sep = \http\Params::DEF_VAL_SEP; /** * The modus operandi of the parser. See http\Params::PARSE_* constants. * * @var int */ public $flags = \http\Params::PARSE_DEFAULT; /** * Instantiate a new HTTP (header) parameter set. * * @param mixed $params Pre-parsed parameters or a string to be parsed. * @param mixed $ps The parameter separator(s). * @param mixed $as The argument separator(s). * @param mixed $vs The value separator(s). * @param int $flags The modus operandi. See http\Params::PARSE_* constants. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException */ public function __construct($params = null, $ps = null, $as = null, $vs = null, int $flags = null) {} /** * String cast handler. Alias of http\Params::toString(). * Returns a stringified version of the parameters. * * @return string version of the parameters. */ public function __toString() {} /** * Implements ArrayAccess. * * @param string $name The offset to look after. * @return bool Existence. */ public function offsetExists($name) {} /** * Implements ArrayAccess. * * @param string $name The offset to retrieve. * @return mixed contents at offset. */ public function offsetGet($name) {} /** * Implements ArrayAccess. * * @param string $name The offset to modify. * @param mixed $value The value to set. */ public function offsetSet($name, $value) {} /** * Implements ArrayAccess. * * @param string $name The offset to delete. */ public function offsetUnset($name) {} /** * Convenience method that simply returns http\Params::$params. * * @return array of parameters. */ public function toArray() {} /** * Returns a stringified version of the parameters. * * @return string version of the parameters. */ public function toString() {} } /** * The http\QueryString class provides versatile facilities to retrieve, use and manipulate query strings and form data. */ class QueryString implements \Serializable, \ArrayAccess, \IteratorAggregate { /** * Cast requested value to bool. */ public const TYPE_BOOL = 16; /** * Cast requested value to int. */ public const TYPE_INT = 4; /** * Cast requested value to float. */ public const TYPE_FLOAT = 5; /** * Cast requested value to string. */ public const TYPE_STRING = 6; /** * Cast requested value to an array. */ public const TYPE_ARRAY = 7; /** * Cast requested value to an object. */ public const TYPE_OBJECT = 8; /** * The global instance. See http\QueryString::getGlobalInstance(). * * @var \http\QueryString */ private $instance = null; /** * The data. * * @var array */ private $queryArray = null; /** * Create an independent querystring instance. * * @param mixed $params The query parameters to use or parse. * @throws \http\Exception\BadQueryStringException */ public function __construct($params = null) {} /** * Get the string representation of the querystring (x-www-form-urlencoded). * * @return string the x-www-form-urlencoded querystring. */ public function __toString() {} /** * Retrieve an querystring value. * * See http\QueryString::TYPE_* constants. * * @param string $name The key to retrieve the value for. * @param mixed $type The type to cast the value to. See http\QueryString::TYPE_* constants. * @param mixed $defval The default value to return if the key $name does not exist. * @param bool $delete Whether to delete the entry from the querystring after retrieval. * @return \http\QueryString|string|mixed|mixed|string \http\QueryString if called without arguments. * or string the whole querystring if $name is of zero length. * or mixed $defval if the key $name does not exist. * or mixed the querystring value cast to $type if $type was specified and the key $name exists. * or string the querystring value if the key $name exists and $type is not specified or equals http\QueryString::TYPE_STRING. */ public function get(string $name = null, $type = null, $defval = null, bool $delete = false) {} /** * Retrieve an array value with at offset $name. * * @param string $name The key to look up. * @param mixed $defval The default value to return if the offset $name does not exist. * @param bool $delete Whether to remove the key and value from the querystring after retrieval. * @return array|mixed array the (casted) value. * or mixed $defval if offset $name does not exist. */ public function getArray(string $name, $defval = null, bool $delete = false) {} /** * Retrieve a boolean value at offset $name. * * @param string $name The key to look up. * @param mixed $defval The default value to return if the offset $name does not exist. * @param bool $delete Whether to remove the key and value from the querystring after retrieval. * @return bool|mixed bool the (casted) value. * or mixed $defval if offset $name does not exist. */ public function getBool(string $name, $defval = null, bool $delete = false) {} /** * Retrieve a float value at offset $name. * * @param string $name The key to look up. * @param mixed $defval The default value to return if the offset $name does not exist. * @param bool $delete Whether to remove the key and value from the querystring after retrieval. * @return float|mixed float the (casted) value. * or mixed $defval if offset $name does not exist. */ public function getFloat(string $name, $defval = null, bool $delete = false) {} /** * Retrieve the global querystring instance referencing $_GET. * * @throws \http\Exception\UnexpectedValueException * @return \http\QueryString the http\QueryString::$instance */ public function getGlobalInstance() {} /** * Retrieve a int value at offset $name. * * @param string $name The key to look up. * @param mixed $defval The default value to return if the offset $name does not exist. * @param bool $delete Whether to remove the key and value from the querystring after retrieval. * @return int|mixed int the (casted) value. * or mixed $defval if offset $name does not exist. */ public function getInt(string $name, $defval = null, bool $delete = false) {} /** * Implements IteratorAggregate. * * @throws \http\Exception\InvalidArgumentException * @throws \InvalidArgumentException */ public function getIterator() {} /** * Retrieve a object value with at offset $name. * * @param string $name The key to look up. * @param mixed $defval The default value to return if the offset $name does not exist. * @param bool $delete Whether to remove the key and value from the querystring after retrieval. * @return object|mixed object the (casted) value. * or mixed $defval if offset $name does not exist. */ public function getObject(string $name, $defval = null, bool $delete = false) {} /** * Retrieve a string value with at offset $name. * * @param string $name The key to look up. * @param mixed $defval The default value to return if the offset $name does not exist. * @param bool $delete Whether to remove the key and value from the querystring after retrieval. * @return string|mixed string the (casted) value. * or mixed $defval if offset $name does not exist. */ public function getString(string $name, $defval = null, bool $delete = false) {} /** * Set additional $params to a clone of this instance. * See http\QueryString::set(). * * ***NOTE:*** * This method returns a clone (copy) of this instance. * * @param mixed $params Additional params as object, array or string to parse. * @throws \http\Exception\BadQueryStringException * @return \http\QueryString clone. */ public function mod($params = null) {} /** * Implements ArrayAccess. * * @param string $name The offset to look up. * @return bool whether the key $name isset. */ public function offsetExists($name) {} /** * Implements ArrayAccess. * * @param mixed $offset The offset to look up. * @return mixed|null mixed the value locate at offset $name. * or NULL if key $name could not be found. */ public function offsetGet($offset) {} /** * Implements ArrayAccess. * * @param string $name The key to set the value for. * @param mixed $data The data to place at offset $name. */ public function offsetSet($name, $data) {} /** * Implements ArrayAccess. * * @param string $name The offset to look up. */ public function offsetUnset($name) {} /** * Implements Serializable. * See http\QueryString::toString(). * * @return string the x-www-form-urlencoded querystring. */ public function serialize() {} /** * Set additional querystring entries. * * @param mixed $params Additional params as object, array or string to parse. * @return \http\QueryString self. */ public function set($params) {} /** * Simply returns http\QueryString::$queryArray. * * @return array the $queryArray property. */ public function toArray() {} /** * Get the string representation of the querystring (x-www-form-urlencoded). * * @return string the x-www-form-urlencoded querystring. */ public function toString() {} /** * Implements Serializable. * * @param string $serialized The x-www-form-urlencoded querystring. * @throws \http\Exception */ public function unserialize($serialized) {} /** * Translate character encodings of the querystring with ext/iconv. * * ***NOTE:*** * This method is only available when ext/iconv support was enabled at build time. * * @param string $from_enc The encoding to convert from. * @param string $to_enc The encoding to convert to. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadConversionException * @return \http\QueryString self. */ public function xlate(string $from_enc, string $to_enc) {} } /** * The http\Url class provides versatile means to parse, construct and manipulate URLs. */ class Url { /** * Replace parts of the old URL with parts of the new. */ public const REPLACE = 0; /** * Whether a relative path should be joined into the old path. */ public const JOIN_PATH = 1; /** * Whether the querystrings should be joined. */ public const JOIN_QUERY = 2; /** * Strip the user information from the URL. */ public const STRIP_USER = 4; /** * Strip the password from the URL. */ public const STRIP_PASS = 8; /** * Strip user and password information from URL (same as STRIP_USER|STRIP_PASS). */ public const STRIP_AUTH = 12; /** * Do not include the port. */ public const STRIP_PORT = 32; /** * Do not include the URL path. */ public const STRIP_PATH = 64; /** * Do not include the URL querystring. */ public const STRIP_QUERY = 128; /** * Strip the fragment (hash) from the URL. */ public const STRIP_FRAGMENT = 256; /** * Strip everything except scheme and host information. */ public const STRIP_ALL = 492; /** * Import initial URL parts from the SAPI environment. */ public const FROM_ENV = 4096; /** * Whether to sanitize the URL path (consolidate double slashes, directory jumps etc.) */ public const SANITIZE_PATH = 8192; /** * Parse UTF-8 encoded multibyte sequences. */ public const PARSE_MBUTF8 = 131072; /** * Parse locale encoded multibyte sequences (on systems with wide character support). */ public const PARSE_MBLOC = 65536; /** * Parse and convert multibyte hostnames according to IDNA (with IDNA support). */ public const PARSE_TOIDN = 1048576; /** * Explicitly request IDNA2003 implementation if available (libidn, idnkit or ICU). */ public const PARSE_TOIDN_2003 = 9437184; /** * Explicitly request IDNA2008 implementation if available (libidn2, idnkit2 or ICU). */ public const PARSE_TOIDN_2008 = 5242880; /** * Percent encode multibyte sequences in the userinfo, path, query and fragment parts of the URL. */ public const PARSE_TOPCT = 2097152; /** * Continue parsing when encountering errors. */ public const IGNORE_ERRORS = 268435456; /** * Suppress errors/exceptions. */ public const SILENT_ERRORS = 536870912; /** * Standard flags used by default internally for e.g. http\Message::setRequestUrl(). * Enables joining path and query, sanitizing path, multibyte/unicode, international domain names and transient percent encoding. */ public const STDFLAGS = 3350531; /** * The URL's scheme. * * @var string */ public $scheme = null; /** * Authenticating user. * * @var string */ public $user = null; /** * Authentication password. * * @var string */ public $pass = null; /** * Hostname/domain. * * @var string */ public $host = null; /** * Port. * * @var string */ public $port = null; /** * URL path. * * @var string */ public $path = null; /** * URL querystring. * * @var string */ public $query = null; /** * URL fragment (hash). * * @var string */ public $fragment = null; /** * Create an instance of an http\Url. * * ***NOTE:*** * Prior to v3.0.0, the default for the $flags parameter was http\Url::FROM_ENV. * * See also http\Env\Url. * * @param mixed $old_url Initial URL parts. Either an array, object, http\Url instance or string to parse. * @param mixed $new_url Overriding URL parts. Either an array, object, http\Url instance or string to parse. * @param int $flags The modus operandi of constructing the url. See http\Url constants. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadUrlException */ public function __construct($old_url = null, $new_url = null, int $flags = 0) {} /** * String cast handler. Alias of http\Url::toString(). * * @return string the URL as string. */ public function __toString() {} /** * Clone this URL and apply $parts to the cloned URL. * * ***NOTE:*** * This method returns a clone (copy) of this instance. * * @param mixed $parts New URL parts. * @param int $flags Modus operandi of URL construction. See http\Url constants. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadUrlException * @return \http\Url clone. */ public function mod($parts, int $flags = \http\Url::JOIN_PATH|\http\Url::JOIN_QUERY|\http\Url::SANITIZE_PATH) {} /** * Retrieve the URL parts as array. * * @return array the URL parts. */ public function toArray() {} /** * Get the string prepresentation of the URL. * * @return string the URL as string. */ public function toString() {} } /** * The http\Client\Curl namespace holds option value constants specific to the curl driver of the http\Client. */ namespace http\Client\Curl; /** * Bitmask of available libcurl features. * See http\Client\Curl\Features namespace. */ const FEATURES = 4179869; /** * List of library versions of or linked into libcurl, * e.g. "libcurl/7.50.0 OpenSSL/1.0.2h zlib/1.2.8 libidn/1.32 nghttp2/1.12.0". * See http\Client\Curl\Versions namespace. */ const VERSIONS = 'libcurl/7.64.0 OpenSSL/1.1.1b zlib/1.2.11 libidn2/2.0.5 libpsl/0.20.2 (+libidn2/2.0.5) libssh2/1.8.0 nghttp2/1.36.0 librtmp/2.3'; /** * Use HTTP/1.0 protocol version. */ const HTTP_VERSION_1_0 = 1; /** * Use HTTP/1.1 protocol version. */ const HTTP_VERSION_1_1 = 2; /** * Attempt to use HTTP/2 protocol version. Available if libcurl is v7.33.0 or more recent and was built with nghttp2 support. */ const HTTP_VERSION_2_0 = 3; /** * Attempt to use version 2 for HTTPS, version 1.1 for HTTP. Available if libcurl is v7.47.0 or more recent and was built with nghttp2 support. */ const HTTP_VERSION_2TLS = 4; /** * Use any HTTP protocol version. */ const HTTP_VERSION_ANY = 0; /** * Use TLS v1.0 encryption. */ const SSL_VERSION_TLSv1_0 = 4; /** * Use TLS v1.1 encryption. */ const SSL_VERSION_TLSv1_1 = 5; /** * Use TLS v1.2 encryption. */ const SSL_VERSION_TLSv1_2 = 6; /** * Use any TLS v1 encryption. */ const SSL_VERSION_TLSv1 = 1; /** * Use SSL v2 encryption. */ const SSL_VERSION_SSLv2 = 2; /** * Use SSL v3 encryption. */ const SSL_VERSION_SSLv3 = 3; /** * Use any encryption. */ const SSL_VERSION_ANY = 0; /** * Use TLS SRP authentication. Available if libcurl is v7.21.4 or more recent and was built with gnutls or openssl with TLS-SRP support. */ const TLSAUTH_SRP = 1; /** * Use IPv4 resolver. */ const IPRESOLVE_V4 = 1; /** * Use IPv6 resolver. */ const IPRESOLVE_V6 = 2; /** * Use any resolver. */ const IPRESOLVE_ANY = 0; /** * Use Basic authentication. */ const AUTH_BASIC = 1; /** * Use Digest authentication. */ const AUTH_DIGEST = 2; /** * Use IE (lower v7) quirks with Digest authentication. Available if libcurl is v7.19.3 or more recent. */ const AUTH_DIGEST_IE = 16; /** * Use NTLM authentication. */ const AUTH_NTLM = 8; /** * Use GSS-Negotiate authentication. */ const AUTH_GSSNEG = 4; /** * Use HTTP Netgotiate authentication (SPNEGO, RFC4559). Available if libcurl is v7.38.0 or more recent. */ const AUTH_SPNEGO = 4; /** * Use any authentication. */ const AUTH_ANY = -17; /** * Use SOCKSv4 proxy protocol. */ const PROXY_SOCKS4 = 4; /** * Use SOCKSv4a proxy protocol. */ const PROXY_SOCKS4A = 5; /** * Use SOCKS5h proxy protocol. */ const PROXY_SOCKS5_HOSTNAME = 5; /** * Use SOCKS5 proxy protoccol. */ const PROXY_SOCKS5 = 5; /** * Use HTTP/1.1 proxy protocol. */ const PROXY_HTTP = 0; /** * Use HTTP/1.0 proxy protocol. Available if libcurl is v7.19.4 or more recent. */ const PROXY_HTTP_1_0 = 1; /** * Keep POSTing on 301 redirects. Available if libcurl is v7.19.1 or more recent. */ const POSTREDIR_301 = 1; /** * Keep POSTing on 302 redirects. Available if libcurl is v7.19.1 or more recent. */ const POSTREDIR_302 = 2; /** * Keep POSTing on 303 redirects. Available if libcurl is v7.19.1 or more recent. */ const POSTREDIR_303 = 4; /** * Keep POSTing on any redirect. Available if libcurl is v7.19.1 or more recent. */ const POSTREDIR_ALL = 7; namespace http\Client; /** * The http\Client\Request class provides an HTTP message implementation tailored to represent a request message to be sent by the client. * * See http\Client::enqueue(). */ class Request extends \http\Message { /** * Array of options for this request, which override client options. * * @var array */ protected $options = null; /** * Create a new client request message to be enqueued and sent by http\Client. * * @param string $meth The request method. * @param string $url The request URL. * @param array $headers HTTP headers. * @param \http\Message\Body $body Request body. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException */ public function __construct(string $meth = null, string $url = null, array $headers = null, http\Message\Body $body = null) {} /** * Add querystring data. * See http\Client\Request::setQuery() and http\Message::setRequestUrl(). * * @param mixed $query_data Additional querystring data. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadQueryStringException * @return \http\Client\Request self. */ public function addQuery($query_data) {} /** * Add specific SSL options. * See http\Client\Request::setSslOptions(), http\Client\Request::setOptions() and http\Client\Curl\$ssl options. * * @param array $ssl_options Add this SSL options. * @throws \http\Exception\InvalidArgumentException * @return \http\Client\Request self. */ public function addSslOptions(array $ssl_options = null) {} /** * Extract the currently set "Content-Type" header. * See http\Client\Request::setContentType(). * * @return string|null string the currently set content type. * or NULL if no "Content-Type" header is set. */ public function getContentType() {} /** * Get priorly set options. * See http\Client\Request::setOptions(). * * @return array options. */ public function getOptions() {} /** * Retrieve the currently set querystring. * * @return string|null string the currently set querystring. * or NULL if no querystring is set. */ public function getQuery() {} /** * Retrieve priorly set SSL options. * See http\Client\Request::getOptions() and http\Client\Request::setSslOptions(). * * @return array SSL options. */ public function getSslOptions() {} /** * Set the MIME content type of the request message. * * @param string $content_type The MIME type used as "Content-Type". * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Client\Request self. */ public function setContentType(string $content_type) {} /** * Set client options. * See http\Client::setOptions() and http\Client\Curl. * * Request specific options override general options which were set in the client. * * ***NOTE:*** * Only options specified prior enqueueing a request are applied to the request. * * @param array $options The options to set. * @throws \http\Exception\InvalidArgumentException * @return \http\Client\Request self. */ public function setOptions(array $options = null) {} /** * (Re)set the querystring. * See http\Client\Request::addQuery() and http\Message::setRequestUrl(). * * @param mixed $query_data * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadQueryStringException * @return \http\Client\Request self. */ public function setQuery($query_data) {} /** * Specifically set SSL options. * See http\Client\Request::setOptions() and http\Client\Curl\$ssl options. * * @param array $ssl_options Set SSL options to this array. * @throws \http\Exception\InvalidArgumentException * @return \http\Client\Request self. */ public function setSslOptions(array $ssl_options = null) {} } /** * The http\Client\Response class represents an HTTP message the client returns as answer from a server to an http\Client\Request. */ class Response extends \http\Message { /** * Extract response cookies. * Parses any "Set-Cookie" response headers into an http\Cookie list. See http\Cookie::__construct(). * * @param int $flags Cookie parser flags. * @param array $allowed_extras List of keys treated as extras. * @return array list of http\Cookie instances. */ public function getCookies(int $flags = 0, array $allowed_extras = null) {} /** * Retrieve transfer related information after the request has completed. * See http\Client::getTransferInfo(). * * @param string $name A key to retrieve out of the transfer info. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\BadMethodCallException * @throws \http\Exception\UnexpectedValueException * @return object|mixed object stdClass instance with all transfer info if $name was not given. * or mixed the specific transfer info for $name. */ public function getTransferInfo(string $name = null) {} } namespace http\Client\Curl; /** * Interface to an user event loop implementation for http\Client::configure()'s $use_eventloop option. * * ***NOTE:*** * This interface was added in v2.6.0, resp. v3.1.0. */ interface User { /** * No action. */ public const POLL_NONE = 0; /** * Poll for read readiness. */ public const POLL_IN = 1; /** * Poll for write readiness. */ public const POLL_OUT = 2; /** * Poll for read/write readiness. */ public const POLL_INOUT = 3; /** * Stop polling for activity on this descriptor. */ public const POLL_REMOVE = 4; /** * Initialize the event loop. * * @param callable $run as function(http\Client $c, resource $s = null, int $action = http\Client\Curl\User::POLL_NONE) : int * Internal callback returning the number of unfinished requests pending. * * * ***NOTE***: * The callback should be run when a timeout occurs or a watched socket needs action. */ public function init(callable $run); /** * Run the loop as long as it does not block. * * ***NOTE:*** * This method is called by http\Client::once(), so it does not need to have an actual implementation if http\Client::once() is never called. */ public function once(); /** * Run the loop. * * ***NOTE:*** * This method is called by http\Client::send(), so it does not need to have an actual implementation if http\Client::send() is never called. */ public function send(); /** * Register (or deregister) a socket watcher. * * @param resource $socket The socket descriptor to watch. * @param int $poll http\Client\Curl\User::POLL_* constant. */ public function socket($socket, int $poll); /** * Register a timeout watcher. * * @param int $timeout_ms Desired maximum timeout in milliseconds. */ public function timer(int $timeout_ms); /** * Wait/poll/select (block the loop) until events fire. * * ***NOTE:*** * This method is called by http\Client::wait(), so it does not need to have an actual implementation if http\Client::wait() is never called. * * @param int $timeout_ms Block for at most this milliseconds. */ public function wait(int $timeout_ms = null); } /** * CURL feature constants. * * ***NOTE:*** * These constants have been added in v2.6.0, resp. v3.1.0. */ namespace http\Client\Curl\Features; /** * Whether libcurl supports asynchronous domain name resolution. */ const ASYNCHDNS = 128; /** * Whether libcurl supports the Generic Security Services Application Program Interface. Available if libcurl is v7.38.0 or more recent. */ const GSSAPI = 131072; /** * Whether libcurl supports HTTP Generic Security Services negotiation. */ const GSSNEGOTIATE = 32; /** * Whether libcurl supports the HTTP/2 protocol. Available if libcurl is v7.33.0 or more recent. */ const HTTP2 = 65536; /** * Whether libcurl supports international domain names. */ const IDN = 1024; /** * Whether libcurl supports IPv6. */ const IPV6 = 1; /** * Whether libcurl supports the old Kerberos protocol. */ const KERBEROS4 = 2; /** * Whether libcurl supports the more recent Kerberos v5 protocol. Available if libcurl is v7.40.0 or more recent. */ const KERBEROS5 = 262144; /** * Whether libcurl supports large files. */ const LARGEFILE = 512; /** * Whether libcurl supports gzip/deflate compression. */ const LIBZ = 8; /** * Whether libcurl supports the NT Lan Manager authentication. */ const NTLM = 16; /** * Whether libcurl supports NTLM delegation to a winbind helper. Available if libcurl is v7.22.0 or more recent. */ const NTLM_WB = 32768; /** * Whether libcurl supports the Public Suffix List for cookie host handling. Available if libcurl is v7.47.0 or more recent. */ const PSL = 1048576; /** * Whether libcurl supports the Simple and Protected GSSAPI Negotiation Mechanism. */ const SPNEGO = 256; /** * Whether libcurl supports SSL/TLS protocols. */ const SSL = 4; /** * Whether libcurl supports the Security Support Provider Interface. */ const SSPI = 2048; /** * Whether libcurl supports TLS Secure Remote Password authentication. Available if libcurl is v7.21.4 or more recent. */ const TLSAUTH_SRP = 16384; /** * Whether libcurl supports connections to unix sockets. Available if libcurl is v7.40.0 or more recent. */ const UNIX_SOCKETS = 524288; /** * CURL version constants. * * ***NOTE:*** * These constants have been added in v2.6.0, resp. v3.1.0. */ namespace http\Client\Curl\Versions; /** * Version string of libcurl, e.g. "7.50.0". */ const CURL = '7.64.0'; /** * Version string of the SSL/TLS library, e.g. "OpenSSL/1.0.2h". */ const SSL = 'OpenSSL/1.1.1b'; /** * Version string of the zlib compression library, e.g. "1.2.8". */ const LIBZ = '1.2.11'; /** * Version string of the c-ares library, e.g. "1.11.0". */ const ARES = null; /** * Version string of the IDN library, e.g. "1.32". */ const IDN = null; namespace http\Encoding; /** * Base class for encoding stream implementations. */ abstract class Stream { /** * Do no intermittent flushes. */ public const FLUSH_NONE = 0; /** * Flush at appropriate transfer points. */ public const FLUSH_SYNC = 1048576; /** * Flush at each IO operation. */ public const FLUSH_FULL = 2097152; /** * Base constructor for encoding stream implementations. * * @param int $flags See http\Encoding\Stream and implementation specific constants. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException */ public function __construct(int $flags = 0) {} /** * Check whether the encoding stream is already done. * * @return bool whether the encoding stream is completed. */ public function done() {} /** * Finish and reset the encoding stream. * Returns any pending data. * * @return string any pending data. */ public function finish() {} /** * Flush the encoding stream. * Returns any pending data. * * @return string any pending data. */ public function flush() {} /** * Update the encoding stream with more input. * * @param string $data The data to pass through the stream. * @return string processed data. */ public function update(string $data) {} } namespace http\Encoding\Stream; /** * A [brotli](https://brotli.org) decoding stream. * * ***NOTE:*** * This class has been added in v3.2.0. */ class Debrotli extends \http\Encoding\Stream { /** * Decode brotli encoded data. * * @param string $data The data to uncompress. * @return string the uncompressed data. */ public function decode(string $data) {} } /** * A stream decoding data encoded with chunked transfer encoding. */ class Dechunk extends \http\Encoding\Stream { /** * Decode chunked encoded data. * * @param string $data The data to decode. * @param int &$decoded_len Out parameter with the length of $data that's been decoded. * Should be ```strlen($data)``` if not truncated. * @return string|string|string|false string the decoded data. * or string the unencoded data. * or string the truncated decoded data. * or false if $data cannot be decoded. */ public function decode(string $data, int &$decoded_len = 0) {} } /** * A deflate stream supporting deflate, zlib and gzip encodings. */ class Deflate extends \http\Encoding\Stream { /** * Gzip encoding. RFC1952 */ public const TYPE_GZIP = 16; /** * Zlib encoding. RFC1950 */ public const TYPE_ZLIB = 0; /** * Deflate encoding. RFC1951 */ public const TYPE_RAW = 32; /** * Default compression level. */ public const LEVEL_DEF = 0; /** * Least compression level. */ public const LEVEL_MIN = 1; /** * Greatest compression level. */ public const LEVEL_MAX = 9; /** * Default compression strategy. */ public const STRATEGY_DEF = 0; /** * Filtered compression strategy. */ public const STRATEGY_FILT = 256; /** * Huffman strategy only. */ public const STRATEGY_HUFF = 512; /** * Run-length encoding strategy. */ public const STRATEGY_RLE = 768; /** * Encoding with fixed Huffman codes only. * * > **A note on the compression strategy:** * > * > The strategy parameter is used to tune the compression algorithm. * > * > Use the value DEFAULT_STRATEGY for normal data, FILTERED for data produced by a filter (or predictor), HUFFMAN_ONLY to force Huffman encoding only (no string match), or RLE to limit match distances to one (run-length encoding). * > * > Filtered data consists mostly of small values with a somewhat random distribution. In this case, the compression algorithm is tuned to compress them better. The effect of FILTERED is to force more Huffman coding and less string matching; it is somewhat intermediate between DEFAULT_STRATEGY and HUFFMAN_ONLY. * > * > RLE is designed to be almost as fast as HUFFMAN_ONLY, but give better compression for PNG image data. * > * > FIXED prevents the use of dynamic Huffman codes, allowing for a simpler decoder for special applications. * > * > The strategy parameter only affects the compression ratio but not the correctness of the compressed output even if it is not set appropriately. * > * >_Source: [zlib Manual](http://www.zlib.net/manual.html)_ */ public const STRATEGY_FIXED = 1024; /** * Encode data with deflate/zlib/gzip encoding. * * @param string $data The data to compress. * @param int $flags Any compression tuning flags. See http\Encoding\Stream\Deflate and http\Encoding\Stream constants. * @return string the compressed data. */ public function encode(string $data, int $flags = 0) {} } /** * A [brotli](https://brotli.org) encoding stream. * * ***NOTE:*** * This class has been added in v3.2.0. */ class Enbrotli extends \http\Encoding\Stream { /** * Default compression level. */ public const LEVEL_DEF = null; /** * Least compression level. */ public const LEVEL_MIN = null; /** * Greatest compression level. */ public const LEVEL_MAX = null; /** * Default window bits. */ public const WBITS_DEF = null; /** * Minimum window bits. */ public const WBITS_MIN = null; /** * Maximum window bits. */ public const WBITS_MAX = null; /** * Default compression mode. */ public const MODE_GENERIC = null; /** * Compression mode for UTF-8 formatted text. */ public const MODE_TEXT = null; /** * Compression mode used in WOFF 2.0. */ public const MODE_FONT = null; /** * Encode data with brotli encoding. * * @param string $data The data to compress. * @param int $flags Any compression tuning flags. See http\Encoding\Stream\Enbrotli and http\Encoding\Stream constants. * @return string the compressed data. */ public function encode(string $data, int $flags = 0) {} } /** * A inflate stream supporting deflate, zlib and gzip encodings. */ class Inflate extends \http\Encoding\Stream { /** * Decode deflate/zlib/gzip encoded data. * * @param string $data The data to uncompress. * @return string the uncompressed data. */ public function decode(string $data) {} } namespace http\Env; /** * The http\Env\Request class' instances represent the server's current HTTP request. * * See http\Message for inherited members. */ class Request extends \http\Message { /** * The request's query parameters. ($_GET) * * @var \http\QueryString */ protected $query = null; /** * The request's form parameters. ($_POST) * * @var \http\QueryString */ protected $form = null; /** * The request's form uploads. ($_FILES) * * @var array */ protected $files = null; /** * The request's cookies. ($_COOKIE) * * @var array */ protected $cookie = null; /** * Create an instance of the server's current HTTP request. * * Upon construction, the http\Env\Request acquires http\QueryString instances of query parameters ($\_GET) and form parameters ($\_POST). * * It also compiles an array of uploaded files ($\_FILES) more comprehensive than the original $\_FILES array, see http\Env\Request::getFiles() for that matter. * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException */ public function __construct() {} /** * Retrieve an URL query value ($_GET). * * See http\QueryString::get() and http\QueryString::TYPE_* constants. * * @param string $name The key to retrieve the value for. * @param mixed $type The type to cast the value to. See http\QueryString::TYPE_* constants. * @param mixed $defval The default value to return if the key $name does not exist. * @param bool $delete Whether to delete the entry from the querystring after retrieval. * @return \http\QueryString|string|mixed|mixed|string \http\QueryString if called without arguments. * or string the whole querystring if $name is of zero length. * or mixed $defval if the key $name does not exist. * or mixed the querystring value cast to $type if $type was specified and the key $name exists. * or string the querystring value if the key $name exists and $type is not specified or equals http\QueryString::TYPE_STRING. */ public function getCookie(string $name = null, $type = null, $defval = null, bool $delete = false) {} /** * Retrieve the uploaded files list ($_FILES). * * @return array the consolidated upload files array. */ public function getFiles() {} /** * Retrieve a form value ($_POST). * * See http\QueryString::get() and http\QueryString::TYPE_* constants. * * @param string $name The key to retrieve the value for. * @param mixed $type The type to cast the value to. See http\QueryString::TYPE_* constants. * @param mixed $defval The default value to return if the key $name does not exist. * @param bool $delete Whether to delete the entry from the querystring after retrieval. * @return \http\QueryString|string|mixed|mixed|string \http\QueryString if called without arguments. * or string the whole querystring if $name is of zero length. * or mixed $defval if the key $name does not exist. * or mixed the querystring value cast to $type if $type was specified and the key $name exists. * or string the querystring value if the key $name exists and $type is not specified or equals http\QueryString::TYPE_STRING. */ public function getForm(string $name = null, $type = null, $defval = null, bool $delete = false) {} /** * Retrieve an URL query value ($_GET). * * See http\QueryString::get() and http\QueryString::TYPE_* constants. * * @param string $name The key to retrieve the value for. * @param mixed $type The type to cast the value to. See http\QueryString::TYPE_* constants. * @param mixed $defval The default value to return if the key $name does not exist. * @param bool $delete Whether to delete the entry from the querystring after retrieval. * @return \http\QueryString|string|mixed|mixed|string \http\QueryString if called without arguments. * or string the whole querystring if $name is of zero length. * or mixed $defval if the key $name does not exist. * or mixed the querystring value cast to $type if $type was specified and the key $name exists. * or string the querystring value if the key $name exists and $type is not specified or equals http\QueryString::TYPE_STRING. */ public function getQuery(string $name = null, $type = null, $defval = null, bool $delete = false) {} } /** * The http\Env\Response class' instances represent the server's current HTTP response. * * See http\Message for inherited members. */ class Response extends \http\Message { /** * Do not use content encoding. */ public const CONTENT_ENCODING_NONE = 0; /** * Support "Accept-Encoding" requests with gzip and deflate encoding. */ public const CONTENT_ENCODING_GZIP = 1; /** * No caching info available. */ public const CACHE_NO = 0; /** * The cache was hit. */ public const CACHE_HIT = 1; /** * The cache was missed. */ public const CACHE_MISS = 2; /** * A request instance which overrides the environments default request. * * @var \http\Env\Request */ protected $request = null; /** * The response's MIME content type. * * @var string */ protected $contentType = null; /** * The response's MIME content disposition. * * @var string */ protected $contentDisposition = null; /** * See http\Env\Response::CONTENT_ENCODING_* constants. * * @var int */ protected $contentEncoding = null; /** * How the client should treat this response in regards to caching. * * @var string */ protected $cacheControl = null; /** * A custom ETag. * * @var string */ protected $etag = null; /** * A "Last-Modified" time stamp. * * @var int */ protected $lastModified = null; /** * Any throttling delay. * * @var int */ protected $throttleDelay = null; /** * The chunk to send every $throttleDelay seconds. * * @var int */ protected $throttleChunk = null; /** * The response's cookies. * * @var array */ protected $cookies = null; /** * Create a new env response message instance. * * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException */ public function __construct() {} /** * Output buffer handler. * Appends output data to the body. * * @param string $data The data output. * @param int $ob_flags Output buffering flags passed from the output buffering control layer. * @return bool success. */ public function __invoke(string $data, int $ob_flags = 0) {} /** * Manually test the header $header_name of the environment's request for a cache hit. * http\Env\Response::send() checks that itself, though. * * @param string $header_name The request header to test. * @return int a http\Env\Response::CACHE_* constant. */ public function isCachedByEtag(string $header_name = "If-None-Match") {} /** * Manually test the header $header_name of the environment's request for a cache hit. * http\Env\Response::send() checks that itself, though. * * @param string $header_name The request header to test. * @return int a http\Env\Response::CACHE_* constant. */ public function isCachedByLastModified(string $header_name = "If-Modified-Since") {} /** * Send the response through the SAPI or $stream. * Flushes all output buffers. * * @param resource $stream A writable stream to send the response through. * @return bool success. */ public function send($stream = null) {} /** * Make suggestions to the client how it should cache the response. * * @param string $cache_control (A) "Cache-Control" header value(s). * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setCacheControl(string $cache_control) {} /** * Set the response's content disposition parameters. * * @param array $disposition_params MIME content disposition as http\Params array. * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setContentDisposition(array $disposition_params) {} /** * Enable support for "Accept-Encoding" requests with deflate or gzip. * The response will be compressed if the client indicates support and wishes that. * * @param int $content_encoding See http\Env\Response::CONTENT_ENCODING_* constants. * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setContentEncoding(int $content_encoding) {} /** * Set the MIME content type of the response. * * @param string $content_type The response's content type. * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setContentType(string $content_type) {} /** * Add cookies to the response to send. * * @param mixed $cookie The cookie to send. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return \http\Env\Response self. */ public function setCookie($cookie) {} /** * Override the environment's request. * * @param \http\Message $env_request The overriding request message. * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setEnvRequest(http\Message $env_request) {} /** * Set a custom ETag. * * ***NOTE:*** * This will be used for caching and pre-condition checks. * * @param string $etag A ETag. * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setEtag(string $etag) {} /** * Set a custom last modified time stamp. * * ***NOTE:*** * This will be used for caching and pre-condition checks. * * @param int $last_modified A unix timestamp. * @throws \http\Exception\InvalidArgumentException * @return \http\Env\Response self. */ public function setLastModified(int $last_modified) {} /** * Enable throttling. * Send $chunk_size bytes every $delay seconds. * * ***NOTE:*** * If you need throttling by regular means, check for other options in your stack, because this method blocks the executing process/thread until the response has completely been sent. * * @param int $chunk_size Bytes to send. * @param float $delay Seconds to sleep. * @return \http\Env\Response self. */ public function setThrottleRate(int $chunk_size, float $delay = 1) {} } /** * URL class using the HTTP environment by default. * * ***NOTE:*** * This class has been added in v3.0.0. * * Always adds http\Url::FROM_ENV to the $flags constructor argument. See also http\Url. */ class Url extends \http\Url {} namespace http\Exception; /** * A bad conversion (e.g. character conversion) was encountered. */ class BadConversionException extends \DomainException implements \http\Exception {} /** * A bad HTTP header was encountered. */ class BadHeaderException extends \DomainException implements \http\Exception {} /** * A bad HTTP message was encountered. */ class BadMessageException extends \DomainException implements \http\Exception {} /** * A method was called on an object, which was in an invalid or unexpected state. */ class BadMethodCallException extends \BadMethodCallException implements \http\Exception {} /** * A bad querystring was encountered. */ class BadQueryStringException extends \DomainException implements \http\Exception {} /** * A bad HTTP URL was encountered. */ class BadUrlException extends \DomainException implements \http\Exception {} /** * One or more invalid arguments were passed to a method. */ class InvalidArgumentException extends \InvalidArgumentException implements \http\Exception {} /** * A generic runtime exception. */ class RuntimeException extends \RuntimeException implements \http\Exception {} /** * An unexpected value was encountered. */ class UnexpectedValueException extends \UnexpectedValueException implements \http\Exception {} namespace http\Header; /** * The parser which is underlying http\Header and http\Message. * * ***NOTE:*** * This class has been added in v2.3.0. */ class Parser { /** * Finish up parser at end of (incomplete) input. */ public const CLEANUP = 1; /** * Parse failure. */ public const STATE_FAILURE = -1; /** * Expecting HTTP info (request/response line) or headers. */ public const STATE_START = 0; /** * Expecting a key or already parsing a key. */ public const STATE_KEY = 1; /** * Expecting a value or already parsing the value. */ public const STATE_VALUE = 2; /** * At EOL of an header, checking whether a folded header line follows. */ public const STATE_VALUE_EX = 3; /** * A header was completed. */ public const STATE_HEADER_DONE = 4; /** * Finished parsing the headers. * * ***NOTE:*** * Most of this states won't be returned to the user, because the parser immediately jumps to the next expected state. */ public const STATE_DONE = 5; /** * Retrieve the current state of the parser. * See http\Header\Parser::STATE_* constants. * * @throws \http\Exception\InvalidArgumentException * @return int http\Header\Parser::STATE_* constant. */ public function getState() {} /** * Parse a string. * * @param string $data The (part of the) header to parse. * @param int $flags Any combination of [parser flags](http/Header/Parser#Parser.flags:). * @param array &$header Successfully parsed headers. * @throws \http\Exception\InvalidArgumentException * @return int http\Header\Parser::STATE_* constant. */ public function parse(string $data, int $flags, array &$header = null) {} /** * Parse a stream. * * @param resource $stream The header stream to parse from. * @param int $flags Any combination of [parser flags](http/Header/Parser#Parser.flags:). * @param array &$headers The headers parsed. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return int http\Header\Parser::STATE_* constant. */ public function stream($stream, int $flags, array &$headers) {} } namespace http\Message; /** * The message body, represented as a PHP (temporary) stream. * * ***NOTE:*** * Currently, http\Message\Body::addForm() creates multipart/form-data bodies. */ class Body implements \Serializable { /** * Create a new message body, optionally referencing $stream. * * @param resource $stream A stream to be used as message body. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException */ public function __construct($stream = null) {} /** * String cast handler. * * @return string the message body. */ public function __toString() {} /** * Add form fields and files to the message body. * * ***NOTE:*** * Currently, http\Message\Body::addForm() creates "multipart/form-data" bodies. * * @param array $fields List of form fields to add. * @param array $files List of form files to add. * * $fields must look like: * * [ * "field_name" => "value", * "multi_field" => [ * "value1", * "value2" * ] * ] * * $files must look like: * * [ * [ * "name" => "field_name", * "type" => "content/type", * "file" => "/path/to/file.ext" * ], [ * "name" => "field_name2", * "type" => "text/plain", * "file" => "file.ext", * "data" => "string" * ], [ * "name" => "field_name3", * "type" => "image/jpeg", * "file" => "file.ext", * "data" => fopen("/home/mike/Pictures/mike.jpg","r") * ] * * As you can see, a file structure must contain a "file" entry, which holds a file path, and an optional "data" entry, which may either contain a resource to read from or the actual data as string. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException * @return \http\Message\Body self. */ public function addForm(array $fields = null, array $files = null) {} /** * Add a part to a multipart body. * * @param \http\Message $part The message part. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException * @return \http\Message\Body self. */ public function addPart(http\Message $part) {} /** * Append plain bytes to the message body. * * @param string $data The data to append to the body. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\RuntimeException * @return \http\Message\Body self. */ public function append(string $data) {} /** * Retrieve the ETag of the body. * * @return string|string|false string an Apache style ETag of inode, mtime and size in hex concatenated by hyphens if the message body stream is stat-able. * or string a content hash (which algorithm is determined by INI http.etag.mode) if the stream is not stat-able. * or false if http.etag.mode is not a known hash algorithm. */ public function etag() {} /** * Retrieve any boundary of the message body. * See http\Message::splitMultipartBody(). * * @return string|null string the message body boundary. * or NULL if this message body has no boundary. */ public function getBoundary() {} /** * Retrieve the underlying stream resource. * * @return resource the underlying stream. */ public function getResource() {} /** * Implements Serializable. * Alias of http\Message\Body::__toString(). * * @return string serialized message body. */ public function serialize() {} /** * Stat size, atime, mtime and/or ctime. * * @param string $field A single stat field to retrieve. * @return int|object int the requested stat field. * or object stdClass instance holding all four stat fields. */ public function stat(string $field = null) {} /** * Stream the message body through a callback. * * @param callable $callback The callback of the form function(http\Message\Body $from, string $data). * @param int $offset Start to stream from this offset. * @param int $maxlen Stream at most $maxlen bytes, or all if $maxlen is less than 1. * @return \http\Message\Body self. */ public function toCallback(callable $callback, int $offset = 0, int $maxlen = 0) {} /** * Stream the message body into another stream $stream, starting from $offset, streaming $maxlen at most. * * @param resource $stream The resource to write to. * @param int $offset The starting offset. * @param int $maxlen The maximum amount of data to stream. All content if less than 1. * @return \http\Message\Body self. */ public function toStream($stream, int $offset = 0, int $maxlen = 0) {} /** * Retrieve the message body serialized to a string. * Alias of http\Message\Body::__toString(). * * @return string message body. */ public function toString() {} /** * Implements Serializable. * * @param string $serialized The serialized message body. */ public function unserialize($serialized) {} } /** * The parser which is underlying http\Message. * * ***NOTE:*** * This class was added in v2.2.0. */ class Parser { /** * Finish up parser at end of (incomplete) input. */ public const CLEANUP = 1; /** * Soak up the rest of input if no entity length is deducible. */ public const DUMB_BODIES = 2; /** * Redirect messages do not contain any body despite of indication of such. */ public const EMPTY_REDIRECTS = 4; /** * Continue parsing while input is available. */ public const GREEDY = 8; /** * Parse failure. */ public const STATE_FAILURE = -1; /** * Expecting HTTP info (request/response line) or headers. */ public const STATE_START = 0; /** * Parsing headers. */ public const STATE_HEADER = 1; /** * Completed parsing headers. */ public const STATE_HEADER_DONE = 2; /** * Parsing the body. */ public const STATE_BODY = 3; /** * Soaking up all input as body. */ public const STATE_BODY_DUMB = 4; /** * Reading body as indicated by `Content-Length` or `Content-Range`. */ public const STATE_BODY_LENGTH = 5; /** * Parsing `chunked` encoded body. */ public const STATE_BODY_CHUNKED = 6; /** * Finished parsing the body. */ public const STATE_BODY_DONE = 7; /** * Updating Content-Length based on body size. */ public const STATE_UPDATE_CL = 8; /** * Finished parsing the message. * * ***NOTE:*** * Most of this states won't be returned to the user, because the parser immediately jumps to the next expected state. */ public const STATE_DONE = 9; /** * Retrieve the current state of the parser. * See http\Message\Parser::STATE_* constants. * * @throws \http\Exception\InvalidArgumentException * @return int http\Message\Parser::STATE_* constant. */ public function getState() {} /** * Parse a string. * * @param string $data The (part of the) message to parse. * @param int $flags Any combination of [parser flags](http/Message/Parser#Parser.flags:). * @param \http\Message $message The current state of the message parsed. * @throws \http\Exception\InvalidArgumentException * @return int http\Message\Parser::STATE_* constant. */ public function parse(string $data, int $flags, http\Message $message) {} /** * Parse a stream. * * @param resource $stream The message stream to parse from. * @param int $flags Any combination of [parser flags](http/Message/Parser#Parser.flags:). * @param \http\Message $message The current state of the message parsed. * @throws \http\Exception\InvalidArgumentException * @throws \http\Exception\UnexpectedValueException * @return int http\Message\Parser::STATE_* constant. */ public function stream($stream, int $flags, http\Message $message) {} }

Es la eliminación del sarro y la placa adherida a la superficie de los dientes mediante un equipo de ultrasonidos que garantiza la integridad de las piezas dentales a la vez que elimina en profundidad cualquier resto de suciedad.

A continuación se procede al pulido de los dientes mediante una fresa especial que elimina la placa bacteriana y devuelve a los dientes el aspecto sano que deben tener.

Una vez terminado todo el proceso, se mantiene al perro en observación hasta que se despierta de la anestesia, bajo la atenta supervisión de un veterinario.

¿Cada cuánto tiempo tengo que hacerle una limpieza dental a mi perro?

A partir de cierta edad, los perros pueden necesitar una limpieza dental anual o bianual. Depende de cada caso. En líneas generales, puede decirse que los perros de razas pequeñas suelen acumular más sarro y suelen necesitar una atención mayor en cuanto a higiene dental.

Riesgos de una mala higiene

Los riesgos más evidentes de una mala higiene dental en los perros son los siguientes:

Cuando la acumulación de sarro no se trata, se puede producir una inflamación y retracción de las encías que puede descalzar el diente y provocar caídas.
Mal aliento (halitosis).
Sarro perros
Puede ir a más
Las bacterias de la placa pueden trasladarse a través del torrente circulatorio a órganos vitales como el corazón ocasionando problemas de endocarditis en las válvulas. Las bacterias pueden incluso acantonarse en huesos (La osteomielitis es la infección ósea, tanto cortical como medular) provocando mucho dolor y una artritis séptica).

¿Cómo se forma el sarro?

El sarro es la calcificación de la placa dental. Los restos de alimentos, junto con las bacterias presentes en la boca, van a formar la placa bacteriana o placa dental. Si la placa no se retira, al mezclarse con la saliva y los minerales presentes en ella, reaccionará formando una costra. La placa se calcifica y se forma el sarro.

El sarro, cuando se forma, es de color blanquecino pero a medida que pasa el tiempo se va poniendo amarillo y luego marrón.

Síntomas de una pobre higiene dental
La señal más obvia de una mala salud dental canina es el mal aliento.

Sin embargo, a veces no es tan fácil de detectar
Y hay perros que no se dejan abrir la boca por su dueño. Por ejemplo…

Recientemente nos trajeron a la clínica a un perro que parpadeaba de un ojo y decía su dueño que le picaba un lado de la cara. Tenía molestias y dificultad para comer, lo que había llevado a sus dueños a comprarle comida blanda (que suele ser un poco más cara y llevar más contenido en grasa) durante medio año. Después de una exploración oftalmológica, nos dimos cuenta de que el ojo tenía una úlcera en la córnea probablemente de rascarse . Además, el canto lateral del ojo estaba inflamado. Tenía lo que en humanos llamamos flemón pero como era un perro de pelo largo, no se le notaba a simple vista. Al abrirle la boca nos llamó la atención el ver una muela llena de sarro. Le realizamos una radiografía y encontramos una fístula que llegaba hasta la parte inferior del ojo.

Le tuvimos que extraer la muela. Tras esto, el ojo se curó completamente con unos colirios y una lentilla protectora de úlcera. Afortunadamente, la úlcera no profundizó y no perforó el ojo. Ahora el perro come perfectamente a pesar de haber perdido una muela.

¿Cómo mantener la higiene dental de tu perro?
Hay varias maneras de prevenir problemas derivados de la salud dental de tu perro.

Limpiezas de dientes en casa
Es recomendable limpiar los dientes de tu perro semanal o diariamente si se puede. Existe una gran variedad de productos que se pueden utilizar:

Pastas de dientes.
Cepillos de dientes o dedales para el dedo índice, que hacen más fácil la limpieza.
Colutorios para echar en agua de bebida o directamente sobre el diente en líquido o en spray.

En la Clínica Tus Veterinarios enseñamos a nuestros clientes a tomar el hábito de limpiar los dientes de sus perros desde que son cachorros. Esto responde a nuestro compromiso con la prevención de enfermedades caninas.

Hoy en día tenemos muchos clientes que limpian los dientes todos los días a su mascota, y como resultado, se ahorran el dinero de hacer limpiezas dentales profesionales y consiguen una mejor salud de su perro.

Limpiezas dentales profesionales de perros y gatos

Recomendamos hacer una limpieza dental especializada anualmente. La realizamos con un aparato de ultrasonidos que utiliza agua para quitar el sarro. Después, procedemos a pulir los dientes con un cepillo de alta velocidad y una pasta especial. Hacemos esto para proteger el esmalte.

La frecuencia de limpiezas dentales necesaria varía mucho entre razas. En general, las razas grandes tienen buena calidad de esmalte, por lo que no necesitan hacerlo tan a menudo e incluso pueden pasarse la vida sin requerir una limpieza. Sin embargo, razas pequeñas como el Yorkshire o el Maltés, deben hacérselas todos los años desde cachorros si se quiere conservar sus piezas dentales.

Otro factor fundamental es la calidad del pienso. Algunas marcas han diseñado croquetas que limpian la superficie del diente y de la muela al masticarse.

Ultrasonido para perros

¿Se necesita anestesia para las limpiezas dentales de perros y gatos?

La limpieza dental en perros no es una técnica que pueda practicarse sin anestesia general , aunque hay veces que los propietarios no quieren anestesiar y si tiene poco sarro y el perro es muy bueno se puede intentar…… , pero no se va a poder pulir ni acceder a todas la zona de la boca …. Además los limpiadores dentales van a irrigar agua y hay riesgo de aspiración a vías respiratorias si no se realiza una anestesia correcta con intubación traqueal . En resumen , sin anestesia no se va hacer una correcta limpieza dental.

Tampoco sirve la sedación ya que necesitamos que el animal esté totalmente quieto, y el veterinario tenga un acceso completo a todas sus piezas dentales y encías.

Alimentos para la limpieza dental

Hay que tener cierto cuidado a la hora de comprar determinados alimentos porque no todos son saludables. Algunos tienen demasiado contenido graso, que en exceso puede causar problemas cardiovasculares y obesidad.

Los mejores alimentos para los dientes son aquellos que están elaborados por empresas farmacéuticas y llevan componentes químicos con tratamientos específicos para el diente del perro. Esto implica no solo limpieza a través de la acción mecánica de morder sino también un tratamiento antibacteriano para prevenir el sarro.

Conclusión

Si eres como la mayoría de dueños, por falta de tiempo , es probable que no estés prestando la suficiente atención a la limpieza dental de tu perro. Por eso te animamos a que comiences a limpiar los dientes de tu perro y consideres atender a su higiene bucal con frecuencia.

Estas simples medidas pueden conllevar a que tu perro tenga una vida más larga y mucho más saludable.

Si te resulta imposible introducir un cepillo de dientes a tu perro en la boca, pásate con él por clínica Tus Veterinarios y te explicamos cómo hacerlo.

Necesitas hacer una limpieza dental profesional a tu mascota?
Llámanos al 622575274 o contacta con nosotros

¿Cada cuánto tiempo tengo que hacerle una limpieza dental a mi perro?

Riesgos de una mala higiene

¿Cómo se forma el sarro?

Limpiezas dentales profesionales de perros y gatos

Ultrasonido para perros

Alimentos para la limpieza dental

Conclusión

Deja un comentario Cancelar respuesta

Entradas recientes

Horarios

Donde estamos

Síguenos