DisplayController::async() - Code Metrics - Inspection of "Merge commit '269d3c1f72ae0b74def636fe5d84e4064e63..." - LaravelRUS/SleepingOwlAdmin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b864c9...ed9166 )

by butschster

created 2017-03-11 07:55 UTC

DisplayController::async() C

↳ Parent: DisplayController

Complexity

Conditions	8
Paths	7

Size

Total Lines	28
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes

Metric	Value
cc	8
eloc	18
nc	7
nop	4
dl	0
loc	28
ccs	0
cts	25
cp	0
crap	72
rs	5.3846
c	0
b	0
f	0

<?php

namespace SleepingOwl\Admin\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
use Illuminate\Routing\Controller;
use SleepingOwl\Admin\Display\DisplayTree;
use SleepingOwl\Admin\Display\DisplayTabbed;
use Illuminate\Contracts\Foundation\Application;
use SleepingOwl\Admin\Display\DisplayDatatablesAsync;
use SleepingOwl\Admin\Contracts\ModelConfigurationInterface;

class DisplayController extends Controller
{
    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     * @param Application $application
     * @param null $name
     *
     * @return JsonResponse
     */
    public function async(ModelConfigurationInterface $model, Request $request, Application $application, $name = null)
    {
        $display = $model->fireDisplay();

        if ($display instanceof DisplayTabbed) {
            $tabs = $display->getTabs();
            foreach ($tabs as $tab) {
                $content = $tab->getContent();
                if ($content instanceof DisplayDatatablesAsync && $content->getName() === $name) {
                    return $content;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                }
            }
        }

        if ($display instanceof DisplayDatatablesAsync) {
            try {
                return $display->renderAsync($request);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            } catch (\Exception $exception) {
                return new JsonResponse([
                    'message'  => $application->isLocal()
                        ? $exception->getMessage()
                        : trans('sleeping_owl::lang.table.error'),
                ], 403);
            }
        }

        abort(404);
    }

    /**
     * @param ModelConfigurationInterface $model
     * @param Request $request
     */
    public function treeReorder(ModelConfigurationInterface $model, Request $request)
    {
        $display = $model->fireDisplay();

        if ($display instanceof DisplayTabbed) {
            $display->getTabs()->each(function ($tab) use ($request) {
                $content = $tab->getContent();
                if ($content instanceof DisplayTree) {
                    $content->getRepository()->reorder(
                        $request->input('data')

                    );
                }
            });
        } else {
            $display->getRepository()->reorder(
                $request->input('data')
            );
        }
    }
}


1			<?php
2
3			namespace SleepingOwl\Admin\Http\Controllers;
4
5			use Illuminate\Http\Request;
6			use Illuminate\Http\JsonResponse;
7			use Illuminate\Routing\Controller;
8			use SleepingOwl\Admin\Display\DisplayTree;
9			use SleepingOwl\Admin\Display\DisplayTabbed;
10			use Illuminate\Contracts\Foundation\Application;
11			use SleepingOwl\Admin\Display\DisplayDatatablesAsync;
12			use SleepingOwl\Admin\Contracts\ModelConfigurationInterface;
13
14			class DisplayController extends Controller
15			{
16			/**
17			* @param ModelConfigurationInterface $model
18			* @param Request $request
19			* @param Application $application
20			* @param null $name
21			*
22			* @return JsonResponse
23			*/
24			public function async(ModelConfigurationInterface $model, Request $request, Application $application, $name = null)
25			{
26			$display = $model->fireDisplay();
27
28			if ($display instanceof DisplayTabbed) {
29			$tabs = $display->getTabs();
30			foreach ($tabs as $tab) {
31			$content = $tab->getContent();
32			if ($content instanceof DisplayDatatablesAsync && $content->getName() === $name) {
33			return $content;
			0 ignored issues – show Bug Best Practice introduced 2017-01-12 12:23 UTC by Report Bug Copy Issue Report The return type of `return $content;` (`SleepingOwl\Admin\Display\DisplayDatatablesAsync`) is incompatible with the return type documented by `SleepingOwl\Admin\Http\C...isplayController::async` of type `Illuminate\Http\JsonResponse\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
34			}
35			}
36			}
37
38			if ($display instanceof DisplayDatatablesAsync) {
39			try {
40			return $display->renderAsync($request);
			0 ignored issues – show Bug Best Practice introduced 2017-01-12 12:23 UTC by Report Bug Copy Issue Report The return type of `return $display->renderAsync($request);` (`array<string,string\|array\|integer>`) is incompatible with the return type documented by `SleepingOwl\Admin\Http\C...isplayController::async` of type `Illuminate\Http\JsonResponse\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
41			} catch (\Exception $exception) {
42			return new JsonResponse([
43			'message' => $application->isLocal()
44			? $exception->getMessage()
45			: trans('sleeping_owl::lang.table.error'),
46			], 403);
47			}
48			}
49
50			abort(404);
51			}
52
53			/**
54			* @param ModelConfigurationInterface $model
55			* @param Request $request
56			*/
57			public function treeReorder(ModelConfigurationInterface $model, Request $request)
58			{
59			$display = $model->fireDisplay();
60
61			if ($display instanceof DisplayTabbed) {
62			$display->getTabs()->each(function ($tab) use ($request) {
63			$content = $tab->getContent();
64			if ($content instanceof DisplayTree) {
65			$content->getRepository()->reorder(
66			$request->input('data')
			0 ignored issues – show Bug introduced 2017-03-11 08:08 UTC by Report Bug Copy Issue Report It seems like `$request->input('data')` targeting `Illuminate\Http\Concerns...ractsWithInput::input()` can also be of type `string`; however, `SleepingOwl\Admin\Contra...oryInterface::reorder()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
67			);
68			}
69			});
70			} else {
71			$display->getRepository()->reorder(
72			$request->input('data')
73			);
74			}
75			}
76			}
77

LaravelRUS / SleepingOwlAdmin

GitHub Access Token became invalid

Push — master ( b864c9...ed9166 )

DisplayController::async() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like