Sabre\HTTP\ClientMock Class Reference

Inheritance diagram for Sabre\HTTP\ClientMock:

Collaboration diagram for Sabre\HTTP\ClientMock:

Public Member Functions
	createCurlSettingsArray (RequestInterface $request)
	Making this method public. More...
	parseCurlResult ($response, $curlHandle)
	Making this method public. More...
	doRequest (RequestInterface $request)
	This method is responsible for performing a single request. More...
Public Member Functions inherited from Sabre\HTTP\Client
	__construct ()
	Initializes the client. More...
	send (RequestInterface $request)
	Sends a request to a HTTP server, and returns a response. More...
	sendAsync (RequestInterface $request, callable $success=null, callable $error=null)
	Sends a HTTP request asynchronously. More...
	poll ()
	This method checks if any http requests have gotten results, and if so, call the appropriate success or error handlers. More...
	wait ()
	Processes every HTTP request in the queue, and waits till they are all completed. More...
	setThrowExceptions ($throwExceptions)
	If this is set to true, the Client will automatically throw exceptions upon HTTP errors. More...
	addCurlSetting ($name, $value)
	Adds a CURL setting. More...
Public Member Functions inherited from Sabre\Event\EventEmitterInterface
	on ($eventName, callable $callBack, $priority=100)
	Subscribe to an event. More...
	once ($eventName, callable $callBack, $priority=100)
	Subscribe to an event exactly once. More...
	emit ($eventName, array $arguments=[], callable $continueCallBack=null)
	Emits an event. More...
	listeners ($eventName)
	Returns the list of listeners for an event. More...
	removeListener ($eventName, callable $listener)
	Removes a specific listener from an event. More...
	removeAllListeners ($eventName=null)
	Removes all listeners. More...

Protected Member Functions
	curlStuff ($curlHandle)
	Returns a bunch of information about a curl request. More...
	curlExec ($curlHandle)
	Calls curl_exec. More...
Protected Member Functions inherited from Sabre\HTTP\Client
	doRequest (RequestInterface $request)
	This method is responsible for performing a single request. More...
	createCurlSettingsArray (RequestInterface $request)
	Turns a RequestInterface object into an array with settings that can be fed to curl_setopt. More...
	parseCurlResult ($response, $curlHandle)
	Parses the result of a curl call in a format that's a bit more convenient to work with. More...
	sendAsyncInternal (RequestInterface $request, callable $success, callable $error, $retryCount=0)
	Sends an asynchronous HTTP request. More...
	curlExec ($curlHandle)
	Calls curl_exec. More...
	curlStuff ($curlHandle)
	Returns a bunch of information about a curl request. More...

Protected Attributes
	$persistedSettings = []
Protected Attributes inherited from Sabre\HTTP\Client
	$curlSettings = []
	$throwExceptions = false
	$maxRedirects = 5

Additional Inherited Members
Data Fields inherited from Sabre\HTTP\Client
const	STATUS_SUCCESS = 0
const	STATUS_CURLERROR = 1
const	STATUS_HTTPERROR = 2

Detailed Description

Definition at line 379 of file ClientTest.php.

Member Function Documentation

createCurlSettingsArray()

Sabre\HTTP\ClientMock::createCurlSettingsArray

(

RequestInterface

$request

)

Making this method public.

We are also going to persist all settings this method generates. While the underlying object doesn't behave exactly the same, it helps us simulate what curl does internally, and helps us identify problems with settings that are set by some methods and not correctly reset by other methods after subsequent use. forces

Definition at line 393 of file ClientTest.php.

                                                                {

        $settings = parent::createCurlSettingsArray($request);
        $settings = $settings + $this->persistedSettings;
        $this->persistedSettings = $settings;
        return $settings;

    }

curlExec()

Sabre\HTTP\ClientMock::curlExec (   $curlHandle )

protected

Calls curl_exec.

This method exists so it can easily be overridden and mocked.

Parameters

resource

$curlHandle

Returns

string

Definition at line 460 of file ClientTest.php.

References Sabre\Event\emit().

                                             {

        $return = null;
        $this->emit('curlExec', [&$return]);

        // If nothing modified $return, we're using the default behavior.
        if (is_null($return)) {
            return parent::curlExec($curlHandle);
        } else {
            return $return;
        }

    }

Here is the call graph for this function:

curlStuff()

Sabre\HTTP\ClientMock::curlStuff (   $curlHandle )

protected

Returns a bunch of information about a curl request.

This method exists so it can easily be overridden and mocked.

Parameters

resource

$curlHandle

Returns

array

Definition at line 438 of file ClientTest.php.

References Sabre\Event\emit().

                                              {

        $return = null;
        $this->emit('curlStuff', [&$return]);

        // If nothing modified $return, we're using the default behavior.
        if (is_null($return)) {
            return parent::curlStuff($curlHandle);
        } else {
            return $return;
        }

    }

Here is the call graph for this function:

doRequest()

Sabre\HTTP\ClientMock::doRequest

(

RequestInterface

$request

)

This method is responsible for performing a single request.

Parameters

RequestInterface

$request

Returns

ResponseInterface

Definition at line 416 of file ClientTest.php.

References $response, and Sabre\Event\emit().

                                                  {

        $response = null;
        $this->emit('doRequest', [$request, &$response]);

        // If nothing modified $response, we're using the default behavior.
        if (is_null($response)) {
            return parent::doRequest($request);
        } else {
            return $response;
        }

    }

Here is the call graph for this function:

parseCurlResult()

Sabre\HTTP\ClientMock::parseCurlResult	(		$response,
			$curlHandle
	)

Making this method public.

Definition at line 404 of file ClientTest.php.

References $response.

                                                     {

        return parent::parseCurlResult($response, $curlHandle);

    }

Field Documentation

$persistedSettings

Sabre\HTTP\ClientMock::$persistedSettings = []

protected

Definition at line 381 of file ClientTest.php.

---

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

• libs/composer/vendor/sabre/http/tests/HTTP/ClientTest.php