Sign upLogin

Formula9/Framework

View on GitHub
Star
Nine/Views/MarkdownView.php

Summary

Maintainability
A
25 mins
Test Coverage

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

    private function include_template($template, array $data = [])
    {
        static $cache = [];

        foreach ($this->templatePaths as $template_path)
Severity: Minor
Found in Nine/Views/MarkdownView.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

Missing class import via use statement (line '47', column '23').
Open

            throw new \InvalidArgumentException('Markdown: invalid template path.');
Severity: Minor
Found in Nine/Views/MarkdownView.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 '228', column '19').
Open

        throw new \InvalidArgumentException("Markdown: template `$template` not found in any path.");
Severity: Minor
Found in Nine/Views/MarkdownView.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 '133', column '19').
Open

        throw new \InvalidArgumentException('MarkdownTemplateService Error: Template file not found.');
Severity: Minor
Found in Nine/Views/MarkdownView.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 '117', column '23').
Open

            throw new \InvalidArgumentException('Markdown template name cannot be empty.');
Severity: Minor
Found in Nine/Views/MarkdownView.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 unused parameters such as '$name'.
Open

    public function with($name, $value) : BladeView
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

UnusedFormalParameter

Since: 0.2

Avoid passing parameters to methods or constructors and then not using those parameters.

Example

class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

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

The parameter $mark_down is not named in camelCase.
Open

    public function translate_template_data($mark_down, array $data = [])
    {
        // @{<include_template_name>}
        $mark_down = preg_replace_callback('$\@\{\s*\w*.md\s*\}$',
            function ($match) use ($data) {
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The parameter $template_paths is not named in camelCase.
Open

    public function addPaths($template_paths)
    {
        foreach ($template_paths as $template_path)
            $this->addPath($template_path);
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The parameter $template_name is not named in camelCase.
Open

    public function hasView($template_name) : bool
    {
        foreach ($this->templatePaths as $template_path)
            if (is_file("$template_path/$template_name")) {
                return TRUE;
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseParameterName

Since: 0.2

It is considered best practice to use the camelCase notation to name parameters.

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The variable $mark_down is not named in camelCase.
Open

    public function translate_template_data($mark_down, array $data = [])
    {
        // @{<include_template_name>}
        $mark_down = preg_replace_callback('$\@\{\s*\w*.md\s*\}$',
            function ($match) use ($data) {
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    public function addPaths($template_paths)
    {
        foreach ($template_paths as $template_path)
            $this->addPath($template_path);
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mark_down is not named in camelCase.
Open

    public function translate_template_data($mark_down, array $data = [])
    {
        // @{<include_template_name>}
        $mark_down = preg_replace_callback('$\@\{\s*\w*.md\s*\}$',
            function ($match) use ($data) {
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    private function include_template($template, array $data = [])
    {
        static $cache = [];

        foreach ($this->templatePaths as $template_path)
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    public function addPaths($template_paths)
    {
        foreach ($template_paths as $template_path)
            $this->addPath($template_path);
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mark_down is not named in camelCase.
Open

    public function translate_template_data($mark_down, array $data = [])
    {
        // @{<include_template_name>}
        $mark_down = preg_replace_callback('$\@\{\s*\w*.md\s*\}$',
            function ($match) use ($data) {
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_paths is not named in camelCase.
Open

    public function addPaths($template_paths)
    {
        foreach ($template_paths as $template_path)
            $this->addPath($template_path);
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_name is not named in camelCase.
Open

    public function hasView($template_name) : bool
    {
        foreach ($this->templatePaths as $template_path)
            if (is_file("$template_path/$template_name")) {
                return TRUE;
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mark_down is not named in camelCase.
Open

    public function translate_template_data($mark_down, array $data = [])
    {
        // @{<include_template_name>}
        $mark_down = preg_replace_callback('$\@\{\s*\w*.md\s*\}$',
            function ($match) use ($data) {
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    private function include_template($template, array $data = [])
    {
        static $cache = [];

        foreach ($this->templatePaths as $template_path)
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    public function hasView($template_name) : bool
    {
        foreach ($this->templatePaths as $template_path)
            if (is_file("$template_path/$template_name")) {
                return TRUE;
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $mark_down is not named in camelCase.
Open

    public function translate_template_data($mark_down, array $data = [])
    {
        // @{<include_template_name>}
        $mark_down = preg_replace_callback('$\@\{\s*\w*.md\s*\}$',
            function ($match) use ($data) {
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    public function hasView($template_name) : bool
    {
        foreach ($this->templatePaths as $template_path)
            if (is_file("$template_path/$template_name")) {
                return TRUE;
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

The variable $template_path is not named in camelCase.
Open

    private function include_template($template, array $data = [])
    {
        static $cache = [];

        foreach ($this->templatePaths as $template_path)
Severity: Minor
Found in Nine/Views/MarkdownView.php by phpmd

CamelCaseVariableName

Since: 0.2

It is considered best practice to use the camelCase notation to name variables.

Example

class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

Source

There are no issues that match your filters.

Category
Status