8000 Add browserkit component documentation by javiereguiluz · Pull Request #6072 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Add browserkit component documentation #6072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Feb 9, 2016
Merged

Add browserkit component documentation #6072

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
93d7258
added introduction
Oct 9, 2014
645d50d
fixed a few mistakes
Oct 10, 2014
9c007e9
syntax fix
Oct 10, 2014
1e5ca13
added in sections that I apln to fill out
Oct 10, 2014
f0f8a50
added links with info about clients and packagist link
Oct 10, 2014
b3d9eb3
added links to index and map files
Oct 10, 2014
6997c4f
make a basic request
Oct 10, 2014
94bb3bf
fixed spelling
Oct 10, 2014
dda78ba
added a link snippit
Oct 10, 2014
74cfecd
more outlines, fixed link, added more about creating a client
Oct 13, 2014
a3d158e
added form submissions and moved creating a client to top
yamiko-ninja May 23, 2015
6b6e23a
added docs on histroy
yamiko-ninja May 23, 2015
ea3fd71
Adding documentation for cookies
Oct 28, 2015
a1df783
spelling and formating
yamiko-ninja Nov 19, 2015
03ea5a5
fix title underline
yamiko-ninja Nov 19, 2015
883c062
Finished the first version of the BrowserKit doc
javiereguiluz Dec 23, 2015
fd35c93
Fixed a syntax issue
javiereguiluz Dec 23, 2015
5aec7c4
Minor fixes
javiereguiluz Dec 23, 2015
e7056a8
Fixed a reference
javiereguiluz Dec 23, 2015
c9093a8
Implemented changes suggested by Wouter
javiereguiluz Dec 23, 2015
3f0858f
Fixed a syntax issue
javiereguiluz Dec 23, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
spelling and formating
  • Loading branch information
@yamiko-ninja @javiereguiluz
yamiko-ninja authored and javiereguiluz committed Dec 23, 2015
commit a1df783f0d47d4ccae07eb250308e9f13ec87aad
31 changes: 18 additions & 13 deletions components/browser_kit/introduction.rst
View file
Open in desktop
< A7AB /tr>
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ The BrowserKit Component

The BrowserKit component simulates the behavior of a web browser.

The BrowserKit component allows you to make web request, click on links and submit forms.
The BrowserKit component allows you to make web requests, click on links and submit forms.

Installation
------------

You can install the component in 2 different ways:
You can install the component in two different ways:

* :doc:`Install it via Composer </components/using_components>` (``symfony/browser-kit`` on `Packagist`_);
* Use the official Git repository (https://github.com/symfony/BrowserKit).
Copy link
Member

Choose a r 10000 eason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after the normalisation done recently the real URL is https://github.com/symfony/browser-kit

Expand All @@ -21,13 +21,14 @@ Basic Usage
-----------

.. note::

The component only provides an abstract client and does not provide any "default" backend for the HTTP layer.

Creating a Client
-----------------

To create your own client you must extend the abstract client class and implement the doRequest method.
This method accepts a request and should return a response.
This method accepts a requests and should return a response.

.. code-block:: php

Expand All @@ -36,8 +37,10 @@ This method accepts a request and should return a response.
use Symfony\Component\BrowserKit\Client as BaseClient;
use Symfony\Component\BrowserKit\Response;

class Client extends BaseClient {
protected function doRequest($request) {
class Client extends BaseClient
{
protected function doRequest($request)
{
// convert request into a response
// ...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// ... convert request into a response

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

return new Response($content, $status, $headers);
Expand All @@ -46,14 +49,14 @@ This method accepts a request and should return a response.

For a simple implementation of a browser based on an HTTP layer, have a look at Goutte_.

For an implementation based on HttpKernelInterface, have a look at the Client provided by the :doc:`/components/http_kernel/introduction`.
For an implementation based on ``HttpKernelInterface``, have a look at the Client provided by the :doc:`/components/http_kernel/introduction`.


Making Request
Making Requests
~~~~~~~~~~~~~~

To make a request you use the client's request method.
The first two arguments are for the HTTP method and the request url.
To make a request you use the client's request_ method.
The first two arguments are for the HTTP method and the request URL.
The request method will return a crawler object.

.. code-block:: php
Expand All @@ -66,7 +69,7 @@ The request method will return a crawler object.
Clicking Links
~~~~~~~~~~~~~~

Select a link with the crawler and pass it to the click method to click on the link.
Select a link with the crawler and pass it to the click_ method to click on the link.

.. code-block:: php

Expand Down Expand Up @@ -195,7 +198,7 @@ You can define create cookies and add them to a cookie jar that can be injected
History
-------

The client stores all your request allowing you to go back and forward in your history.
The client stores all your requests allowing you to go back and forward in your history.

.. code-block:: php

Expand All @@ -215,7 +218,7 @@ The client stores all your request allowing you to go back and forward in your h
// go forward to documentation page
$doc_crawler = $client->forward();

You can restart the clients history with the restart method. This will also clear out the CookieJar.
You can restart the client's history with the restart method. This will also clear out the CookieJar.

.. code-block:: php

Expand All @@ -230,4 +233,6 @@ You can restart the clients history with the restart method. This will also clea


.. _Packagist: https://packagist.org/packages/symfony/browser-kit
.. _Goutte: https://github.com/fabpot/Goutte
.. _Goutte: https://github.com/fabpot/Goutte
.. _request: http://api.symfony.com/2.3/Symfony/Component/BrowserKit/Client.html#method_request
.. _click: http://api.symfony.com/2.3/Symfony/Component/BrowserKit/Client.html#method_click
0