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) {

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
 	 */

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);

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;

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;

source/Threema/MsgApi/Tools/CryptTool.php

Doc Comments +16 added lines, -4 removed lines

@@ -145,6 +145,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,
@@ -193,9 +198,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);
 
@@ -337,6 +342,9 @@ 
 		return hash_hmac('sha256', $phoneNoClean, self::PHONENO_HMAC_KEY);
 	}
 
+	/**
+	 * @return string
+	 */
 	abstract protected function createRandom($size);
 
 	/**
@@ -379,7 +387,7 @@ 
 	abstract public function validate();
 
 	/**
-	 * @param $data
+	 * @param string $data
 	 * @return EncryptResult
 	 */
 	public final function encryptFile($data) {
@@ -391,7 +399,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);
@@ -408,6 +416,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;

samples/web/include/Connection.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
  *
  * @param string $keystorePath Path public key store file (PHP)
  *
- * @return PhpFile public key store
+ * @return Threema\MsgApi\PublicKeyStores\PhpFile public key store
  */
 function CreatePublicKeyStore($keystorePath)
 {

samples/web/SendTextMessage.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
  * @param string $threemaId The id whose public key should be fetched
  * @param string $message The message to send (max 3500 characters)
  *
- * @return string|Exception
+ * @return string
  */
 function SendMessage($connector, $threemaId, $message)
 {

source/Threema/MsgApi/Connection.php

Doc Comments +10 added lines, -10 removed lines

@@ -56,7 +56,7 @@ 
 
 	/**
 	 * @param Receiver $receiver
-	 * @param $text
+	 * @param string $text
 	 * @return SendSimpleResult
 	 */
 	public function sendSimple(Receiver $receiver, $text) {
@@ -76,7 +76,7 @@ 
 	}
 
 	/**
-	 * @param $encryptedFileData (binary string)
+	 * @param string $encryptedFileData (binary string)
 	 * @return UploadFileResult
 	 */
 	public function uploadFile($encryptedFileData) {
@@ -86,8 +86,8 @@ 
 
 
 	/**
-	 * @param $blobId
-	 * @param callable $progress
+	 * @param string $blobId
+	 * @param \Closure $progress
 	 * @return DownloadFileResult
 	 */
 	public function downloadFile($blobId, \Closure $progress = null) {
@@ -96,7 +96,7 @@ 
 	}
 
 	/**
-	 * @param $phoneNumber
+	 * @param null|string $phoneNumber
 	 * @return LookupIdResult
 	 */
 	public function keyLookupByPhoneNumber($phoneNumber) {
@@ -123,14 +123,14 @@ 
 
 
 	/**
-	 * @return CreditsResult
+	 * @return Result
 	 */
 	public function credits() {
 		return $this->get(new Credits());
 	}
 
 	/**
-	 * @param $threemaId
+	 * @param string|null $threemaId
 	 * @return FetchPublicKeyResult
 	 */
 	public function fetchPublicKey($threemaId) {
@@ -158,7 +158,7 @@ 
 	}
 
 	/**
-	 * @param callable $progress
+	 * @param \Closure $progress
 	 * @return array
 	 */
 	private function createDefaultOptions(\Closure $progress = null) {
@@ -225,7 +225,7 @@ 
 
 	/**
 	 * @param CommandInterface $command
-	 * @param callable $progress
+	 * @param \Closure $progress
 	 * @return Result
 	 */
 	protected function get(CommandInterface $command, \Closure $progress = null) {
@@ -280,7 +280,7 @@ 
 	 * @param string $path
 	 * @param array $curlOptions
 	 * @param array $parameters
-	 * @param callable $result
+	 * @param \Closure $result
 	 * @return mixed
 	 * @throws \Threema\Core\Exception
 	 */