rugk / threema-msgapi-sdk-php

source/Threema/Console/Command/Base.php

Doc Comments +2 added lines, -2 removed lines

@@ -48,7 +48,7 @@ 
 	 * @param string $subject
 	 * @param string[] $requiredArguments
 	 * @param string $description
-	 * @param array $optionalArguments
+	 * @param string[] $optionalArguments
 	 */
 	public function __construct($subject, array $requiredArguments, $description, array $optionalArguments = array()) {
 		$this->subject = $subject;
@@ -115,7 +115,7 @@ 
 	 * return a valid file path
 	 *
 	 * @param string $pos
-	 * @return null|string
+	 * @return string
 	 * @throws \Threema\Core\Exception
 	 */
 	public function getArgumentFile($pos) {

Spacing +18 added lines, -18 removed lines

@@ -68,7 +68,7 @@ 
 	 * @return int
 	 */
 	public function getAllArgumentsCount() {
-		return $this->getRequiredArgumentCount() + (null !== $this->optionalArguments ? count($this->optionalArguments) : 0);
+		return $this->getRequiredArgumentCount()+(null !== $this->optionalArguments ? count($this->optionalArguments) : 0);
 	}
 
 	/**
@@ -76,15 +76,15 @@ 
 	 * @return int
 	 * @throws \Threema\Core\Exception
 	 */
-	private function getIndexByPos($pos){
+	private function getIndexByPos($pos) {
 		$i = array_search($pos, $this->requiredArguments);
-		if(false === $i) {
+		if (false === $i) {
 			$i = array_search($pos, $this->optionalArguments);
-			if(false !== $i) {
+			if (false !== $i) {
 				$i += count($this->requiredArguments);
 			}
 		}
-		if(false === $i) {
+		if (false === $i) {
 			throw new Exception('argument '.$pos.' not found');
 		}
 
@@ -100,8 +100,8 @@ 
 		$i = $this->getIndexByPos($pos);
 		$required = $i < count($this->requiredArguments);
 
-		if(false === array_key_exists($i, $this->arguments)) {
-			if(true === $required) {
+		if (false === array_key_exists($i, $this->arguments)) {
+			if (true === $required) {
 				throw new Exception('no argument at position '.$i.' ('.$pos.')');
 			}
 			else {
@@ -121,7 +121,7 @@ 
 	public function getArgumentFile($pos) {
 		$i = $this->getIndexByPos($pos);
 
-		if(false === is_file($this->arguments[$i])) {
+		if (false === is_file($this->arguments[$i])) {
 			throw new Exception('argument '.$i.' is not a file');
 		}
 
@@ -134,7 +134,7 @@ 
 	 */
 	public function getArgumentPrivateKey($pos) {
 		$content = Common::getPrivateKey($this->getArgumentStringOrFileContent($pos));
-		if(null !== $content) {
+		if (null !== $content) {
 			return hex2bin($content);
 		}
 		return null;
@@ -146,7 +146,7 @@ 
 	 */
 	public function getArgumentPublicKey($pos) {
 		$content = Common::getPublicKey($this->getArgumentStringOrFileContent($pos));
-		if(null !== $content) {
+		if (null !== $content) {
 			return hex2bin($content);
 		}
 		return null;
@@ -158,7 +158,7 @@ 
 	 */
 	private function getArgumentStringOrFileContent($pos) {
 		$content = $this->getArgument($pos);
-		if(file_exists($content)) {
+		if (file_exists($content)) {
 			$content = trim(file_get_contents($content));
 		}
 		return $content;
@@ -170,7 +170,7 @@ 
 	 */
 	public function getArgumentThreemaId($pos) {
 		$content = $this->getArgument($pos);
-		if(null !== $content && strlen($content) == 8) {
+		if (null !== $content && strlen($content) == 8) {
 			return strtoupper($content);
 		}
 		return null;
@@ -180,12 +180,12 @@ 
 	 * @return string
 	 */
 	protected function readStdIn() {
-		$f = fopen( 'php://stdin', 'r' );
+		$f = fopen('php://stdin', 'r');
 
 		$lines = array();
-		while( $line = trim(fgets($f)) ) {
+		while ($line = trim(fgets($f))) {
 
-			if(strlen($line) == 0 || $line == "\n") {
+			if (strlen($line) == 0 || $line == "\n") {
 				continue;
 			}
 
@@ -204,7 +204,7 @@ 
 
 		$argCount = null !== $this->arguments ? count($this->arguments) : 0;
 
-		if($argCount < count($this->requiredArguments)) {
+		if ($argCount < count($this->requiredArguments)) {
 			throw new Exception('invalid count of arguments');
 		}
 		$this->doRun();
@@ -217,10 +217,10 @@ 
 	final public function help($shellColors = true) {
 		$args = array_merge($this->requiredArguments, $this->optionalArguments);
 
-		if(count($args) > 0) {
+		if (count($args) > 0) {
 			$colorPrefix = '';
 			$colorPostfix = '';
-			if(true === $shellColors) {
+			if (true === $shellColors) {
 				$colorPrefix = "\033[0;36m\033[40m";
 				$colorPostfix = "\033[0m";
 			}

Braces +1 added lines, -2 removed lines

@@ -103,8 +103,7 @@
 		if(false === array_key_exists($i, $this->arguments)) {
 			if(true === $required) {
 				throw new Exception('no argument at position '.$i.' ('.$pos.')');
-			}
-			else {
+			} else {
 				return null;
 			}
 		}

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

source/Threema/Core/AssocArray.php

Doc Comments +2 added lines, -2 removed lines

@@ -36,8 +36,8 @@
 	}
 
 	/**
-	 * @param $string
-	 * @param array|null $requiredKeys
+	 * @param string $string
+	 * @param string[] $requiredKeys
 	 * @return AssocArray
 	 * @throws Exception
 	 */

Spacing +5 added lines, -5 removed lines

@@ -28,7 +28,7 @@ 
 	 * @return mixed|null return the key value or the default value
 	 */
 	public function getValue($key, $defaultValue = null) {
-		if(false === array_key_exists($key, $this->data)) {
+		if (false === array_key_exists($key, $this->data)) {
 			return $defaultValue;
 		}
 
@@ -43,15 +43,15 @@ 
 	 */
 	public static final function byJsonString($string, array $requiredKeys = null) {
 		$v = json_decode($string, true);
-		if(null === $v || false === $v) {
+		if (null === $v || false === $v) {
 			throw new Exception('invalid json string');
 		}
 
 		//validate first
-		if(null !== $requiredKeys) {
+		if (null !== $requiredKeys) {
 			//validate array first
-			foreach($requiredKeys as $requiredKey) {
-				if(false === array($v)) {
+			foreach ($requiredKeys as $requiredKey) {
+				if (false === array($v)) {
 					throw new Exception('required key '.$requiredKey.' failed');
 				}
 			}

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

source/Threema/MsgApi/Commands/DownloadFile.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	/**
 	 * @param int $httpCode
 	 * @param object $res
-	 * @return UploadFileResult
+	 * @return DownloadFileResult
 	 */
 	function parseResult($httpCode, $res){
 		return new DownloadFileResult($httpCode, $res);

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

Spacing +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 	 * @param object $res
 	 * @return UploadFileResult
 	 */
-	function parseResult($httpCode, $res){
+	function parseResult($httpCode, $res) {
 		return new UploadFileResult($httpCode, $res);
 	}
 }

source/Threema/MsgApi/Helpers/ReceiveMessageResult.php

Doc Comments +2 added lines, -2 removed lines

@@ -73,7 +73,7 @@ 
 	}
 
 	/**
-	 * @return \string[]
+	 * @return string[]
 	 */
 	public function getErrors() {
 		return $this->errors;
@@ -87,7 +87,7 @@ 
 	}
 
 	/**
-	 * @return \string[]
+	 * @return string[]
 	 */
 	public function getFiles() {
 		return $this->files;

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

source/Threema/MsgApi/Messages/DeliveryReceipt.php

Doc Comments +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
 
 	/**
 	 * Get the acknowledged message ids
-	 * @return array
+	 * @return string[]
 	 */
 	public function getAckedMessageIds() {
 		return $this->ackedMessageIds;

Spacing +2 added lines, -2 removed lines

@@ -57,7 +57,7 @@ 
 	 * @return string
 	 */
 	public function getReceiptTypeName() {
-		if(true === array_key_exists($this->receiptType, self::$receiptTypesToNames)) {
+		if (true === array_key_exists($this->receiptType, self::$receiptTypesToNames)) {
 			return self::$receiptTypesToNames[$this->receiptType];
 		}
 		return null;
@@ -77,7 +77,7 @@ 
 	 * @return string
 	 */
 	function __toString() {
-		$str = "Delivery receipt (" . $this->getReceiptTypeName() . "): ";
+		$str = "Delivery receipt (".$this->getReceiptTypeName()."): ";
 		$hexMessageIds = array();
 		foreach ($this->ackedMessageIds as $messageId) {
 			$hexMessageIds[] = bin2hex($messageId);

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

source/Threema/MsgApi/Tools/CryptTool.php

Doc Comments +13 added lines, -4 removed lines

@@ -142,6 +142,11 @@ 
 		return $this->makeBox($message, $nonce, $senderPrivateKey, $recipientPublicKey);
 	}
 
+	/**
+	 * @param string $senderPrivateKey
+	 * @param string $recipientPublicKey
+	 * @param string $nonce
+	 */
 	final public function encryptFileMessage(UploadFileResult $uploadFileResult,
 											 EncryptResult $encryptResult,
 											 UploadFileResult $thumbnailUploadFileResult = null,
@@ -190,9 +195,9 @@ 
 	 * make a secret box
 	 *
 	 * @param $data
-	 * @param $nonce
+	 * @param string $nonce
 	 * @param $key
-	 * @return mixed
+	 * @return string
 	 */
 	abstract protected function makeSecretBox($data, $nonce, $key);
 
@@ -376,7 +381,7 @@ 
 	abstract public function validate();
 
 	/**
-	 * @param $data
+	 * @param string $data
 	 * @return EncryptResult
 	 */
 	public final function encryptFile($data) {
@@ -388,7 +393,7 @@ 
 	/**
 	 * @param string $data as binary
 	 * @param string $key as binary
-	 * @return null|string
+	 * @return string
 	 */
 	public final function decryptFile($data, $key) {
 		$result =  $this->openSecretBox($data, self::FILE_NONCE, $key);
@@ -405,6 +410,10 @@ 
 		return new EncryptResult($box, $key,  self::FILE_THUMBNAIL_NONCE, strlen($box));
 	}
 
+	/**
+	 * @param string $data
+	 * @param string $key
+	 */
 	public final function decryptFileThumbnail($data, $key) {
 		$result = $this->openSecretBox($data, self::FILE_THUMBNAIL_NONCE, $key);
 		return false === $result ? null : $result;

Spacing +18 added lines, -18 removed lines

@@ -42,8 +42,8 @@ 
 	 * @return CryptTool
 	 */
 	public static function getInstance() {
-		if(null === self::$instance) {
-			foreach(array(
+		if (null === self::$instance) {
+			foreach (array(
 				function() {
 					return self::createInstance(self::TYPE_SODIUM);
 				},
@@ -51,7 +51,7 @@ 
 					return self::createInstance(self::TYPE_SALT);
 				}) as $instanceGenerator) {
 				$i = $instanceGenerator->__invoke();
-				if(null !== $i) {
+				if (null !== $i) {
 					self::$instance = $i;
 					break;
 				}
@@ -66,18 +66,18 @@ 
 	 * @return null|CryptTool null on unknown type
 	 */
 	public static function createInstance($type) {
-		switch($type) {
+		switch ($type) {
 			case self::TYPE_SODIUM:
 				$instance = new CryptToolSodium();
-				if(false === $instance->isSupported()) {
+				if (false === $instance->isSupported()) {
 					//try to instance old version of sodium wrapper
 					/** @noinspection PhpDeprecationInspection */
 					$instance = new CryptToolSodiumDep();
 				}
-				return $instance->isSupported() ? $instance :null;
+				return $instance->isSupported() ? $instance : null;
 			case self::TYPE_SALT:
 				$instance = new CryptToolSalt();
-				return $instance->isSupported() ? $instance :null;
+				return $instance->isSupported() ? $instance : null;
 			default:
 				return null;
 		}
@@ -104,7 +104,7 @@ 
 	 */
 	final public function encryptMessageText($text, $senderPrivateKey, $recipientPublicKey, $nonce) {
 		/* prepend type byte (0x01) to message data */
-		$textBytes = "\x01" . $text;
+		$textBytes = "\x01".$text;
 
 		/* determine random amount of PKCS7 padding */
 		$padbytes = mt_rand(1, 255);
@@ -129,7 +129,7 @@ 
 			$senderPrivateKey,
 			$recipientPublicKey,
 			$nonce) {
-		$message = "\x02" . hex2bin($uploadFileResult->getBlobId());
+		$message = "\x02".hex2bin($uploadFileResult->getBlobId());
 		$message .= pack('V', $encryptResult->getSize());
 		$message .= $encryptResult->getNonce();
 
@@ -160,11 +160,11 @@ 
 			'i' => 0
 		);
 
-		if($thumbnailUploadFileResult != null && strlen($thumbnailUploadFileResult->getBlobId()) > 0) {
+		if ($thumbnailUploadFileResult != null && strlen($thumbnailUploadFileResult->getBlobId()) > 0) {
 			$messageContent['t'] = $thumbnailUploadFileResult->getBlobId();
 		}
 
-		$message = "\x17" . json_encode($messageContent);
+		$message = "\x17".json_encode($messageContent);
 
 		/* determine random amount of PKCS7 padding */
 		$padbytes = mt_rand(1, 255);
@@ -237,7 +237,7 @@ 
 
 		/* remove padding */
 		$padbytes = ord($data[strlen($data)-1]);
-		$realDataLength = strlen($data) - $padbytes;
+		$realDataLength = strlen($data)-$padbytes;
 		if ($realDataLength < 1) {
 			throw new BadMessageException();
 		}
@@ -263,7 +263,7 @@ 
 				return new TextMessage(substr($data, 1));
 			case DeliveryReceipt::TYPE_CODE:
 				/* Delivery receipt */
-				if ($realDataLength < (self::MESSAGE_ID_LEN-2) || (($realDataLength - 2) % self::MESSAGE_ID_LEN) != 0)  {
+				if ($realDataLength < (self::MESSAGE_ID_LEN-2) || (($realDataLength-2)%self::MESSAGE_ID_LEN) != 0) {
 					throw new BadMessageException();
 				}
 
@@ -273,7 +273,7 @@ 
 				return new DeliveryReceipt($receiptType, $messageIds);
 			case ImageMessage::TYPE_CODE:
 				/* Image Message */
-				if ($realDataLength != 1 + self::BLOB_ID_LEN + self::IMAGE_FILE_SIZE_LEN + self::IMAGE_NONCE_LEN)  {
+				if ($realDataLength != 1+self::BLOB_ID_LEN+self::IMAGE_FILE_SIZE_LEN+self::IMAGE_NONCE_LEN) {
 					throw new BadMessageException();
 				}
 
@@ -284,12 +284,12 @@ 
 			case FileMessage::TYPE_CODE:
 				/* Image Message */
 				$decodeResult = json_decode(substr($data, 1), true);
-				if(null === $decodeResult || false === $decodeResult) {
+				if (null === $decodeResult || false === $decodeResult) {
 					throw new BadMessageException();
 				}
 
 				$values = AssocArray::byJsonString(substr($data, 1), array('b', 't', 'k', 'm', 'n', 's'));
-				if(null === $values) {
+				if (null === $values) {
 					throw new BadMessageException();
 				}
 
@@ -391,7 +391,7 @@ 
 	 * @return null|string
 	 */
 	public final function decryptFile($data, $key) {
-		$result =  $this->openSecretBox($data, self::FILE_NONCE, $key);
+		$result = $this->openSecretBox($data, self::FILE_NONCE, $key);
 		return false === $result ? null : $result;
 	}
 
@@ -402,7 +402,7 @@ 
 	 */
 	public final function encryptFileThumbnail($data, $key) {
 		$box = $this->makeSecretBox($data, self::FILE_THUMBNAIL_NONCE, $key);
-		return new EncryptResult($box, $key,  self::FILE_THUMBNAIL_NONCE, strlen($box));
+		return new EncryptResult($box, $key, self::FILE_THUMBNAIL_NONCE, strlen($box));
 	}
 
 	public final function decryptFileThumbnail($data, $key) {

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

samples/testFetchPublicKey.php

Spacing +3 added lines, -3 removed lines

@@ -22,9 +22,9 @@
 
 
 $result = $connector->fetchPublicKey('ECHOECHO');
-if($result->isSuccess()) {
-	echo 'public key '.$result->getPublicKey() . "\n";
+if ($result->isSuccess()) {
+	echo 'public key '.$result->getPublicKey()."\n";
 }
 else {
-	echo 'error '.$result->getErrorMessage() . "\n";
+	echo 'error '.$result->getErrorMessage()."\n";
 }

Braces +1 added lines, -2 removed lines

@@ -29,7 +29,6 @@
 $result = $connector->sendSimple($receiver, "This is a Test Message");
 if($result->isSuccess()) {
 	echo 'Message ID: '.$result->getMessageId() . "\n";
-}
-else {
+} else {
 	echo 'Error: '.$result->getErrorMessage() . "\n";
 }

samples/testKeyLookup.php

Spacing +3 added lines, -3 removed lines

@@ -21,9 +21,9 @@
 $connector = new Connection($settings, $publicKeyStore);
 
 $result = $connector->keyLookupByPhoneNumber('123456789');
-if($result->isSuccess()) {
-	echo 'Threema ID found: '.$result->getId() . "\n";
+if ($result->isSuccess()) {
+	echo 'Threema ID found: '.$result->getId()."\n";
 }
 else {
-	echo 'Error: '.$result->getErrorMessage() . "\n";
+	echo 'Error: '.$result->getErrorMessage()."\n";
 }

Braces +1 added lines, -2 removed lines

@@ -29,7 +29,6 @@
 $result = $connector->sendSimple($receiver, "This is a Test Message");
 if($result->isSuccess()) {
 	echo 'Message ID: '.$result->getMessageId() . "\n";
-}
-else {
+} else {
 	echo 'Error: '.$result->getErrorMessage() . "\n";
 }

samples/testSendE2EFile.php

Spacing +4 added lines, -4 removed lines

@@ -23,12 +23,12 @@
 $senderPrivateKey = "MY_PUBLIC_KEY_IN_BIN";
 $filePath = "/path/to/my/file.pdf";
 
-$e2eHelper = new \Threema\MsgApi\Helpers\E2EHelper($senderPrivateKey,$connector);
+$e2eHelper = new \Threema\MsgApi\Helpers\E2EHelper($senderPrivateKey, $connector);
 $result = $e2eHelper->sendFileMessage("TEST1234", $filePath);
 
-if(true === $result->isSuccess()) {
-	echo 'File Message ID: '.$result->getMessageId() . "\n";
+if (true === $result->isSuccess()) {
+	echo 'File Message ID: '.$result->getMessageId()."\n";
 }
 else {
-	echo 'Error: '.$result->getErrorMessage() . "\n";
+	echo 'Error: '.$result->getErrorMessage()."\n";
 }

Braces +1 added lines, -2 removed lines

@@ -29,7 +29,6 @@
 $result = $connector->sendSimple($receiver, "This is a Test Message");
 if($result->isSuccess()) {
 	echo 'Message ID: '.$result->getMessageId() . "\n";
-}
-else {
+} else {
 	echo 'Error: '.$result->getErrorMessage() . "\n";
 }