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.
__construct(array $server = array(), History $history = null, CookieJar $cookieJar = null) | ||
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. |
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 |
Sets whether to automatically follow redirects or not.
bool | $followRedirect | Whether to follow redirects |
Returns whether client automatically follows redirects or not.
bool |
Sets the maximum number of requests that crawler can follow.
int | $maxRedirects |
Returns the maximum number of requests that crawler can follow.
int |
Sets the insulated flag.
bool | $insulated | Whether to insulate the requests or not |
RuntimeException | When Symfony Process Component is not installed |
Sets server parameters.
array | $server | An array of server parameters |
Sets single server parameter.
string | $key | A key of the parameter |
string | $value | A value of the parameter |
Gets single server parameter for specified key.
string | $key | A key of the parameter to get |
string | $default | A default value when key is undefined |
string | A value of the parameter |
Returns the History instance.
History | A History instance |
Returns the CookieJar instance.
CookieJar | A CookieJar instance |
Returns the current Crawler instance.
Crawler|null | A Crawler instance |
Returns the current BrowserKit Response instance.
Response|null | A BrowserKit Response instance |
Returns the current origin response instance.
The origin response is the response instance that is returned by the code that handles requests.
object|null | A response instance |
doRequest() |
Returns the current BrowserKit Request instance.
Request|null | A BrowserKit Request instance |
Returns the current origin Request instance.
The origin request is the request instance that is sent to the code that handles requests.
object|null | A Request instance |
doRequest() |
Clicks on a given link.
Link | $link |
Crawler |
Submits a form.
Form | $form | A Form instance |
array | $values | An array of form field values |
Crawler |
Calls a URI.
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()) |
Crawler |
Goes back in the browser history.
Crawler |
Goes forward in the browser history.
Crawler |
Reloads the current browser.
Crawler |
Follow redirects?
Crawler |
LogicException | If request was not a redirect |
Restarts the client.
It flushes history and all cookies.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/BrowserKit/Client.html