.dev/samples/classes/sample_core_api.class.php

Summary

Maintainability
D
3 days
Test Coverage

File sample_core_api.class.php has 399 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

class sample_core_api
{
    public function _init()
Severity: Minor
Found in .dev/samples/classes/sample_core_api.class.php - About 5 hrs to fix

    sample_core_api has 33 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class sample_core_api
    {
        public function _init()
        {
            _class('core_api')->SOURCE_ONLY_FRAMEWORK = true;
    Severity: Minor
    Found in .dev/samples/classes/sample_core_api.class.php - About 4 hrs to fix

      Method get_all_submodules has 31 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function get_all_submodules($section = 'all')
          {
              $data = [];
              $submodules = (array) _class('core_api')->get_submodules($section);
              foreach ($submodules as $_section => $modules) {
      Severity: Minor
      Found in .dev/samples/classes/sample_core_api.class.php - About 1 hr to fix

        Method get_all_methods has 28 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function get_all_methods($section = 'all', $privacy = '')
            {
                $data = [];
                $func = 'get_methods';
                if ($privacy == 'public') {
        Severity: Minor
        Found in .dev/samples/classes/sample_core_api.class.php - About 1 hr to fix

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

              public function _hook_side_column()
              {
                  $skip_list = [
                      'get_methods',
                      'get_function_source',
          Severity: Minor
          Found in .dev/samples/classes/sample_core_api.class.php - About 1 hr to fix

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

                public function _hook_side_column()
                {
                    $skip_list = [
                        'get_methods',
                        'get_function_source',
            Severity: Minor
            Found in .dev/samples/classes/sample_core_api.class.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

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

                public function get_all_properties($section = 'all')
                {
                    $data = [];
                    foreach (_class('core_api')->get_properties($section) as $module => $props) {
                        $i++;
            Severity: Minor
            Found in .dev/samples/classes/sample_core_api.class.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 get_all_submodules has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                public function get_all_submodules($section = 'all')
                {
                    $data = [];
                    $submodules = (array) _class('core_api')->get_submodules($section);
                    foreach ($submodules as $_section => $modules) {
            Severity: Minor
            Found in .dev/samples/classes/sample_core_api.class.php - About 25 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

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

                public function get_widgets()
                {
                    $data = [];
                    foreach (_class('core_api')->get_widgets() as $module => $hooks) {
                        $i++;
            Severity: Major
            Found in .dev/samples/classes/sample_core_api.class.php and 1 other location - About 4 hrs to fix
            .dev/samples/classes/sample_core_api.class.php on lines 275..299

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

            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

                public function get_hooks()
                {
                    $data = [];
                    foreach (_class('core_api')->get_all_hooks() as $module => $hooks) {
                        $i++;
            Severity: Major
            Found in .dev/samples/classes/sample_core_api.class.php and 1 other location - About 4 hrs to fix
            .dev/samples/classes/sample_core_api.class.php on lines 302..326

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

            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