HasEditor::newEditor() - Code Metrics - Inspection of "Bump v4.1.0 :rocket:" - yajra/laravel-datatables-html - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3f5d51...85b3b0 )

by Arjay

created 2018-11-16 03:49 UTC

HasEditor::newEditor() A

↳ Parent: HasEditor

Complexity

Conditions	4
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	4
nc	8
nop	1

<?php

namespace Yajra\DataTables\Html;

use Yajra\DataTables\Html\Editor\Editor;

trait HasEditor
{
    /**
     * Collection of Editors.
     *
     * @var null|Editor
     */
    protected $editors = [];

    /**
     * Attach multiple editors to builder.
     *
     * @param mixed ...$editors
     * @return $this
     * @see https://editor.datatables.net/
     * @throws \Exception
     */
    public function editors(...$editors)
    {
        foreach ($editors as $editor) {
            $this->editor($editor);
        }

        return $this;
    }

    /**
     * Integrate with DataTables Editor.
     *
     * @param array|Editor $fields
     * @return $this
     * @see https://editor.datatables.net/
     * @throws \Exception
     */
    public function editor($fields)
    {
        $this->setTemplate($this->config->get('datatables-html.editor', 'datatables::editor'));
class MyClass { }

$x = new MyClass();
$x->foo = true;

        $editor = $this->newEditor($fields);

        $this->editors[] = $editor;

        return $this;
    }

    /**
     * @param array|Editor $fields
     * @return array|Editor
     * @throws \Exception
     */
    protected function newEditor($fields)
    {
        if ($fields instanceof Editor) {
            $editor = $fields;
        } else {
            $editor = new Editor;
            $editor->fields($fields);
        }

        if (! $editor->table) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $editor->table($this->getTableAttribute('id'));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        if (! $editor->ajax) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $editor->ajax($this->getAjaxUrl());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $editor;
    }
}


1			<?php
2
3			namespace Yajra\DataTables\Html;
4
5			use Yajra\DataTables\Html\Editor\Editor;
6
7			trait HasEditor
8			{
9			/**
10			* Collection of Editors.
11			*
12			* @var null\|Editor
13			*/
14			protected $editors = [];
15
16			/**
17			* Attach multiple editors to builder.
18			*
19			* @param mixed ...$editors
20			* @return $this
21			* @see https://editor.datatables.net/
22			* @throws \Exception
23			*/
24			public function editors(...$editors)
25			{
26			foreach ($editors as $editor) {
27			$this->editor($editor);
28			}
29
30			return $this;
31			}
32
33			/**
34			* Integrate with DataTables Editor.
35			*
36			* @param array\|Editor $fields
37			* @return $this
38			* @see https://editor.datatables.net/
39			* @throws \Exception
40			*/
41			public function editor($fields)
42			{
43			$this->setTemplate($this->config->get('datatables-html.editor', 'datatables::editor'));
			0 ignored issues – show Bug introduced 2018-11-14 08:10 UTC by Report Bug Copy Issue Report The property `config` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2018-11-14 08:10 UTC by Report Bug Copy Issue Report It seems like `setTemplate()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
44
45			$editor = $this->newEditor($fields);
46
47			$this->editors[] = $editor;
48
49			return $this;
50			}
51
52			/**
53			* @param array\|Editor $fields
54			* @return array\|Editor
55			* @throws \Exception
56			*/
57			protected function newEditor($fields)
58			{
59			if ($fields instanceof Editor) {
60			$editor = $fields;
61			} else {
62			$editor = new Editor;
63			$editor->fields($fields);
64			}
65
66			if (! $editor->table) {
			0 ignored issues – show Documentation introduced 2018-11-16 03:50 UTC by Report Bug Copy Issue Report The property `table` does not exist on `object<Yajra\DataTables\Html\Editor\Editor>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67			$editor->table($this->getTableAttribute('id'));
			0 ignored issues – show Bug introduced 2018-11-14 08:10 UTC by Report Bug Copy Issue Report It seems like `getTableAttribute()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
68			}
69
70			if (! $editor->ajax) {
			0 ignored issues – show Documentation introduced 2018-11-16 03:50 UTC by Report Bug Copy Issue Report The property `ajax` does not exist on `object<Yajra\DataTables\Html\Editor\Editor>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
71			$editor->ajax($this->getAjaxUrl());
			0 ignored issues – show Bug introduced 2018-11-14 08:10 UTC by Report Bug Copy Issue Report It seems like `getAjaxUrl()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
72			}
73
74			return $editor;
75			}
76			}
77

yajra / laravel-datatables-html

Push — master ( 3f5d51...85b3b0 )

HasEditor::newEditor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like