Inheritance diagram for Zend_Http_Client:

Public Member Functions
	__construct ($uri=null, $config=null)

	setUri ($uri)

	getUri ($as_string=false)

	setConfig ($config=array())

	setMethod ($method=self::GET)

	setHeaders ($name, $value=null)

	getHeader ($key)

	setParameterGet ($name, $value=null)

	setParameterPost ($name, $value=null)

	getRedirectionsCount ()

	setAuth ($user, $password='', $type=self::AUTH_BASIC)

	setCookieJar ($cookiejar=true)

	getCookieJar ()

	setCookie ($cookie, $value=null)

	setFileUpload ($filename, $formname, $data=null, $ctype=null)

	setEncType ($enctype=self::ENC_URLENCODED)

	setRawData ($data, $enctype=null)

	setUnmaskStatus ($status=true)

	getUnmaskStatus ()

	resetParameters ($clearAll=false)

	getLastRequest ()

	getLastResponse ()

	setAdapter ($adapter)

	getAdapter ()

	setStream ($streamfile=true)

	getStream ()

	request ($method=null)

Static Public Member Functions
static	encodeFormData ($boundary, $name, $value, $filename=null, $headers=array())

static	encodeAuthHeader ($user, $password, $type=self::AUTH_BASIC)

Data Fields
const	GET = 'GET'

const	POST = 'POST'

const	PUT = 'PUT'

const	HEAD = 'HEAD'

const	DELETE = 'DELETE'

const	TRACE = 'TRACE'

const	OPTIONS = 'OPTIONS'

const	CONNECT = 'CONNECT'

const	MERGE = 'MERGE'

const	PATCH = 'PATCH'

const	AUTH_BASIC = 'basic'

const	HTTP_1 = '1.1'

const	HTTP_0 = '1.0'

const	CONTENT_TYPE = 'Content-Type'

const	CONTENT_LENGTH = 'Content-Length'

const	ENC_URLENCODED = 'application/x-www-form-urlencoded'

const	ENC_FORMDATA = 'multipart/form-data'

const	VTYPE_SCALAR = 'SCALAR'

const	VTYPE_FILE = 'FILE'

Protected Member Functions
	_setParameter ($type, $name, $value)

	_openTempStream ()

	_prepareHeaders ()

	_prepareBody ()

	_getParametersRecursive ($parray, $urlencode=false)

	_detectFileMimeType ($file)

	_validateHeaderValue ($value, $recurse=true)

Static Protected Member Functions
static	_flattenParametersArray ($parray, $prefix=null)

Protected Attributes
	$config

	$adapter = null

	$uri = null

	$headers = array()

	$method = self::GET

	$paramsGet = array()

	$paramsPost = array()

	$enctype = null

	$raw_post_data = null

	$auth

	$files = array()

	$body_field_order = array()

	$cookiejar = null

	$last_request = null

	$last_response = null

	$redirectCounter = 0

	$_unmaskStatus = false

	$_queryBracketsEscaped = true

Static Protected Attributes
static	$_fileInfoDb = null

Detailed Description

Definition at line 72 of file Client.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$uri = `null`,
		$config = `null`
	)

Constructor method. Will create a new HTTP client. Accepts the target URL and optionally configuration array.

Parameters

Zend_Uri_Http \| string	$uri
array	$config	Configuration key-value pairs.

Definition at line 287 of file Client.php.

     {
         if ($uri !== null) {
             $this->setUri($uri);
         }
         if ($config !== null) {
             $this->setConfig($config);
         }
 
         $this->_queryBracketsEscaped = version_compare(phpversion(), '5.1.3', '>=');
     }

Member Function Documentation

◆ _detectFileMimeType()

_detectFileMimeType ( $file )

protected

Attempt to detect the MIME type of a file using available extensions

This method will try to detect the MIME type of a file. If the fileinfo extension is available, it will be used. If not, the mime_magic extension which is deprected but is still available in many PHP setups will be tried.

If neither extension is available, the default application/octet-stream MIME type will be returned

Parameters

string $file File path

Returns: string MIME type

Definition at line 1435 of file Client.php.

     {
         $type = null;
 
         // First try with fileinfo functions
         if (function_exists('finfo_open')) {
             if (self::$_fileInfoDb === null) {
                 self::$_fileInfoDb = @finfo_open(FILEINFO_MIME);
             }
 
             if (self::$_fileInfoDb) {
                 $type = finfo_file(self::$_fileInfoDb, $file);
             }
 
         } elseif (function_exists('mime_content_type')) {
             $type = mime_content_type($file);
         }
 
         // Fallback to the default application/octet-stream
         if (! $type) {
             $type = 'application/octet-stream';
         }
 
         return $type;
     }

◆ _flattenParametersArray()

static _flattenParametersArray	(	$parray,
		$prefix = `null`
	)

staticprotected

Convert an array of parameters into a flat array of (key, value) pairs

Will flatten a potentially multi-dimentional array of parameters (such as POST parameters) into a flat array of (key, value) paris. In case of multi-dimentional arrays, square brackets ([]) will be added to the key to indicate an array.

Since: 1.9

Parameters

array	$parray
string	$prefix

Returns: array

Definition at line 1547 of file Client.php.

     {
         if (! is_array($parray)) {
             return $parray;
         }
 
         $parameters = array();
 
         foreach($parray as $name => $value) {
 
             // Calculate array key
             if ($prefix) {
                 if (is_int($name)) {
                     $key = $prefix . '[]';
                 } else {
                     $key = $prefix . "[$name]";
                 }
             } else {
                 $key = $name;
             }
 
             if (is_array($value)) {
                 $parameters = array_merge($parameters, self::_flattenParametersArray($value, $key));
 
             } else {
                 $parameters[] = array($key, $value);
             }
         }
 
         return $parameters;
     }

◆ _getParametersRecursive()

