OAuth::setAuthType
OAuth::setAuthType
(PECL OAuth >= 0.99.1)
OAuth::setAuthType — Set authorization type
Description
public mixed OAuth::setAuthType ( int $auth_type )
Set where the OAuth parameters should be passed.
Parameters
-
auth_type -
auth_typecan be one of the following flags (in order of decreasing preference as per OAuth 1.0 section 5.2):-
OAUTH_AUTH_TYPE_AUTHORIZATION - Pass the OAuth parameters in the HTTP Authorization header.
-
OAUTH_AUTH_TYPE_FORM - Append the OAuth parameters to the HTTP POST request body.
-
OAUTH_AUTH_TYPE_URI - Append the OAuth parameters to the request URI.
-
OAUTH_AUTH_TYPE_NONE - None.
-
Return Values
Returns TRUE if a parameter is correctly set, otherwise FALSE (e.g., if an invalid auth_type is passed in.)
Changelog
| Version | Description |
|---|---|
| 1.0.0 | Previously returned NULL on failure, instead of FALSE. |
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/oauth.setauthtype.php
