The OAuth class
(PECL OAuth >= 0.99.1)
Introduction
The OAuth extension provides a simple interface to interact with data providers using the OAuth HTTP specification to protect private resources.
Class synopsis
$consumer_key
, string $consumer_secret
[, string $signature_method
= OAUTH_SIG_METHOD_HMACSHA1
[, int $auth_type
= 0
]] )$protected_resource_url
[, array $extra_parameters
[, string $http_method
[, array $http_headers
]]] ) : mixed$http_method
, string $url
[, mixed $extra_parameters
] ) : string$access_token_url
[, string $auth_session_handle
[, string $verifier_token
[, string $http_method
]]] ) : array$request_token_url
[, string $callback_url
[, string $http_method
]] ) : arrayTable of Contents
- OAuth::__construct — Create a new OAuth object
- OAuth::__destruct — The destructor
- OAuth::disableDebug — Turn off verbose debugging
- OAuth::disableRedirects — Turn off redirects
- OAuth::disableSSLChecks — Turn off SSL checks
- OAuth::enableDebug — Turn on verbose debugging
- OAuth::enableRedirects — Turn on redirects
- OAuth::enableSSLChecks — Turn on SSL checks
- OAuth::fetch — Fetch an OAuth protected resource
- OAuth::generateSignature — Generate a signature
- OAuth::getAccessToken — Fetch an access token
- OAuth::getCAPath — Gets CA information
- OAuth::getLastResponse — Get the last response
- OAuth::getLastResponseHeaders — Get headers for last response
- OAuth::getLastResponseInfo — Get HTTP information about the last response
- OAuth::getRequestHeader — Generate OAuth header string signature
- OAuth::getRequestToken — Fetch a request token
- OAuth::setAuthType — Set authorization type
- OAuth::setCAPath — Set CA path and info
- OAuth::setNonce — Set the nonce for subsequent requests
- OAuth::setRequestEngine — The setRequestEngine purpose
- OAuth::setRSACertificate — Set the RSA certificate
- OAuth::setSSLChecks — Tweak specific SSL checks for requests
- OAuth::setTimestamp — Set the timestamp
- OAuth::setToken — Sets the token and secret
- OAuth::setVersion — Set the OAuth version
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.oauth.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.