OAuthProvider

class OAuthProvider (View source)

Manages an OAuth provider class.

Methods

bool
addRequiredParameter(string $req_params)

No description

void
callconsumerHandler()

No description

void
callTimestampNonceHandler()

No description

void
calltokenHandler()

No description

void
checkOAuthRequest(string $uri = '', string $method = '')

No description

__construct(array $params_array)

No description

void
consumerHandler(callable $callback_function)

No description

static string
generateToken(int $size, bool $strong = false)

No description

void
is2LeggedEndpoint(mixed $params_array)

No description

void
isRequestTokenEndpoint(bool $will_issue_request_token)

No description

bool
removeRequiredParameter(string $req_params)

No description

static string
reportProblem(string $oauthexception, bool $send_headers = true)

No description

bool
setParam(string $param_key, mixed $param_val = null)

No description

bool
setRequestTokenPath(string $path)

No description

void
timestampNonceHandler(callable $callback_function)

No description

void
tokenHandler(callable $callback_function)

No description

Details

at line 292
final bool addRequiredParameter(string $req_params)

No description

Parameters

string $req_params

The required parameters.

Return Value

bool

at line 297
void callconsumerHandler()

No description

Return Value

void

at line 302
void callTimestampNonceHandler()

No description

Return Value

void

at line 307
void calltokenHandler()

No description

Return Value

void

at line 315
void checkOAuthRequest(string $uri = '', string $method = '')

No description

Parameters

string $uri

The optional URI, or endpoint.
string $method

The HTTP method. Optionally pass in one of the OAUTH_HTTPMETHOD* OAuth constants.

Return Value

void

at line 320
__construct(array $params_array)

No description

Parameters

array $params_array

Setting these optional parameters is limited to the CLI SAPI.

at line 326
void consumerHandler(callable $callback_function)

No description

Parameters

callable $callback_function

The callable functions name.

Return Value

void

at line 334
final static string generateToken(int $size, bool $strong = false)

No description

Parameters

int $size

The desired token length, in terms of bytes.
bool $strong

Setting to true means /dev/random will be used for entropy, as otherwise the non-blocking /dev/urandom is used. This parameter is ignored on Windows.

Return Value

string

The generated token, as a string of bytes.

at line 340
void is2LeggedEndpoint(mixed $params_array)

No description

Parameters

mixed $params_array

Return Value

void

at line 347
void isRequestTokenEndpoint(bool $will_issue_request_token)

No description

Parameters

bool $will_issue_request_token

Sets whether or not it will issue a request token, thus determining if OAuthProvider::tokenHandler needs to be called.

Return Value

void

at line 353
final bool removeRequiredParameter(string $req_params)

No description

Parameters

string $req_params

The required parameter to be removed.

Return Value

bool

at line 360
final static string reportProblem(string $oauthexception, bool $send_headers = true)

No description

Parameters

string $oauthexception

The OAuthException.
bool $send_headers

Return Value

string

at line 368
final bool setParam(string $param_key, mixed $param_val = null)

No description

Parameters

string $param_key

The parameter key.
mixed $param_val

The optional parameter value. To exclude a parameter from signature verification, set its value to null.

Return Value

bool

at line 374
final bool setRequestTokenPath(string $path)

No description

Parameters

string $path

The path.

Return Value

bool

at line 380
void timestampNonceHandler(callable $callback_function)

No description

Parameters

callable $callback_function

The callable functions name.

Return Value

void

at line 386
void tokenHandler(callable $callback_function)

No description

Parameters

callable $callback_function

The callable functions name.

Return Value

void