Header::render() - Code Metrics - Inspection of "Enhance model-grid" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7a7fba...3207da )

by Song

created 2019-03-05 14:37 UTC

Header::render() A

↳ Parent: Header

Complexity

Conditions	4
Paths	5

Size

Total Lines

Duplication

Lines	22
Ratio	100 %

Importance

Changes

Metric	Value
cc	4
nc	5
nop	0
dl	22
loc	22
rs	9.568
c	0
b	0
f	0

<?php

namespace Encore\Admin\Grid\Tools;

use Encore\Admin\Grid;
use Illuminate\Contracts\Support\Htmlable;
use Illuminate\Contracts\Support\Renderable;
use Illuminate\Database\Query\Builder;

class Header extends AbstractTool

{
    /**
     * @var Builder
     */
    protected $queryBuilder;

    /**
     * Header constructor.
     *
     * @param Grid $grid
     */
    public function __construct(Grid $grid)
    {
        $this->grid = $grid;
    }

    /**
     * Get model query builder.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function queryBuilder()
    {
        if (!$this->queryBuilder) {
            $this->queryBuilder = $this->grid->model()->getQueryBuilder();

        }

        return $this->queryBuilder;
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());
}
    }

    /**
     * {@inheritdoc}
     */
    public function render()
    {
        $content = call_user_func($this->grid->header(), $this->queryBuilder());

        if (empty($content)) {
            return '';
        }

        if ($content instanceof Renderable) {
            $content = $content->render();
        }

        if ($content instanceof Htmlable) {
            $content = $content->toHtml();
        }

        return <<<HTML
    <div class="box-header with-border clearfix">
        {$content}
    </div>
HTML;
    }
}


1		<?php
2
3		namespace Encore\Admin\Grid\Tools;
4
5		use Encore\Admin\Grid;
6		use Illuminate\Contracts\Support\Htmlable;
7		use Illuminate\Contracts\Support\Renderable;
8		use Illuminate\Database\Query\Builder;
9
10	View Code Duplication	class Header extends AbstractTool
		0 ignored issues – show Duplication introduced 2019-03-05 14:50 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
11		{
12		/**
13		* @var Builder
14		*/
15		protected $queryBuilder;
16
17		/**
18		* Header constructor.
19		*
20		* @param Grid $grid
21		*/
22		public function __construct(Grid $grid)
23		{
24		$this->grid = $grid;
25		}
26
27		/**
28		* Get model query builder.
29		*
30		* @return \Illuminate\Database\Eloquent\Builder
31		*/
32		public function queryBuilder()
33		{
34		if (!$this->queryBuilder) {
35		$this->queryBuilder = $this->grid->model()->getQueryBuilder();
		0 ignored issues – show Documentation Bug introduced 2019-03-05 14:50 UTC by Report Bug Copy Issue Report It seems like `$this->grid->model()->getQueryBuilder()` of type `object<Illuminate\Database\Eloquent\Builder>` or `object<Illuminate\Database\Eloquent\Model>` is incompatible with the declared type `object<Illuminate\Database\Query\Builder>` of property `$queryBuilder`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
36		}
37
38		return $this->queryBuilder;
		0 ignored issues – show Bug Best Practice introduced 2019-03-05 14:50 UTC by Report Bug Copy Issue Report The return type of `return $this->queryBuilder;` (`Illuminate\Database\Eloq...\Database\Query\Builder`) is incompatible with the return type documented by `Encore\Admin\Grid\Tools\Header::queryBuilder` of type `Illuminate\Database\Eloquent\Builder`. 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...
39		}
40
41		/**
42		* {@inheritdoc}
43		*/
44		public function render()
45		{
46		$content = call_user_func($this->grid->header(), $this->queryBuilder());
47
48		if (empty($content)) {
49		return '';
50		}
51
52		if ($content instanceof Renderable) {
53		$content = $content->render();
54		}
55
56		if ($content instanceof Htmlable) {
57		$content = $content->toHtml();
58		}
59
60		return <<<HTML
61		<div class="box-header with-border clearfix">
62		{$content}
63		</div>
64		HTML;
65		}
66		}
67

z-song / laravel-admin

Push — master ( 7a7fba...3207da )

Header::render() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like