Auth_Yadis_HTTPFetcher Class Reference
Detailed Description
This class is the interface for HTTP fetchers the Yadis library uses. This interface is only important if you need to write a new fetcher for some reason.private
Definition at line 43 of file HTTPFetcher.php.
Public Member Functions | |
| canFetchURL ($url) | |
| allowedURL ($url) | |
| supportsSSL () | |
| isHTTPS ($url) | |
| URLHasAllowedScheme ($url) | |
| _findRedirect ($headers) | |
| get ($url, $headers) | |
Public Attributes | |
| $timeout = 20 | |
Member Function Documentation
| Auth_Yadis_HTTPFetcher.canFetchURL | ( | $ | url | ) |
Return whether a URL can be fetched. Returns false if the URL scheme is not allowed or is not supported by this fetcher implementation; returns true otherwise.
- Returns:
- bool
Definition at line 54 of file HTTPFetcher.php.
| Auth_Yadis_HTTPFetcher.allowedURL | ( | $ | url | ) |
Return whether a URL should be allowed. Override this method to conform to your local policy.
By default, will attempt to fetch any http or https URL.
Definition at line 77 of file HTTPFetcher.php.
| Auth_Yadis_HTTPFetcher.supportsSSL | ( | ) |
Does this fetcher implementation (and runtime) support fetching HTTPS URLs? May inspect the runtime environment.
- Returns:
- bool $support True if this fetcher supports HTTPS fetching; false if not.
Reimplemented in Auth_Yadis_ParanoidHTTPFetcher, and Auth_Yadis_PlainHTTPFetcher.
Definition at line 89 of file HTTPFetcher.php.
| Auth_Yadis_HTTPFetcher.isHTTPS | ( | $ | url | ) |
| Auth_Yadis_HTTPFetcher.URLHasAllowedScheme | ( | $ | url | ) |
| Auth_Yadis_HTTPFetcher._findRedirect | ( | $ | headers | ) |
private
Definition at line 117 of file HTTPFetcher.php.
| Auth_Yadis_HTTPFetcher.get | ( | $ | url, | |
| $ | headers | |||
| ) |
Fetches the specified URL using optional extra headers and returns the server's response.
- Parameters:
-
string $url The URL to be fetched. array $extra_headers An array of header strings (e.g. "Accept: text/html").
- Returns:
- mixed $result An array of ($code, $url, $headers, $body) if the URL could be fetched; null if the URL does not pass the URLHasAllowedScheme check or if the server's response is malformed.
Reimplemented in Auth_Yadis_ParanoidHTTPFetcher, and Auth_Yadis_PlainHTTPFetcher.
Definition at line 140 of file HTTPFetcher.php.
Member Data Documentation
| Auth_Yadis_HTTPFetcher.$timeout = 20 |
Definition at line 45 of file HTTPFetcher.php.
The documentation for this class was generated from the following file:
- core/openid/Auth/Yadis/HTTPFetcher.php
