summaryrefslogtreecommitdiff
path: root/lib/facebook-graph-sdk/src/Facebook/Facebook.php
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2017-01-16 22:04:43 +0100
committeremkael <emkael@tlen.pl>2017-01-16 22:50:24 +0100
commit677953067f2bb5502a70f0d004f1ac844b18a128 (patch)
tree003c26454b543c2a8d73f0602446482fdbbef8db /lib/facebook-graph-sdk/src/Facebook/Facebook.php
parentf7b2bfae9778af2c99e0c7fe7b2634e0f4f0973f (diff)
* Facebook support
Diffstat (limited to 'lib/facebook-graph-sdk/src/Facebook/Facebook.php')
-rw-r--r--lib/facebook-graph-sdk/src/Facebook/Facebook.php589
1 files changed, 589 insertions, 0 deletions
diff --git a/lib/facebook-graph-sdk/src/Facebook/Facebook.php b/lib/facebook-graph-sdk/src/Facebook/Facebook.php
new file mode 100644
index 0000000..227a166
--- /dev/null
+++ b/lib/facebook-graph-sdk/src/Facebook/Facebook.php
@@ -0,0 +1,589 @@
+<?php
+/**
+ * Copyright 2014 Facebook, Inc.
+ *
+ * You are hereby granted a non-exclusive, worldwide, royalty-free license to
+ * use, copy, modify, and distribute this software in source code or binary
+ * form for use in connection with the web services and APIs provided by
+ * Facebook.
+ *
+ * As with any software that integrates with the Facebook platform, your use
+ * of this software is subject to the Facebook Developer Principles and
+ * Policies [http://developers.facebook.com/policy/]. This copyright notice
+ * shall be included in all copies or substantial portions of the software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ *
+ */
+namespace Facebook;
+
+use Facebook\Authentication\AccessToken;
+use Facebook\Authentication\OAuth2Client;
+use Facebook\FileUpload\FacebookFile;
+use Facebook\FileUpload\FacebookVideo;
+use Facebook\GraphNodes\GraphEdge;
+use Facebook\Url\UrlDetectionInterface;
+use Facebook\Url\FacebookUrlDetectionHandler;
+use Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface;
+use Facebook\PseudoRandomString\McryptPseudoRandomStringGenerator;
+use Facebook\PseudoRandomString\OpenSslPseudoRandomStringGenerator;
+use Facebook\PseudoRandomString\UrandomPseudoRandomStringGenerator;
+use Facebook\HttpClients\FacebookHttpClientInterface;
+use Facebook\HttpClients\FacebookCurlHttpClient;
+use Facebook\HttpClients\FacebookStreamHttpClient;
+use Facebook\HttpClients\FacebookGuzzleHttpClient;
+use Facebook\PersistentData\PersistentDataInterface;
+use Facebook\PersistentData\FacebookSessionPersistentDataHandler;
+use Facebook\PersistentData\FacebookMemoryPersistentDataHandler;
+use Facebook\Helpers\FacebookCanvasHelper;
+use Facebook\Helpers\FacebookJavaScriptHelper;
+use Facebook\Helpers\FacebookPageTabHelper;
+use Facebook\Helpers\FacebookRedirectLoginHelper;
+use Facebook\Exceptions\FacebookSDKException;
+
+/**
+ * Class Facebook
+ *
+ * @package Facebook
+ */
+class Facebook
+{
+ /**
+ * @const string Version number of the Facebook PHP SDK.
+ */
+ const VERSION = '5.0.0';
+
+ /**
+ * @const string Default Graph API version for requests.
+ */
+ const DEFAULT_GRAPH_VERSION = 'v2.4';
+
+ /**
+ * @const string The name of the environment variable that contains the app ID.
+ */
+ const APP_ID_ENV_NAME = 'FACEBOOK_APP_ID';
+
+ /**
+ * @const string The name of the environment variable that contains the app secret.
+ */
+ const APP_SECRET_ENV_NAME = 'FACEBOOK_APP_SECRET';
+
+ /**
+ * @var FacebookApp The FacebookApp entity.
+ */
+ protected $app;
+
+ /**
+ * @var FacebookClient The Facebook client service.
+ */
+ protected $client;
+
+ /**
+ * @var OAuth2Client The OAuth 2.0 client service.
+ */
+ protected $oAuth2Client;
+
+ /**
+ * @var UrlDetectionInterface|null The URL detection handler.
+ */
+ protected $urlDetectionHandler;
+
+ /**
+ * @var PseudoRandomStringGeneratorInterface|null The cryptographically secure pseudo-random string generator.
+ */
+ protected $pseudoRandomStringGenerator;
+
+ /**
+ * @var AccessToken|null The default access token to use with requests.
+ */
+ protected $defaultAccessToken;
+
+ /**
+ * @var string|null The default Graph version we want to use.
+ */
+ protected $defaultGraphVersion;
+
+ /**
+ * @var PersistentDataInterface|null The persistent data handler.
+ */
+ protected $persistentDataHandler;
+
+ /**
+ * @var FacebookResponse|FacebookBatchResponse|null Stores the last request made to Graph.
+ */
+ protected $lastResponse;
+
+ /**
+ * Instantiates a new Facebook super-class object.
+ *
+ * @param array $config
+ *
+ * @throws FacebookSDKException
+ */
+ public function __construct(array $config = [])
+ {
+ $appId = isset($config['app_id']) ? $config['app_id'] : getenv(static::APP_ID_ENV_NAME);
+ if (!$appId) {
+ throw new FacebookSDKException('Required "app_id" key not supplied in config and could not find fallback environment variable "' . static::APP_ID_ENV_NAME . '"');
+ }
+
+ $appSecret = isset($config['app_secret']) ? $config['app_secret'] : getenv(static::APP_SECRET_ENV_NAME);
+ if (!$appSecret) {
+ 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($appId, $appSecret);
+
+ $httpClientHandler = null;
+ if (isset($config['http_client_handler'])) {
+ if ($config['http_client_handler'] instanceof FacebookHttpClientInterface) {
+ $httpClientHandler = $config['http_client_handler'];
+ } elseif ($config['http_client_handler'] === 'curl') {
+ $httpClientHandler = new FacebookCurlHttpClient();
+ } elseif ($config['http_client_handler'] === 'stream') {
+ $httpClientHandler = new FacebookStreamHttpClient();
+ } elseif ($config['http_client_handler'] === 'guzzle') {
+ $httpClientHandler = new FacebookGuzzleHttpClient();
+ } else {
+ throw new \InvalidArgumentException('The http_client_handler must be set to "curl", "stream", "guzzle", or be an instance of Facebook\HttpClients\FacebookHttpClientInterface');
+ }
+ }
+
+ $enableBeta = isset($config['enable_beta_mode']) && $config['enable_beta_mode'] === true;
+ $this->client = new FacebookClient($httpClientHandler, $enableBeta);
+
+ if (isset($config['url_detection_handler'])) {
+ if ($config['url_detection_handler'] instanceof UrlDetectionInterface) {
+ $this->urlDetectionHandler = $config['url_detection_handler'];
+ } else {
+ throw new \InvalidArgumentException('The url_detection_handler must be an instance of Facebook\Url\UrlDetectionInterface');
+ }
+ }
+
+ if (isset($config['pseudo_random_string_generator'])) {
+ if ($config['pseudo_random_string_generator'] instanceof PseudoRandomStringGeneratorInterface) {
+ $this->pseudoRandomStringGenerator = $config['pseudo_random_string_generator'];
+ } elseif ($config['pseudo_random_string_generator'] === 'mcrypt') {
+ $this->pseudoRandomStringGenerator = new McryptPseudoRandomStringGenerator();
+ } elseif ($config['pseudo_random_string_generator'] === 'openssl') {
+ $this->pseudoRandomStringGenerator = new OpenSslPseudoRandomStringGenerator();
+ } elseif ($config['pseudo_random_string_generator'] === 'urandom') {
+ $this->pseudoRandomStringGenerator = new UrandomPseudoRandomStringGenerator();
+ } else {
+ throw new \InvalidArgumentException('The pseudo_random_string_generator must be set to "mcrypt", "openssl", or "urandom", or be an instance of Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface');
+ }
+ }
+
+ if (isset($config['persistent_data_handler'])) {
+ if ($config['persistent_data_handler'] instanceof PersistentDataInterface) {
+ $this->persistentDataHandler = $config['persistent_data_handler'];
+ } elseif ($config['persistent_data_handler'] === 'session') {
+ $this->persistentDataHandler = new FacebookSessionPersistentDataHandler();
+ } elseif ($config['persistent_data_handler'] === 'memory') {
+ $this->persistentDataHandler = new FacebookMemoryPersistentDataHandler();
+ } else {
+ throw new \InvalidArgumentException('The persistent_data_handler must be set to "session", "memory", or be an instance of Facebook\PersistentData\PersistentDataInterface');
+ }
+ }
+
+ if (isset($config['default_access_token'])) {
+ $this->setDefaultAccessToken($config['default_access_token']);
+ }
+
+ if (isset($config['default_graph_version'])) {
+ $this->defaultGraphVersion = $config['default_graph_version'];
+ } else {
+ // @todo v6: Throw an InvalidArgumentException if "default_graph_version" is not set
+ $this->defaultGraphVersion = static::DEFAULT_GRAPH_VERSION;
+ }
+ }
+
+ /**
+ * Returns the FacebookApp entity.
+ *
+ * @return FacebookApp
+ */
+ public function getApp()
+ {
+ return $this->app;
+ }
+
+ /**
+ * Returns the FacebookClient service.
+ *
+ * @return FacebookClient
+ */
+ public function getClient()
+ {
+ return $this->client;
+ }
+
+ /**
+ * Returns the OAuth 2.0 client service.
+ *
+ * @return OAuth2Client
+ */
+ 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 last response returned from Graph.
+ *
+ * @return FacebookResponse|FacebookBatchResponse|null
+ */
+ public function getLastResponse()
+ {
+ return $this->lastResponse;
+ }
+
+ /**
+ * Returns the URL detection handler.
+ *
+ * @return UrlDetectionInterface
+ */
+ public function getUrlDetectionHandler()
+ {
+ if (!$this->urlDetectionHandler instanceof UrlDetectionInterface) {
+ $this->urlDetectionHandler = new FacebookUrlDetectionHandler();
+ }
+
+ return $this->urlDetectionHandler;
+ }
+
+ /**
+ * Returns the default AccessToken entity.
+ *
+ * @return AccessToken|null
+ */
+ public function getDefaultAccessToken()
+ {
+ return $this->defaultAccessToken;
+ }
+
+ /**
+ * Sets the default access token to use with requests.
+ *
+ * @param AccessToken|string $accessToken The access token to save.
+ *
+ * @throws \InvalidArgumentException
+ */
+ 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');
+ }
+
+ /**
+ * Returns the default Graph version.
+ *
+ * @return string
+ */
+ public function getDefaultGraphVersion()
+ {
+ return $this->defaultGraphVersion;
+ }
+
+ /**
+ * Returns the redirect login helper.
+ *
+ * @return FacebookRedirectLoginHelper
+ */
+ public function getRedirectLoginHelper()
+ {
+ return new FacebookRedirectLoginHelper(
+ $this->getOAuth2Client(),
+ $this->persistentDataHandler,
+ $this->urlDetectionHandler,
+ $this->pseudoRandomStringGenerator
+ );
+ }
+
+ /**
+ * Returns the JavaScript helper.
+ *
+ * @return FacebookJavaScriptHelper
+ */
+ public function getJavaScriptHelper()
+ {
+ return new FacebookJavaScriptHelper($this->app, $this->client, $this->defaultGraphVersion);
+ }
+
+ /**
+ * Returns the canvas helper.
+ *
+ * @return FacebookCanvasHelper
+ */
+ public function getCanvasHelper()
+ {
+ return new FacebookCanvasHelper($this->app, $this->client, $this->defaultGraphVersion);
+ }
+
+ /**
+ * Returns the page tab helper.
+ *
+ * @return FacebookPageTabHelper
+ */
+ public function getPageTabHelper()
+ {
+ return new FacebookPageTabHelper($this->app, $this->client, $this->defaultGraphVersion);
+ }
+
+ /**
+ * 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
+ */
+ public function get($endpoint, $accessToken = null, $eTag = null, $graphVersion = null)
+ {
+ return $this->sendRequest(
+ 'GET',
+ $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
+ */
+ public function post($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
+ {
+ return $this->sendRequest(
+ 'POST',
+ $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
+ */
+ public function delete($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
+ {
+ return $this->sendRequest(
+ 'DELETE',
+ $endpoint,
+ $params,
+ $accessToken,
+ $eTag,
+ $graphVersion
+ );
+ }
+
+ /**
+ * Sends a request to Graph for the next page of results.
+ *
+ * @param GraphEdge $graphEdge The GraphEdge to paginate over.
+ *
+ * @return GraphEdge|null
+ *
+ * @throws FacebookSDKException
+ */
+ public function next(GraphEdge $graphEdge)
+ {
+ return $this->getPaginationResults($graphEdge, 'next');
+ }
+
+ /**
+ * Sends a request to Graph for the previous page of results.
+ *
+ * @param GraphEdge $graphEdge The GraphEdge to paginate over.
+ *
+ * @return GraphEdge|null
+ *
+ * @throws FacebookSDKException
+ */
+ public function previous(GraphEdge $graphEdge)
+ {
+ return $this->getPaginationResults($graphEdge, 'previous');
+ }
+
+ /**
+ * 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
+ */
+ 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 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
+ */
+ 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 batched request to Graph and returns the result.
+ *
+ * @param array $requests
+ * @param AccessToken|string|null $accessToken
+ * @param string|null $graphVersion
+ *
+ * @return FacebookBatchResponse
+ *
+ * @throws FacebookSDKException
+ */
+ 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);
+ }
+
+ /**
+ * Instantiates a new FacebookRequest entity.
+ *
+ * @param string $method
+ * @param string $endpoint
+ * @param array $params
+ * @param AccessToken|string|null $accessToken
+ * @param string|null $eTag
+ * @param string|null $graphVersion
+ *
+ * @return FacebookRequest
+ *
+ * @throws FacebookSDKException
+ */
+ public function request($method, $endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
+ {
+ $accessToken = $accessToken ?: $this->defaultAccessToken;
+ $graphVersion = $graphVersion ?: $this->defaultGraphVersion;
+
+ return new FacebookRequest(
+ $this->app,
+ $accessToken,
+ $method,
+ $endpoint,
+ $params,
+ $eTag,
+ $graphVersion
+ );
+ }
+
+ /**
+ * Factory to create FacebookFile's.
+ *
+ * @param string $pathToFile
+ *
+ * @return FacebookFile
+ *
+ * @throws FacebookSDKException
+ */
+ public function fileToUpload($pathToFile)
+ {
+ return new FacebookFile($pathToFile);
+ }
+
+ /**
+ * Factory to create FacebookVideo's.
+ *
+ * @param string $pathToFile
+ *
+ * @return FacebookVideo
+ *
+ * @throws FacebookSDKException
+ */
+ public function videoToUpload($pathToFile)
+ {
+ return new FacebookVideo($pathToFile);
+ }
+}