DataTables::createDataTable() - Code Metrics - Inspection of "Refactor DataTables factory" - yajra/laravel-datatables - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1488)

by Elf

created 2017-11-10 07:33 UTC

DataTables::createDataTable() A

↳ Parent: DataTables

Complexity

Conditions	3
Paths	4

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	4
nop	2
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0

<?php

namespace Yajra\DataTables;

use Exception;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;

class DataTables
{
    /**
     * DataTables request object.
     *
     * @var \Yajra\DataTables\Utilities\Request
     */
    protected $request;

    /**
     * HTML builder instance.
     *
     * @var \Yajra\DataTables\Html\Builder
     */
    protected $html;

    /**
     * Make a DataTable instance from source.
     * Alias of make for backward compatibility.
     *
     * @param  mixed $source
     * @return mixed
     * @throws \Exception
     */
    public function of($source)
    {
        return $this->make($source);
    }

    /**
     * Make a DataTable instance from source.
     *
     * @param mixed $source
     * @return mixed
     * @throws \Exception
     */
    public function make($source)
    {
        foreach (config('datatables.builders') as $engine => $types) {
            foreach ((array) $types as $type) {
                if ($this->checkType($source, $type)) {
                    return $this->createDataTable($engine, $source);
                }
            }
        }

        throw new Exception('No available engine for ' . gettype($source));
    }

    /**
     * Check whether a variable is the given type.
     *
     * @param  mixed  $var
     * @param  string  $type
     * @return bool
     */
    protected function checkType($var, $type)
    {
        if (is_object($var)) {
            return $var instanceof $type;
        }

        if (function_exists($func = "is_$type")) {
            return $func($var);
        }

        return false;
    }

    /**
     * Create a new DataTable instance.
     *
     * @param  string  $engine
     * @param  mixed  $source
     * @return mixed
     * @throws \Exception
     */
    protected function createDataTable($engine, $source)
    {
        $class = class_exists($engine) ? $engine : Arr::get(config('datatables.engines'), $engine);

        if (! $class) {
            throw new Exception("Unsupported DataTable engine [$engine]");
        }

        return new $class($source);
    }

    /**
     * Get request object.
     *
     * @return \Yajra\DataTables\Utilities\Request
     */
    public function getRequest()
    {
        return app('datatables.request');
    }

    /**
     * Get config instance.
     *
     * @return \Yajra\DataTables\Utilities\Config
     */
    public function getConfig()
    {
        return app('datatables.config');
    }

    /**
     * @deprecated Please use query() instead, this method will be removed in a next version.
     * @param $builder
     * @return QueryDataTable
     */
    public function queryBuilder($builder)
    {
        return $this->query($builder);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Get html builder instance.
     *
     * @return \Yajra\DataTables\Html\Builder
     * @throws \Exception
     */
    public function getHtmlBuilder()
    {
        if (! class_exists('\Yajra\DataTables\Html\Builder')) {
            throw new \Exception('Please install yajra/laravel-datatables-html to be able to use this function.');
        }

        return $this->html ?: $this->html = app('datatables.html');
    }

    /**
     * Make a DataTable instance by using method name as engine.
     *
     * @param  string  $method
     * @param  array  $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        return $this->createDataTable(Str::snake($method), ...$parameters);
    }
}


1			<?php
2
3			namespace Yajra\DataTables;
4
5			use Exception;
6			use Illuminate\Support\Arr;
7			use Illuminate\Support\Str;
8
9			class DataTables
10			{
11			/**
12			* DataTables request object.
13			*
14			* @var \Yajra\DataTables\Utilities\Request
15			*/
16			protected $request;
17
18			/**
19			* HTML builder instance.
20			*
21			* @var \Yajra\DataTables\Html\Builder
22			*/
23			protected $html;
24
25			/**
26			* Make a DataTable instance from source.
27			* Alias of make for backward compatibility.
28			*
29			* @param mixed $source
30			* @return mixed
31			* @throws \Exception
32			*/
33			public function of($source)
34			{
35			return $this->make($source);
36			}
37
38			/**
39			* Make a DataTable instance from source.
40			*
41			* @param mixed $source
42			* @return mixed
43			* @throws \Exception
44			*/
45			public function make($source)
46			{
47			foreach (config('datatables.builders') as $engine => $types) {
48			foreach ((array) $types as $type) {
49			if ($this->checkType($source, $type)) {
50			return $this->createDataTable($engine, $source);
51			}
52			}
53			}
54
55			throw new Exception('No available engine for ' . gettype($source));
56			}
57
58			/**
59			* Check whether a variable is the given type.
60			*
61			* @param mixed $var
62			* @param string $type
63			* @return bool
64			*/
65			protected function checkType($var, $type)
66			{
67			if (is_object($var)) {
68			return $var instanceof $type;
69			}
70
71			if (function_exists($func = "is_$type")) {
72			return $func($var);
73			}
74
75			return false;
76			}
77
78			/**
79			* Create a new DataTable instance.
80			*
81			* @param string $engine
82			* @param mixed $source
83			* @return mixed
84			* @throws \Exception
85			*/
86			protected function createDataTable($engine, $source)
87			{
88			$class = class_exists($engine) ? $engine : Arr::get(config('datatables.engines'), $engine);
89
90			if (! $class) {
91			throw new Exception("Unsupported DataTable engine [$engine]");
92			}
93
94			return new $class($source);
95			}
96
97			/**
98			* Get request object.
99			*
100			* @return \Yajra\DataTables\Utilities\Request
101			*/
102			public function getRequest()
103			{
104			return app('datatables.request');
105			}
106
107			/**
108			* Get config instance.
109			*
110			* @return \Yajra\DataTables\Utilities\Config
111			*/
112			public function getConfig()
113			{
114			return app('datatables.config');
115			}
116
117			/**
118			* @deprecated Please use query() instead, this method will be removed in a next version.
119			* @param $builder
120			* @return QueryDataTable
121			*/
122			public function queryBuilder($builder)
123			{
124			return $this->query($builder);
			0 ignored issues – show Documentation Bug introduced 2017-11-10 07:34 UTC by Report Bug Copy Issue Report The method `query` does not exist on `object<Yajra\DataTables\DataTables>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
125			}
126
127			/**
128			* Get html builder instance.
129			*
130			* @return \Yajra\DataTables\Html\Builder
131			* @throws \Exception
132			*/
133			public function getHtmlBuilder()
134			{
135			if (! class_exists('\Yajra\DataTables\Html\Builder')) {
136			throw new \Exception('Please install yajra/laravel-datatables-html to be able to use this function.');
137			}
138
139			return $this->html ?: $this->html = app('datatables.html');
140			}
141
142			/**
143			* Make a DataTable instance by using method name as engine.
144			*
145			* @param string $method
146			* @param array $parameters
147			* @return mixed
148			*/
149			public function __call($method, $parameters)
150			{
151			return $this->createDataTable(Str::snake($method), ...$parameters);
152			}
153			}
154

yajra / laravel-datatables

Pull Request — master (#1488)

DataTables::createDataTable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like