1. class
  2. Symfony
  3. \
  4. Bundle
  5. \
  6. FrameworkBundle
  7. \
  8. Client

Client

class Client extends Client

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

Properties

protected $history from Client
protected $cookieJar from Client
protected $server from Client
protected $internalRequest from Client
protected $request from Client
protected $internalResponse from Client
protected $response from Client
protected $crawler from Client
protected $insulated from Client
protected $redirect from Client
protected $followRedirects from Client
protected $followMetaRefresh from Client
protected $kernel from Client

Methods

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

No description

followRedirects(bool $followRedirect = true)

Sets whether to automatically follow redirects or not.

from Client
followMetaRefresh(bool $followMetaRefresh = true)

Sets whether to automatically follow meta refresh 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 redirects that crawler can follow.

from Client
int
getMaxRedirects()

Returns the maximum number of redirects 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
Crawler
xmlHttpRequest(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true)

No description

from Client
History
getHistory()

Returns the History instance.

from Client
CookieJar
getCookieJar()

Returns the CookieJar instance.

from Client
Crawler
getCrawler()

Returns the current Crawler instance.

from Client
Response
getInternalResponse()

Returns the current BrowserKit Response instance.

from Client
Response
getResponse()

A Response instance

from Client
Request
getInternalRequest()

Returns the current BrowserKit Request instance.

from Client
Request
getRequest()

A Request instance

from Client
Crawler
click(Link $link)

Clicks on a given link.

from Client
Crawler
clickLink(string $linkText)

Clicks the first link (or clickable image) that contains the given text.

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

Submits a form.

from Client
Crawler
submitForm(string $button, array $fieldValues = array(), string $method = 'POST', array $serverParameters = array())

Finds the first form that contains a button with the given content and uses it to submit the given form field values.

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
object
doRequestInProcess(object $request)

Makes a request in another process.

object
doRequest(object $request)

Makes a request.

getScript(object $request)

Returns the script to execute when the request must be insulated.

object
filterRequest(Request $request)

Converts the BrowserKit request to a HttpKernel request.

from Client
Response
filterResponse(object $response)

Converts the HttpKernel response to a BrowserKit response.

from Client
Crawler|null
createCrawlerFromContent(string $uri, string $content, string $type)

Creates a crawler.

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
string
getAbsoluteUri(string $uri)

Takes a URI and converts it to absolute if it is not already absolute.

from Client
Crawler
requestFromRequest(Request $request, bool $changeHistory = true)

Makes a request from a Request object directly.

from Client
catchExceptions(bool $catchExceptions)

Sets whether to catch exceptions when the kernel is handling a request.

from Client
getHandleScript()

No description

from Client
array
filterFiles(array $files)

Filters an array of files.

from Client
ContainerInterface|null
getContainer()

Returns the container.

KernelInterface
getKernel()

Returns the kernel.

Profile|false
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

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

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

followRedirects(bool $followRedirect = true)

Sets whether to automatically follow redirects or not.

Parameters

bool $followRedirect Whether to follow redirects

followMetaRefresh(bool $followMetaRefresh = true)

Sets whether to automatically follow meta refresh redirects or not.

Parameters

bool $followMetaRefresh

bool isFollowingRedirects()

Returns whether client automatically follows redirects or not.

Return Value

bool

setMaxRedirects(int $maxRedirects)

Sets the maximum number of redirects that crawler can follow.

Parameters

int $maxRedirects

int getMaxRedirects()

Returns the maximum number of redirects that crawler can follow.

Return Value

int

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

setServerParameters(array $server)

Sets server parameters.

Parameters

array $server An array of server parameters

setServerParameter(string $key, string $value)

Sets single server parameter.

Parameters

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

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

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

Parameters

string $method
string $uri
array $parameters
array $files
array $server
string $content
bool $changeHistory

Return Value

Crawler

History getHistory()

Returns the History instance.

Return Value

History A History instance

CookieJar getCookieJar()

Returns the CookieJar instance.

Return Value

CookieJar A CookieJar instance

Crawler getCrawler()

Returns the current Crawler instance.

Return Value

Crawler A Crawler instance

Response getInternalResponse()

Returns the current BrowserKit Response instance.

