rugk/xenforo-threema-gateway

View on GitHub
src/library/ThreemaGateway/DataWriter/TfaPendingMessagesConfirmation.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method _getFields has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    protected function _getFields()
    {
        return [
            ThreemaGateway_Model_TfaPendingMessagesConfirmation::DB_TABLE => [
                'request_id' => [

    Method _getExistingData has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function _getExistingData($data)
        {
            // try primary key first
            /** @var string $requestId */
            if ($requestId = $this->_getExistingPrimaryKey($data, 'request_id')) {

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

          protected function _getExistingData($data)
          {
              // try primary key first
              /** @var string $requestId */
              if ($requestId = $this->_getExistingPrimaryKey($data, 'request_id')) {
      Severity: Minor
      Found in src/library/ThreemaGateway/DataWriter/TfaPendingMessagesConfirmation.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"

      Further reading

      Avoid assigning values to variables in if clauses and the like (line '71', column '13').
      Open

          protected function _getExistingData($data)
          {
              // try primary key first
              /** @var string $requestId */
              if ($requestId = $this->_getExistingPrimaryKey($data, 'request_id')) {

      IfStatementAssignment

      Since: 2.7.0

      Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

      Example

      class Foo
      {
          public function bar($flag)
          {
              if ($foo = 'bar') { // possible typo
                  // ...
              }
              if ($baz = 0) { // always false
                  // ...
              }
          }
      }

      Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

      Avoid unused parameters such as '$tableName'.
      Open

          protected function _getUpdateCondition($tableName)

      UnusedFormalParameter

      Since: 0.2

      Avoid passing parameters to methods or constructors and then not using those parameters.

      Example

      class Foo
      {
          private function bar($howdy)
          {
              // $howdy is not used
          }
      }

      Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

      Avoid excessively long class names like ThreemaGateway_DataWriter_TfaPendingMessagesConfirmation. Keep class name length under 40.
      Open

      class ThreemaGateway_DataWriter_TfaPendingMessagesConfirmation extends XenForo_DataWriter
      {
          /**
           * Gets the fields that are defined for the table. See parent for explanation.
           *

      LongClassName

      Since: 2.9

      Detects when classes or interfaces are declared with excessively long names.

      Example

      class ATooLongClassNameThatHintsAtADesignProblem {
      
      }
      
      interface ATooLongInterfaceNameThatHintsAtADesignProblem {
      
      }

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

      The method _getFields is not named in camelCase.
      Open

          protected function _getFields()
          {
              return [
                  ThreemaGateway_Model_TfaPendingMessagesConfirmation::DB_TABLE => [
                      'request_id' => [

      CamelCaseMethodName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name methods.

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method _getPendingConfirmMsgModel is not named in camelCase.
      Open

          protected function _getPendingConfirmMsgModel()
          {
              return $this->getModelFromCache('ThreemaGateway_Model_TfaPendingMessagesConfirmation');
          }

      CamelCaseMethodName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name methods.

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method _getExistingData is not named in camelCase.
      Open

          protected function _getExistingData($data)
          {
              // try primary key first
              /** @var string $requestId */
              if ($requestId = $this->_getExistingPrimaryKey($data, 'request_id')) {

      CamelCaseMethodName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name methods.

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      The method _getUpdateCondition is not named in camelCase.
      Open

          protected function _getUpdateCondition($tableName)
          {
              return 'request_id = ' . $this->_db->quote($this->getExisting('request_id'));
          }

      CamelCaseMethodName

      Since: 0.2

      It is considered best practice to use the camelCase notation to name methods.

      Example

      class ClassName {
          public function get_name() {
          }
      }

      Source

      There are no issues that match your filters.

      Category
      Status