declare strict_types and tighten return and parameter types

pavarnos · Aug 14, 2018 · 6bf1a2f · 6bf1a2f
1 parent dac4028
commit 6bf1a2f
Show file tree

Hide file tree

Showing 43 changed files with 172 additions and 129 deletions.
diff --git a/samples/testFetchPublicKey.php b/samples/testFetchPublicKey.php
@@ -1,17 +1,10 @@
 <?php
-
-use Threema\MsgApi\Connection;
+declare(strict_types=1);
 
 require_once '../vendor/autoload.php';
 
-//define your connection settings
-$driver = new \Threema\MsgApi\HttpDriver\CurlHttpDriver(
- '*YOUR_GATEWAY_THREEMA_ID',
- 'YOUR_GATEWAY_THREEMA_ID_SECRET'
-);
-
-//create a connection
-$connector = new Connection($driver);
+$factory = new \Threema\MsgApi\ConnectionFactory();
+$connection = $factory->getConnection('*YOUR_GATEWAY_THREEMA_ID', 'YOUR_GATEWAY_THREEMA_ID_SECRET');
 
 $result = $connector->fetchPublicKey('ECHOECHO');
 if ($result->isSuccess()) {

diff --git a/samples/testKeyLookup.php b/samples/testKeyLookup.php
@@ -1,19 +1,14 @@
 <?php
+declare(strict_types=1);
 
 use Threema\MsgApi\Connection;
 
 require_once '../vendor/autoload.php';
 
-//define your connection settings
-$driver = new \Threema\MsgApi\HttpDriver\CurlHttpDriver(
- '*YOUR_GATEWAY_THREEMA_ID',
- 'YOUR_GATEWAY_THREEMA_ID_SECRET'
-);
+$factory = new \Threema\MsgApi\ConnectionFactory();
+$connection = $factory->getConnection('*YOUR_GATEWAY_THREEMA_ID', 'YOUR_GATEWAY_THREEMA_ID_SECRET');
 
-//create a connection
-$connector = new Connection($driver);
-
-$result = $connector->keyLookupByPhoneNumber('123456789');
+$result = $connection->keyLookupByPhoneNumber('123456789');
 if ($result->isSuccess()) {
  echo 'Threema ID found: ' . $result->getId() . "\n";
 } else {

diff --git a/samples/testSendE2EFile.php b/samples/testSendE2EFile.php
@@ -1,23 +1,14 @@
 <?php
-
-use Threema\MsgApi\Connection;
+declare(strict_types=1);
 
 require_once '../vendor/autoload.php';
 
-//define your connection settings
-$driver = new \Threema\MsgApi\HttpDriver\CurlHttpDriver(
- '*YOUR_GATEWAY_THREEMA_ID',
- 'YOUR_GATEWAY_THREEMA_ID_SECRET'
-);
-
-//create a connection
-$connector = new Connection($driver);
+$factory = new \Threema\MsgApi\ConnectionFactory();
+$connection = $factory->getConnection('*YOUR_GATEWAY_THREEMA_ID', 'YOUR_GATEWAY_THREEMA_ID_SECRET');
 
-$senderPrivateKey = "MY_PUBLIC_KEY_IN_BIN";
+$senderPrivateKey = "MY_PRIVATE_KEY_AS_HEX";
 $filePath = "/path/to/my/file.pdf";
-
-$e2eHelper = new \Threema\MsgApi\Helpers\E2EHelper($senderPrivateKey, $connector);
-$result = $e2eHelper->sendFileMessage("TEST1234", "thePublicKeyAsHex", $filePath);
+$result = $connection->sendFileMessage($senderPrivateKey, "TEST1234", "thePublicKeyAsHex", $filePath);
 
 if (true === $result->isSuccess()) {
  echo 'File Message ID: ' . $result->getMessageId() . "\n";

diff --git a/samples/testSendE2EText.php b/samples/testSendE2EText.php
@@ -1,22 +1,13 @@
 <?php
-
-use Threema\MsgApi\Connection;
+declare(strict_types=1);
 
 require_once '../vendor/autoload.php';
 
-//define your connection settings
-$driver = new \Threema\MsgApi\HttpDriver\CurlHttpDriver(
- '*YOUR_GATEWAY_THREEMA_ID',
- 'YOUR_GATEWAY_THREEMA_ID_SECRET'
-);
-
-//create a connection
-$connector = new Connection($driver);
-
-$senderPrivateKey = "MY_PUBLIC_KEY_IN_BIN";
+$factory = new \Threema\MsgApi\ConnectionFactory();
+$connection = $factory->getConnection('*YOUR_GATEWAY_THREEMA_ID', 'YOUR_GATEWAY_THREEMA_ID_SECRET');
 
-$e2eHelper = new \Threema\MsgApi\Helpers\E2EHelper($senderPrivateKey, $connector);
-$result  = $e2eHelper->sendTextMessage("TEST1234", "thePublicKeyAsHex", "This is an end-to-end encrypted message");
+$result = $connection->sendTextMessage("MY_PRIVATE_KEY_AS_HEX", "TEST1234", "thePublicKeyAsHex",
+ "This is an end-to-end encrypted message");
 
 if (true === $result->isSuccess()) {
  echo 'Message ID: ' . $result->getMessageId() . "\n";

diff --git a/samples/testSendSimple.php b/samples/testSendSimple.php
@@ -1,23 +1,17 @@
 <?php
+declare(strict_types=1);
 
-use Threema\MsgApi\Connection;
 use Threema\MsgApi\Receiver;
 
 require_once '../vendor/autoload.php';
 
-//define your connection settings
-$driver = new \Threema\MsgApi\HttpDriver\CurlHttpDriver(
- '*YOUR_GATEWAY_THREEMA_ID',
- 'YOUR_GATEWAY_THREEMA_ID_SECRET'
-);
-
-//create a connection
-$connector = new Connection($driver);
+$factory = new \Threema\MsgApi\ConnectionFactory();
+$connection = $factory->getConnection('*YOUR_GATEWAY_THREEMA_ID', 'YOUR_GATEWAY_THREEMA_ID_SECRET');
 
 //create a receiver
 $receiver = new Receiver('ECHOECHO', Receiver::TYPE_ID);
 
-$result = $connector->sendSimple($receiver, "This is a Test Message");
+$result = $connection->sendSimple($receiver, "This is a Test Message");
 if ($result->isSuccess()) {
  echo 'Message ID: ' . $result->getMessageId() . "\n";
 } else {

diff --git a/src/Threema/MsgApi/Commands/Capability.php b/src/Threema/MsgApi/Commands/Capability.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands;
 
 use Threema\MsgApi\Commands\Results\CapabilityResult;
@@ -19,7 +21,7 @@ class Capability implements CommandInterface
  /**
  * @param string $threemaId
  */
- public function __construct($threemaId)
+ public function __construct(string $threemaId)
  {
  $this->threemaId = $threemaId;
  }

diff --git a/src/Threema/MsgApi/Commands/Credits.php b/src/Threema/MsgApi/Commands/Credits.php
@@ -4,9 +4,12 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands;
 
 use Threema\MsgApi\Commands\Results\CreditsResult;
+use Threema\MsgApi\Commands\Results\Result;
 
 class Credits implements CommandInterface
 {
@@ -28,7 +31,7 @@ public function getPath(): string
  * @param string $response
  * @return CreditsResult
  */
- public function parseResult(int $httpCode, string $response): \Threema\MsgApi\Commands\Results\Result
+ public function parseResult(int $httpCode, string $response): Result
  {
  return new CreditsResult($httpCode, $response);
  }

diff --git a/src/Threema/MsgApi/Commands/DownloadFile.php b/src/Threema/MsgApi/Commands/DownloadFile.php
@@ -4,9 +4,12 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands;
 
 use Threema\MsgApi\Commands\Results\DownloadFileResult;
+use Threema\MsgApi\Commands\Results\Result;
 
 class DownloadFile implements CommandInterface
 {
@@ -18,7 +21,7 @@ class DownloadFile implements CommandInterface
  /**
  * @param string $blobId
  */
- public function __construct($blobId)
+ public function __construct(string $blobId)
  {
  $this->blobId = $blobId;
  }
@@ -44,7 +47,7 @@ public function getPath(): string
  * @param string $response
  * @return DownloadFileResult
  */
- public function parseResult(int $httpCode, string $response): \Threema\MsgApi\Commands\Results\Result
+ public function parseResult(int $httpCode, string $response): Result
  {
  return new DownloadFileResult($httpCode, $response);
  }

diff --git a/src/Threema/MsgApi/Commands/FetchPublicKey.php b/src/Threema/MsgApi/Commands/FetchPublicKey.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands;
 
 use Threema\MsgApi\Commands\Results\FetchPublicKeyResult;
@@ -18,7 +20,7 @@ class FetchPublicKey implements CommandInterface
  /**
  * @param string $threemaId
  */
- public function __construct($threemaId)
+ public function __construct(string $threemaId)
  {
  $this->threemaId = $threemaId;
  }

diff --git a/src/Threema/MsgApi/Commands/Results/CapabilityResult.php b/src/Threema/MsgApi/Commands/Results/CapabilityResult.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 class CapabilityResult extends Result
@@ -22,7 +24,7 @@ class CapabilityResult extends Result
  /**
  * @return string[]
  */
- public function getCapabilities()
+ public function getCapabilities(): array
  {
  return $this->capabilities;
  }
@@ -31,7 +33,7 @@ public function getCapabilities()
  * the threema id can receive text
  * @return bool
  */
- public function canText()
+ public function canText(): bool
  {
  return $this->can(self::TEXT);
  }
@@ -40,7 +42,7 @@ public function canText()
  * the threema id can receive images
  * @return bool
  */
- public function canImage()
+ public function canImage(): bool
  {
  return $this->can(self::IMAGE);
  }
@@ -49,7 +51,7 @@ public function canImage()
  * the threema id can receive videos
  * @return bool
  */
- public function canVideo()
+ public function canVideo(): bool
  {
  return $this->can(self::VIDEO);
  }
@@ -58,7 +60,7 @@ public function canVideo()
  * the threema id can receive files
  * @return bool
  */
- public function canAudio()
+ public function canAudio(): bool
  {
  return $this->can(self::AUDIO);
  }
@@ -67,12 +69,12 @@ public function canAudio()
  * the threema id can receive files
  * @return bool
  */
- public function canFile()
+ public function canFile(): bool
  {
  return $this->can(self::FILE);
  }
 
- public function can($key)
+ public function can(string $key): bool
  {
  return in_array($key, $this->capabilities);
  }

diff --git a/src/Threema/MsgApi/Commands/Results/CreditsResult.php b/src/Threema/MsgApi/Commands/Results/CreditsResult.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 class CreditsResult extends Result
@@ -16,7 +18,7 @@ class CreditsResult extends Result
  /**
  * @return int
  */
- public function getCredits()
+ public function getCredits(): int
  {
  return $this->credits;
  }

diff --git a/src/Threema/MsgApi/Commands/Results/DownloadFileResult.php b/src/Threema/MsgApi/Commands/Results/DownloadFileResult.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 class DownloadFileResult extends Result
@@ -18,7 +20,7 @@ class DownloadFileResult extends Result
  *
  * @return string
  */
- public function getData()
+ public function getData(): string
  {
  return $this->data;
  }

diff --git a/src/Threema/MsgApi/Commands/Results/FetchPublicKeyResult.php b/src/Threema/MsgApi/Commands/Results/FetchPublicKeyResult.php
@@ -4,19 +4,21 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 class FetchPublicKeyResult extends Result
 {
  /**
- * @var string
+ * @var string as hex
  */
  private $publicKey;
 
  /**
  * @return string
  */
- public function getPublicKey()
+ public function getPublicKey(): string
  {
  return $this->publicKey;
  }

diff --git a/src/Threema/MsgApi/Commands/Results/LookupBulkResult.php b/src/Threema/MsgApi/Commands/Results/LookupBulkResult.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 use Threema\MsgApi\Commands\LookupBulk;

diff --git a/src/Threema/MsgApi/Commands/Results/LookupIdResult.php b/src/Threema/MsgApi/Commands/Results/LookupIdResult.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 class LookupIdResult extends Result
@@ -16,7 +18,7 @@ class LookupIdResult extends Result
  /**
  * @return string
  */
- public function getId()
+ public function getId(): string
  {
  return $this->id;
  }

diff --git a/src/Threema/MsgApi/Commands/Results/Result.php b/src/Threema/MsgApi/Commands/Results/Result.php
@@ -4,6 +4,8 @@
  * @copyright Copyright (c) 2015-2016 Threema GmbH
  */
 
+declare(strict_types=1);
+
 namespace Threema\MsgApi\Commands\Results;
 
 abstract class Result