diff options
author | tailor <cygnus@janrain.com> | 2006-01-14 00:04:26 +0000 |
---|---|---|
committer | tailor <cygnus@janrain.com> | 2006-01-14 00:04:26 +0000 |
commit | c3eb2e8863d40dfcc227145879c8b97ccfaaf11a (patch) | |
tree | 2b24c50e684fa1f38ce4051fd332877cc99c8c9b /Net | |
parent | 3a09110c51b51ca2728993508d124162e2f966db (diff) | |
download | php-openid-c3eb2e8863d40dfcc227145879c8b97ccfaaf11a.zip php-openid-c3eb2e8863d40dfcc227145879c8b97ccfaaf11a.tar.gz php-openid-c3eb2e8863d40dfcc227145879c8b97ccfaaf11a.tar.bz2 |
[project @ Updated Fetchers docs]
Diffstat (limited to 'Net')
-rw-r--r-- | Net/OpenID/Consumer/Fetchers.php | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Net/OpenID/Consumer/Fetchers.php b/Net/OpenID/Consumer/Fetchers.php index 8ad2c26..5b3afb3 100644 --- a/Net/OpenID/Consumer/Fetchers.php +++ b/Net/OpenID/Consumer/Fetchers.php @@ -32,6 +32,16 @@ $_Net_OpenID_allowed_schemes = array('http', 'https'); * @package OpenID */ class Net_OpenID_HTTPFetcher { + + /** + * This performs an HTTP get, following redirects along the way. + * + * @return array $tuple This returns a three-tuple on success. + * The first value is the http return code. The second value is + * the final url that was fetched, after following any redirects. + * The third value is the data that was retrieved from the site. + * If the fetch didn't succeed, return null. + */ function get($url) { trigger_error("not implemented", E_USER_ERROR); @@ -40,6 +50,12 @@ class Net_OpenID_HTTPFetcher { /** * This performs an HTTP post. If it makes sense, it will follow * redirects along the way. + * + * @return array $tuple This returns a three-tuple on success. + * The first value is the http return code. The second value is + * the final url that was fetched, after following any redirects. + * The third value is the data that was retrieved from the site. + * If the fetch didn't succeed, return null. */ function post($url, $body) { |