Fetch an OAuth protected resource

- « OAuth::enableSSLChecks

- OAuth::generateSignature »

- PHP Manual
- OAuth
- Fetch an OAuth protected resource

# OAuth::fetch

(PECL OAuth >= 0.99.1)

OAuth::fetch — Fetch an OAuth protected resource

### Description

public OAuth::fetch(
string `$protected_resource_url`,
array `$extra_parameters` = ?,
string `$http_method` = ?,
array `$http_headers` = ?
): mixed

Fetch a resource.

### Parameters

`protected_resource_url`

  URL to the OAuth protected resource.

`extra_parameters`

  Extra parameters to send with the request for the resource.

`http_method`

  One of the `OAUTH_HTTP_METHOD_*` OAUTH constants, which includes GET, POST, PUT, HEAD, or DELETE.

  HEAD (`OAUTH_HTTP_METHOD_HEAD`) can be useful for discovering information prior to the request (if OAuth credentials are in the `Authorization` header).

`http_headers`

  HTTP client headers (such as User-Agent, Accept, etc.)

### Return Values

Returns `true` on success or `false` on failure.

### Changelog

Version | Description
--- | ---
PECL oauth 1.0.0 | Previously returned `null` on failure, instead of `false`.
PECL oauth 0.99.5 | The `http_method` parameter was added
PECL oauth 0.99.8 | The `http_headers` parameter was added

### Examples

Example #1 OAuth::fetch() example

    <?php
    try {
        $oauth = new OAuth("consumer_key","consumer_secret",OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_AUTHORIZATION);
        $oauth->setToken("access_token","access_token_secret");

        $oauth->fetch("http://photos.example.net/photo?file=vacation.jpg");

        $response_info = $oauth->getLastResponseInfo();
        header("Content-Type: {$response_info["content_type"]}");
        echo $oauth->getLastResponse();
    } catch(OAuthException $E) {
        echo "Exception caught!\n";
        echo "Response: ". $E->lastResponse . "\n";
    }
    ?>

### See Also

- OAuth::getLastResponse() - Get the last response
- OAuth::getLastResponseInfo() - Get HTTP information about the last response
- OAuth::setToken() - Sets the token and secret