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 | $kernel |
Methods
__construct(HttpKernelInterface $kernel, array $server = array(), History $history = null, CookieJar $cookieJar = null) | ||
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 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) | 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 | |
Request | getInternalRequest() Returns the current BrowserKit Request instance. | from Client |
Request | getRequest() A Request instance | |
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 |
object | doRequestInProcess(object $request) Makes a request in another process. | from Client |
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. | |
Response | filterResponse(object $response) Converts the HttpKernel response to a BrowserKit response. | |
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. | ||
getHandleScript() | ||
array | filterFiles(array $files) Filters an array of files. |
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 |
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 |
Crawler submit(Form $form, array $values = array())
Submits a form.
Parameters
Form | $form | |
array | $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 |
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.
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
UploadedFile |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/Client.html