Doc fixes

Author: Nyholm

src/Application.php

@@ -86,7 +86,7 @@ public function getAccessToken()
     }
 
     /**
-     * Serializes the FacebookApp entity as a string.
+     * Serializes the App entity as a string.
      *
      * @return string
      */
@@ -96,7 +96,7 @@ public function serialize()
     }
 
     /**
-     * Unserializes a string as a FacebookApp entity.
+     * Unserializes a string as a App entity.
      *
      * @param string $serialized
      */

src/Authentication/OAuth2Client.php

@@ -41,7 +41,7 @@ class OAuth2Client
     const BASE_AUTHORIZATION_URL = 'https://www.facebook.com';
 
     /**
-     * The FacebookApp entity.
+     * The App entity.
      *
      * @var Application
      */
@@ -81,7 +81,7 @@ public function __construct(Application $app, Client $client, $graphVersion)
     }
 
     /**
-     * Returns the last FacebookRequest that was sent.
+     * Returns the last Request that was sent.
      * Useful for debugging and testing.
      *
      * @return null|Request

src/BatchRequest.php

@@ -34,7 +34,7 @@
 class BatchRequest extends Request implements IteratorAggregate, ArrayAccess
 {
     /**
-     * @var array an array of FacebookRequest entities to send
+     * @var array an array of Request entities to send
      */
     protected $requests = [];
 
@@ -81,7 +81,7 @@ public function add($request, $options = null)
         }
 
         if (!$request instanceof Request) {
-            throw new \InvalidArgumentException('Argument for add() must be of type array or FacebookRequest.');
+            throw new \InvalidArgumentException('Argument for add() must be of type array or Request.');
         }
 
         if (null === $options) {
@@ -112,7 +112,7 @@ public function add($request, $options = null)
     }
 
     /**
-     * Ensures that the FacebookApp and access token fall back when missing.
+     * Ensures that the App and access token fall back when missing.
      *
      * @param Request $request
      *
@@ -123,15 +123,15 @@ public function addFallbackDefaults(Request $request)
         if (!$request->getApp()) {
             $app = $this->getApp();
             if (!$app) {
-                throw new SDKException('Missing FacebookApp on FacebookRequest and no fallback detected on FacebookBatchRequest.');
+                throw new SDKException('Missing App on Request and no fallback detected on BatchRequest.');
             }
             $request->setApp($app);
         }
 
         if (!$request->getAccessToken()) {
             $accessToken = $this->getAccessToken();
             if (!$accessToken) {
-                throw new SDKException('Missing access token on FacebookRequest and no fallback detected on FacebookBatchRequest.');
+                throw new SDKException('Missing access token on Request and no fallback detected on BatchRequest.');
             }
             $request->setAccessToken($accessToken);
         }
@@ -167,7 +167,7 @@ public function extractFileAttachments(Request $request)
     }
 
     /**
-     * Return the FacebookRequest entities.
+     * Return the Request entities.
      *
      * @return array
      */

src/BatchResponse.php

@@ -37,7 +37,7 @@ class BatchResponse extends Response implements IteratorAggregate, ArrayAccess
     protected $batchRequest;
 
     /**
-     * @var Response[] an array of FacebookResponse entities
+     * @var Response[] an array of Response entities
      */
     protected $responses = [];
 
@@ -62,7 +62,7 @@ public function __construct(BatchRequest $batchRequest, Response $response)
     }
 
     /**
-     * Returns an array of FacebookResponse entities.
+     * Returns an array of Response entities.
      *
      * @return Response[]
      */

src/Client.php

@@ -83,7 +83,7 @@ class Client
     public static $requestCount = 0;
 
     /**
-     * Instantiates a new FacebookClient object.
+     * Instantiates a new Client object.
      *
      * @param null|HttpClient $httpClient
      * @param bool            $enableBeta
@@ -202,18 +202,18 @@ public function sendRequest(Request $request)
             $responseHeaders[] = sprintf('%s: %s', $name, implode(", ", $values));
         }
 
-        $facebookResponse = new Response(
+        $Response = new Response(
             $request,
             $psr7Response->getBody(),
             $psr7Response->getStatusCode(),
             $responseHeaders
         );
 
-        if ($facebookResponse->isError()) {
-            throw $facebookResponse->getThrownException();
+        if ($Response->isError()) {
+            throw $Response->getThrownException();
         }
 
-        return $facebookResponse;
+        return $Response;
     }
 
     /**
@@ -228,8 +228,8 @@ public function sendRequest(Request $request)
     public function sendBatchRequest(BatchRequest $request)
     {
         $request->prepareRequestsForBatch();
-        $facebookResponse = $this->sendRequest($request);
+        $Response = $this->sendRequest($request);
 
-        return new BatchResponse($request, $facebookResponse);
+        return new BatchResponse($request, $Response);
     }
 }

src/Exception/ResponseException.php

@@ -40,7 +40,7 @@ class ResponseException extends SDKException
     protected $responseData;
 
     /**
-     * Creates a FacebookResponseException.
+     * Creates a ResponseException.
      *
      * @param Response     $response          the response that threw the exception
      * @param SDKException $previousException the more detailed exception

src/Facebook.php

@@ -61,7 +61,7 @@ class Facebook
     const APP_SECRET_ENV_NAME = 'FACEBOOK_APP_SECRET';
 
     /**
-     * @var Application the FacebookApp entity
+     * @var Application the App entity
      */
     protected $app;
 
