# rugk/threema-msgapi-sdk-php

## ShortVariable

### Since: 0.2

Detects when a field, local, or parameter has a very short name.

## Example

class Something {
private $q = 15; // VIOLATION - Field public static function main( array$as ) { // VIOLATION - Formal
$r = 20 +$this->q; // VIOLATION - Local

        $p = Common::convertPublicKey('PUBKEYSTRING'); ## ShortVariable ### Since: 0.2 Detects when a field, local, or parameter has a very short name. ## Example class Something { private$q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal$r = 20 + $this->q; // VIOLATION - Local for (int$i = 0; $i < 10;$i++) { // Not a Violation (inside FOR)
$r +=$this->q;
}
}
}

### Source https://phpmd.org/rules/naming.html#shortvariable

#### Avoid variables with short names like $p. Configured minimum length is 3. Open $p['to'] = $this->threemaId; ## ShortVariable ### Since: 0.2 Detects when a field, local, or parameter has a very short name. ## Example class Something { private$q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal$r = 20 + $this->q; // VIOLATION - Local for (int$i = 0; $i < 10;$i++) { // Not a Violation (inside FOR)
$r +=$this->q;
}
}
}

## ShortVariable

### Since: 0.2

Detects when a field, local, or parameter has a very short name.

## Example

class Something {
private $q = 15; // VIOLATION - Field public static function main( array$as ) { // VIOLATION - Formal
$r = 20 +$this->q; // VIOLATION - Local

        $kp = \Sodium\crypto_box_keypair_from_secretkey_and_publickey($recipientPrivateKey, $senderPublicKey); ## ShortVariable ### Since: 0.2 Detects when a field, local, or parameter has a very short name. ## Example class Something { private$q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal$r = 20 + $this->q; // VIOLATION - Local for (int$i = 0; $i < 10;$i++) { // Not a Violation (inside FOR)
$r +=$this->q;
}
}
}

## ShortVariable

### Since: 0.2

Detects when a field, local, or parameter has a very short name.

## Example

class Something {
private $q = 15; // VIOLATION - Field public static function main( array$as ) { // VIOLATION - Formal
$r = 20 +$this->q; // VIOLATION - Local
for (int $i = 0;$i < 10; $i++) { // Not a Violation (inside FOR)$r += $this->q; } } } ### Source https://phpmd.org/rules/naming.html#shortvariable #### Avoid variables with short names like$o. Configured minimum length is 3. Open

            $o = func_get_arg($n);
Found in source/Threema/Console/Common.php by phpmd

## ShortVariable

### Since: 0.2

Detects when a field, local, or parameter has a very short name.

## Example

class Something {
private $q = 15; // VIOLATION - Field public static function main( array$as ) { // VIOLATION - Formal
$r = 20 +$this->q; // VIOLATION - Local
for (int $i = 0;$i < 10; $i++) { // Not a Violation (inside FOR)$r += $this->q; } } } ### Source https://phpmd.org/rules/naming.html#shortvariable #### Avoid variables with short names like$p. Configured minimum length is 3. Open

        $p =$this->receiver->getParams();

## ShortVariable

### Since: 0.2

Detects when a field, local, or parameter has a very short name.

## Example

class Something {
private $q = 15; // VIOLATION - Field public static function main( array$as ) { // VIOLATION - Formal
$r = 20 +$this->q; // VIOLATION - Local

        $kp = Sodium::crypto_box_keypair_from_secretkey_and_publickey($recipientPrivateKey, $senderPublicKey); ## ShortVariable ### Since: 0.2 Detects when a field, local, or parameter has a very short name. ## Example class Something { private$q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal$r = 20 + $this->q; // VIOLATION - Local for (int$i = 0; $i < 10;$i++) { // Not a Violation (inside FOR)
$r +=$this->q;
}
}
}

### Source https://phpmd.org/rules/naming.html#shortvariable

#### Avoid variables with short names like $s. Configured minimum length is 3. Open $s = http_build_query($this->values); Found in source/Threema/Core/Url.php by phpmd ## ShortVariable ### Since: 0.2 Detects when a field, local, or parameter has a very short name. ## Example class Something { private$q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal$r = 20 + $this->q; // VIOLATION - Local for (int$i = 0; $i < 10;$i++) { // Not a Violation (inside FOR)
$r +=$this->q;
}
}
}

### Source https://phpmd.org/rules/naming.html#shortvariable

#### Avoid variables with short names like $to. Configured minimum length is 3. Open $to = $this->type; Found in source/Threema/MsgApi/Receiver.php by phpmd ## ShortVariable ### Since: 0.2 Detects when a field, local, or parameter has a very short name. ## Example class Something { private$q = 15; // VIOLATION - Field
public static function main( array $as ) { // VIOLATION - Formal$r = 20 + $this->q; // VIOLATION - Local for (int$i = 0; $i < 10;$i++) { // Not a Violation (inside FOR)
$r +=$this->q;
}
}
}