_getParametersRecursive	(	$parray,
		$urlencode = `false`
	)

protected

Helper method that gets a possibly multi-level parameters array (get or post) and flattens it.

The method returns an array of (key, value) pairs (because keys are not necessarily unique. If one of the parameters in as array, it will also add a [] suffix to the key.

This method is deprecated since Zend Framework 1.9 in favour of self::_flattenParametersArray() and will be dropped in 2.0

Deprecated:: since 1.9

Parameters

array	$parray	The parameters array
bool	$urlencode	Whether to urlencode the name and value

Returns: array

Definition at line 1385 of file Client.php.

     {
         // Issue a deprecated notice
         trigger_error("The " .  __METHOD__ . " method is deprecated and will be dropped in 2.0.",
             E_USER_NOTICE);
 
         if (! is_array($parray)) {
             return $parray;
         }
         $parameters = array();
 
         foreach ($parray as $name => $value) {
             if ($urlencode) {
                 $name = urlencode($name);
             }
 
             // If $value is an array, iterate over it
             if (is_array($value)) {
                 $name .= ($urlencode ? '%5B%5D' : '[]');
                 foreach ($value as $subval) {
                     if ($urlencode) {
                         $subval = urlencode($subval);
                     }
                     $parameters[] = array($name, $subval);
                 }
             } else {
                 if ($urlencode) {
                     $value = urlencode($value);
                 }
                 $parameters[] = array($name, $value);
             }
         }
 
         return $parameters;
     }

◆ _openTempStream()

_openTempStream ( )

protected

Create temporary stream

Returns: resource

Definition at line 989 of file Client.php.

     {
         $this->_stream_name = $this->config['output_stream'];
         if(!is_string($this->_stream_name)) {
             // If name is not given, create temp name
             $this->_stream_name = tempnam(isset($this->config['stream_tmp_dir'])?$this->config['stream_tmp_dir']:sys_get_temp_dir(),
                  'Zend_Http_Client');
         }
 
         if (false === ($fp = @fopen($this->_stream_name, "w+b"))) {
                 if ($this->adapter instanceof Zend_Http_Client_Adapter_Interface) {
                     $this->adapter->close();
                 }
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception("Could not open temp file {$this->_stream_name}");
         }
 
         return $fp;
     }

◆ _prepareBody()

_prepareBody ( )

protected

Prepare the request body (for POST and PUT requests)

Returns: string

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 1264 of file Client.php.

     {
         // According to RFC2616, a TRACE request should not have a body.
         if ($this->method == self::TRACE) {
             return '';
         }
 
         if (isset($this->raw_post_data) && is_resource($this->raw_post_data)) {
             return $this->raw_post_data;
         }
         // If mbstring overloads substr and strlen functions, we have to
         // override it's internal encoding
         if (function_exists('mb_internal_encoding') &&
            ((int) ini_get('mbstring.func_overload')) & 2) {
 
             $mbIntEnc = mb_internal_encoding();
             mb_internal_encoding('ASCII');
         }
 
         // If we have raw_post_data set, just use it as the body.
         if (isset($this->raw_post_data)) {
             $this->setHeaders(self::CONTENT_LENGTH, strlen($this->raw_post_data));
             if (isset($mbIntEnc)) {
                 mb_internal_encoding($mbIntEnc);
             }
 
             return $this->raw_post_data;
         }
 
         $body = '';
 
         // If we have files to upload, force enctype to multipart/form-data
         if (count ($this->files) > 0) {
             $this->setEncType(self::ENC_FORMDATA);
         }
 
         // If we have POST parameters or files, encode and add them to the body
         if (count($this->paramsPost) > 0 || count($this->files) > 0) {
             switch($this->enctype) {
                 case self::ENC_FORMDATA:
                     // Encode body as multipart/form-data
                     $boundary = '---ZENDHTTPCLIENT-' . md5(microtime());
                     $this->setHeaders(self::CONTENT_TYPE, self::ENC_FORMDATA . "; boundary={$boundary}");
 
                     // Encode all files and POST vars in the order they were given
                     foreach ($this->body_field_order as $fieldName=>$fieldType) {
                         switch ($fieldType) {
                             case self::VTYPE_FILE:
                                 foreach ($this->files as $file) {
                                     if ($file['formname']===$fieldName) {
                                         $fhead = array(self::CONTENT_TYPE => $file['ctype']);
                                         $body .= self::encodeFormData($boundary, $file['formname'], $file['data'], $file['filename'], $fhead);
                                     }
                                 }
                                 break;
                             case self::VTYPE_SCALAR:
                                 if (isset($this->paramsPost[$fieldName])) {
                                     if (is_array($this->paramsPost[$fieldName])) {
                                         $flattened = self::_flattenParametersArray($this->paramsPost[$fieldName], $fieldName);
                                         foreach ($flattened as $pp) {
                                             $body .= self::encodeFormData($boundary, $pp[0], $pp[1]);
                                         }
                                     } else {
                                         $body .= self::encodeFormData($boundary, $fieldName, $this->paramsPost[$fieldName]);
                                     }
                                 }
                                 break;
                         }
                     }
 
                     $body .= "--{$boundary}--\r\n";
                     break;
 
                 case self::ENC_URLENCODED:
                     // Encode body as application/x-www-form-urlencoded
                     $this->setHeaders(self::CONTENT_TYPE, self::ENC_URLENCODED);
                     $body = http_build_query($this->paramsPost, '', '&');
                     break;
 
                 default:
                     if (isset($mbIntEnc)) {
                         mb_internal_encoding($mbIntEnc);
                     }
 
                     #require_once 'Zend/Http/Client/Exception.php';
                     throw new Zend_Http_Client_Exception("Cannot handle content type '{$this->enctype}' automatically." .
                         " Please use Zend_Http_Client::setRawData to send this kind of content.");
                     break;
             }
         }
 
         // Set the Content-Length if we have a body or if request is POST/PUT
         if ($body || $this->method == self::POST || $this->method == self::PUT) {
             $this->setHeaders(self::CONTENT_LENGTH, strlen($body));
         }
 
         if (isset($mbIntEnc)) {
             mb_internal_encoding($mbIntEnc);
         }
 
         return $body;
     }

◆ _prepareHeaders()

_prepareHeaders ( )

protected

Prepare the request headers

Returns: array

Definition at line 1183 of file Client.php.

     {
         $headers = array();
 
         // Set the host header
         if (! isset($this->headers['host'])) {
             $host = $this->uri->getHost();
 
             // If the port is not default, add it
             if (! (($this->uri->getScheme() == 'http' && $this->uri->getPort() == 80) ||
                   ($this->uri->getScheme() == 'https' && $this->uri->getPort() == 443))) {
                 $host .= ':' . $this->uri->getPort();
             }
 
             $headers[] = "Host: {$host}";
         }
 
         // Set the connection header
         if (! isset($this->headers['connection'])) {
             if (! $this->config['keepalive']) {
                 $headers[] = "Connection: close";
             }
         }
 
         // Set the Accept-encoding header if not set - depending on whether
         // zlib is available or not.
         if (! isset($this->headers['accept-encoding'])) {
             if (function_exists('gzinflate')) {
                 $headers[] = 'Accept-encoding: gzip, deflate';
             } else {
                 $headers[] = 'Accept-encoding: identity';
             }
         }
 
         // Set the Content-Type header
         if (($this->method == self::POST || $this->method == self::PUT) &&
            (! isset($this->headers[strtolower(self::CONTENT_TYPE)]) && isset($this->enctype))) {
 
             $headers[] = self::CONTENT_TYPE . ': ' . $this->enctype;
         }
 
         // Set the user agent header
         if (! isset($this->headers['user-agent']) && isset($this->config['useragent'])) {
             $headers[] = "User-Agent: {$this->config['useragent']}";
         }
 
         // Set HTTP authentication if needed
         if (is_array($this->auth)) {
             $auth = self::encodeAuthHeader($this->auth['user'], $this->auth['password'], $this->auth['type']);
             $headers[] = "Authorization: {$auth}";
         }
 
         // Load cookies from cookie jar
         if (isset($this->cookiejar)) {
             $cookstr = $this->cookiejar->getMatchingCookies($this->uri,
                 true, Zend_Http_CookieJar::COOKIE_STRING_CONCAT);
 
             if ($cookstr) {
                 $headers[] = "Cookie: {$cookstr}";
             }
         }
 
         // Add all other user defined headers
         foreach ($this->headers as $header) {
             list($name, $value) = $header;
             if (is_array($value)) {
                 $value = implode(', ', $value);
             }
 
             $headers[] = "$name: $value";
         }
 
         return $headers;
     }

◆ _setParameter()

_setParameter	(	$type,
		$name,
		$value
	)

protected

Set a GET or POST parameter - used by SetParameterGet and SetParameterPost

Parameters

string	$type	GET or POST
string	$name
string	$value

Returns: null

Definition at line 543 of file Client.php.

     {
         $parray = array();
         $type = strtolower($type);
         switch ($type) {
             case 'get':
                 $parray = &$this->paramsGet;
                 break;
             case 'post':
                 $parray = &$this->paramsPost;
                 if ( $value === null ) {
                     if (isset($this->body_field_order[$name]))
                         unset($this->body_field_order[$name]);
                 } else {
                     $this->body_field_order[$name] = self::VTYPE_SCALAR;
                 }
                 break;
         }
 
         if ($value === null) {
             if (isset($parray[$name])) unset($parray[$name]);
         } else {
             $parray[$name] = $value;
         }
     }

◆ _validateHeaderValue()

_validateHeaderValue	(	$value,
		$recurse = `true`
	)

protected

Ensure a header value is valid per RFC 7230.

See also: http://tools.ietf.org/html/rfc7230#section-3.2

Parameters

string \| object \| array	$value
bool	$recurse

Definition at line 1586 of file Client.php.

     {
         if (is_array($value) && $recurse) {
             foreach ($value as $v) {
                 $this->_validateHeaderValue($v, false);
             }
             return;
         }
 
         // Cast integers and floats to strings for purposes of header representation.
         if (is_int($value) || is_float($value)) {
             $value = (string) $value;
         }
 
         if (! is_string($value) && (! is_object($value) || ! method_exists($value, '__toString'))) {
             #require_once 'Zend/Http/Exception.php';
             throw new Zend_Http_Exception('Invalid header value detected');
         }
 
         Zend_Http_Header_HeaderValue::assertValid($value);
     }

◆ encodeAuthHeader()

static encodeAuthHeader	(	$user,
		$password,
		$type = `self::AUTH_BASIC`
	)

static

Create a HTTP authentication "Authorization:" header according to the specified user, password and authentication method.

See also: http://www.faqs.org/rfcs/rfc2617.html

Parameters

string	$user
string	$password
string	$type

Returns: string

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Todo:: Implement digest authentication

See also: Zend_Http_Client_Exception

Definition at line 1502 of file Client.php.

     {
         $authHeader = null;
 
         switch ($type) {
             case self::AUTH_BASIC:
                 // In basic authentication, the user name cannot contain ":"
                 if (strpos($user, ':') !== false) {
                     #require_once 'Zend/Http/Client/Exception.php';
                     throw new Zend_Http_Client_Exception("The user name cannot contain ':' in 'Basic' HTTP authentication");
                 }
 
                 $authHeader = 'Basic ' . base64_encode($user . ':' . $password);
                 break;
 
             //case self::AUTH_DIGEST:
             //    break;
 
             default:
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception("Not a supported HTTP authentication type: '$type'");
         }
 
         return $authHeader;
     }

◆ encodeFormData()

static encodeFormData	(	$boundary,
		$name,
		$value,
		$filename = `null`,
		$headers = `array()`
	)

static

Definition at line 1471 of file Client.php.

     {
         $ret = "--{$boundary}\r\n" .
             'Content-Disposition: form-data; name="' . $name .'"';
 
         if ($filename) {
             $ret .= '; filename="' . $filename . '"';
         }
         $ret .= "\r\n";
 
         foreach ($headers as $hname => $hvalue) {
             $ret .= "{$hname}: {$hvalue}\r\n";
         }
         $ret .= "\r\n";
 
         $ret .= "{$value}\r\n";
 
         return $ret;
     }

◆ getAdapter()

getAdapter ( )

Load the connection adapter

Returns: Zend_Http_Client_Adapter_Interface $adapter

Definition at line 954 of file Client.php.

     {
         if (null === $this->adapter) {
             $this->setAdapter($this->config['adapter']);
         }
 
         return $this->adapter;
     }

◆ getCookieJar()

getCookieJar ( )

Return the current cookie jar or null if none.

Returns: Zend_Http_CookieJar|null

Definition at line 666 of file Client.php.

     {
         return $this->cookiejar;
     }

◆ getHeader()

getHeader ( $key )

Get the value of a specific header

Note that if the header has more than one value, an array will be returned.

Parameters

string $key

Returns: string|array|null The header value or null if it is not set

Definition at line 487 of file Client.php.

     {
         $key = strtolower($key);
         if (isset($this->headers[$key])) {
             return $this->headers[$key][1];
         } else {
             return null;
         }
     }

◆ getLastRequest()

getLastRequest ( )

Get the last HTTP request as string

Returns: string

Definition at line 895 of file Client.php.

     {
         return $this->last_request;
     }

◆ getLastResponse()

getLastResponse ( )

Get the last HTTP response received by this client

If $config['storeresponse'] is set to false, or no response was stored yet, will return null

Returns: Zend_Http_Response or null if none

Definition at line 908 of file Client.php.

     {
         return $this->last_response;
     }

◆ getRedirectionsCount()

getRedirectionsCount ( )

Get the number of redirections done on the last request

Returns: int

Definition at line 574 of file Client.php.

     {
         return $this->redirectCounter;
     }

◆ getStream()

getStream ( )

Get status of streaming for received data

Returns: boolean|string

Definition at line 979 of file Client.php.

     {
         return $this->config["output_stream"];
     }

◆ getUnmaskStatus()

getUnmaskStatus ( )

Returns the currently configured unmask status

Returns: boolean

Definition at line 847 of file Client.php.

     {
         return $this->_unmaskStatus;
     }

◆ getUri()

getUri ( $as_string = false )

Get the URI for the next request

Parameters

boolean $as_string If true, will return the URI as a string

Returns: Zend_Uri_Http|string

Definition at line 342 of file Client.php.

     {
         if ($as_string && $this->uri instanceof Zend_Uri_Http) {
             return $this->uri->__toString();
         } else {
             return $this->uri;
         }
     }

◆ request()

request ( $method = null )

Send the HTTP request and return an HTTP response object

Parameters

string $method

Returns: Zend_Http_Response

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception; Zend_Http_Client_Exception; Zend_Http_Client_Exception; Zend_Http_Client_Exception

Definition at line 1016 of file Client.php.

     {
         if (! $this->uri instanceof Zend_Uri_Http) {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception('No valid URI has been passed to the client');
         }
 
         if ($method) {
             $this->setMethod($method);
         }
         $this->redirectCounter = 0;
         $response = null;
 
         // Make sure the adapter is loaded
         if ($this->adapter == null) {
             $this->setAdapter($this->config['adapter']);
         }
 
         // Send the first request. If redirected, continue.
         do {
             // Clone the URI and add the additional GET parameters to it
             $uri = clone $this->uri;
             if (! empty($this->paramsGet)) {
                 $query = $uri->getQuery();
                    if (! empty($query)) {
                        $query .= '&';
                    }
                 $query .= http_build_query($this->paramsGet, null, '&');
                 if ($this->config['rfc3986_strict']) {
                     $query = str_replace('+', '%20', $query);
                 }
 
                 // @see ZF-11671 to unmask for some services to foo=val1&foo=val2
                 if ($this->getUnmaskStatus()) {
                     if ($this->_queryBracketsEscaped) {
                         $query = preg_replace('/%5B(?:[0-9]|[1-9][0-9]+)%5D=/', '=', $query);
                     } else {
                         $query = preg_replace('/\\[(?:[0-9]|[1-9][0-9]+)\\]=/', '=', $query);
                     }
                 }
 
                 $uri->setQuery($query);
             }
 
             $body = $this->_prepareBody();
             $headers = $this->_prepareHeaders();
 
             // check that adapter supports streaming before using it
             if(is_resource($body) && !($this->adapter instanceof Zend_Http_Client_Adapter_Stream)) {
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception('Adapter does not support streaming');
             }
 
             // Open the connection, send the request and read the response
             $this->adapter->connect($uri->getHost(), $uri->getPort(),
                 ($uri->getScheme() == 'https' ? true : false));
 
             if($this->config['output_stream']) {
                 if($this->adapter instanceof Zend_Http_Client_Adapter_Stream) {
                     $stream = $this->_openTempStream();
                     $this->adapter->setOutputStream($stream);
                 } else {
                     #require_once 'Zend/Http/Client/Exception.php';
                     throw new Zend_Http_Client_Exception('Adapter does not support streaming');
                 }
             }
 
             $this->last_request = $this->adapter->write($this->method,
                 $uri, $this->config['httpversion'], $headers, $body);
 
             $response = $this->adapter->read();
             if (! $response) {
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception('Unable to read response, or response is empty');
             }
 
             if($this->config['output_stream']) {
                 $streamMetaData = stream_get_meta_data($stream);
                 if ($streamMetaData['seekable']) {
                     rewind($stream);
                 }
                 // cleanup the adapter
                 $this->adapter->setOutputStream(null);
                 $response = Zend_Http_Response_Stream::fromStream($response, $stream);
                 $response->setStreamName($this->_stream_name);
                 if(!is_string($this->config['output_stream'])) {
                     // we used temp name, will need to clean up
                     $response->setCleanup(true);
                 }
             } else {
                 $response = Zend_Http_Response::fromString($response);
             }
 
             if ($this->config['storeresponse']) {
                 $this->last_response = $response;
             }
 
             // Load cookies into cookie jar
             if (isset($this->cookiejar)) {
                 $this->cookiejar->addCookiesFromResponse($response, $uri, $this->config['encodecookies']);
             }
 
             // If we got redirected, look for the Location header
             if ($response->isRedirect() && ($location = $response->getHeader('location'))) {
 
                 // Avoid problems with buggy servers that add whitespace at the
                 // end of some headers (See ZF-11283)
                 $location = trim($location);
 
                 // Check whether we send the exact same request again, or drop the parameters
                 // and send a GET request
                 if ($response->getStatus() == 303 ||
                    ((! $this->config['strictredirects']) && ($response->getStatus() == 302 ||
                        $response->getStatus() == 301))) {
 
                     $this->resetParameters();
                     $this->setMethod(self::GET);
                 }
 
                 // If we got a well formed absolute URI
                 if (($scheme = substr($location, 0, 6)) && ($scheme == 'http:/' || $scheme == 'https:')) {
                     $this->setHeaders('host', null);
                     $this->setUri($location);
 
                 } else {
 
                     // Split into path and query and set the query
                     if (strpos($location, '?') !== false) {
                         list($location, $query) = explode('?', $location, 2);
                     } else {
                         $query = '';
                     }
                     $this->uri->setQuery($query);
 
                     // Else, if we got just an absolute path, set it
                     if(strpos($location, '/') === 0) {
                         $this->uri->setPath($location);
 
                         // Else, assume we have a relative path
                     } else {
                         // Get the current path directory, removing any trailing slashes
                         $path = $this->uri->getPath();
                         $path = rtrim(substr($path, 0, strrpos($path, '/')), "/");
                         $this->uri->setPath($path . '/' . $location);
                     }
                 }
                 ++$this->redirectCounter;
 
             } else {
                 // If we didn't get any location, stop redirecting
                 break;
             }
 
         } while ($this->redirectCounter < $this->config['maxredirects']);
 
         return $response;
     }

◆ resetParameters()

resetParameters ( $clearAll = false )

Clear all GET and POST parameters

Should be used to reset the request parameters if the client is used for several concurrent requests.

clearAll parameter controls if we clean just parameters or also headers and last_*

Parameters

bool $clearAll Should all data be cleared?

Returns: Zend_Http_Client

Definition at line 864 of file Client.php.

     {
         // Reset parameter data
         $this->paramsGet     = array();
         $this->paramsPost    = array();
         $this->files         = array();
         $this->raw_post_data = null;
         $this->enctype       = null;
 
         if($clearAll) {
             $this->headers = array();
             $this->last_request = null;
             $this->last_response = null;
         } else {
             // Clear outdated headers
             if (isset($this->headers[strtolower(self::CONTENT_TYPE)])) {
                 unset($this->headers[strtolower(self::CONTENT_TYPE)]);
             }
             if (isset($this->headers[strtolower(self::CONTENT_LENGTH)])) {
                 unset($this->headers[strtolower(self::CONTENT_LENGTH)]);
             }
         }
 
         return $this;
     }

◆ setAdapter()

setAdapter ( $adapter )

Load the connection adapter

While this method is not called more than one for a client, it is seperated from ->request() to preserve logic and readability

Parameters

Zend_Http_Client_Adapter_Interface | string $adapter

Returns: null

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception; Zend_Http_Client_Exception

Definition at line 923 of file Client.php.

     {
         if (is_string($adapter)) {
             try {
                 Zend_Loader::loadClass($adapter);
             } catch (Zend_Exception $e) {
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception("Unable to load adapter '$adapter': {$e->getMessage()}", 0, $e);
             }
 
             $adapter = new $adapter;
         }
 
         if (! $adapter instanceof Zend_Http_Client_Adapter_Interface) {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception('Passed adapter is not a HTTP connection adapter');
         }
 
         $this->adapter = $adapter;
         $config = $this->config;
         unset($config['adapter']);
         $this->adapter->setConfig($config);
     }

◆ setAuth()

setAuth	(	$user,
		$password = `''`,
		$type = `self::AUTH_BASIC`
	)

Set HTTP authentication parameters

$type should be one of the supported types - see the self::AUTH_* constants.

To enable authentication: $this->setAuth('shahar', 'secret', Zend_Http_Client::AUTH_BASIC);

To disable authentication: $this->setAuth(false);

See also: http://www.faqs.org/rfcs/rfc2617.html

Parameters

string \| false	$user	User name or false disable authentication
string	$password	Password
string	$type	Authentication type

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 602 of file Client.php.

     {
         // If we got false or null, disable authentication
         if ($user === false || $user === null) {
             $this->auth = null;
 
             // Clear the auth information in the uri instance as well
             if ($this->uri instanceof Zend_Uri_Http) {
                 $this->getUri()->setUsername('');
                 $this->getUri()->setPassword('');
             }
         // Else, set up authentication
         } else {
             // Check we got a proper authentication type
             if (! defined('self::AUTH_' . strtoupper($type))) {
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception("Invalid or not supported authentication type: '$type'");
             }
 
             $this->auth = array(
                 'user' => (string) $user,
                 'password' => (string) $password,
                 'type' => $type
             );
         }
 
         return $this;
     }

◆ setConfig()

setConfig ( $config = array() )

Set configuration parameters for this HTTP client

Parameters

Zend_Config | array $config

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 358 of file Client.php.

     {
         if ($config instanceof Zend_Config) {
             $config = $config->toArray();
 
         } elseif (! is_array($config)) {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception('Array or Zend_Config object expected, got ' . gettype($config));
         }
 
         foreach ($config as $k => $v) {
             $this->config[strtolower($k)] = $v;
         }
 
         // Pass configuration options to the adapter if it exists
         if ($this->adapter instanceof Zend_Http_Client_Adapter_Interface) {
             $this->adapter->setConfig($config);
         }
 
         return $this;
     }

◆ setCookie()

setCookie	(	$cookie,
		$value = `null`
	)

Add a cookie to the request. If the client has no Cookie Jar, the cookies will be added directly to the headers array as "Cookie" headers.

Parameters

Zend_Http_Cookie \| string	$cookie
string \| null	$value	If "cookie" is a string, this is the cookie value.

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 680 of file Client.php.

     {
         Zend_Loader::loadClass('Zend_Http_Cookie');
 
         if (is_array($cookie)) {
             foreach ($cookie as $c => $v) {
                 if (is_string($c)) {
                     $this->setCookie($c, $v);
                 } else {
                     $this->setCookie($v);
                 }
             }
 
             return $this;
         }
 
         if ($value !== null && $this->config['encodecookies']) {
             $value = urlencode($value);
         }
 
         if (isset($this->cookiejar)) {
             if ($cookie instanceof Zend_Http_Cookie) {
                 $this->cookiejar->addCookie($cookie);
             } elseif (is_string($cookie) && $value !== null) {
                 $cookie = Zend_Http_Cookie::fromString("{$cookie}={$value}",
                                                        $this->uri,
                                                        $this->config['encodecookies']);
                 $this->cookiejar->addCookie($cookie);
             }
         } else {
             if ($cookie instanceof Zend_Http_Cookie) {
                 $name = $cookie->getName();
                 $value = $cookie->getValue();
                 $cookie = $name;
             }
 
             if (preg_match("/[=,; \t\r\n\013\014]/", $cookie)) {
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception("Cookie name cannot contain these characters: =,; \t\r\n\013\014 ({$cookie})");
             }
 
             $value = addslashes($value);
 
             if (! isset($this->headers['cookie'])) {
                 $this->headers['cookie'] = array('Cookie', '');
             }
             $this->headers['cookie'][1] .= $cookie . '=' . $value . '; ';
         }
 
         return $this;
     }

◆ setCookieJar()

setCookieJar ( $cookiejar = true )

Set the HTTP client's cookie jar.

A cookie jar is an object that holds and maintains cookies across HTTP requests and responses.

Parameters

Zend_Http_CookieJar | boolean $cookiejar Existing cookiejar object, true to create a new one, false to disable

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 642 of file Client.php.

     {
         Zend_Loader::loadClass('Zend_Http_CookieJar');
 
         if ($cookiejar instanceof Zend_Http_CookieJar) {
             $this->cookiejar = $cookiejar;
         } elseif ($cookiejar === true) {
             $this->cookiejar = new Zend_Http_CookieJar();
         } elseif (! $cookiejar) {
             $this->cookiejar = null;
         } else {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception('Invalid parameter type passed as CookieJar');
         }
 
         return $this;
     }

◆ setEncType()

setEncType ( $enctype = self::ENC_URLENCODED )

Set the encoding type for POST data

Parameters

string $enctype

Returns: Zend_Http_Client

Definition at line 788 of file Client.php.

     {
         $this->enctype = $enctype;
 
         return $this;
     }

◆ setFileUpload()

setFileUpload	(	$filename,
		$formname,
		$data = `null`,
		$ctype = `null`
	)

Set a file to upload (using a POST request)

Can be used in two ways:

$data is null (default): $filename is treated as the name if a local file which will be read and sent. Will try to guess the content type using mime_content_type().
$data is set - $filename is sent as the file name, but $data is sent as the file contents and no file is read from the file system. In this case, you need to manually set the Content-Type ($ctype) or it will default to application/octet-stream.

Parameters

string	$filename	Name of file to upload, or name to save as
string	$formname	Name of form element to send as
string	$data	Data to send (if null, $filename is read and sent)
string	$ctype	Content type to use (if $data is set and $ctype is null, will be application/octet-stream)

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 753 of file Client.php.

     {
         if ($data === null) {
             if (($data = @file_get_contents($filename)) === false) {
                 #require_once 'Zend/Http/Client/Exception.php';
                 throw new Zend_Http_Client_Exception("Unable to read file '{$filename}' for upload");
             }
 
             if (! $ctype) {
                 $ctype = $this->_detectFileMimeType($filename);
             }
         }
 
         // Force enctype to multipart/form-data
         $this->setEncType(self::ENC_FORMDATA);
 
         $this->files[] = array(
             'formname' => $formname,
             'filename' => basename($filename),
             'ctype'    => $ctype,
             'data'     => $data
         );
 
         $this->body_field_order[$formname] = self::VTYPE_FILE;
 
         return $this;
     }

◆ setHeaders()

setHeaders	(	$name,
		$value = `null`
	)

Set one or more request headers

This function can be used in several ways to set the client's request headers:

By providing two parameters: $name as the header to set (e.g. 'Host') and $value as it's value (e.g. 'www.example.com').
By providing a single header string as the only parameter e.g. 'Host: www.example.com'
By providing an array of headers as the first parameter e.g. array('host' => 'www.example.com', 'x-foo: bar'). In This case the function will call itself recursively for each array item.

Parameters

string \| array	$name	Header name, full header string ('Header: value') or an array of headers
mixed	$value	Header value or null

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

Definition at line 433 of file Client.php.

     {
         // If we got an array, go recursive!
         if (is_array($name)) {
             foreach ($name as $k => $v) {
                 if (is_string($k)) {
                     $this->setHeaders($k, $v);
                     continue;
                 }
                 $this->setHeaders($v, null);
             }
             return $this;
         }
 
         // Check if $name needs to be split
         if ($value === null && (strpos($name, ':') > 0)) {
             list($name, $value) = explode(':', $name, 2);
         }
 
         // Make sure the name is valid if we are in strict mode
         if ($this->config['strict'] && (! preg_match('/^[a-zA-Z0-9-]+$/', $name))) {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception("{$name} is not a valid HTTP header name");
         }
 
         $normalized_name = strtolower($name);
 
         // If $value is null or false, unset the header
         if ($value === null || $value === false) {
             unset($this->headers[$normalized_name]);
             return $this;
         }
 
         // Validate value
         $this->_validateHeaderValue($value);
 
         // Header names are stored lowercase internally.
         if (is_string($value)) {
             $value = trim($value);
         }
         $this->headers[$normalized_name] = array($name, $value);
 
         return $this;
     }

◆ setMethod()

setMethod ( $method = self::GET )

Set the next request's method

Validated the passed method and sets it. If we have files set for POST requests, and the new method is not POST, the files are silently dropped.

Parameters

string $method

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

Definition at line 392 of file Client.php.

     {
         if (! preg_match('/^[^\x00-\x1f\x7f-\xff\(\)<>@,;:\\\\"\/\[\]\?={}\s]+$/', $method)) {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception("'{$method}' is not a valid HTTP request method.");
         }
 
         if (($method == self::POST
                 || $method == self::PUT
                 || $method == self::DELETE
                 || $method == self::PATCH
                 || $method == self::OPTIONS)
             && $this->enctype === null
         ) {
             $this->setEncType(self::ENC_URLENCODED);
         }
 
         $this->method = $method;
 
         return $this;
     }

◆ setParameterGet()

setParameterGet	(	$name,
		$value = `null`
	)

Set a GET parameter for the request. Wrapper around _setParameter

Parameters

string \| array	$name
string	$value

Returns: Zend_Http_Client

Definition at line 504 of file Client.php.

     {
         if (is_array($name)) {
             foreach ($name as $k => $v)
                 $this->_setParameter('GET', $k, $v);
         } else {
             $this->_setParameter('GET', $name, $value);
         }
 
         return $this;
     }

◆ setParameterPost()

setParameterPost	(	$name,
		$value = `null`
	)

Set a POST parameter for the request. Wrapper around _setParameter

Parameters

string \| array	$name
string	$value

Returns: Zend_Http_Client

Definition at line 523 of file Client.php.

     {
         if (is_array($name)) {
             foreach ($name as $k => $v)
                 $this->_setParameter('POST', $k, $v);
         } else {
             $this->_setParameter('POST', $name, $value);
         }
 
         return $this;
     }

◆ setRawData()

setRawData	(	$data,
		$enctype = `null`
	)

Set the raw (already encoded) POST data.

This function is here for two reasons:

For advanced user who would like to set their own data, already encoded
For backwards compatibilty: If someone uses the old post($data) method. this method will be used to set the encoded data.

$data can also be stream (such as file) from which the data will be read.

Parameters

string \| resource	$data
string	$enctype

Returns: Zend_Http_Client

Definition at line 809 of file Client.php.

     {
         $this->raw_post_data = $data;
         $this->setEncType($enctype);
         if (is_resource($data)) {
             // We've got stream data
             $stat = @fstat($data);
             if($stat) {
                 $this->setHeaders(self::CONTENT_LENGTH, $stat['size']);
             }
         }
         return $this;
     }

◆ setStream()

setStream ( $streamfile = true )

Set streaming for received data

Parameters

string | boolean $streamfile Stream file, true for temp file, false/null for no streaming

Returns: Zend_Http_Client

Definition at line 969 of file Client.php.

     {
         $this->setConfig(array("output_stream" => $streamfile));
         return $this;
     }

◆ setUnmaskStatus()

setUnmaskStatus ( $status = true )

Set the unmask feature for GET parameters as array

Example: foo%5B0%5D=a&foo%5B1%5D=b becomes foo=a&foo=b

This is usefull for some services

Parameters

boolean $status

Returns: Zend_Http_Client

Definition at line 836 of file Client.php.

     {
         $this->_unmaskStatus = (BOOL)$status;
         return $this;
     }

◆ setUri()

setUri ( $uri )

Set the URI for the next request

Parameters

Zend_Uri_Http | string $uri

Returns: Zend_Http_Client

Exceptions

Zend_Http_Client_Exception

See also: Zend_Http_Client_Exception

Definition at line 306 of file Client.php.

     {
         if ($uri instanceof Zend_Uri_Http) {
             // clone the URI in order to keep the passed parameter constant
             $uri = clone $uri;
         } elseif (is_string($uri)) {
             $uri = Zend_Uri::factory($uri);
         }
 
         if (!$uri instanceof Zend_Uri_Http) {
             #require_once 'Zend/Http/Client/Exception.php';
             throw new Zend_Http_Client_Exception('Passed parameter is not a valid HTTP URI.');
         }
 
         // Set auth if username and password has been specified in the uri
         if ($uri->getUsername() && $uri->getPassword()) {
             $this->setAuth($uri->getUsername(), $uri->getPassword());
         }
 
         // We have no ports, set the defaults
         if (! $uri->getPort()) {
             $uri->setPort(($uri->getScheme() == 'https' ? 443 : 80));
         }
 
         $this->uri = $uri;
 
         return $this;
     }

Field Documentation

◆ $_fileInfoDb

$_fileInfoDb = null

staticprotected

Definition at line 278 of file Client.php.

◆ $_queryBracketsEscaped

$_queryBracketsEscaped = true

protected

Definition at line 268 of file Client.php.

◆ $_unmaskStatus

$_unmaskStatus = false

protected

Definition at line 261 of file Client.php.

◆ $adapter

$adapter = null

protected

Definition at line 143 of file Client.php.

◆ $auth

$auth

protected

Definition at line 206 of file Client.php.

◆ $body_field_order

$body_field_order = array()

protected

Definition at line 226 of file Client.php.

◆ $config

$config

protected

Initial value:

= array(
        'maxredirects'    => 5,
        'strictredirects' => false,
        'useragent'       => 'Zend_Http_Client',
        'timeout'         => 10,
        'adapter'         => 'Zend_Http_Client_Adapter_Socket',
        'httpversion'     => self::HTTP_1,
        'keepalive'       => false,
        'storeresponse'   => true,
        'strict'          => true,
        'output_stream'   => false,
        'encodecookies'   => true,
        'rfc3986_strict'  => false
    )

Definition at line 123 of file Client.php.

◆ $cookiejar

$cookiejar = null

protected

Definition at line 233 of file Client.php.

◆ $enctype

$enctype = null

protected

Definition at line 185 of file Client.php.

◆ $files

$files = array()

protected

Definition at line 216 of file Client.php.

◆ $headers

$headers = array()

protected

Definition at line 157 of file Client.php.

◆ $last_request

$last_request = null

protected

Definition at line 240 of file Client.php.

◆ $last_response

$last_response = null

protected

Definition at line 247 of file Client.php.

◆ $method

$method = self::GET

protected

Definition at line 164 of file Client.php.

◆ $paramsGet

$paramsGet = array()

protected

Definition at line 171 of file Client.php.

◆ $paramsPost

$paramsPost = array()

protected

Definition at line 178 of file Client.php.

◆ $raw_post_data

$raw_post_data = null

protected

Definition at line 192 of file Client.php.

◆ $redirectCounter

$redirectCounter = 0

protected

Definition at line 254 of file Client.php.

◆ $uri

$uri = null

protected

Definition at line 150 of file Client.php.

◆ AUTH_BASIC

const AUTH_BASIC = 'basic'

Supported HTTP Authentication methods

Definition at line 91 of file Client.php.

◆ CONNECT

const CONNECT = 'CONNECT'

Definition at line 84 of file Client.php.

◆ CONTENT_LENGTH

const CONTENT_LENGTH = 'Content-Length'

Definition at line 104 of file Client.php.

◆ CONTENT_TYPE

const CONTENT_TYPE = 'Content-Type'

Content attributes

Definition at line 103 of file Client.php.

◆ DELETE

const DELETE = 'DELETE'

Definition at line 81 of file Client.php.

◆ ENC_FORMDATA

const ENC_FORMDATA = 'multipart/form-data'

Definition at line 110 of file Client.php.

◆ ENC_URLENCODED

const ENC_URLENCODED = 'application/x-www-form-urlencoded'

POST data encoding methods

Definition at line 109 of file Client.php.

◆ GET

const GET = 'GET'

HTTP request methods

Definition at line 77 of file Client.php.

◆ HEAD

const HEAD = 'HEAD'

Definition at line 80 of file Client.php.

◆ HTTP_0

const HTTP_0 = '1.0'

Definition at line 98 of file Client.php.

◆ HTTP_1

const HTTP_1 = '1.1'

HTTP protocol versions

Definition at line 97 of file Client.php.

◆ MERGE

const MERGE = 'MERGE'

Definition at line 85 of file Client.php.

◆ OPTIONS

const OPTIONS = 'OPTIONS'

Definition at line 83 of file Client.php.

◆ PATCH

const PATCH = 'PATCH'

Definition at line 86 of file Client.php.

◆ POST

const POST = 'POST'

Definition at line 78 of file Client.php.

◆ PUT

const PUT = 'PUT'

Definition at line 79 of file Client.php.

◆ TRACE

const TRACE = 'TRACE'

Definition at line 82 of file Client.php.

◆ VTYPE_FILE

const VTYPE_FILE = 'FILE'

Definition at line 116 of file Client.php.

◆ VTYPE_SCALAR

const VTYPE_SCALAR = 'SCALAR'

Value types for Body key/value pairs

Definition at line 115 of file Client.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Http/Client.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _detectFileMimeType()

◆ _flattenParametersArray()

◆ _getParametersRecursive()

◆ _openTempStream()

◆ _prepareBody()

◆ _prepareHeaders()

◆ _setParameter()

◆ _validateHeaderValue()

◆ encodeAuthHeader()

◆ encodeFormData()

◆ getAdapter()

◆ getCookieJar()

◆ getHeader()

◆ getLastRequest()

◆ getLastResponse()

◆ getRedirectionsCount()

◆ getStream()

◆ getUnmaskStatus()

◆ getUri()

◆ request()

◆ resetParameters()

◆ setAdapter()

◆ setAuth()

◆ setConfig()

◆ setCookie()

◆ setCookieJar()

◆ setEncType()

◆ setFileUpload()

◆ setHeaders()

◆ setMethod()

◆ setParameterGet()

◆ setParameterPost()

◆ setRawData()

◆ setStream()

◆ setUnmaskStatus()

◆ setUri()

Field Documentation

◆ $_fileInfoDb

◆ $_queryBracketsEscaped

◆ $_unmaskStatus

◆ $adapter

◆ $auth

◆ $body_field_order

◆ $config

◆ $cookiejar

◆ $enctype

◆ $files

◆ $headers

◆ $last_request

◆ $last_response

◆ $method

◆ $paramsGet

◆ $paramsPost

◆ $raw_post_data

◆ $redirectCounter

◆ $uri

◆ AUTH_BASIC

◆ CONNECT

◆ CONTENT_LENGTH

◆ CONTENT_TYPE

◆ DELETE

◆ ENC_FORMDATA

◆ ENC_URLENCODED

◆ GET

◆ HEAD

◆ HTTP_0

◆ HTTP_1

◆ MERGE

◆ OPTIONS