Sign upLogin

librenms/librenms

View on GitHub
Star
app/Http/Controllers/ServiceTemplateController.php

Summary

Maintainability
D
2 days
Test Coverage

File ServiceTemplateController.php has 307 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace App\Http\Controllers;

use App\Models\Device;
Severity: Minor
Found in app/Http/Controllers/ServiceTemplateController.php - About 3 hrs to fix

    The class ServiceTemplateController has 15 public methods. Consider refactoring ServiceTemplateController to keep number of public methods under 10.
    Open

    class ServiceTemplateController extends Controller
{
    public function __construct()
    {
        $this->authorizeResource(ServiceTemplate::class, 'template');
    Severity: Minor
    Found in app/Http/Controllers/ServiceTemplateController.php by phpmd

    TooManyPublicMethods

    Since: 0.1

    A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

    By default it ignores methods starting with 'get' or 'set'.

    Example

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

    Method update has 73 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function update(Request $request, ServiceTemplate $template, FlasherInterface $flasher)
    {
        $this->validate(
            $request, [
                'name' => [
    Severity: Major
    Found in app/Http/Controllers/ServiceTemplateController.php - About 2 hrs to fix

      Method applyDevice has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function applyDevice(ServiceTemplate $template, int $device_id)
    {
        // Check if the device needs to be added
        foreach (Device::inServiceTemplate($template->id)->where('device_id', $device_id)->get() as $device) {
            $device->services()->updateOrCreate(
      Severity: Minor
      Found in app/Http/Controllers/ServiceTemplateController.php - About 1 hr to fix

        Method store has 42 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function store(Request $request, FlasherInterface $flasher)
    {
        $this->validate(
            $request, [
                'name' => 'required|string|unique:service_templates',
        Severity: Minor
        Found in app/Http/Controllers/ServiceTemplateController.php - About 1 hr to fix

          Function update has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
          Open

              public function update(Request $request, ServiceTemplate $template, FlasherInterface $flasher)
    {
        $this->validate(
            $request, [
                'name' => [
          Severity: Minor
          Found in app/Http/Controllers/ServiceTemplateController.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

          Avoid too many return statements within this method.
          Open

                  return redirect()->route('services.templates.index');
          Severity: Major
          Found in app/Http/Controllers/ServiceTemplateController.php - About 30 mins to fix

            The method update() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
            Open

                public function update(Request $request, ServiceTemplate $template, FlasherInterface $flasher)
    {
        $this->validate(
            $request, [
                'name' => [
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.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

            The method update uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
            Open

                    } else {
            $flasher->addInfo(__('No changes made'));
        }
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpmd

            ElseExpression

            Since: 1.4.0

            An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

            Example

            class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

            Source https://phpmd.org/rules/cleancode.html#elseexpression

            The method update uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
            Open

                            } else {
                    $flasher->addError(__('Failed to save'));

                    return redirect()->back()->withInput();
                }
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpmd

            ElseExpression

            Since: 1.4.0

            An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

            Example

            class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

            Source https://phpmd.org/rules/cleancode.html#elseexpression

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

                        foreach (Device::inDeviceGroup($device_group->id)->where('device_id', $device_id)->get() as $device) {
                $device->services()->updateOrCreate(
                    [
                        'service_template_id' => $template->id,
                    ],
            Severity: Major
            Found in app/Http/Controllers/ServiceTemplateController.php and 1 other location - About 2 hrs to fix
            app/Http/Controllers/ServiceTemplateController.php on lines 360..378

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

            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

                    foreach (Device::inServiceTemplate($template->id)->where('device_id', $device_id)->get() as $device) {
            $device->services()->updateOrCreate(
                [
                    'service_template_id' => $template->id,
                ],
            Severity: Major
            Found in app/Http/Controllers/ServiceTemplateController.php and 1 other location - About 2 hrs to fix
            app/Http/Controllers/ServiceTemplateController.php on lines 381..399

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

            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

                        foreach (Device::inDeviceGroup($device_group->id)->get() as $device) {
                $device->services()->updateOrCreate(
                    [
                        'service_template_id' => $template->id,
                    ],
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php and 1 other location - About 55 mins to fix
            app/Http/Controllers/ServiceTemplateController.php on lines 275..291

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

            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

                    foreach (Device::inServiceTemplate($template->id)->get() as $device) {
            $device->services()->updateOrCreate(
                [
                    'service_template_id' => $template->id,
                ],
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php and 1 other location - About 55 mins to fix
            app/Http/Controllers/ServiceTemplateController.php on lines 244..260

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

            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

            Avoid excessively long variable names like $device_groups_updated. Keep variable name length under 20.
            Open

                        $device_groups_updated = array_sum(array_map(function ($device_group_ids) {
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpmd

            LongVariable

            Since: 0.2

            Detects when a field, formal or local variable is declared with a long name.

            Example

            class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

            Source https://phpmd.org/rules/naming.html#longvariable

            Only one argument is allowed per line in a multi-line function call
            Open

                        'service-template.create', [
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpcodesniffer

            Only one argument is allowed per line in a multi-line function call
            Open

                        $request, [
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpcodesniffer

            Only one argument is allowed per line in a multi-line function call
            Open

                        'service-template.index', [
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpcodesniffer

            Only one argument is allowed per line in a multi-line function call
            Open

                        'service-template.edit', [
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpcodesniffer

            Only one argument is allowed per line in a multi-line function call
            Open

                        $request, [
            Severity: Minor
            Found in app/Http/Controllers/ServiceTemplateController.php by phpcodesniffer

            There are no issues that match your filters.

            Category
            Status