@@ -150,7 +150,7 @@ public function __construct(array $config = [])
     }
 
     /**
-     * Returns the FacebookApp entity.
+     * Returns the App entity.
      *
      * @return Application
      */
@@ -160,7 +160,7 @@ public function getApp()
     }
 
     /**
-     * Returns the FacebookClient service.
+     * Returns the Client service.
      *
      * @return Client
      */
@@ -480,20 +480,20 @@ public function sendBatchRequest(array $requests, $accessToken = null, $graphVer
     }
 
     /**
-     * Instantiates an empty FacebookBatchRequest entity.
+     * Instantiates an empty BatchRequest entity.
      *
      * @param null|AccessToken|string $accessToken  The top-level access token. Requests with no access token
      *                                              will fallback to this.
      * @param null|string             $graphVersion the Graph API version to use
      *
-     * @return FacebookBatchRequest
+     * @return BatchRequest
      */
     public function newBatchRequest($accessToken = null, $graphVersion = null)
     {
         $accessToken = $accessToken ?: $this->defaultAccessToken;
         $graphVersion = $graphVersion ?: $this->defaultGraphVersion;
 
-        return new FacebookBatchRequest(
+        return new BatchRequest(
             $this->app,
             [],
             $accessToken,
@@ -502,7 +502,7 @@ public function newBatchRequest($accessToken = null, $graphVersion = null)
     }
 
     /**
-     * Instantiates a new FacebookRequest entity.
+     * Instantiates a new Request entity.
      *
      * @param string                  $method
      * @param string                  $endpoint
@@ -532,7 +532,7 @@ public function request($method, $endpoint, array $params = [], $accessToken = n
     }
 
     /**
-     * Factory to create FacebookFile's.
+     * Factory to create File's.
      *
      * @param string $pathToFile
      *
@@ -546,7 +546,7 @@ public function fileToUpload($pathToFile)
     }
 
     /**
-     * Factory to create FacebookVideo's.
+     * Factory to create Video's.
      *
      * @param string $pathToFile
      *

src/FileUpload/File.php

@@ -50,7 +50,7 @@ class File
     protected $stream;
 
     /**
-     * Creates a new FacebookFile entity.
+     * Creates a new File entity.
      *
      * @param string $filePath
      * @param int    $maxLength
@@ -82,13 +82,13 @@ public function __destruct()
     public function open()
     {
         if (!$this->isRemoteFile($this->path) && !is_readable($this->path)) {
-            throw new SDKException('Failed to create FacebookFile entity. Unable to read resource: ' . $this->path . '.');
+            throw new SDKException('Failed to create File entity. Unable to read resource: ' . $this->path . '.');
         }
 
         $this->stream = fopen($this->path, 'r');
 
         if (!$this->stream) {
-            throw new SDKException('Failed to create FacebookFile entity. Unable to open resource: ' . $this->path . '.');
+            throw new SDKException('Failed to create File entity. Unable to open resource: ' . $this->path . '.');
         }
     }
 

src/FileUpload/ResumableUploader.php

@@ -148,7 +148,7 @@ public function finish($endpoint, $uploadSessionId, $metadata = [])
     }
 
     /**
-     * Helper to make a FacebookRequest and send it.
+     * Helper to make a Request and send it.
      *
      * @param string $endpoint the endpoint to POST to
      * @param array  $params   the params to send with the request

src/FileUpload/TransferChunk.php

@@ -79,7 +79,7 @@ public function getFile()
     }
 
     /**
-     * Return a FacebookFile entity with partial content.
+     * Return a File entity with partial content.
      *
      * @return File
      */