canax/content

View on GitHub

Showing 17 of 17 total issues

File FileBasedContent.php has 430 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Anax\Content;

use Anax\Commons\ContainerInjectableInterface;
Severity: Minor
Found in src/Content/FileBasedContent.php - About 6 hrs to fix

    Function loadAdditionalContent has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
    Open

        private function loadAdditionalContent(&$views, $route, $routeIndex)
        {
            foreach ($views as $id => $view) {
                $meta = isset($view["data"]["meta"])
                    ? $view["data"]["meta"]
    Severity: Minor
    Found in src/Content/FBCLoadAdditionalContentTrait.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

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

        private function loadCategoryDetails($category)
        {
            if (is_array($category) && is_array(array_values($category)[0])) {
                return $category;
            }
    Severity: Major
    Found in src/Content/FileBasedContent.php and 1 other location - About 3 hrs to fix
    src/Content/FileBasedContent.php on lines 389..412

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

    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 loadAuthorDetails($author)
        {
            if (is_array($author) && is_array(array_values($author)[0])) {
                return $author;
            }
    Severity: Major
    Found in src/Content/FileBasedContent.php and 1 other location - About 3 hrs to fix
    src/Content/FileBasedContent.php on lines 452..475

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

    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

    Method loadAdditionalContent has 93 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function loadAdditionalContent(&$views, $route, $routeIndex)
        {
            foreach ($views as $id => $view) {
                $meta = isset($view["data"]["meta"])
                    ? $view["data"]["meta"]
    Severity: Major
    Found in src/Content/FBCLoadAdditionalContentTrait.php - About 3 hrs to fix

      FileBasedContent has 26 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class FileBasedContent implements ContainerInjectableInterface
      {
          use ContainerInjectableTrait,
              FBCBreadcrumbTrait,
              FBCLoadAdditionalContentTrait,
      Severity: Minor
      Found in src/Content/FileBasedContent.php - About 3 hrs to fix

        Function findNextAndPrevious has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
        Open

            private function findNextAndPrevious($routeIndex)
            {
                $key = dirname($routeIndex);
                if (!isset($this->meta[$key]["__toc__"])) {
                    return [null, null];
        Severity: Minor
        Found in src/Content/FBCLoadAdditionalContentTrait.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 processMainContentPhaseTwo has 44 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function processMainContentPhaseTwo(&$content, &$filtered)
            {
                // From configuration
                $filter = $this->config["textfilter"];
                $revisionStart = $this->config["revision-history"]["start"];
        Severity: Minor
        Found in src/Content/FileBasedContent.php - About 1 hr to fix

          Method findNextAndPrevious has 38 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private function findNextAndPrevious($routeIndex)
              {
                  $key = dirname($routeIndex);
                  if (!isset($this->meta[$key]["__toc__"])) {
                      return [null, null];
          Severity: Minor
          Found in src/Content/FBCLoadAdditionalContentTrait.php - About 1 hr to fix

            Method limitToc has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                private function limitToc(&$toc, &$meta, $baseRoute = null)
                {
                    $defaults = [
                        "items" => 7,
                        "offset" => 0,
            Severity: Minor
            Found in src/Content/FBCLoadAdditionalContentTrait.php - About 1 hr to fix

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

                  private function createIndex()
                  {
                      $basepath   = $this->config["basePath"];
                      $pattern    = $this->config["pattern"];
                      $path       = "$basepath/$pattern";
              Severity: Minor
              Found in src/Content/FileBasedContent.php - About 1 hr to fix

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

                    private function loadCategoryDetails($category)
                    {
                        if (is_array($category) && is_array(array_values($category)[0])) {
                            return $category;
                        }
                Severity: Minor
                Found in src/Content/FileBasedContent.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 createBaseRouteToc has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function createBaseRouteToc($route)
                    {
                        $toc = [];
                        $len = strlen($route);
                
                
                Severity: Minor
                Found in src/Content/FileBasedContent.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 loadAuthorDetails has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function loadAuthorDetails($author)
                    {
                        if (is_array($author) && is_array(array_values($author)[0])) {
                            return $author;
                        }
                Severity: Minor
                Found in src/Content/FileBasedContent.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 createIndex has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function createIndex()
                    {
                        $basepath   = $this->config["basePath"];
                        $pattern    = $this->config["pattern"];
                        $path       = "$basepath/$pattern";
                Severity: Minor
                Found in src/Content/FileBasedContent.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

                Function isInternalRoute has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function isInternalRoute($filepath)
                    {
                        foreach ($this->internalRouteDirPattern as $pattern) {
                            if (preg_match($pattern, $filepath)) {
                                return true;
                Severity: Minor
                Found in src/Content/FileBasedContent.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

                Function limitToc has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function limitToc(&$toc, &$meta, $baseRoute = null)
                    {
                        $defaults = [
                            "items" => 7,
                            "offset" => 0,
                Severity: Minor
                Found in src/Content/FBCLoadAdditionalContentTrait.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

                Severity
                Category
                Status
                Source
                Language