SearchDataTable::getBuilderParameters() - Code Metrics - Inspection of "Create BaseDataTable class" - murrant/librenmsv2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — datatables-fix ( 619c08...4af1f0 )

by Tony

created 2016-04-30 05:54 UTC

SearchDataTable::getBuilderParameters() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	12
rs	9.4285
cc	1
eloc	8
nc	1
nop	0

<?php
/**
 * app/DataTables/General/SearchDataTable.php
 *
 * Datatable for search
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @package    LibreNMS
 * @link       http://librenms.org
 * @copyright  2016 Neil Lathwood
 * @author     Neil Lathwood <[email protected]>
 */

namespace App\DataTables\General;

use App\DataTables\BaseDataTable;
use App\Models\General\IPv4;
use App\Models\General\IPv4Mac;
use App\Models\General\IPv6;
use App\Models\Port;

class SearchDataTable extends BaseDataTable
{

    protected $type;

    /**
     * Display ajax response.
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function ajax()
    {
        if ($this->type !== "arp")
        {
            return $this->datatables
                ->eloquent($this->query())
                ->editColumn('hostname', function($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $hostname = is_null($data->device) ? trans('devices.text.deleted') : $data->device->hostname;
                    return '<a href="'.url("devices/".$data->device_id).'">'.$hostname.'</a>';
                })
                ->editColumn('ifName', function($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $ifName = is_null($data->ifName) ? trans('devices.text.deleted') : $data->ifName;
                    return '<a href="'.url("devices/".$data->device_id."/ports/".$data->port_id).'">'.$ifName.'</a>';
                })
                ->make(true);
        }
        else {
            return $this->datatables
                ->eloquent($this->query())
                ->editColumn('hostname', function($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $hostname = is_null($data->device) ? trans('devices.text.deleted') : $data->device->hostname;
                    return '<a href="'.url("devices/".$data->device_id).'">'.$hostname.'</a>';
                })
                ->editColumn('ifName', function($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $ifName = is_null($data->ifName) ? trans('devices.text.deleted') : $data->ifName;
                    return '<a href="'.url("devices/".$data->device_id."/ports/".$data->port_id).'">'.$ifName.'</a>';
                })
                ->addColumn('remote_device', function($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $remote_device = IPv4::where('ipv4_addresses.ipv4_address', $data->ipv4_address)->with('port.device')->first();
                    $remote_id = empty($remote_device->port->device->device_id) ? '' : $remote_device->port->device->device_id;
                    $remote_hostname = empty($remote_device->port->device->hostname) ? trans('devices.text.deleted') : $remote_device->port->device->hostname;
                    return '<a href="'.url("devices/".$remote_id).'">'.$remote_hostname.'</a>';
                })
                ->addColumn('remote_interface', function($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $remote_device = IPv4::where('ipv4_addresses.ipv4_address', $data->ipv4_address)->with('port.device')->first();
                    $remote_id = empty($remote_device->port->device->device_id) ? '' : $remote_device->port->device->device_id;
                    $remote_port_id = empty($remote_device->port->port_id) ? '' : $remote_device->port->port_id;
                    $remote_port = empty($remote_device->port->ifName) ? trans('devices.text.deleted') : $remote_device->port->ifName;
                    return '<a href="'.url("devices/".$remote_id."/ports/".$remote_port_id).'">'.$remote_port.'</a>';
                })
                ->make(true);
        }
    }

    /**
     * Get the query object to be processed by datatables.
     *
     * @return \Illuminate\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder
     */
    public function query()
    {
        if ($this->type === "ipv4")
        {
            $data = IPv4::join('ports', 'ports.port_id', '=', 'ipv4_addresses.port_id')->join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ipv4_addresses.*', 'ports.*', 'devices.*');
            //FIXME We should use this once laravel-datatables supports it upstream $data = IPv4::with('port.device')->select('ipv4_addresses.*');
        }
        elseif ($this->type === "ipv6")

        {
            $data = IPv6::join('ports', 'ports.port_id', '=', 'ipv6_addresses.port_id')->join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ipv6_addresses.*', 'ports.*', 'devices.*');
            //FIXME We should use this once laravel-datatables supports it upstream $data = IPv6::with('port.device')->select('ipv6_addresses.*');
        }
        elseif ($this->type === "mac")
        {
            $data = Port::join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ports.*', 'devices.*');
            //FIXME This is valid but stops us generalising this file so until the nested queries above are fixed then we default to joins
            //$data = Port::with('device')->select('ports.*');

        }
        elseif ($this->type === "arp")

        {
            $data = IPv4Mac::join('ports', 'ports.port_id', '=', 'ipv4_mac.port_id')->join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ipv4_mac.*', 'ports.*', 'devices.*');
            //FIXME We should use this once laravel-datatables supports it upstream $data = IPv4Mac::with('port.device')->select('ipv4_mac.*');
        }
        return $this->applyScopes($data);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Get columns.
     *
     * @return array
     */
    public function getColumns()
    {
        $cols = [
            'hostname'  => [
                'title' => trans('devices.label.hostname'),
            ],
            'ifName'    => [
                'title' => trans('general.text.interface'),
            ],
        ];
        if ($this->type === "ipv4")
        {
            $cols = array_merge($cols, [
                'ipv4_address' => [
                    'title'    => trans('general.text.address'),
                ],
            ]);
        }
        if ($this->type === "ipv6")
        {
            $cols = array_merge($cols, [
                'ipv6_address' => [
                    'title'    => trans('general.text.address'),
                ],
            ]);
        }
        if ($this->type === "mac")
        {
            $cols = array_merge($cols, [
                'ifPhysAddress' => [
                    'title'    => trans('general.text.mac_address'),
                ],
            ]);
        }
        if ($this->type === "arp")
        {
            $cols = array_merge($cols, [
                'mac_address' => [
                    'title'   => trans('general.text.mac_address'),
                ],
                'ipv4_address' => [
                    'title'    => trans('general.text.address'),
                ],
                'remote_device'  => [
                    'searchable' => false,
                ],
                'remote_interface' => [
                    'searchable'   => false,
                ]
            ]);
        }
        if ($this->type !== "arp")
        {
            $cols = array_merge($cols, [
                'ifDescr'   => [
                    'title' => trans('general.text.port_descr'),
                ],
            ]);
        }
        return $cols;
    }

    /**
     * Get filename for export.
     *
     * @return string
     */
    protected function filename()
    {
        return 'search';
    }


    /**
     * @param string $type
     */
    public function forType($type)
    {
        $this->type = $type;
        return $this;
    }

}


1		<?php
2		/**
3		* app/DataTables/General/SearchDataTable.php
4		*
5		* Datatable for search
6		*
7		* This program is free software: you can redistribute it and/or modify
8		* it under the terms of the GNU General Public License as published by
9		* the Free Software Foundation, either version 3 of the License, or
10		* (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License
18		* along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*
20		* @package LibreNMS
21		* @link http://librenms.org
22		* @copyright 2016 Neil Lathwood
23		* @author Neil Lathwood <[email protected]>
24		*/
25
26		namespace App\DataTables\General;
27
28		use App\DataTables\BaseDataTable;
29		use App\Models\General\IPv4;
30		use App\Models\General\IPv4Mac;
31		use App\Models\General\IPv6;
32		use App\Models\Port;
33
34		class SearchDataTable extends BaseDataTable
35		{
36
37		protected $type;
38
39		/**
40		* Display ajax response.
41		*
42		* @return \Illuminate\Http\JsonResponse
43		*/
44		public function ajax()
45		{
46		if ($this->type !== "arp")
47		{
48		return $this->datatables
49		->eloquent($this->query())
50		->editColumn('hostname', function($data) {
		0 ignored issues – show Documentation introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `function ($data) { $.... $hostname . '</a>'; }` is of type `object<Closure>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51		$hostname = is_null($data->device) ? trans('devices.text.deleted') : $data->device->hostname;
52		return '<a href="'.url("devices/".$data->device_id).'">'.$hostname.'</a>';
53		})
54	View Code Duplication	->editColumn('ifName', function($data) {
		0 ignored issues – show Documentation introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `function ($data) { $...' . $ifName . '</a>'; }` is of type `object<Closure>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Duplication introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
55		$ifName = is_null($data->ifName) ? trans('devices.text.deleted') : $data->ifName;
56		return '<a href="'.url("devices/".$data->device_id."/ports/".$data->port_id).'">'.$ifName.'</a>';
57		})
58		->make(true);
59		}
60		else {
61		return $this->datatables
62		->eloquent($this->query())
63		->editColumn('hostname', function($data) {
		0 ignored issues – show Documentation introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `function ($data) { $.... $hostname . '</a>'; }` is of type `object<Closure>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
64		$hostname = is_null($data->device) ? trans('devices.text.deleted') : $data->device->hostname;
65		return '<a href="'.url("devices/".$data->device_id).'">'.$hostname.'</a>';
66		})
67	View Code Duplication	->editColumn('ifName', function($data) {
		0 ignored issues – show Documentation introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `function ($data) { $...' . $ifName . '</a>'; }` is of type `object<Closure>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Duplication introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
68		$ifName = is_null($data->ifName) ? trans('devices.text.deleted') : $data->ifName;
69		return '<a href="'.url("devices/".$data->device_id."/ports/".$data->port_id).'">'.$ifName.'</a>';
70		})
71		->addColumn('remote_device', function($data) {
		0 ignored issues – show Documentation introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `function ($data) { $...te_hostname . '</a>'; }` is of type `object<Closure>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
72		$remote_device = IPv4::where('ipv4_addresses.ipv4_address', $data->ipv4_address)->with('port.device')->first();
73		$remote_id = empty($remote_device->port->device->device_id) ? '' : $remote_device->port->device->device_id;
74		$remote_hostname = empty($remote_device->port->device->hostname) ? trans('devices.text.deleted') : $remote_device->port->device->hostname;
75		return '<a href="'.url("devices/".$remote_id).'">'.$remote_hostname.'</a>';
76		})
77		->addColumn('remote_interface', function($data) {
		0 ignored issues – show Documentation introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `function ($data) { $...remote_port . '</a>'; }` is of type `object<Closure>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
78		$remote_device = IPv4::where('ipv4_addresses.ipv4_address', $data->ipv4_address)->with('port.device')->first();
79		$remote_id = empty($remote_device->port->device->device_id) ? '' : $remote_device->port->device->device_id;
80		$remote_port_id = empty($remote_device->port->port_id) ? '' : $remote_device->port->port_id;
81		$remote_port = empty($remote_device->port->ifName) ? trans('devices.text.deleted') : $remote_device->port->ifName;
82		return '<a href="'.url("devices/".$remote_id."/ports/".$remote_port_id).'">'.$remote_port.'</a>';
83		})
84		->make(true);
85		}
86		}
87
88		/**
89		* Get the query object to be processed by datatables.
90		*
91		* @return \Illuminate\Database\Query\Builder\|\Illuminate\Database\Eloquent\Builder
92		*/
93		public function query()
94		{
95		if ($this->type === "ipv4")
96		{
97		$data = IPv4::join('ports', 'ports.port_id', '=', 'ipv4_addresses.port_id')->join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ipv4_addresses.', 'ports.', 'devices.*');
98		//FIXME We should use this once laravel-datatables supports it upstream $data = IPv4::with('port.device')->select('ipv4_addresses.*');
99		}
100	View Code Duplication	elseif ($this->type === "ipv6")
		0 ignored issues – show Duplication introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
101		{
102		$data = IPv6::join('ports', 'ports.port_id', '=', 'ipv6_addresses.port_id')->join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ipv6_addresses.', 'ports.', 'devices.*');
103		//FIXME We should use this once laravel-datatables supports it upstream $data = IPv6::with('port.device')->select('ipv6_addresses.*');
104		}
105		elseif ($this->type === "mac")
106		{
107		$data = Port::join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ports.', 'devices.');
108		//FIXME This is valid but stops us generalising this file so until the nested queries above are fixed then we default to joins
109		//$data = Port::with('device')->select('ports.*');
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
110		}
111	View Code Duplication	elseif ($this->type === "arp")
		0 ignored issues – show Duplication introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
112		{
113		$data = IPv4Mac::join('ports', 'ports.port_id', '=', 'ipv4_mac.port_id')->join('devices', 'devices.device_id', '=', 'ports.device_id')->select('ipv4_mac.', 'ports.', 'devices.*');
114		//FIXME We should use this once laravel-datatables supports it upstream $data = IPv4Mac::with('port.device')->select('ipv4_mac.*');
115		}
116		return $this->applyScopes($data);
		0 ignored issues – show Bug introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report The variable `$data` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Bug Compatibility introduced 2016-04-30 05:17 UTC by Report Bug Copy Issue Report The expression `$this->applyScopes($data);` of type `Illuminate\Database\Quer...tabase\Eloquent\Builder` adds the type `Illuminate\Database\Query\Builder` to the return on line 116 which is incompatible with the return type declared by the interface `Yajra\Datatables\Contrac...ataTableContract::query` of type `Illuminate\Database\Eloquent\Builder`. Loading history...
117		}
118
119		/**
120		* Get columns.
121		*
122		* @return array
123		*/
124		public function getColumns()
125		{
126		$cols = [
127		'hostname' => [
128		'title' => trans('devices.label.hostname'),
129		],
130		'ifName' => [
131		'title' => trans('general.text.interface'),
132		],
133		];
134		if ($this->type === "ipv4")
135		{
136		$cols = array_merge($cols, [
137		'ipv4_address' => [
138		'title' => trans('general.text.address'),
139		],
140		]);
141		}
142		if ($this->type === "ipv6")
143		{
144		$cols = array_merge($cols, [
145		'ipv6_address' => [
146		'title' => trans('general.text.address'),
147		],
148		]);
149		}
150		if ($this->type === "mac")
151		{
152		$cols = array_merge($cols, [
153		'ifPhysAddress' => [
154		'title' => trans('general.text.mac_address'),
155		],
156		]);
157		}
158		if ($this->type === "arp")
159		{
160		$cols = array_merge($cols, [
161		'mac_address' => [
162		'title' => trans('general.text.mac_address'),
163		],
164		'ipv4_address' => [
165		'title' => trans('general.text.address'),
166		],
167		'remote_device' => [
168		'searchable' => false,
169		],
170		'remote_interface' => [
171		'searchable' => false,
172		]
173		]);
174		}
175		if ($this->type !== "arp")
176		{
177		$cols = array_merge($cols, [
178		'ifDescr' => [
179		'title' => trans('general.text.port_descr'),
180		],
181		]);
182		}
183		return $cols;
184		}
185
186		/**
187		* Get filename for export.
188		*
189		* @return string
190		*/
191		protected function filename()
192		{
193		return 'search';
194		}
195
196
197		/**
198		* @param string $type
199		*/
200		public function forType($type)
201		{
202		$this->type = $type;
203		return $this;
204		}
205
206		}
207

murrant / librenmsv2

Push — datatables-fix ( 619c08...4af1f0 )

SearchDataTable::getBuilderParameters() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like