Edit
In Place Editing Advanced Editing

Client

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(bool $followRedirect = true)

Sets whether to automatically follow redirects or not.
bool isFollowingRedirects()

Returns whether client automatically follows redirects or not.
setMaxRedirects(int $maxRedirects)

Sets the maximum number of requests that crawler can follow.
int getMaxRedirects()

Returns the maximum number of requests that crawler can follow.
insulate(bool $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|null getCrawler()

Returns the current Crawler instance.
Response|null getInternalResponse()

Returns the current BrowserKit Response instance.
object|null getResponse()

Returns the current origin response instance.
Request|null getInternalRequest()

Returns the current BrowserKit Request instance.
object|null getRequest()

Returns the current origin 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, bool $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

__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

followRedirects(bool $followRedirect = true)

Sets whether to automatically follow redirects or not.

Parameters

bool $followRedirect Whether to follow redirects

bool isFollowingRedirects()

Returns whether client automatically follows redirects or not.

Return Value

bool

setMaxRedirects(int $maxRedirects)

Sets the maximum number of requests that crawler can follow.

Parameters

int $maxRedirects

int getMaxRedirects()

Returns the maximum number of requests 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

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|null getCrawler()

Returns the current Crawler instance.

Return Value

Crawler|null A Crawler instance

Response|null getInternalResponse()

Returns the current BrowserKit Response instance.

Return Value

Response|null A BrowserKit Response instance

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

See also

doRequest()

Request|null getInternalRequest()

Returns the current BrowserKit Request instance.

Return Value

Request|null A BrowserKit Request instance

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

See also

doRequest()

Crawler click(Link $link)

Clicks on a given link.

Parameters

Link $link A Link instance

Return Value

Crawler

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

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

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.

doc_Symfony
doc_Symfony
2016-10-28 06:09:08
Comments
Leave a Comment

Please login to continue.