Skip to content

Add doc-blocks to Browser #93

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
clue merged 1 commit into from
Jan 23, 2018
Merged

Add doc-blocks to Browser #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 57 additions & 6 deletions src/Browser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
use Clue\React\Buzz\Io\Sender;
use Clue\React\Buzz\Io\Transaction;
use Clue\React\Buzz\Message\MessageFactory;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\UriInterface;
use React\EventLoop\LoopInterface;
use React\Promise\PromiseInterface;
use React\Socket\ConnectorInterface;

class Browser
Expand All @@ -30,36 +32,77 @@ public function __construct(LoopInterface $loop, ConnectorInterface $connector =
$this->messageFactory = new MessageFactory();
}

public function get($url, $headers = array())
/**
* @param string|UriInterface $url URI for the request.
* @param array $headers
* @return PromiseInterface
*/
public function get($url, array $headers = array())
{
return $this->send($this->messageFactory->request('GET', $url, $headers));
}

public function post($url, $headers = array(), $content = '')
/**
* @param string|UriInterface $url URI for the request.
* @param array $headers
* @param string $content
* @return PromiseInterface
*/
public function post($url, array $headers = array(), $content = '')
{
return $this->send($this->messageFactory->request('POST', $url, $headers, $content));
}

public function head($url, $headers = array())
/**
* @param string|UriInterface $url URI for the request.
* @param array $headers
* @return PromiseInterface
*/
public function head($url, array $headers = array())
{
return $this->send($this->messageFactory->request('HEAD', $url, $headers));
}

public function patch($url, $headers = array(), $content = '')
/**
* @param string|UriInterface $url URI for the request.
* @param array $headers
* @param string $content
* @return PromiseInterface
*/
public function patch($url, array $headers = array(), $content = '')
{
return $this->send($this->messageFactory->request('PATCH', $url , $headers, $content));
}

public function put($url, $headers = array(), $content = '')
/**
* @param string|UriInterface $url URI for the request.
* @param array $headers
* @param string $content
* @return PromiseInterface
*/
public function put($url, array $headers = array(), $content = '')
{
return $this->send($this->messageFactory->request('PUT', $url, $headers, $content));
}

public function delete($url, $headers = array(), $content = '')
/**
* @param string|UriInterface $url URI for the request.
* @param array $headers
* @param string $content
* @return PromiseInterface
*/
public function delete($url, array $headers = array(), $content = '')
{
return $this->send($this->messageFactory->request('DELETE', $url, $headers, $content));
}

/**
* @param string|UriInterface $url URI for the request.
* @param array $fields
* @param array $headers
* @param string $method
* @return PromiseInterface
*/
public function submit($url, array $fields, $headers = array(), $method = 'POST')
{
$headers['Content-Type'] = 'application/x-www-form-urlencoded';
Expand All @@ -68,6 +111,10 @@ public function submit($url, array $fields, $headers = array(), $method = 'POST'
return $this->send($this->messageFactory->request($method, $url, $headers, $content));
}

/**
* @param RequestInterface $request
* @return PromiseInterface
*/
public function send(RequestInterface $request)
{
if ($this->baseUri !== null) {
Expand Down Expand Up @@ -121,6 +168,10 @@ public function withoutBase()
return $browser;
}

/**
* @param array $options
* @return self
*/
public function withOptions(array $options)
{
$browser = clone $this;
Expand Down