api · PHP笔记

## [**预定义常量**](https://www.php.net/manual/zh/oauth.constants.php) ``` OAUTH_SIG_METHOD_RSASHA1 (字符串):OAuth RSA-SHA1 签名方法。 OAUTH_SIG_METHOD_HMACSHA1 (字符串):OAuth HMAC-SHA1 签名方法。 OAUTH_SIG_METHOD_HMACSHA256 (字符串):OAuth HMAC-SHA256 签名方法。 OAUTH_AUTH_TYPE_AUTHORIZATION (字符串):此常量代表把 OAuth 参数放在 Authorization 头部。 OAUTH_AUTH_TYPE_NONE (字符串):此常量标志着一个 NoAuth OAuth 请求。 OAUTH_AUTH_TYPE_URI (字符串):此常量表示将 OAuth 参数放在请求中。 URI. OAUTH_AUTH_TYPE_FORM (字符串):此常量表示将 OAuth 参数作为 HTTP POST 主体的一部分。 OAUTH_HTTP_METHOD_GET (字符串):为 OAuth 请求使用 GET 方法。 OAUTH_HTTP_METHOD_POST (字符串):为 OAuth 请求使用 POST 方法。 OAUTH_HTTP_METHOD_PUT (字符串):为 OAuth 请求使用 PUT 方法。 OAUTH_HTTP_METHOD_HEAD (字符串):为 OAuth 请求使用 HEAD 方法。 OAUTH_HTTP_METHOD_DELETE (字符串):为 OAuth 请求使用 DELETE 方法。 OAUTH_REQENGINE_STREAMS (整型):使用 OAuth::setRequestEngine() 来设置引擎为 PHP 流，与用 OAUTH_REQENGINE_CURL 的 Curl 截然相反。 OAUTH_REQENGINE_CURL (整型):使用 OAuth::setRequestEngine() 来设置引擎为 Curl，与用 OAUTH_REQENGINE_STREAMS 的 PHP 流截然相反。 OAUTH_OK (整型):一切良好。 OAUTH_BAD_NONCE (整型):oauth_nonce 值已经用于上一个上一个请求，因此现在不能使用了。 OAUTH_BAD_TIMESTAMP (整型):oauth_timestamp 值不能被服务提供者接受。这种情况下，响应应该也包含 oauth_acceptable_timestamps 参数。 OAUTH_CONSUMER_KEY_UNKNOWN (整型):oauth_consumer_key 暂时不能被服务提供者接受。比如，服务提供者限流了使用者。 OAUTH_CONSUMER_KEY_REFUSED (整型):使用者密钥遭拒绝。 OAUTH_INVALID_SIGNATURE (整型):oauth_signature 无效，因为和服务提供者的签名计算不匹配。 OAUTH_TOKEN_USED (整型):oauth_token 已经被消费。此令牌不能再被使用，因为在上一次请求中已经使用过。 OAUTH_TOKEN_EXPIRED (整型):oauth_token 已经过期。 OAUTH_TOKEN_REVOKED (整型):oauth_token 已经被撤销，且将决不再接受。 OAUTH_TOKEN_REJECTED (整型):oauth_token 被服务提供者拒绝。原因未知，也许是因为令牌从未发布、已经消费、过期、或服务提供者忘记了。 OAUTH_VERIFIER_INVALID (整型):oauth_verifier 不正确。 OAUTH_PARAMETER_ABSENT (整型):一个必需的参数没有接收到。这种情况下，响应也应该包含 oauth_parameters_absent 参数。 OAUTH_SIGNATURE_METHOD_REJECTED (整型):oauth_signature_method 不能被服务提供者接受。 ``` ## [**OAuth 函数**](https://www.php.net/manual/zh/ref.oauth.php) [oauth\_get\_sbs](https://www.php.net/manual/zh/function.oauth-get-sbs.php)— 生成一个签名字符基串 [oauth\_urlencode](https://www.php.net/manual/zh/function.oauth-urlencode.php)— 将 URI 编码为 RFC 3986 规范 ## [**OAuth**](https://www.php.net/manual/zh/class.oauth.php)— OAuth 类 **属性** public[$debug](https://www.php.net/manual/zh/class.oauth.php#oauth.props.debug); public[$sslChecks](https://www.php.net/manual/zh/class.oauth.php#oauth.props.sslchecks); public[$debugInfo](https://www.php.net/manual/zh/class.oauth.php#oauth.props.debuginfo); **方法** [OAuth::\_\_construct](https://www.php.net/manual/zh/oauth.construct.php)(string`$consumer_key`,string`$consumer_secret`\[,string`$signature_method`\=**`OAUTH_SIG_METHOD_HMACSHA1`**\[,int`$auth_type`\= 0\]\] )— 新建一个 OAuth 对象 >[info]`consumer_key`: 由服务提供者提供的 consumer key 。 >[info]`consumer_secret`: 由服务提供者提供的 consumer secret 。 >[info]`signature_method`: 可选参数，用来定义使用哪种签名方法，默认为 **`OAUTH_SIG_METHOD_HMACSHA1`**（HMAC-SHA1）。 (可用：OAUTH_SIG_METHOD_HMACSHA1、OAUTH_SIG_METHOD_HMACSHA256、OAUTH_SIG_METHOD_RSASHA1、OAUTH_SIG_METHOD_PLAINTEXT) >[info]`auth_type`: 可选参数，用来定义如何传递 OAuth 参数给消费方，默认为 **`OAUTH_AUTH_TYPE_AUTHORIZATION`**（在*Authorization*头部）。(可用：OAUTH_AUTH_TYPE_AUTHORIZATION、OAUTH_AUTH_TYPE_URI、OAUTH_AUTH_TYPE_FORM、OAUTH_AUTH_TYPE_NONE) [OAuth::__destruct](https://www.php.net/manual/zh/oauth.destruct.php)():void— 析构函数 [OAuth::disableDebug](https://www.php.net/manual/zh/oauth.disabledebug.php)(void) :bool— 关闭详细的调试（默认为关闭）或者，将debug属性设置为`FALSE` [OAuth::enableDebug](https://www.php.net/manual/zh/oauth.enabledebug.php)(void) :bool— 启用详细调试 [OAuth::disableRedirects](https://www.php.net/manual/zh/oauth.disableredirects.php)(void) :bool— 关闭重定向（默认为启用） [OAuth::enableRedirects](https://www.php.net/manual/zh/oauth.enableredirects.php)(void) :bool— 启用重定向 [OAuth::disableSSLChecks](https://www.php.net/manual/zh/oauth.disablesslchecks.php)(void) :bool— 关闭 SSL 检查（默认为启用），或者设置`sslChecks`成员属性为`FALSE`来关闭 SSL 检查 [OAuth::enableSSLChecks](https://www.php.net/manual/zh/oauth.enablesslchecks.php)(void) :bool— 启用 SSL 检查（默认为启用） [**OAuth::fetch**](https://www.php.net/manual/zh/oauth.fetch.php)(string`$protected_resource_url`\[,array`$extra_parameters`\[,string`$http_method`\[,array`$http_headers`\]\]\] ) :[mixed](https://www.php.net/manual/zh/language.pseudo-types.php#language.types.mixed)— 获取一个 OAuth 受保护的资源 >[info]`protected_resource_url`：OAuth 受保护资源的URL >[info]`extra_parameters`：和资源请求一起发送的额外参数。 >[info]`http_method`：**`OAUTH_HTTP_METHOD_*`** 系列[OAUTH 常量](https://www.php.net/manual/zh/oauth.constants.php)之一，GET、POST、PUT、HEAD 或 DELETE 其中的一个。 HEAD （`OAUTH_HTTP_METHOD_HEAD`）可以用于先于请求发现信息（如果 OAuth 证书在*Authorization*头部）。 >[info]`http_headers`：HTTP 客户端头信息（像 User-Agent， Accept 等等这样的）。 [OAuth::generateSignature](https://www.php.net/manual/zh/oauth.generatesignature.php)— 生成一个签名 [OAuth::getAccessToken](https://www.php.net/manual/zh/oauth.getaccesstoken.php)— 获取一个访问令牌 [OAuth::getCAPath](https://www.php.net/manual/zh/oauth.getcapath.php)— 获取 CA 信息 [OAuth::getLastResponse](https://www.php.net/manual/zh/oauth.getlastresponse.php)— 获取最后一次的响应 [OAuth::getLastResponseHeaders](https://www.php.net/manual/zh/oauth.getlastresponseheaders.php)— 获取最后一次响应的头信息 [OAuth::getLastResponseInfo](https://www.php.net/manual/zh/oauth.getlastresponseinfo.php)— 获取关于最后一次响应的 HTTP 信息 [OAuth::getRequestHeader](https://www.php.net/manual/zh/oauth.getrequestheader.php)— 生成 OAuth 头信息字符串签名 [OAuth::getRequestToken](https://www.php.net/manual/zh/oauth.getrequesttoken.php)— 获取一个请求令牌 [OAuth::setAuthType](https://www.php.net/manual/zh/oauth.setauthtype.php)— 设置授权类型 [OAuth::setCAPath](https://www.php.net/manual/zh/oauth.setcapath.php)— 设置 CA 路径和信息 [OAuth::setNonce](https://www.php.net/manual/zh/oauth.setnonce.php)— 为后续请求设置现时标志 [OAuth::setRequestEngine](https://www.php.net/manual/zh/oauth.setrequestengine.php)— 设置目标请求引擎 [OAuth::setRSACertificate](https://www.php.net/manual/zh/oauth.setrsacertificate.php)— 设置 RSA 证书 [OAuth::setSSLChecks](https://www.php.net/manual/zh/oauth.setsslchecks.php)— 调整特定的SSL请求检查 [OAuth::setTimestamp](https://www.php.net/manual/zh/oauth.settimestamp.php)— 设置时间戳 [OAuth::setToken](https://www.php.net/manual/zh/oauth.settoken.php)— 设置令牌和 secret [OAuth::setVersion](https://www.php.net/manual/zh/oauth.setversion.php)— 设置 OAuth 版本 ## [**OAuthProvider**](https://www.php.net/manual/zh/class.oauthprovider.php)— OAuthProvider 类 [OAuthProvider::addRequiredParameter](https://www.php.net/manual/zh/oauthprovider.addrequiredparameter.php)— 添加必需的参数 [OAuthProvider::callconsumerHandler](https://www.php.net/manual/zh/oauthprovider.callconsumerhandler.php)— 调用 consumerNonceHandler 回调函数 [OAuthProvider::callTimestampNonceHandler](https://www.php.net/manual/zh/oauthprovider.calltimestampnoncehandler.php)— 调用 timestampNonceHandler 回调函数 [OAuthProvider::calltokenHandler](https://www.php.net/manual/zh/oauthprovider.calltokenhandler.php)— 调用 tokenNonceHandler 回调函数 [OAuthProvider::checkOAuthRequest](https://www.php.net/manual/zh/oauthprovider.checkoauthrequest.php)— 检查一个 oauth 请求 [OAuthProvider::\_\_construct](https://www.php.net/manual/zh/oauthprovider.construct.php)— 新建一个 OAuthProvider 对象 [OAuthProvider::consumerHandler](https://www.php.net/manual/zh/oauthprovider.consumerhandler.php)— 设置 consumerHandler 句柄回调函数 [OAuthProvider::generateToken](https://www.php.net/manual/zh/oauthprovider.generatetoken.php)— 生成一个随机令牌 [OAuthProvider::is2LeggedEndpoint](https://www.php.net/manual/zh/oauthprovider.is2leggedendpoint.php)— is2LeggedEndpoint [OAuthProvider::isRequestTokenEndpoint](https://www.php.net/manual/zh/oauthprovider.isrequesttokenendpoint.php)— 设置 isRequestTokenEndpoint [OAuthProvider::removeRequiredParameter](https://www.php.net/manual/zh/oauthprovider.removerequiredparameter.php)— 移除一个必需的参数 [OAuthProvider::reportProblem](https://www.php.net/manual/zh/oauthprovider.reportproblem.php)— 报告问题 [OAuthProvider::setParam](https://www.php.net/manual/zh/oauthprovider.setparam.php)— 设置一个参数 [OAuthProvider::setRequestTokenPath](https://www.php.net/manual/zh/oauthprovider.setrequesttokenpath.php)— 设置请求令牌路径 [OAuthProvider::timestampNonceHandler](https://www.php.net/manual/zh/oauthprovider.timestampnoncehandler.php)— 设置 timestampNonceHandler 句柄回调函数 [OAuthProvider::tokenHandler](https://www.php.net/manual/zh/oauthprovider.tokenhandler.php)— 设置 tokenHandler 句柄回调函数 ## [**OAuthException**](https://www.php.net/manual/zh/class.oauthexception.php)— OAuthException 类