code
stringlengths 17
247k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
protected function recordLastTransactionID()
{
$reply = $this->getLastReply();
if (empty($reply)) {
$this->last_smtp_transaction_id = null;
} else {
$this->last_smtp_transaction_id = false;
foreach ($this->smtp_transaction_id_patterns as $smtp_transaction_id_pattern) {
if (preg_match($smtp_transaction_id_pattern, $reply, $matches)) {
$this->last_smtp_transaction_id = $matches[1];
}
}
}
return $this->last_smtp_transaction_id;
} | Extract and return the ID of the last SMTP transaction based on
a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
Relies on the host providing the ID in response to a DATA command.
If no reply has been received yet, it will return null.
If no pattern was matched, it will return false.
@return bool|null|string | recordLastTransactionID | php | boonex/dolphin.pro | plugins/phpmailer/class.smtp.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/phpmailer/class.smtp.php | MIT |
public function getLastTransactionID()
{
return $this->last_smtp_transaction_id;
} | Get the queue/transaction ID of the last SMTP transaction
If no reply has been received yet, it will return null.
If no pattern was matched, it will return false.
@return bool|null|string
@see recordLastTransactionID() | getLastTransactionID | php | boonex/dolphin.pro | plugins/phpmailer/class.smtp.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/phpmailer/class.smtp.php | MIT |
function _recaptcha_qsencode ($data) {
$req = "";
foreach ( $data as $key => $value )
$req .= $key . '=' . urlencode( stripslashes($value) ) . '&';
// Cut the last '&'
$req=substr($req,0,strlen($req)-1);
return $req;
} | Encodes the given data into a query string format
@param $data - array of string elements to be encoded
@return string - encoded request | _recaptcha_qsencode | php | boonex/dolphin.pro | plugins/recaptcha/recaptchalib.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/recaptcha/recaptchalib.php | MIT |
function _recaptcha_http_post($host, $path, $data, $port = 80) {
$req = _recaptcha_qsencode ($data);
$http_request = "POST $path HTTP/1.0\r\n";
$http_request .= "Host: $host\r\n";
$http_request .= "Content-Type: application/x-www-form-urlencoded;\r\n";
$http_request .= "Content-Length: " . strlen($req) . "\r\n";
$http_request .= "User-Agent: reCAPTCHA/PHP\r\n";
$http_request .= "\r\n";
$http_request .= $req;
$response = '';
if( false == ( $fs = @fsockopen($host, $port, $errno, $errstr, 10) ) ) {
die ('Could not open socket');
}
fwrite($fs, $http_request);
while ( !feof($fs) )
$response .= fgets($fs, 1160); // One TCP-IP packet
fclose($fs);
$response = explode("\r\n\r\n", $response, 2);
return $response;
} | Submits an HTTP POST to a reCAPTCHA server
@param string $host
@param string $path
@param array $data
@param int port
@return array response | _recaptcha_http_post | php | boonex/dolphin.pro | plugins/recaptcha/recaptchalib.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/recaptcha/recaptchalib.php | MIT |
function recaptcha_get_html ($pubkey, $error = null, $use_ssl = false)
{
if ($pubkey == null || $pubkey == '') {
die ("To use reCAPTCHA you must get an API key from <a href='https://www.google.com/recaptcha/admin/create'>https://www.google.com/recaptcha/admin/create</a>");
}
if ($use_ssl) {
$server = RECAPTCHA_API_SECURE_SERVER;
} else {
$server = RECAPTCHA_API_SERVER;
}
$errorpart = "";
if ($error) {
$errorpart = "&error=" . $error;
}
return '<script type="text/javascript" src="'. $server . '/challenge?k=' . $pubkey . $errorpart . '"></script>
<noscript>
<iframe src="'. $server . '/noscript?k=' . $pubkey . $errorpart . '" height="300" width="500" frameborder="0"></iframe><br/>
<textarea name="recaptcha_challenge_field" rows="3" cols="40"></textarea>
<input type="hidden" name="recaptcha_response_field" value="manual_challenge"/>
</noscript>';
} | Gets the challenge HTML (javascript and non-javascript version).
This is called from the browser, and the resulting reCAPTCHA HTML widget
is embedded within the HTML form it was called from.
@param string $pubkey A public key for reCAPTCHA
@param string $error The error given by reCAPTCHA (optional, default is null)
@param boolean $use_ssl Should the request be made over ssl? (optional, default is false)
@return string - The HTML to be embedded in the user's form. | recaptcha_get_html | php | boonex/dolphin.pro | plugins/recaptcha/recaptchalib.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/recaptcha/recaptchalib.php | MIT |
function _recaptcha_mailhide_email_parts ($email) {
$arr = preg_split("/@/", $email );
if (strlen ($arr[0]) <= 4) {
$arr[0] = substr ($arr[0], 0, 1);
} else if (strlen ($arr[0]) <= 6) {
$arr[0] = substr ($arr[0], 0, 3);
} else {
$arr[0] = substr ($arr[0], 0, 4);
}
return $arr;
} | gets the parts of the email to expose to the user.
eg, given johndoe@example,com return ["john", "example.com"].
the email is then displayed as [email protected] | _recaptcha_mailhide_email_parts | php | boonex/dolphin.pro | plugins/recaptcha/recaptchalib.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/recaptcha/recaptchalib.php | MIT |
function recaptcha_mailhide_html($pubkey, $privkey, $email) {
$emailparts = _recaptcha_mailhide_email_parts ($email);
$url = recaptcha_mailhide_url ($pubkey, $privkey, $email);
return htmlentities($emailparts[0]) . "<a href='" . htmlentities ($url) .
"' onclick=\"window.open('" . htmlentities ($url) . "', '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return false;\" title=\"Reveal this e-mail address\">...</a>@" . htmlentities ($emailparts [1]);
} | Gets html to display an email address given a public an private key.
to get a key, go to:
http://www.google.com/recaptcha/mailhide/apikey | recaptcha_mailhide_html | php | boonex/dolphin.pro | plugins/recaptcha/recaptchalib.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/recaptcha/recaptchalib.php | MIT |
public function serialize()
{
return implode('|', [$this->id, $this->secret]);
} | Serializes the FacebookApp entity as a string.
@return string | serialize | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookApp.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookApp.php | MIT |
public function unserialize($serialized)
{
list($id, $secret) = explode('|', $serialized);
$this->__construct($id, $secret);
} | Unserializes a string as a FacebookApp entity.
@param string $serialized | unserialize | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookApp.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookApp.php | MIT |
public function __construct(FacebookHttpClientInterface $httpClientHandler = null, $enableBeta = false)
{
$this->httpClientHandler = $httpClientHandler ?: $this->detectHttpClientHandler();
$this->enableBetaMode = $enableBeta;
} | Instantiates a new FacebookClient object.
@param FacebookHttpClientInterface|null $httpClientHandler
@param boolean $enableBeta | __construct | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | MIT |
public function getHttpClientHandler()
{
return $this->httpClientHandler;
} | Returns the HTTP client handler.
@return FacebookHttpClientInterface | getHttpClientHandler | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | MIT |
public function detectHttpClientHandler()
{
return extension_loaded('curl') ? new FacebookCurlHttpClient() : new FacebookStreamHttpClient();
} | Detects which HTTP client handler to use.
@return FacebookHttpClientInterface | detectHttpClientHandler | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | MIT |
public function prepareRequestMessage(FacebookRequest $request)
{
$postToVideoUrl = $request->containsVideoUploads();
$url = $this->getBaseGraphUrl($postToVideoUrl) . $request->getUrl();
// If we're sending files they should be sent as multipart/form-data
if ($request->containsFileUploads()) {
$requestBody = $request->getMultipartBody();
$request->setHeaders([
'Content-Type' => 'multipart/form-data; boundary=' . $requestBody->getBoundary(),
]);
} else {
$requestBody = $request->getUrlEncodedBody();
$request->setHeaders([
'Content-Type' => 'application/x-www-form-urlencoded',
]);
}
return [
$url,
$request->getMethod(),
$request->getHeaders(),
$requestBody->getBody(),
];
} | Prepares the request for sending to the client handler.
@param FacebookRequest $request
@return array | prepareRequestMessage | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | MIT |
public function sendRequest(FacebookRequest $request)
{
if (get_class($request) === 'Facebook\FacebookRequest') {
$request->validateAccessToken();
}
list($url, $method, $headers, $body) = $this->prepareRequestMessage($request);
// Since file uploads can take a while, we need to give more time for uploads
$timeOut = static::DEFAULT_REQUEST_TIMEOUT;
if ($request->containsFileUploads()) {
$timeOut = static::DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT;
} elseif ($request->containsVideoUploads()) {
$timeOut = static::DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT;
}
// Should throw `FacebookSDKException` exception on HTTP client error.
// Don't catch to allow it to bubble up.
$rawResponse = $this->httpClientHandler->send($url, $method, $body, $headers, $timeOut);
static::$requestCount++;
$returnResponse = new FacebookResponse(
$request,
$rawResponse->getBody(),
$rawResponse->getHttpResponseCode(),
$rawResponse->getHeaders()
);
if ($returnResponse->isError()) {
throw $returnResponse->getThrownException();
}
return $returnResponse;
} | Makes the request to Graph and returns the result.
@param FacebookRequest $request
@return FacebookResponse
@throws FacebookSDKException | sendRequest | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | MIT |
public function sendBatchRequest(FacebookBatchRequest $request)
{
$request->prepareRequestsForBatch();
$facebookResponse = $this->sendRequest($request);
return new FacebookBatchResponse($request, $facebookResponse);
} | Makes a batched request to Graph and returns the result.
@param FacebookBatchRequest $request
@return FacebookBatchResponse
@throws FacebookSDKException | sendBatchRequest | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookClient.php | MIT |
public function __construct(FacebookBatchRequest $batchRequest, FacebookResponse $response)
{
$this->batchRequest = $batchRequest;
$request = $response->getRequest();
$body = $response->getBody();
$httpStatusCode = $response->getHttpStatusCode();
$headers = $response->getHeaders();
parent::__construct($request, $body, $httpStatusCode, $headers);
$responses = $response->getDecodedBody();
$this->setResponses($responses);
} | Creates a new Response entity.
@param FacebookBatchRequest $batchRequest
@param FacebookResponse $response | __construct | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookBatchResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookBatchResponse.php | MIT |
public function getResponses()
{
return $this->responses;
} | Returns an array of FacebookResponse entities.
@return array | getResponses | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookBatchResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookBatchResponse.php | MIT |
private function normalizeBatchHeaders(array $batchHeaders)
{
$headers = [];
foreach ($batchHeaders as $header) {
$headers[$header['name']] = $header['value'];
}
return $headers;
} | Converts the batch header array into a standard format.
@TODO replace with array_column() when PHP 5.5 is supported.
@param array $batchHeaders
@return array | normalizeBatchHeaders | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookBatchResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookBatchResponse.php | MIT |
public function __construct(FacebookRequest $request, $body = null, $httpStatusCode = null, array $headers = [])
{
$this->request = $request;
$this->body = $body;
$this->httpStatusCode = $httpStatusCode;
$this->headers = $headers;
$this->decodeBody();
} | Creates a new Response entity.
@param FacebookRequest $request
@param string|null $body
@param int|null $httpStatusCode
@param array|null $headers | __construct | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getRequest()
{
return $this->request;
} | Return the original request that returned this response.
@return FacebookRequest | getRequest | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getApp()
{
return $this->request->getApp();
} | Return the FacebookApp entity used for this response.
@return FacebookApp | getApp | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getAccessToken()
{
return $this->request->getAccessToken();
} | Return the access token that was used for this response.
@return string|null | getAccessToken | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getHttpStatusCode()
{
return $this->httpStatusCode;
} | Return the HTTP status code for this response.
@return int | getHttpStatusCode | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getDecodedBody()
{
return $this->decodedBody;
} | Return the decoded body response.
@return array | getDecodedBody | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getAppSecretProof()
{
return $this->request->getAppSecretProof();
} | Get the app secret proof that was used for this response.
@return string|null | getAppSecretProof | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getETag()
{
return isset($this->headers['ETag']) ? $this->headers['ETag'] : null;
} | Get the ETag associated with the response.
@return string|null | getETag | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphVersion()
{
return isset($this->headers['Facebook-API-Version']) ? $this->headers['Facebook-API-Version'] : null;
} | Get the version of Graph that returned this response.
@return string|null | getGraphVersion | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function isError()
{
return isset($this->decodedBody['error']);
} | Returns true if Graph returned an error message.
@return boolean | isError | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function makeException()
{
$this->thrownException = FacebookResponseException::create($this);
} | Instantiates an exception to be thrown later. | makeException | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getThrownException()
{
return $this->thrownException;
} | Returns the exception that was thrown for this request.
@return FacebookResponseException|null | getThrownException | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphObject($subclassName = null)
{
return $this->getGraphNode($subclassName);
} | Instantiate a new GraphObject from response.
@param string|null $subclassName The GraphNode subclass to cast to.
@return \Facebook\GraphNodes\GraphObject
@throws FacebookSDKException
@deprecated 5.0.0 getGraphObject() has been renamed to getGraphNode()
@todo v6: Remove this method | getGraphObject | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphNode($subclassName = null)
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphNode($subclassName);
} | Instantiate a new GraphNode from response.
@param string|null $subclassName The GraphNode subclass to cast to.
@return \Facebook\GraphNodes\GraphNode
@throws FacebookSDKException | getGraphNode | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphAlbum()
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphAlbum();
} | Convenience method for creating a GraphAlbum collection.
@return \Facebook\GraphNodes\GraphAlbum
@throws FacebookSDKException | getGraphAlbum | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphPage()
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphPage();
} | Convenience method for creating a GraphPage collection.
@return \Facebook\GraphNodes\GraphPage
@throws FacebookSDKException | getGraphPage | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphSessionInfo()
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphSessionInfo();
} | Convenience method for creating a GraphSessionInfo collection.
@return \Facebook\GraphNodes\GraphSessionInfo
@throws FacebookSDKException | getGraphSessionInfo | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphUser()
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphUser();
} | Convenience method for creating a GraphUser collection.
@return \Facebook\GraphNodes\GraphUser
@throws FacebookSDKException | getGraphUser | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphEvent()
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphEvent();
} | Convenience method for creating a GraphEvent collection.
@return \Facebook\GraphNodes\GraphEvent
@throws FacebookSDKException | getGraphEvent | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphGroup()
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphGroup();
} | Convenience method for creating a GraphGroup collection.
@return \Facebook\GraphNodes\GraphGroup
@throws FacebookSDKException | getGraphGroup | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphList($subclassName = null, $auto_prefix = true)
{
return $this->getGraphEdge($subclassName, $auto_prefix);
} | Instantiate a new GraphList from response.
@param string|null $subclassName The GraphNode subclass to cast list items to.
@param boolean $auto_prefix Toggle to auto-prefix the subclass name.
@return \Facebook\GraphNodes\GraphList
@throws FacebookSDKException
@deprecated 5.0.0 getGraphList() has been renamed to getGraphEdge()
@todo v6: Remove this method | getGraphList | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function getGraphEdge($subclassName = null, $auto_prefix = true)
{
$factory = new GraphNodeFactory($this);
return $factory->makeGraphEdge($subclassName, $auto_prefix);
} | Instantiate a new GraphEdge from response.
@param string|null $subclassName The GraphNode subclass to cast list items to.
@param boolean $auto_prefix Toggle to auto-prefix the subclass name.
@return \Facebook\GraphNodes\GraphEdge
@throws FacebookSDKException | getGraphEdge | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookResponse.php | MIT |
public function __construct(FacebookApp $facebookApp, $rawSignedRequest = null)
{
$this->app = $facebookApp;
if (!$rawSignedRequest) {
return;
}
$this->rawSignedRequest = $rawSignedRequest;
$this->parse();
} | Instantiate a new SignedRequest entity.
@param FacebookApp $facebookApp The FacebookApp entity.
@param string|null $rawSignedRequest The raw signed request. | __construct | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function getRawSignedRequest()
{
return $this->rawSignedRequest;
} | Returns the raw signed request data.
@return string|null | getRawSignedRequest | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function get($key, $default = null)
{
if (isset($this->payload[$key])) {
return $this->payload[$key];
}
return $default;
} | Returns a property from the signed request data if available.
@param string $key
@param mixed|null $default
@return mixed|null | get | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function getUserId()
{
return $this->get('user_id');
} | Returns user_id from signed request data if available.
@return string|null | getUserId | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function hasOAuthData()
{
return $this->get('oauth_token') || $this->get('code');
} | Checks for OAuth data in the payload.
@return boolean | hasOAuthData | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function make(array $payload)
{
$payload['algorithm'] = isset($payload['algorithm']) ? $payload['algorithm'] : 'HMAC-SHA256';
$payload['issued_at'] = isset($payload['issued_at']) ? $payload['issued_at'] : time();
$encodedPayload = $this->base64UrlEncode(json_encode($payload));
$hashedSig = $this->hashSignature($encodedPayload);
$encodedSig = $this->base64UrlEncode($hashedSig);
return $encodedSig . '.' . $encodedPayload;
} | Creates a signed request from an array of data.
@param array $payload
@return string | make | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function parse()
{
list($encodedSig, $encodedPayload) = $this->split();
// Signature validation
$sig = $this->decodeSignature($encodedSig);
$hashedSig = $this->hashSignature($encodedPayload);
$this->validateSignature($hashedSig, $sig);
$this->payload = $this->decodePayload($encodedPayload);
// Payload validation
$this->validateAlgorithm();
} | Validates and decodes a signed request and saves
the payload to an array. | parse | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function split()
{
if (strpos($this->rawSignedRequest, '.') === false) {
throw new FacebookSDKException('Malformed signed request.', 606);
}
return explode('.', $this->rawSignedRequest, 2);
} | Splits a raw signed request into signature and payload.
@return array
@throws FacebookSDKException | split | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function decodeSignature($encodedSig)
{
$sig = $this->base64UrlDecode($encodedSig);
if (!$sig) {
throw new FacebookSDKException('Signed request has malformed encoded signature data.', 607);
}
return $sig;
} | Decodes the raw signature from a signed request.
@param string $encodedSig
@return string
@throws FacebookSDKException | decodeSignature | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function decodePayload($encodedPayload)
{
$payload = $this->base64UrlDecode($encodedPayload);
if ($payload) {
$payload = json_decode($payload, true);
}
if (!is_array($payload)) {
throw new FacebookSDKException('Signed request has malformed encoded payload data.', 607);
}
return $payload;
} | Decodes the raw payload from a signed request.
@param string $encodedPayload
@return array
@throws FacebookSDKException | decodePayload | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function validateAlgorithm()
{
if ($this->get('algorithm') !== 'HMAC-SHA256') {
throw new FacebookSDKException('Signed request is using the wrong algorithm.', 605);
}
} | Validates the algorithm used in a signed request.
@throws FacebookSDKException | validateAlgorithm | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function hashSignature($encodedData)
{
$hashedSig = hash_hmac(
'sha256',
$encodedData,
$this->app->getSecret(),
$raw_output = true
);
if (!$hashedSig) {
throw new FacebookSDKException('Unable to hash signature from encoded payload data.', 602);
}
return $hashedSig;
} | Hashes the signature used in a signed request.
@param string $encodedData
@return string
@throws FacebookSDKException | hashSignature | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
protected function validateSignature($hashedSig, $sig)
{
if (\hash_equals($hashedSig, $sig)) {
return;
}
throw new FacebookSDKException('Signed request has an invalid signature.', 602);
} | Validates the signature used in a signed request.
@param string $hashedSig
@param string $sig
@throws FacebookSDKException | validateSignature | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function base64UrlDecode($input)
{
$urlDecodedBase64 = strtr($input, '-_', '+/');
$this->validateBase64($urlDecodedBase64);
return base64_decode($urlDecodedBase64);
} | Base64 decoding which replaces characters:
+ instead of -
/ instead of _
@link http://en.wikipedia.org/wiki/Base64#URL_applications
@param string $input base64 url encoded input
@return string decoded string | base64UrlDecode | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function base64UrlEncode($input)
{
return strtr(base64_encode($input), '+/', '-_');
} | Base64 encoding which replaces characters:
+ instead of -
/ instead of _
@link http://en.wikipedia.org/wiki/Base64#URL_applications
@param string $input string to encode
@return string base64 url encoded input | base64UrlEncode | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/SignedRequest.php | MIT |
public function setAccessToken($accessToken)
{
$this->accessToken = $accessToken;
if ($accessToken instanceof AccessToken) {
$this->accessToken = $accessToken->getValue();
}
return $this;
} | Set the access token for this request.
@param AccessToken|string|null
@return FacebookRequest | setAccessToken | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getAccessTokenEntity()
{
return $this->accessToken ? new AccessToken($this->accessToken) : null;
} | Return the access token for this request as an AccessToken entity.
@return AccessToken|null | getAccessTokenEntity | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function setApp(FacebookApp $app = null)
{
$this->app = $app;
} | Set the FacebookApp entity used for this request.
@param FacebookApp|null $app | setApp | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getApp()
{
return $this->app;
} | Return the FacebookApp entity used for this request.
@return FacebookApp | getApp | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getAppSecretProof()
{
if (!$accessTokenEntity = $this->getAccessTokenEntity()) {
return null;
}
return $accessTokenEntity->getAppSecretProof($this->app->getSecret());
} | Generate an app secret proof to sign this request.
@return string|null | getAppSecretProof | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function validateAccessToken()
{
$accessToken = $this->getAccessToken();
if (!$accessToken) {
throw new FacebookSDKException('You must provide an access token.');
}
} | Validate that an access token exists for this request.
@throws FacebookSDKException | validateAccessToken | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function setMethod($method)
{
$this->method = strtoupper($method);
} | Set the HTTP method for this request.
@param string | setMethod | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function validateMethod()
{
if (!$this->method) {
throw new FacebookSDKException('HTTP method not specified.');
}
if (!in_array($this->method, ['GET', 'POST', 'DELETE'])) {
throw new FacebookSDKException('Invalid HTTP method specified.');
}
} | Validate that the HTTP method is set.
@throws FacebookSDKException | validateMethod | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function setEndpoint($endpoint)
{
// Harvest the access token from the endpoint to keep things in sync
$params = FacebookUrlManipulator::getParamsAsArray($endpoint);
if (isset($params['access_token'])) {
$this->setAccessTokenFromParams($params['access_token']);
}
// Clean the token & app secret proof from the endpoint.
$filterParams = ['access_token', 'appsecret_proof'];
$this->endpoint = FacebookUrlManipulator::removeParamsFromUrl($endpoint, $filterParams);
return $this;
} | Set the endpoint for this request.
@param string
@return FacebookRequest
@throws FacebookSDKException | setEndpoint | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getEndpoint()
{
// For batch requests, this will be empty
return $this->endpoint;
} | Return the endpoint for this request.
@return string | getEndpoint | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getHeaders()
{
$headers = static::getDefaultHeaders();
if ($this->eTag) {
$headers['If-None-Match'] = $this->eTag;
}
return array_merge($this->headers, $headers);
} | Generate and return the headers for this request.
@return array | getHeaders | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function setHeaders(array $headers)
{
$this->headers = array_merge($this->headers, $headers);
} | Set the headers for this request.
@param array $headers | setHeaders | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function setParams(array $params = [])
{
if (isset($params['access_token'])) {
$this->setAccessTokenFromParams($params['access_token']);
}
// Don't let these buggers slip in.
unset($params['access_token'], $params['appsecret_proof']);
// @TODO Refactor code above with this
//$params = $this->sanitizeAuthenticationParams($params);
$params = $this->sanitizeFileParams($params);
$this->dangerouslySetParams($params);
return $this;
} | Set the params for this request.
@param array $params
@return FacebookRequest
@throws FacebookSDKException | setParams | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function dangerouslySetParams(array $params = [])
{
$this->params = array_merge($this->params, $params);
return $this;
} | Set the params for this request without filtering them first.
@param array $params
@return FacebookRequest | dangerouslySetParams | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function sanitizeFileParams(array $params)
{
foreach ($params as $key => $value) {
if ($value instanceof FacebookFile) {
$this->addFile($key, $value);
unset($params[$key]);
}
}
return $params;
} | Iterate over the params and pull out the file uploads.
@param array $params
@return array | sanitizeFileParams | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function resetFiles()
{
$this->files = [];
} | Removes all the files from the upload queue. | resetFiles | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getFiles()
{
return $this->files;
} | Get the list of files to be uploaded.
@return array | getFiles | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function containsFileUploads()
{
return !empty($this->files);
} | Let's us know if there is a file upload with this request.
@return boolean | containsFileUploads | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function containsVideoUploads()
{
foreach ($this->files as $file) {
if ($file instanceof FacebookVideo) {
return true;
}
}
return false;
} | Let's us know if there is a video upload with this request.
@return boolean | containsVideoUploads | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getMultipartBody()
{
$params = $this->getPostParams();
return new RequestBodyMultipart($params, $this->files);
} | Returns the body of the request as multipart/form-data.
@return RequestBodyMultipart | getMultipartBody | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getUrlEncodedBody()
{
$params = $this->getPostParams();
return new RequestBodyUrlEncoded($params);
} | Returns the body of the request as URL-encoded.
@return RequestBodyUrlEncoded | getUrlEncodedBody | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getParams()
{
$params = $this->params;
$accessToken = $this->getAccessToken();
if ($accessToken) {
$params['access_token'] = $accessToken;
$params['appsecret_proof'] = $this->getAppSecretProof();
}
return $params;
} | Generate and return the params for this request.
@return array | getParams | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getPostParams()
{
if ($this->getMethod() === 'POST') {
return $this->getParams();
}
return [];
} | Only return params on POST requests.
@return array | getPostParams | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getGraphVersion()
{
return $this->graphVersion;
} | The graph version used for this request.
@return string | getGraphVersion | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function getUrl()
{
$this->validateMethod();
$graphVersion = FacebookUrlManipulator::forceSlashPrefix($this->graphVersion);
$endpoint = FacebookUrlManipulator::forceSlashPrefix($this->getEndpoint());
$url = $graphVersion . $endpoint;
if ($this->getMethod() !== 'POST') {
$params = $this->getParams();
$url = FacebookUrlManipulator::appendParamsToUrl($url, $params);
}
return $url;
} | Generate and return the URL for this request.
@return string | getUrl | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public static function getDefaultHeaders()
{
return [
'User-Agent' => 'fb-php-' . Facebook::VERSION,
'Accept-Encoding' => '*',
];
} | Return the default headers that every request should use.
@return array | getDefaultHeaders | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/FacebookRequest.php | MIT |
public function __construct(array $config = [])
{
$config = array_merge([
'app_id' => getenv(static::APP_ID_ENV_NAME),
'app_secret' => getenv(static::APP_SECRET_ENV_NAME),
'default_graph_version' => static::DEFAULT_GRAPH_VERSION,
'enable_beta_mode' => false,
'http_client_handler' => null,
'persistent_data_handler' => null,
'pseudo_random_string_generator' => null,
'url_detection_handler' => null,
], $config);
if (!$config['app_id']) {
throw new FacebookSDKException('Required "app_id" key not supplied in config and could not find fallback environment variable "' . static::APP_ID_ENV_NAME . '"');
}
if (!$config['app_secret']) {
throw new FacebookSDKException('Required "app_secret" key not supplied in config and could not find fallback environment variable "' . static::APP_SECRET_ENV_NAME . '"');
}
$this->app = new FacebookApp($config['app_id'], $config['app_secret']);
$this->client = new FacebookClient(
HttpClientsFactory::createHttpClient($config['http_client_handler']),
$config['enable_beta_mode']
);
$this->pseudoRandomStringGenerator = PseudoRandomStringGeneratorFactory::createPseudoRandomStringGenerator(
$config['pseudo_random_string_generator']
);
$this->setUrlDetectionHandler($config['url_detection_handler'] ?: new FacebookUrlDetectionHandler());
$this->persistentDataHandler = PersistentDataFactory::createPersistentDataHandler(
$config['persistent_data_handler']
);
if (isset($config['default_access_token'])) {
$this->setDefaultAccessToken($config['default_access_token']);
}
// @todo v6: Throw an InvalidArgumentException if "default_graph_version" is not set
$this->defaultGraphVersion = $config['default_graph_version'];
} | Instantiates a new Facebook super-class object.
@param array $config
@throws FacebookSDKException | __construct | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getClient()
{
return $this->client;
} | Returns the FacebookClient service.
@return FacebookClient | getClient | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getOAuth2Client()
{
if (!$this->oAuth2Client instanceof OAuth2Client) {
$app = $this->getApp();
$client = $this->getClient();
$this->oAuth2Client = new OAuth2Client($app, $client, $this->defaultGraphVersion);
}
return $this->oAuth2Client;
} | Returns the OAuth 2.0 client service.
@return OAuth2Client | getOAuth2Client | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getLastResponse()
{
return $this->lastResponse;
} | Returns the last response returned from Graph.
@return FacebookResponse|FacebookBatchResponse|null | getLastResponse | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getUrlDetectionHandler()
{
return $this->urlDetectionHandler;
} | Returns the URL detection handler.
@return UrlDetectionInterface | getUrlDetectionHandler | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
private function setUrlDetectionHandler(UrlDetectionInterface $urlDetectionHandler)
{
$this->urlDetectionHandler = $urlDetectionHandler;
} | Changes the URL detection handler.
@param UrlDetectionInterface $urlDetectionHandler | setUrlDetectionHandler | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getDefaultAccessToken()
{
return $this->defaultAccessToken;
} | Returns the default AccessToken entity.
@return AccessToken|null | getDefaultAccessToken | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function setDefaultAccessToken($accessToken)
{
if (is_string($accessToken)) {
$this->defaultAccessToken = new AccessToken($accessToken);
return;
}
if ($accessToken instanceof AccessToken) {
$this->defaultAccessToken = $accessToken;
return;
}
throw new \InvalidArgumentException('The default access token must be of type "string" or Facebook\AccessToken');
} | Sets the default access token to use with requests.
@param AccessToken|string $accessToken The access token to save.
@throws \InvalidArgumentException | setDefaultAccessToken | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getDefaultGraphVersion()
{
return $this->defaultGraphVersion;
} | Returns the default Graph version.
@return string | getDefaultGraphVersion | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getRedirectLoginHelper()
{
return new FacebookRedirectLoginHelper(
$this->getOAuth2Client(),
$this->persistentDataHandler,
$this->urlDetectionHandler,
$this->pseudoRandomStringGenerator
);
} | Returns the redirect login helper.
@return FacebookRedirectLoginHelper | getRedirectLoginHelper | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getJavaScriptHelper()
{
return new FacebookJavaScriptHelper($this->app, $this->client, $this->defaultGraphVersion);
} | Returns the JavaScript helper.
@return FacebookJavaScriptHelper | getJavaScriptHelper | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function get($endpoint, $accessToken = null, $eTag = null, $graphVersion = null)
{
return $this->sendRequest(
'GET',
$endpoint,
$params = [],
$accessToken,
$eTag,
$graphVersion
);
} | Sends a GET request to Graph and returns the result.
@param string $endpoint
@param AccessToken|string|null $accessToken
@param string|null $eTag
@param string|null $graphVersion
@return FacebookResponse
@throws FacebookSDKException | get | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function post($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
return $this->sendRequest(
'POST',
$endpoint,
$params,
$accessToken,
$eTag,
$graphVersion
);
} | Sends a POST request to Graph and returns the result.
@param string $endpoint
@param array $params
@param AccessToken|string|null $accessToken
@param string|null $eTag
@param string|null $graphVersion
@return FacebookResponse
@throws FacebookSDKException | post | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function delete($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
return $this->sendRequest(
'DELETE',
$endpoint,
$params,
$accessToken,
$eTag,
$graphVersion
);
} | Sends a DELETE request to Graph and returns the result.
@param string $endpoint
@param array $params
@param AccessToken|string|null $accessToken
@param string|null $eTag
@param string|null $graphVersion
@return FacebookResponse
@throws FacebookSDKException | delete | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function next(GraphEdge $graphEdge)
{
return $this->getPaginationResults($graphEdge, 'next');
} | Sends a request to Graph for the next page of results.
@param GraphEdge $graphEdge The GraphEdge to paginate over.
@return GraphEdge|null
@throws FacebookSDKException | next | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function previous(GraphEdge $graphEdge)
{
return $this->getPaginationResults($graphEdge, 'previous');
} | Sends a request to Graph for the previous page of results.
@param GraphEdge $graphEdge The GraphEdge to paginate over.
@return GraphEdge|null
@throws FacebookSDKException | previous | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function getPaginationResults(GraphEdge $graphEdge, $direction)
{
$paginationRequest = $graphEdge->getPaginationRequest($direction);
if (!$paginationRequest) {
return null;
}
$this->lastResponse = $this->client->sendRequest($paginationRequest);
// Keep the same GraphNode subclass
$subClassName = $graphEdge->getSubClassName();
$graphEdge = $this->lastResponse->getGraphEdge($subClassName, false);
return count($graphEdge) > 0 ? $graphEdge : null;
} | Sends a request to Graph for the next page of results.
@param GraphEdge $graphEdge The GraphEdge to paginate over.
@param string $direction The direction of the pagination: next|previous.
@return GraphEdge|null
@throws FacebookSDKException | getPaginationResults | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function sendRequest($method, $endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
$accessToken = $accessToken ?: $this->defaultAccessToken;
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
$request = $this->request($method, $endpoint, $params, $accessToken, $eTag, $graphVersion);
return $this->lastResponse = $this->client->sendRequest($request);
} | Sends a request to Graph and returns the result.
@param string $method
@param string $endpoint
@param array $params
@param AccessToken|string|null $accessToken
@param string|null $eTag
@param string|null $graphVersion
@return FacebookResponse
@throws FacebookSDKException | sendRequest | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
public function sendBatchRequest(array $requests, $accessToken = null, $graphVersion = null)
{
$accessToken = $accessToken ?: $this->defaultAccessToken;
$graphVersion = $graphVersion ?: $this->defaultGraphVersion;
$batchRequest = new FacebookBatchRequest(
$this->app,
$requests,
$accessToken,
$graphVersion
);
return $this->lastResponse = $this->client->sendBatchRequest($batchRequest);
} | Sends a batched request to Graph and returns the result.
@param array $requests
@param AccessToken|string|null $accessToken
@param string|null $graphVersion
@return FacebookBatchResponse
@throws FacebookSDKException | sendBatchRequest | php | boonex/dolphin.pro | plugins/facebook-php-sdk/src/Facebook/Facebook.php | https://github.com/boonex/dolphin.pro/blob/master/plugins/facebook-php-sdk/src/Facebook/Facebook.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.