CurlClient Class Reference

Public Member Functions
	get ($url, $data=[], $headers=[])
	delete ($url, $headers=[])
	post ($url, $data, $headers=[])
	put ($url, $data, $headers=[])
	invokeApi ($url, $additionalCurlOpts, $headers=[])

Data Fields
const	EMPTY_REQUEST_BODY = 'Empty body'

Detailed Description

Generic cURL client wrapper for get/delete/post/put requests

Definition at line 11 of file CurlClient.php.

Member Function Documentation

delete()

delete	(		$url,
			$headers = []
	)

Perform HTTP DELETE request

Parameters

string	$url
array	$headers

Returns

string

Definition at line 42 of file CurlClient.php.

    {
        $curlOpts = [];
        $curlOpts[CURLOPT_CUSTOMREQUEST] = \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_DELETE;

        $resp = $this->invokeApi($url, $curlOpts, $headers);
        return $resp["body"];
    }

get()

get	(		$url,
			$data = [],
			$headers = []
	)

Perform HTTP GET request

Parameters

string	$url	Resource URL like /V1/Resource1/123
array	$data
array	$headers

Returns

string

Definition at line 23 of file CurlClient.php.

    {
        if (!empty($data)) {
            $url .= '?' . http_build_query($data);
        }

        $curlOpts = [];
        $curlOpts[CURLOPT_CUSTOMREQUEST] = \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_GET;
        $resp = $this->invokeApi($url, $curlOpts, $headers);
        return $resp["body"];
    }

invokeApi()

invokeApi	(		$url,
			$additionalCurlOpts,
			$headers = []
	)

Makes the REST api call using passed $curl object

Parameters

string	$url
array	$additionalCurlOpts	cURL Options
array	$headers

Returns

array

Exceptions

Definition at line 98 of file CurlClient.php.

    {
        // initialize cURL
        $curl = curl_init($url);
        if ($curl === false) {
            throw new \Exception("Error Initializing cURL for baseUrl: " . $url);
        }

        // get cURL options
        $curlOpts = $this->getCurlOptions($additionalCurlOpts, $headers);

        // add CURL opts
        foreach ($curlOpts as $opt => $val) {
            curl_setopt($curl, $opt, $val);
        }

        $response = curl_exec($curl);
        if ($response === false) {
            throw new \Exception(curl_error($curl));
        }

        $resp = [];
        $headerSize = curl_getinfo($curl, CURLINFO_HEADER_SIZE);
        $resp["header"] = substr($response, 0, $headerSize);
        $resp["body"] = substr($response, $headerSize);

        $resp["meta"] = curl_getinfo($curl);
        if ($resp["meta"] === false) {
            throw new \Exception(curl_error($curl));
        }

        curl_close($curl);

        $meta = $resp["meta"];
        if ($meta && $meta['http_code'] >= 400) {
            throw new \Exception($resp["body"], $meta['http_code']);
        }

        return $resp;
    }

post()

post	(		$url,
			$data,
			$headers = []
	)

Perform HTTP POST request

Parameters

string	$url
array | string	$data
array	$headers

Returns

string

Definition at line 59 of file CurlClient.php.

    {
        $curlOpts = [];
        $curlOpts[CURLOPT_CUSTOMREQUEST] = \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_POST;
        $headers[] = 'Content-Length: ' . strlen($data);
        $curlOpts[CURLOPT_POSTFIELDS] = $data;

        $resp = $this->invokeApi($url, $curlOpts, $headers);
        return $resp["body"];
    }

put()

put	(		$url,
			$data,
			$headers = []
	)

Perform HTTP PUT request

Parameters

string	$url
array | string	$data
array	$headers

Returns

string

Definition at line 78 of file CurlClient.php.

    {
        $curlOpts = [];
        $curlOpts[CURLOPT_CUSTOMREQUEST] = \Magento\Framework\Webapi\Rest\Request::HTTP_METHOD_PUT;
        $headers[] = 'Content-Length: ' . strlen($data);
        $curlOpts[CURLOPT_POSTFIELDS] = $data;

        $resp = $this->invokeApi($url, $curlOpts, $headers);
        return $resp["body"];
    }

Field Documentation

EMPTY_REQUEST_BODY

const EMPTY_REQUEST_BODY = 'Empty body'

Definition at line 13 of file CurlClient.php.

---

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

• vendor/magento/magento2-base/dev/tests/api-functional/framework/Magento/TestFramework/TestCase/HttpClient/CurlClient.php