Class

Symfony\Component\BrowserKit\Client

abstract class Client

Client simulates a browser.

To make the actual request, you need to implement the doRequest() method.

If you want to be able to run requests in their own process (insulated flag), you need to also implement the getScript() method.

Methods

__construct(array $server = array(), History $history = null, CookieJar $cookieJar = null)

Constructor.

followRedirects(Boolean $followRedirect = true)

Sets whether to automatically follow redirects or not.

insulate(Boolean $insulated = true)

Sets the insulated flag.

setServerParameters(array $server)

Sets server parameters.

setServerParameter(string $key, string $value)

Sets single server parameter.

string getServerParameter(string $key, string $default = '')

Gets single server parameter for specified key.

History getHistory()

Returns the History instance.

CookieJar getCookieJar()

Returns the CookieJar instance.

Crawler getCrawler()

Returns the current Crawler instance.

Response getResponse()

Returns the current Response instance.

Request getRequest()

Returns the current Request instance.

Crawler click(Link $link)

Clicks on a given link.

Crawler submit(Form $form, array $values = array())

Submits a form.

Crawler request(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, Boolean $changeHistory = true)

Calls a URI.

Crawler back()

Goes back in the browser history.

Crawler forward()

Goes forward in the browser history.

Crawler reload()

Reloads the current browser.

Crawler followRedirect()

Follow redirects?

restart()

Restarts the client.

Details

at line 52
public __construct(array $server = array(), History $history = null, CookieJar $cookieJar = null)

Constructor.

Parameters

array $server The server parameters (equivalent of $_SERVER)
History $history A History instance to store the browser history
CookieJar $cookieJar A CookieJar instance to store the cookies

at line 68
public followRedirects(Boolean $followRedirect = true)

Sets whether to automatically follow redirects or not.

Parameters

Boolean $followRedirect Whether to follow redirects

at line 82
public insulate(Boolean $insulated = true)

Sets the insulated flag.

Parameters

Boolean $insulated Whether to insulate the requests or not

Exceptions

RuntimeException When Symfony Process Component is not installed

at line 100
public setServerParameters(array $server)

Sets server parameters.

Parameters

array $server An array of server parameters

at line 114
public setServerParameter(string $key, string $value)

Sets single server parameter.

Parameters

string $key A key of the parameter
string $value A value of the parameter

at line 127
public string getServerParameter(string $key, string $default = '')

Gets single server parameter for specified key.

Parameters

string $key A key of the parameter to get
string $default A default value when key is undefined

Return Value

string A value of the parameter

at line 139
public History getHistory()

Returns the History instance.

Return Value

History A History instance

at line 151
public CookieJar getCookieJar()

Returns the CookieJar instance.

Return Value

CookieJar A CookieJar instance

at line 163
public Crawler getCrawler()

Returns the current Crawler instance.

Return Value

Crawler A Crawler instance

at line 175
public Response getResponse()

Returns the current Response instance.

Return Value

Response A Response instance

at line 187
public Request getRequest()

Returns the current Request instance.

Return Value

Request A Request instance

at line 201
public Crawler click(Link $link)

Clicks on a given link.

Parameters

Link $link A Link instance

Return Value

Crawler

at line 220
public Crawler submit(Form $form, array $values = array())

Submits a form.

Parameters

Form $form A Form instance
array $values An array of form field values

Return Value

Crawler

at line 242
public Crawler request(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, Boolean $changeHistory = true)

Calls a URI.

Parameters

string $method The request method
string $uri The URI to fetch
array $parameters The Request parameters
array $files The files
array $server The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
string $content The raw body data
Boolean $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())

Return Value

Crawler

at line 373
public Crawler back()

Goes back in the browser history.

Return Value

Crawler

at line 385
public Crawler forward()

Goes forward in the browser history.

Return Value

Crawler

at line 397
public Crawler reload()

Reloads the current browser.

Return Value

Crawler

at line 411
public Crawler followRedirect()

Follow redirects?

Return Value

Crawler

Exceptions

LogicException If request was not a redirect

at line 427
public restart()

Restarts the client.

It flushes history and all cookies.