learningworks/moodle-block_lw_courses

View on GitHub
locallib.php

Summary

Maintainability
C
7 hrs
Test Coverage

Function block_lw_courses_get_sorted_courses has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

function block_lw_courses_get_sorted_courses($showallcourses = false) {
    global $USER;

    $limit = block_lw_courses_get_max_user_courses($showallcourses);

Severity: Minor
Found in locallib.php - About 2 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

Method block_lw_courses_get_sorted_courses has 45 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function block_lw_courses_get_sorted_courses($showallcourses = false) {
    global $USER;

    $limit = block_lw_courses_get_max_user_courses($showallcourses);

Severity: Minor
Found in locallib.php - About 1 hr to fix

    Method block_lw_courses_get_child_shortnames has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function block_lw_courses_get_child_shortnames($courseid) {
        global $DB;
        $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
        $sql = "SELECT c.id, c.shortname, $ctxselect
                FROM {enrol} e
    Severity: Minor
    Found in locallib.php - About 1 hr to fix

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

      function block_lw_courses_get_overviews($courses) {
          $htmlarray = array();
          if ($modules = get_plugin_list_with_function('mod', 'print_overview')) {
              // Split courses list into batches with no more than MAX_MODINFO_CACHE_SIZE courses in one batch.
              // Otherwise we exceed the cache limit in get_fast_modinfo() and rebuild it too often.
      Severity: Minor
      Found in locallib.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

      Function block_lw_courses_get_child_shortnames has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

      function block_lw_courses_get_child_shortnames($courseid) {
          global $DB;
          $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
          $sql = "SELECT c.id, c.shortname, $ctxselect
                  FROM {enrol} e
      Severity: Minor
      Found in locallib.php - About 55 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

      The function block_lw_courses_get_sorted_courses() has an NPath complexity of 882. The configured NPath complexity threshold is 200.
      Open

      function block_lw_courses_get_sorted_courses($showallcourses = false) {
          global $USER;
      
          $limit = block_lw_courses_get_max_user_courses($showallcourses);
      
      
      Severity: Minor
      Found in locallib.php by phpmd

      NPathComplexity

      Since: 0.1

      The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

      Example

      class Foo {
          function bar() {
              // lots of complicated code
          }
      }

      Source https://phpmd.org/rules/codesize.html#npathcomplexity

      The function block_lw_courses_get_sorted_courses() has a Cyclomatic Complexity of 14. The configured cyclomatic complexity threshold is 10.
      Open

      function block_lw_courses_get_sorted_courses($showallcourses = false) {
          global $USER;
      
          $limit = block_lw_courses_get_max_user_courses($showallcourses);
      
      
      Severity: Minor
      Found in locallib.php by phpmd

      CyclomaticComplexity

      Since: 0.1

      Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

      Example

      // Cyclomatic Complexity = 11
      class Foo {
      1   public function example() {
      2       if ($a == $b) {
      3           if ($a1 == $b1) {
                      fiddle();
      4           } elseif ($a2 == $b2) {
                      fiddle();
                  } else {
                      fiddle();
                  }
      5       } elseif ($c == $d) {
      6           while ($c == $d) {
                      fiddle();
                  }
      7        } elseif ($e == $f) {
      8           for ($n = 0; $n < $h; $n++) {
                      fiddle();
                  }
              } else {
                  switch ($z) {
      9               case 1:
                          fiddle();
                          break;
      10              case 2:
                          fiddle();
                          break;
      11              case 3:
                          fiddle();
                          break;
                      default:
                          fiddle();
                          break;
                  }
              }
          }
      }

      Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

      Missing class import via use statement (line '266', column '16').
      Open

          return new moodle_url("/pluginfile.php/1/block_lw_courses/courseimagedefault{$fileorfilename}");
      Severity: Minor
      Found in locallib.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

      Missing class import via use statement (line '258', column '20').
      Open

              $url = new moodle_url("/pluginfile.php/{$filecontextid}/{$filecomponent}/{$filearea}/{$filepath}/{$filename}");
      Severity: Minor
      Found in locallib.php by phpmd

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

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

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

      function block_lw_courses_get_myorder() {
          if ($value = get_user_preferences('lw_courses_course_sortorder')) {
              return explode(',', $value);
          }
          // If preference was not found, look in the old location and convert if found.
      Severity: Minor
      Found in locallib.php by phpmd

      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 assigning values to variables in if clauses and the like (line '124', column '9').
      Open

      function block_lw_courses_get_child_shortnames($courseid) {
          global $DB;
          $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
          $sql = "SELECT c.id, c.shortname, $ctxselect
                  FROM {enrol} e
      Severity: Minor
      Found in locallib.php by phpmd

      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 assigning values to variables in if clauses and the like (line '100', column '9').
      Open

      function block_lw_courses_get_myorder() {
          if ($value = get_user_preferences('lw_courses_course_sortorder')) {
              return explode(',', $value);
          }
          // If preference was not found, look in the old location and convert if found.
      Severity: Minor
      Found in locallib.php by phpmd

      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 assigning values to variables in if clauses and the like (line '48', column '9').
      Open

      function block_lw_courses_get_overviews($courses) {
          $htmlarray = array();
          if ($modules = get_plugin_list_with_function('mod', 'print_overview')) {
              // Split courses list into batches with no more than MAX_MODINFO_CACHE_SIZE courses in one batch.
              // Otherwise we exceed the cache limit in get_fast_modinfo() and rebuild it too often.
      Severity: Minor
      Found in locallib.php by phpmd

      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 local variables such as '$id'.
      Open

              foreach ($remotecourses as $id => $val) {
      Severity: Minor
      Found in locallib.php by phpmd

      UnusedLocalVariable

      Since: 0.2

      Detects when a local variable is declared and/or assigned, but not used.

      Example

      class Foo {
          public function doSomething()
          {
              $i = 5; // Unused
          }
      }

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

      Avoid unused local variables such as '$key'.
      Open

          foreach ($order as $key => $cid) {
      Severity: Minor
      Found in locallib.php by phpmd

      UnusedLocalVariable

      Since: 0.2

      Detects when a local variable is declared and/or assigned, but not used.

      Example

      class Foo {
          public function doSomething()
          {
              $i = 5; // Unused
          }
      }

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

      There are no issues that match your filters.

      Category
      Status