Return Value

Response A BrowserKit Response instance

Response getResponse()

A Response instance

Return Value

Response

Request getInternalRequest()

Returns the current BrowserKit Request instance.

Return Value

Request A BrowserKit Request instance

Request getRequest()

A Request instance

Return Value

Request

Crawler click(Link $link)

Clicks on a given link.

Parameters

Link $link

Return Value

Crawler

Clicks the first link (or clickable image) that contains the given text.

Parameters

string $linkText The text of the link or the alt attribute of the clickable image

Return Value

Crawler

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

Submits a form.

Parameters

Form $form
array $values

Return Value

Crawler

Crawler submitForm(string $button, array $fieldValues = array(), string $method = 'POST', array $serverParameters = array())

Finds the first form that contains a button with the given content and uses it to submit the given form field values.

Parameters

string $button The text content, id, value or name of the form
array $fieldValues Use this syntax: array('my_form[name]' => '...', 'my_form[email]' => '...')
string $method The HTTP method used to submit the form
array $serverParameters These values override the ones stored in $SERVER (HTTP headers must include a HTTP prefix as PHP does)

Return Value

Crawler

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

protected object doRequestInProcess(object $request)

Makes a request in another process.

Parameters

object $request An origin request instance

Return Value

object An origin response instance

Exceptions

RuntimeException When processing returns exit code

protected object doRequest(object $request)

Makes a request.

Parameters

object $request An origin request instance

Return Value

object An origin response instance

protected getScript(object $request)

Returns the script to execute when the request must be insulated.

It assumes that the autoloader is named 'autoload.php' and that it is stored in the same directory as the kernel (this is the case for the Symfony Standard Edition). If this is not your case, create your own client and override this method.

Parameters

object $request An origin request instance

protected object filterRequest(Request $request)

Converts the BrowserKit request to a HttpKernel request.

Parameters

Request $request The BrowserKit Request to filter

Return Value

object An origin request instance

protected Response filterResponse(object $response)

Converts the HttpKernel response to a BrowserKit response.

Parameters

object $response The origin response to filter

Return Value

Response An BrowserKit Response instance

protected Crawler|null createCrawlerFromContent(string $uri, string $content, string $type)

Creates a crawler.

This method returns null if the DomCrawler component is not available.

Parameters

string $uri A URI
string $content Content for the crawler to use
string $type Content type

Return Value

Crawler|null

Crawler back()

Goes back in the browser history.

Return Value

Crawler

Crawler forward()

Goes forward in the browser history.

Return Value

Crawler

Crawler reload()

Reloads the current browser.

Return Value

Crawler

Crawler followRedirect()

Follow redirects?

Return Value

Crawler

Exceptions

LogicException If request was not a redirect

restart()

Restarts the client.

It flushes history and all cookies.

protected string getAbsoluteUri(string $uri)

Takes a URI and converts it to absolute if it is not already absolute.

Parameters

string $uri A URI

Return Value

string An absolute URI

protected Crawler requestFromRequest(Request $request, bool $changeHistory = true)

Makes a request from a Request object directly.

Parameters

Request $request A Request instance
bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())

Return Value

Crawler

catchExceptions(bool $catchExceptions)

Sets whether to catch exceptions when the kernel is handling a request.

Parameters

bool $catchExceptions Whether to catch exceptions

protected getHandleScript()

protected array filterFiles(array $files)

Filters an array of files.

This method created test instances of UploadedFile so that the move() method can be called on those instances.

If the size of a file is greater than the allowed size (from php.ini) then an invalid UploadedFile is returned with an error set to UPLOAD_ERR_INI_SIZE.

Parameters

array $files

Return Value

array An array with all uploaded files marked as already moved

See also

ContainerInterface|null getContainer()

Returns the container.

Return Value

ContainerInterface|null Returns null when the Kernel has been shutdown or not started yet

KernelInterface getKernel()

Returns the kernel.

Return Value

KernelInterface

Profile|false getProfile()

Gets the profile associated with the current Response.

Return Value

Profile|false A Profile instance

enableProfiler()

Enables the profiler for the very next request.

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

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.

enableReboot()

Enables kernel reboot between requests.