1. class
  2. Symfony
  3. Bundle
  4. FrameworkBundle
  5. Client

Client

class Client extends Client

Client simulates a browser and makes requests to a Kernel object.

Methods

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

Constructor.

followRedirects(bool $followRedirect = true)

Sets whether to automatically follow redirects or not.

from Client
bool
isFollowingRedirects()

Returns whether client automatically follows redirects or not.

from Client
setMaxRedirects(int $maxRedirects)

Sets the maximum number of requests that crawler can follow.

from Client
int
getMaxRedirects()

Returns the maximum number of requests that crawler can follow.

from Client
insulate(bool $insulated = true)

Sets the insulated flag.

from Client
setServerParameters(array $server)

Sets server parameters.

from Client
setServerParameter(string $key, string $value)

Sets single server parameter.

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

Gets single server parameter for specified key.

from Client
History
getHistory()

Returns the History instance.

from Client
CookieJar
getCookieJar()

Returns the CookieJar instance.

from Client
Crawler|null
getCrawler()

Returns the current Crawler instance.

from Client
Response|null
getInternalResponse()

Returns the current BrowserKit Response instance.

from Client
object|null
getResponse()

Returns the current origin response instance.

from Client
Request|null
getInternalRequest()

Returns the current BrowserKit Request instance.

from Client
object|null
getRequest()

Returns the current origin Request instance.

from Client
Crawler
click(Link $link)

Clicks on a given link.

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

Submits a form.

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

Calls a URI.

from Client
Crawler
back()

Goes back in the browser history.

from Client
Crawler
forward()

Goes forward in the browser history.

from Client
Crawler
reload()

Reloads the current browser.

from Client
Crawler
followRedirect()

Follow redirects?

from Client
restart()

Restarts the client.

from Client
ContainerInterface
getContainer()

Returns the container.

KernelInterface
getKernel()

Returns the kernel.

Profile
getProfile()

Gets the profile associated with the current Response.

enableProfiler()

Enables the profiler for the very next request.

disableReboot()

Disables kernel reboot between requests.

enableReboot()

Enables kernel reboot between requests.

Details

at line line 37
__construct(HttpKernelInterface $kernel, array $server = array(), History $history = null, CookieJar $cookieJar = null)

Constructor.

Parameters

HttpKernelInterface $kernel An HttpKernel instance
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

in Client at line line 66
followRedirects(bool $followRedirect = true)

Sets whether to automatically follow redirects or not.

Parameters

bool $followRedirect Whether to follow redirects

in Client at line line 76
bool isFollowingRedirects()

Returns whether client automatically follows redirects or not.

Return Value

bool

in Client at line line 86
setMaxRedirects(int $maxRedirects)

Sets the maximum number of requests that crawler can follow.

Parameters

int $maxRedirects

in Client at line line 97
int getMaxRedirects()

Returns the maximum number of requests that crawler can follow.

Return Value

int

in Client at line line 109
insulate(bool $insulated = true)

Sets the insulated flag.

Parameters

bool $insulated Whether to insulate the requests or not

Exceptions

RuntimeException When Symfony Process Component is not installed

in Client at line line 123
setServerParameters(array $server)

Sets server parameters.

Parameters

array $server An array of server parameters

in Client at line line 137
setServerParameter(string $key, string $value)

Sets single server parameter.

Parameters

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

in Client at line line 150
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

in Client at line line 160
History getHistory()

Returns the History instance.

Return Value

History A History instance

in Client at line line 170
CookieJar getCookieJar()

Returns the CookieJar instance.

Return Value

CookieJar A CookieJar instance

in Client at line line 180
Crawler|null getCrawler()

Returns the current Crawler instance.

Return Value

Crawler|null A Crawler instance

in Client at line line 190
Response|null getInternalResponse()

Returns the current BrowserKit Response instance.

Return Value

Response|null A BrowserKit Response instance

in Client at line line 65
object|null getResponse()

Returns the current origin response instance.

The origin response is the response instance that is returned by the code that handles requests.

Return Value

object|null A response instance

in Client at line line 215
Request|null getInternalRequest()

Returns the current BrowserKit Request instance.

Return Value

Request|null A BrowserKit Request instance

in Client at line line 55
object|null getRequest()

Returns the current origin Request instance.

The origin request is the request instance that is sent to the code that handles requests.

Return Value

object|null A Request instance

in Client at line line 242
Crawler click(Link $link)

Clicks on a given link.

Parameters

Link $link A Link instance

Return Value

Crawler

in Client at line line 259
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

in Client at line line 279
Crawler request(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $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
bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())

Return Value

Crawler

in Client at line line 433
Crawler back()

Goes back in the browser history.

Return Value

Crawler

in Client at line line 443
Crawler forward()

Goes forward in the browser history.

Return Value

Crawler

in Client at line line 453
Crawler reload()

Reloads the current browser.

Return Value

Crawler

in Client at line line 465
Crawler followRedirect()

Follow redirects?

Return Value

Crawler

Exceptions

LogicException If request was not a redirect

in Client at line line 513
restart()

Restarts the client.

It flushes history and all cookies.

at line line 47
ContainerInterface getContainer()

Returns the container.

Return Value

ContainerInterface

at line line 57
KernelInterface getKernel()

Returns the kernel.

Return Value

KernelInterface

at line line 67
Profile getProfile()

Gets the profile associated with the current Response.

Return Value

Profile A Profile instance

at line line 81
enableProfiler()

Enables the profiler for the very next request.

If the profiler is not enabled, the call to this method does nothing.

at line line 94
disableReboot()

Disables kernel reboot between requests.

By default, the Client reboots the Kernel for each request. This method allows to keep the same kernel across requests.

at line line 102
enableReboot()

Enables kernel reboot between requests.