DEV-4690 - Formatting and naming changes

Author: ethancarlsson-pf

src/PrintfulApiClient.php

@@ -48,6 +48,7 @@ class PrintfulApiClient
 
     /**
      * @param string $key
+     * @param string $type // OAuth token or Legacy Store Key
      * @throws \Printful\Exceptions\PrintfulException if the library failed to initialize
      */
     public function __construct($key, $type = self::DEFAULT_KEY)
@@ -61,21 +62,21 @@ public function __construct($key, $type = self::DEFAULT_KEY)
     }
 
     /**
-     * @param string $key
+     * @param string $oAuthToken
      * @throws PrintfulException
      */
-    public static function createOauthClient($key)
+    public static function createOauthClient($oAuthToken)
     {
-        return new self($key, self::TYPE_OAUTH_TOKEN);
+        return new self($oAuthToken, self::TYPE_OAUTH_TOKEN);
     }
 
     /**
-     * @param string $key
+     * @param string $legacyStoreKey
      * @throws PrintfulException
      */
-    public static function createLegacyStoreKeyClient($key)
+    public static function createLegacyStoreKeyClient($legacyStoreKey)
     {
-        return new self($key, self::TYPE_LEGACY_STORE_KEY);
+        return new self($legacyStoreKey, self::TYPE_LEGACY_STORE_KEY);
     }
 
     /**
@@ -226,7 +227,7 @@ private function request($method, $path, array $params = [], $data = null)
     }
 
     /**
-     * @param $curl resource
+     * @param resource $curl
      * @throws PrintfulException
      */
     private function setCredentials($curl)

tests/ApiClient/PrintfulApiClientTest.php

@@ -9,7 +9,6 @@
 
 class PrintfulApiClientTest extends TestCase
 {
-
     /**
      * @throws \Printful\Exceptions\PrintfulException
      * @throws \Printful\Exceptions\PrintfulApiException

tests/TestCase.php

@@ -24,7 +24,7 @@ protected function setUp()
 
         if (Credentials::$oAuthToken !== '') {
             $this->api = PrintfulApiClient::createOauthClient(Credentials::$oAuthToken);
-        } elseif  (Credentials::$legacyStoreKey !== ''){
+        } elseif (Credentials::$legacyStoreKey !== '') {
             $this->api = PrintfulApiClient::createLegacyStoreKeyClient(Credentials::$legacyStoreKey);
         } else {
             throw new \Exception('Printful test credentials are not set. Please enter a valid $oAuthToken or $legacyStoreKey in your tests/Credentials.php file');