Page MenuHomePhabricator

final class PhutilOAuth1Future
libphutil Technical Documentation (Futures)

Proxy future that implements OAuth1 request signing. For references, see:

RFC 5849: http://tools.ietf.org/html/rfc5849 Guzzle: https://github.com/guzzle/guzzle/blob/master/src/Guzzle/Plugin/Oauth/OauthPlugin.php

Methods

public function isReady()
Inherited

Future

Is this future's process complete? Specifically, can this future be resolved without blocking?

Return
boolIf true, the external process is complete and resolving this future will not block.

public function resolve()
Inherited

Future

Resolve a future and return its result, blocking until the result is ready if necessary.

Return
wildFuture result.

final public function updateFuture()
Inherited

This method is not documented.
Return
wild

private function startServiceProfiler()
Inherited

This method is not documented.
Return
wild

private function endServiceProfiler()
Inherited

This method is not documented.
Return
wild

protected function getServiceProfilerStartParameters()
Inherited

This method is not documented.
Return
wild

protected function getServiceProfilerResultParameters()
Inherited

This method is not documented.
Return
wild

public function getReadSockets()
Inherited

Future

Retrieve a list of sockets which we can wait to become readable while a future is resolving. If your future has sockets which can be select()ed, return them here (or in getWriteSockets()) to make the resolve loop do a select(). If you do not return sockets in either case, you'll get a busy wait.

Return
listA list of sockets which we expect to become readable.

public function getWriteSockets()
Inherited

Future

Retrieve a list of sockets which we can wait to become writable while a future is resolving. See getReadSockets().

Return
listA list of sockets which we expect to become writable.

public function getDefaultWait()
Inherited

Future

Default amount of time to wait on stream select for this future. Normally 1 second is fine, but if the future has a timeout sooner than that it should return the amount of time left before the timeout.

Return
wild

public function start()
Inherited

This method is not documented.
Return
wild

final protected function getResult()
Inherited

Future

Retrieve the final result of the future.

Return
wildFinal resolution of this future.

final protected function setResult($result)
Inherited

This method is not documented.
Parameters
$result
Return
wild

final public function hasResult()
Inherited

This method is not documented.
Return
wild

private function setException($exception)
Inherited

This method is not documented.
Parameters
$exception
Return
wild

private function getException()
Inherited

This method is not documented.
Return
wild

final public function hasException()
Inherited

This method is not documented.
Return
wild

final public function setFutureKey($key)
Inherited

This method is not documented.
Parameters
$key
Return
wild

final public function getFutureKey()
Inherited

This method is not documented.
Return
wild

final public function setRaiseExceptionOnStart($raise)
Inherited

This method is not documented.
Parameters
$raise
Return
wild

final public function getHasFutureStarted()
Inherited

This method is not documented.
Return
wild

final public function canResolve()
Inherited

This method is not documented.
Return
wild

private function endFuture()
Inherited

This method is not documented.
Return
wild

public function __construct($uri, $data)

This method is not documented.
Parameters
Future$proxied
Return
this//Implicit.//

public function setProxiedFuture($proxied)
Inherited

This method is not documented.
Parameters
Future$proxied
Return
wild

protected function getProxiedFuture()

This method is not documented.
Return
wild

protected function didReceiveResult($result)

This method is not documented.
Parameters
$result
Return
wild

protected function didReceiveException($exception)
Inherited

This method is not documented.
Parameters
$exception
Return
wild

public function setCallbackURI($callback_uri)

This method is not documented.
Parameters
$callback_uri
Return
wild

public function setTimestamp($timestamp)

This method is not documented.
Parameters
$timestamp
Return
wild

public function setNonce($nonce)

This method is not documented.
Parameters
$nonce
Return
wild

public function setTokenSecret($token_secret)

This method is not documented.
Parameters
$token_secret
Return
wild

public function setToken($token)

This method is not documented.
Parameters
$token
Return
wild

public function setPrivateKey($private_key)

This method is not documented.
Parameters
PhutilOpaqueEnvelope$private_key
Return
wild

public function setSignatureMethod($signature_method)

This method is not documented.
Parameters
$signature_method
Return
wild

public function setConsumerKey($consumer_key)

This method is not documented.
Parameters
$consumer_key
Return
wild

public function setConsumerSecret($consumer_secret)

This method is not documented.
Parameters
PhutilOpaqueEnvelope$consumer_secret
Return
wild

public function setMethod($method)

This method is not documented.
Parameters
$method
Return
wild

public function setTimeout($timeout)

This method is not documented.
Parameters
$timeout
Return
wild

public function getTimeout()

This method is not documented.
Return
wild

public function getSignature()

This method is not documented.
Return
wild

public function addHeader($name, $value)

This method is not documented.
Parameters
$name
$value
Return
wild

private function getOAuth1Headers()

This method is not documented.
Return
wild

private function sign($params)

This method is not documented.
Parameters
array$params
Return
wild

private function signString($string)

This method is not documented.
Parameters
$string
Return
wild

public function resolvex()

This method is not documented.
Return
wild

public function resolveJSON()

This method is not documented.
Return
wild