hnhdigital-os/laravel-search-components

View on GitHub

Showing 70 of 70 total issues

File Search.php has 537 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace HnhDigital\SearchComponents;

use HnhDigital\LaravelHtmlBuilder\Tag;
Severity: Major
Found in src/Search.php - About 1 day to fix

    Search has 42 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class Search
    {
        /**
         * Config.
         *
    Severity: Minor
    Found in src/Search.php - About 5 hrs to fix

      Function parseRequest has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
      Open

          private function parseRequest()
          {
              $result = [
                  'count'      => 0,
                  'attributes' => [],
      Severity: Minor
      Found in src/Search.php - About 4 hrs 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

      The class Search has an overall complexity of 122 which is very high. The configured complexity threshold is 50.
      Open

      class Search
      {
          /**
           * Config.
           *
      Severity: Minor
      Found in src/Search.php by phpmd

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          private function setSearchEmpty($config = false)
          {
              // Turn off the the search empty option.
              if ($config === false) {
                  Arr::set($this->config, 'search_empty', false);
      Severity: Major
      Found in src/Search.php and 1 other location - About 1 hr to fix
      src/Search.php on lines 615..636

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 115.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          private function setSearchInput($config = false)
          {
              // Turn off the the search empty option.
              if ($config === false) {
                  Arr::set($this->config, 'search_input', false);
      Severity: Major
      Found in src/Search.php and 1 other location - About 1 hr to fix
      src/Search.php on lines 586..607

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 115.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Avoid excessively long variable names like $additional_info_closure. Keep variable name length under 20.
      Open

              $additional_info_closure = Arr::get($search_info, 'additional_info', false);
      Severity: Minor
      Found in src/Search.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

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

      Avoid excessively long variable names like $render_columns_closure. Keep variable name length under 20.
      Open

              $render_columns_closure = Arr::get($search_input, 'render_columns', false);
      Severity: Minor
      Found in src/Search.php by phpmd

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

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

      Method parseRequest has 40 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function parseRequest()
          {
              $result = [
                  'count'      => 0,
                  'attributes' => [],
      Severity: Minor
      Found in src/Search.php - About 1 hr to fix

        Function autoInit has 39 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          autoInit: function() {
            $('.hnhdigital-search-form').on('submit', function() {
              var form = $(this);
              var results = $('.'+$(this).attr('id').replace(new RegExp('-form$'), '-results'));
              var page = $(form).find('[name=page]').val();
        Severity: Minor
        Found in resources/js/search.js - About 1 hr to fix

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

              public function render($html, $response = [])
              {
                  $this->result = $html;
                  $this->result_response = $response;
          
          
          Severity: Minor
          Found in src/Search.php - About 1 hr to fix

            Function updateResults has 36 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              updateResults: function(results, response) {
                if (!results.hasClass('hnhdigital-search-results')) {
                  var form_id = results.attr('id').replace(new RegExp('-form$'), '-results');
                  results = $('.'+form_id);
                }
            Severity: Minor
            Found in resources/js/search.js - About 1 hr to fix

              Method getSearchInput has 34 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function getSearchInput()
                  {
                      $total_columns = $this->checkColumns();
                      $search_input = Arr::get($this->config, 'search_input', []);
                      $force_search_input = Arr::get($this->config, 'force_search_input', false);
              Severity: Minor
              Found in src/Search.php - About 1 hr to fix

                Function serialize has 34 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                  serialize: function(form, results) {
                    var search = {};
                
                    results.find('.search-field').each(function() {
                
                
                Severity: Minor
                Found in resources/js/search.js - About 1 hr to fix

                  Function render has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                  Open

                      public function render($html, $response = [])
                      {
                          $this->result = $html;
                          $this->result_response = $response;
                  
                  
                  Severity: Minor
                  Found in src/Search.php - About 1 hr 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 variables with short names like $tr. Configured minimum length is 3.
                  Open

                          $tr = $tbody->tr();
                  Severity: Minor
                  Found in src/Search.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 $tr. Configured minimum length is 3.
                  Open

                          $tr = $thead->tr(['class' => 'search-header']);
                  Severity: Minor
                  Found in src/Search.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 $tr. Configured minimum length is 3.
                  Open

                          $tr = $tbody->tr(['class' => 'search-input']);
                  Severity: Minor
                  Found in src/Search.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 $tr. Configured minimum length is 3.
                  Open

                          $tr = $tbody->tr(['class' => 'search-info']);
                  Severity: Minor
                  Found in src/Search.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 $tr. Configured minimum length is 3.
                  Open

                              $tr = $tbody->tr();
                  Severity: Minor
                  Found in src/Search.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

                  Severity
                  Category
                  Status
                  Source
                  Language