Add support of JsonSerializable interface

Author: zoonman

src/AccessToken.php

@@ -21,7 +21,7 @@
  *
  * @package LinkedIn
  */
-class AccessToken
+class AccessToken implements \JsonSerializable
 {
 
     /**
@@ -80,7 +80,7 @@ public function setToken($token)
     }
 
     /**
-     * Get token expiration
+     * The number of seconds remaining, from the time it was requested, before the token will expire.
      *
      * @return int seconds
      */
@@ -92,7 +92,7 @@ public function getExpiresIn()
     /**
      * Set token expiration time
      *
-     * @param int $expiresIn seconds
+     * @param int $expiresIn amount of seconds before expiration
      *
      * @return AccessToken
      */
@@ -113,6 +113,8 @@ public function __toString()
     }
 
     /**
+     * Get Unix epoch time when token will expire
+     *
      * @return int
      */
     public function getExpiresAt()
@@ -121,7 +123,9 @@ public function getExpiresAt()
     }
 
     /**
-     * @param int $expiresAt
+     * Set Unix epoch time when token will expire
+     *
+     * @param int $expiresAt seconds, unix time
      *
      * @return AccessToken
      */
@@ -132,7 +136,7 @@ public function setExpiresAt($expiresAt)
     }
 
     /**
-     * Instantiate token object
+     * Instantiate access token object
      *
      * @param $responseArray
      *
@@ -160,4 +164,14 @@ public static function fromResponseArray($responseArray)
             $responseArray['expires_in'] + time()
         );
     }
+
+    public function jsonSerialize()
+    {
+        return [
+          'token' => $this->getToken(),
+          'expiresAt' => $this->getExpiresAt(),
+        ];
+    }
+
+
 }

src/Client.php

@@ -183,7 +183,9 @@ protected static function responseToArray($response)
     }
 
     /**
-     * @param string $accessToken
+     * Set AccessToken object
+     *
+     * @param AccessToken $accessToken
      *
      * @return Client
      */

src/Exception.php

@@ -16,9 +16,26 @@
 
 namespace LinkedIn;
 
+/**
+ * Class Exception
+ * @package LinkedIn
+ */
 class Exception extends \Exception
 {
+    /**
+     * Error's description
+     *
+     * @var string
+     */
     protected $description;
+
+    /**
+     * Exception constructor.
+     * @param string $message
+     * @param int $code
+     * @param null $previousException
+     * @param $description
+     */
     public function __construct(
         $message = "",
         $code = 0,
@@ -30,7 +47,9 @@ public function __construct(
     }
 
     /**
-     * @return mixed
+     * Get textual description that summarizes error.
+     *
+     * @return string
      */
     public function getDescription()
     {

src/Scope.php

@@ -16,10 +16,30 @@
 
 namespace LinkedIn;
 
+/**
+ * Class Scope defines list of available permissions
+ *
+ * @package LinkedIn
+ */
 class Scope extends AbstractEnum
 {
+    /**
+     * Allows to read basic information about profile, such as name
+     */
     const READ_BASIC_PROFILE = 'r_basicprofile';
+
+    /**
+     * Enables access to email address field
+     */
     const READ_EMAIL_ADDRESS = 'r_emailaddress';
+
+    /**
+     * Enables  to manage business company, retrieve analytics
+     */
     const MANAGE_COMPANY = 'rw_company_admin';
+
+    /**
+     * Enables ability to share content on LinkedIn
+     */
     const SHARING = 'w_share';
 }

tests/AccessTokenTest.php

@@ -112,4 +112,10 @@ public function testToString()
         $token = new AccessToken('hello', 1);
         $this->assertEquals('hello', (string) $token);
     }
+
+    public function testJsonSerialize()
+    {
+        $token = new AccessToken('hello', 1);
+        $this->assertEquals('{"token":"hello","expiresAt":1}', json_encode($token));
+    }
 }