Sign upLogin

learningworks/moodle-block_lw_courses

View on GitHub
Star
renderer.php

Summary

Maintainability
F
3 days
Test Coverage

Function lw_courses has a Cognitive Complexity of 61 (exceeds 5 allowed). Consider refactoring.
Open

    public function lw_courses($courses) {
        global $CFG, $PAGE, $DB, $OUTPUT;
        $html = '';
        // LearningWorks.
        $PAGE->requires->js(new moodle_url($CFG->wwwroot.'/blocks/lw_courses/js/custom.js'));
Severity: Minor
Found in renderer.php - About 1 day 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 lw_courses has 167 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function lw_courses($courses) {
        global $CFG, $PAGE, $DB, $OUTPUT;
        $html = '';
        // LearningWorks.
        $PAGE->requires->js(new moodle_url($CFG->wwwroot.'/blocks/lw_courses/js/custom.js'));
Severity: Major
Found in renderer.php - About 6 hrs to fix

    File renderer.php has 359 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
    Severity: Minor
    Found in renderer.php - About 4 hrs to fix

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

      class block_lw_courses_renderer extends plugin_renderer_base {

    /**
     * Construct contents of lw_courses block
     *
      Severity: Minor
      Found in renderer.php by phpmd

      Function course_image has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
      Open

          public function course_image($course) {
        global $CFG;

        $course = new core_course_list_element($course);
        // Check to see if a file has been set on the course level.
      Severity: Minor
      Found in renderer.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 truncate_html has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          public function truncate_html($s, $l, $e = '&hellip;') {
        $s = trim($s);
        $e = (strlen(strip_tags($s)) > $l) ? $e : '';
        $i = 0;
        $tags = array();
      Severity: Minor
      Found in renderer.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

      Method course_image has 26 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function course_image($course) {
        global $CFG;

        $course = new core_course_list_element($course);
        // Check to see if a file has been set on the course level.
      Severity: Minor
      Found in renderer.php - About 1 hr to fix

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

            protected function collapsible_region($contents, $classes, $id, $caption, $userpref = '', $default = false) {
        Severity: Minor
        Found in renderer.php - About 45 mins to fix

          Method collapsible_region_start has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              protected function collapsible_region_start($classes, $id, $caption, $userpref = '', $default = false) {
          Severity: Minor
          Found in renderer.php - About 35 mins to fix

            Function welcome_area has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                public function welcome_area($msgcount) {
        global $CFG, $USER;
        $output = $this->output->box_start('welcome_area');

        $picture = $this->output->user_picture($USER, array('size' => 75, 'class' => 'welcome_userpicture'));
            Severity: Minor
            Found in renderer.php - About 35 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

            Function course_image_defaults has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

                public function course_image_defaults() {

        $config = get_config('block_lw_courses');

        if (method_exists($this->output, 'image_url')) {
            Severity: Minor
            Found in renderer.php - About 35 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 too many return statements within this method.
            Open

                    return print_error('error');
            Severity: Major
            Found in renderer.php - About 30 mins to fix

              The method lw_courses() has an NPath complexity of 14930208. The configured NPath complexity threshold is 200.
              Open

                  public function lw_courses($courses) {
        global $CFG, $PAGE, $DB, $OUTPUT;
        $html = '';
        // LearningWorks.
        $PAGE->requires->js(new moodle_url($CFG->wwwroot.'/blocks/lw_courses/js/custom.js'));
              Severity: Minor
              Found in renderer.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 method lw_courses() has a Cyclomatic Complexity of 33. The configured cyclomatic complexity threshold is 10.
              Open

                  public function lw_courses($courses) {
        global $CFG, $PAGE, $DB, $OUTPUT;
        $html = '';
        // LearningWorks.
        $PAGE->requires->js(new moodle_url($CFG->wwwroot.'/blocks/lw_courses/js/custom.js'));
              Severity: Minor
              Found in renderer.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 '68', column '22').
              Open

                          $a = new stdClass();
              Severity: Minor
              Found in renderer.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 '74', column '28').
              Open

                          $moveurl = new moodle_url('/blocks/lw_courses/move.php',
              Severity: Minor
              Found in renderer.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 '45', column '33').
              Open

                      $PAGE->requires->js(new moodle_url($CFG->wwwroot.'/blocks/lw_courses/js/custom.js'));
              Severity: Minor
              Found in renderer.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 '235', column '32').
              Open

                              $moveurl = new moodle_url('/blocks/lw_courses/move.php',
              Severity: Minor
              Found in renderer.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 '299', column '23').
              Open

                      $select = new single_select($url, 'mynumber', $options, block_lw_courses_get_max_user_courses(), array());
              Severity: Minor
              Found in renderer.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 '298', column '20').
              Open

                      $url = new moodle_url('/my/index.php');
              Severity: Minor
              Found in renderer.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 '324', column '22').
              Open

                          $a = new stdClass();
              Severity: Minor
              Found in renderer.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 '326', column '53').
              Open

                          $a->showalllink = html_writer::link(new moodle_url('/my/index.php',
              Severity: Minor
              Found in renderer.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 '182', column '28').
              Open

                                     new moodle_url('/auth/mnet/jump.php', array(
              Severity: Minor
              Found in renderer.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 '164', column '32').
              Open

                              $moveurl = new moodle_url($this->page->url, array('sesskey' => sesskey(), 'movecourse' => 1,
              Severity: Minor
              Found in renderer.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 '451', column '23').
              Open

                      $course = new core_course_list_element($course);
              Severity: Minor
              Found in renderer.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 '529', column '23').
              Open

                      $course = new core_course_list_element($course);
              Severity: Minor
              Found in renderer.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 '237', column '26').
              Open

                              $a = new stdClass();
              Severity: Minor
              Found in renderer.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 '176', column '34').
              Open

                              $courseurl = new moodle_url('/course/view.php', array('id' => $course->id));
              Severity: Minor
              Found in renderer.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 '430', column '46').
              Open

                          $output .= html_writer::link(new moodle_url('/message/index.php'),
              Severity: Minor
              Found in renderer.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 '266', column '24').
              Open

                          $url = new moodle_url("/mod/$module/index.php", array('id' => $cid));
              Severity: Minor
              Found in renderer.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 '193', column '21').
              Open

                  public function lw_courses($courses) {
        global $CFG, $PAGE, $DB, $OUTPUT;
        $html = '';
        // LearningWorks.
        $PAGE->requires->js(new moodle_url($CFG->wwwroot.'/blocks/lw_courses/js/custom.js'));
              Severity: Minor
              Found in renderer.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 '499', column '13').
              Open

                  public function course_image_defaults() {

        $config = get_config('block_lw_courses');

        if (method_exists($this->output, 'image_url')) {
              Severity: Minor
              Found in renderer.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 '$listonly'.
              Open

                      $listonly = false;
              Severity: Minor
              Found in renderer.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

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

                      if (is_null($config->lw_courses_bgimage) || $config->lw_courses_bgimage == BLOCKS_LW_COURSES_IMAGEASBACKGROUND_FALSE) {
            // Embed the image url as a img tag sweet...
            $image = html_writer::empty_tag('img', array( 'src' => $imageurl, 'class' => 'course_image' ));
            return html_writer::div($image, 'image_wrap');
        } else {
              Severity: Major
              Found in renderer.php and 1 other location - About 1 hr to fix
              renderer.php on lines 461..470

              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 101.

              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

                                  if (is_null($config->lw_courses_bgimage) ||
                         $config->lw_courses_bgimage == BLOCKS_LW_COURSES_IMAGEASBACKGROUND_FALSE) {
                        // Embed the image url as a img tag sweet...
                        $image = html_writer::empty_tag('img', array('src' => $url, 'class' => 'course_image'));
                        return html_writer::div($image, 'image_wrap');
              Severity: Major
              Found in renderer.php and 1 other location - About 1 hr to fix
              renderer.php on lines 509..517

              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 101.

              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

              There are no issues that match your filters.

              Category
              Status