mirror of
https://github.com/guzzle/guzzle.git
synced 2025-02-13 03:45:22 +01:00
Updating docblocks
This commit is contained in:
parent
229aace559
commit
4c7bc0b702
@ -15,7 +15,7 @@ use Guzzle\Common\Collection;
|
||||
*/
|
||||
class Guzzle
|
||||
{
|
||||
const VERSION = '0.9';
|
||||
const VERSION = '1.0b';
|
||||
|
||||
/**
|
||||
* @var string Default Guzzle User-Agent header
|
||||
|
@ -9,17 +9,12 @@ namespace Guzzle\Http\CookieJar;
|
||||
use Guzzle\Common\Collection;
|
||||
|
||||
/**
|
||||
* Persists cookies using a temporary array
|
||||
* Cookie jar that stores cookies an an array
|
||||
*
|
||||
* @author Michael Dowling <michael@guzzlephp.org>
|
||||
*/
|
||||
class ArrayCookieJar implements CookieJarInterface
|
||||
{
|
||||
/**
|
||||
* @var array CSV columns
|
||||
*/
|
||||
protected $columns = array('comment', 'comment_url', 'cookie', 'data', 'discard', 'domain', 'expires', 'http_only', 'max_age', 'path', 'port', 'secure', 'version');
|
||||
|
||||
/**
|
||||
* @var array Loaded cookie data
|
||||
*/
|
||||
|
@ -64,7 +64,7 @@ interface CookieJarInterface
|
||||
*
|
||||
* domain (string) - Domain of the cookie
|
||||
* path (string) - Path of the cookie
|
||||
* cookies (array) - Array of cookie name value pairs (e.g. 'x=123')
|
||||
* cookie (array) - Array of cookie name (0) and value (1)
|
||||
* max_age (int) - Lifetime of the cookie in seconds
|
||||
* expires (int) - The UNIX timestamp when the cookie expires
|
||||
* version (int) - Version of the cookie specification. RFC 2965 is 1
|
||||
@ -83,7 +83,7 @@ interface CookieJarInterface
|
||||
* @parm array $cookieData Cookie information, including the following:
|
||||
* domain (string, required) - Domain of the cookie
|
||||
* path (string, required) - Path of the cookie
|
||||
* cookies - Array of cookie names and values as string
|
||||
* cookie - Array of cookie name (0) and value (1)
|
||||
* max_age (int, required) - Lifetime of the cookie in seconds
|
||||
* version (int) - Version of the cookie specification. Default is 0. RFC 2965 is 1
|
||||
* secure (bool) - If it is a secure cookie
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Curl;
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Curl;
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Curl;
|
||||
|
||||
@ -18,9 +22,7 @@ class CurlFactory implements CurlFactoryInterface
|
||||
private static $instance;
|
||||
|
||||
/**
|
||||
* Array of open curl handles {@see CurlHandle}
|
||||
*
|
||||
* @var array
|
||||
* @var array Array of open curl handles {@see CurlHandle}
|
||||
*/
|
||||
protected $handles = array();
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Curl;
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Curl;
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Pool;
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Pool;
|
||||
|
||||
@ -33,15 +37,6 @@ interface PoolInterface extends Subject, \Countable
|
||||
*/
|
||||
public function add(RequestInterface $request);
|
||||
|
||||
/**
|
||||
* Remove a request from the pool.
|
||||
*
|
||||
* @param RequestInterface $request Request to detach.
|
||||
*
|
||||
* @return RequestInterface Returns the Request object that was removed
|
||||
*/
|
||||
public function remove(RequestInterface $request);
|
||||
|
||||
/**
|
||||
* Get an array of attached {@see RequestInterface}s.
|
||||
*
|
||||
@ -57,7 +52,16 @@ interface PoolInterface extends Subject, \Countable
|
||||
public function getState();
|
||||
|
||||
/**
|
||||
* Reset the state of the Pool and remove any attached Requests
|
||||
* Remove a request from the pool.
|
||||
*
|
||||
* @param RequestInterface $request Request to detach.
|
||||
*
|
||||
* @return RequestInterface Returns the Request object that was removed
|
||||
*/
|
||||
public function remove(RequestInterface $request);
|
||||
|
||||
/**
|
||||
* Reset the state of the Pool and remove any attached RequestInterface objects
|
||||
*/
|
||||
public function reset();
|
||||
|
||||
@ -68,6 +72,9 @@ interface PoolInterface extends Subject, \Countable
|
||||
*
|
||||
* @return array|bool Returns an array of attached Request objects on
|
||||
* success FALSE on failure.
|
||||
*
|
||||
* @throws PoolRequestException if any requests threw exceptions during the
|
||||
* transfer.
|
||||
*/
|
||||
public function send();
|
||||
}
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Http\Pool;
|
||||
|
||||
|
@ -1,4 +1,8 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Guzzle PHP <http://www.guzzlephp.org>
|
||||
* @license See the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Guzzle\Service\Command;
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user