### Source https://phpmd.org/rules/naming.html#shortvariable

#### Method receiveMessage has 6 arguments (exceeds 4 allowed). Consider refactoring. Open

    public final function receiveMessage($threemaId,$messageId,
$box,$nonce,
$outputFolder = null, Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 45 mins to fix #### Function findPublicKey has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open  public function findPublicKey($threemaId) {
$storeHandle = fopen($this->file, 'r');
if(false === $storeHandle) { throw new Exception('could not open file '.$this->file);
}
Found in source/Threema/MsgApi/PublicKeyStores/File.php - About 45 mins to fix

# Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

### A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

#### Method __construct has 6 arguments (exceeds 4 allowed). Consider refactoring. Open

    public function __construct($blobId,$thumbnailBlobId, $encryptionKey,$mimeType, $filename,$size) {
Found in source/Threema/MsgApi/Messages/FileMessage.php - About 45 mins to fix

#### Function initFile has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open

    private function initFile($fileHandle = null) { //check if file does already contain content if (filesize($this->file) != 0) {
return true;
Found in source/Threema/MsgApi/PublicKeyStores/PhpFile.php - About 45 mins to fix

# Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

### A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

#### Function sendFileMessage has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open

    public final function sendFileMessage($threemaId,$filePath, $thumbnailPath = null) { //analyse the file$fileAnalyzeResult = FileAnalysisTool::analyse($filePath); if(null ===$fileAnalyzeResult) {
Found in source/Threema/MsgApi/Helpers/E2EHelper.php - About 45 mins to fix

# Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

### A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

#### Function byJsonString has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open

    public static final function byJsonString($string, array$requiredKeys = null) {
$v = json_decode($string, true);
if(null === $v || false ===$v) {
throw new Exception('invalid json string');
}
Found in source/Threema/Core/AssocArray.php - About 45 mins to fix

# Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

### A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

#### The class Connection has a coupling between objects value of 29. Consider to reduce the number of dependencies under 13. Open

class Connection
{
/**
* @var ConnectionSettings
*/
Found in source/Threema/MsgApi/Connection.php by phpmd

## CouplingBetweenObjects

### Since: 1.1.0

A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

## Example

class Foo {
/**
* @var \foo\bar\X
*/
private $x = null; /** * @var \foo\bar\Y */ private$y = null;

/**
* @var \foo\bar\Z
*/
private $z = null; public function setFoo(\Foo$foo) {}
public function setBar(\Bar $bar) {} public function setBaz(\Baz$baz) {}

/**
* @return \SplObjectStorage
* @throws \OutOfRangeException
* @throws \InvalidArgumentException
* @throws \ErrorException
*/
public function process(\Iterator $it) {} // ... } ### Source https://phpmd.org/rules/design.html#couplingbetweenobjects #### The class Run has a coupling between objects value of 23. Consider to reduce the number of dependencies under 13. Open class Run { /** * @var array */ private$arguments = array();
Found in source/Threema/Console/Run.php by phpmd

## CouplingBetweenObjects

### Since: 1.1.0

A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

## Example

class Foo {
/**
* @var \foo\bar\X
*/
private $x = null; /** * @var \foo\bar\Y */ private$y = null;

/**
* @var \foo\bar\Z
*/
private $z = null; public function setFoo(\Foo$foo) {}
public function setBar(\Bar $bar) {} public function setBaz(\Baz$baz) {}

/**
* @return \SplObjectStorage
* @throws \OutOfRangeException
* @throws \InvalidArgumentException
* @throws \ErrorException
*/
public function process(\Iterator $it) {} // ... } ### Source https://phpmd.org/rules/design.html#couplingbetweenobjects #### The class CryptTool has a coupling between objects value of 18. Consider to reduce the number of dependencies under 13. Open abstract class CryptTool { const TYPE_SODIUM = 'sodium'; const TYPE_SALT = 'salt'; const FILE_NONCE = "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01"; ## CouplingBetweenObjects ### Since: 1.1.0 A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability ## Example class Foo { /** * @var \foo\bar\X */ private$x = null;

/**
* @var \foo\bar\Y
*/
private $y = null; /** * @var \foo\bar\Z */ private$z = null;

public function setFoo(\Foo $foo) {} public function setBar(\Bar$bar) {}
public function setBaz(\Baz $baz) {} /** * @return \SplObjectStorage * @throws \OutOfRangeException * @throws \InvalidArgumentException * @throws \ErrorException */ public function process(\Iterator$it) {}

// ...
}