|
|
sfWebBrowserPlugin - 1.1.0Standalone HTTP client |
|
The sfWebBrowserPlugin proposes an HTTP client capable of making web requests. The interface is similar to that of sfTestBrowser.
This plugin contains four classes: sfWebBrowser, sfCurlAdapter, sfFopenAdapter, and sfSocketsAdapter. Unit tests are available in the SVN repository, to be placed in a symfony application's test/ directory.
The sfWebBrowser class makes web requests based on a URI:
$b = new sfWebBrowser(); $b->get('http://www.example.com/'); $res = $b->getResponseText();
The usual methods of the sfTestBrowser also work there, with the fluid interface.
// Inline $b->get('http://www.example.com/')->get('http://www.google.com/')->back()->reload(); // More readable $b->get('http://www.example.com/') ->get('http://www.google.com/') ->back() ->reload();
The browser accepts absolute and relative URIs
$b->get('http://www.example.com/test.html'); $b->get('test.html');
The get() method accepts parameters either as a query string, or as an array.
$b->get('http://www.example.com/test.php?foo=bar'); $b->get('http://www.example.com/test.php', array('foo', 'bar'));
POST, PUT and DELETE requests are also supported.
$b->post('http://www.example.com/test.php', array('foo', 'bar')); $b->put('http://www.example.com/test.php', array('foo', 'bar')); $b->delete('http://www.example.com/test.php', array('foo', 'bar'));
You can access the response in various formats, at your convenience:
$myString = $b->getResponseText(); $myString = $b->getResponseBody(); // drop the <head> part $myDomDocument = $b->getResponseDom(); $myDomCssSelector = $b->getResponseDomCssSelector(); $mySimpleXml = $b->getResponseXml();
You can also interact with the response with the setFields() and click() methods.
$b->get('http://www.example.com/login') ->setField('user', 'foobar') ->setField('password', 'barbaz') ->click('submit');
The browser supports HTTP and HTTPS requests, proxies, redirects, and timeouts.
Gzip and deflate content-encoded response bodies are also supported, provided that you have the [http://php.net/zlib zlib extention] enabled.
The browser can use various adapters to perform the requests, and uses the following selection order by default:
sfCurlAdapter: Uses Curl to fetch pages. This adapter is a lot faster than sfFopenAdapter, however PHP must be compiled with the with-curl option, and the curl extension must be enabled in php.ini (which is rarely the case by default) for it to work.
sfFopenAdapter: Uses fopen() to fetch pages. fopen() can take an URL as a parameter provided that PHP is compiled with sockets support, and allow_url_fopen is defined to true in php.ini. This is the case in most PHP distributions, so the default adapter should work in almost every platform. On the other hand, the compatibility has a cost: this adapter is slow.
sfSocketsAdapter: Uses fsockopen() to fetch pages.
Alternatively, you can specify an adapter explicitly when you create a new browser object, as follows:
// use default adapter, i.e. sfCurlAdapter $b = new sfWebBrowser(array()); // use sfFopenAdapter $b = new sfWebBrowser(array(), 'sfFopenAdapter');
Currenly, sfCurlAdapter offers slightly more functionality than the other adapters. Namely, it supports multipart file uploads and cookies, which means you can login to a site as well as upload files via forms.
// upload files via a form $b = new sfWebBrowser(); $b->post($url_of_form, array('file_field' => '/path/to/my/local/file.jpg')); // login to a website $b = new sfWebBrowser(array(), 'sfCurlAdapter', array('cookies' => true)); $b->post($url_of_login_form, array('user_field' => $username, 'pass_field' => $password));
Full examples are available in the unit tests.
sfWebBrowser distinguishes to types of error: adapter errors and response errors. Thus, sfWebBrowser calls should be run this way :
$b = new sfWebBrowser(); try { if (!$b->get($url)->responseIsError()) { // Successful response (eg. 200, 201, etc) } else { // Error response (eg. 404, 500, etc) } } catch (Exception $e) { // Adapter error (eg. Host not found) }
Besides, you should always remember that the response contents may contain incorrect code. Consider it as 'tainted', and therefore always use the escaping when outputting it to a template.
// In the action $this->title = (string) $b->getResponseXml()->body->h1 // In the template <?php echo $title // dangerous ?> <?php echo $sf_data->get('title') // correct ?>
Install the plugin
$ symfony plugin-install http://plugins.symfony-project.com/sfWebBrowserPlugin
Clear the cache to enable the autoloading to find the new class
$ symfony cc
Cookies, caching, and file uploads are not yet supported in any of the packages (some of this functionality is available with sfCurlAdapter, see above).
sfCurlAdaptersfCurlAdapter (based on a patch by adoanhuu)getResponseXMLsfCurlAdaptersfCurlAdapter: Added new options: 'cookies', 'cookies_dir', 'cookies_file', 'verbose', 'verbose_log'sfCurlAdapter: Increased speed by Moving some initialization from call() to the constructersfFopenAdapter error handlersfSocketsAdaptersfSocketsAdaptersfCurlAdapter causing 'Bad Request' error responsesget() when arg_separator.output is not set to '&' in php.ini (patch from river.bright)get() when query string is already present in the url (based on a patch from Jeff Merlet)sfWebBrowser::__construct()sfWebBrowser::__construct()sfSocketsAdaptersfCurlAdapter: more detailed error messages & leaner request setupsfCurlAdaptersfWebBrowser::responseIsError()sfWebBrowser::getResponseMessage()sfFopenAdapternew sfWebBrowser(array $headers, string $adapter_class, array $adapter_options) initializeRequestHeaders()new sfWebBrowser(array $headers, array $adapter_options)getResponseBody()getResponseXML()