Html::ensureModelIsAvailable() - Code Metrics - Inspection of "Multiselect Support for <select>" - spatie/laravel-html - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

by Paul

created 2017-05-30 21:08 UTC

Html::ensureModelIsAvailable() A

↳ Parent: Html

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\Html;

use Spatie\Html\Elements\A;
use Illuminate\Http\Request;
use Spatie\Html\Elements\Div;
use Spatie\Html\Elements\Form;
use Spatie\Html\Elements\Span;
use Spatie\Html\Elements\Input;
use Spatie\Html\Elements\Label;
use Spatie\Html\Elements\Button;
use Spatie\Html\Elements\Legend;
use Spatie\Html\Elements\Option;
use Spatie\Html\Elements\Select;
use Spatie\Html\Elements\Element;
use Illuminate\Support\Collection;
use Illuminate\Support\HtmlString;
use Spatie\Html\Elements\Fieldset;
use Spatie\Html\Elements\Textarea;
use Illuminate\Contracts\Support\Htmlable;

class Html
{
    /** @var \Illuminate\Http\Request */
    protected $request;

    /** @var \ArrayAccess|array */
    protected $model;

    public function __construct(Request $request)

    {
        $this->request = $request;
    }

    /**
     * @param string $href
     * @param string $text
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Spatie\Html\Elements\A
     */
    public function a(?string $href = '', ?string $contents = '')
    {
        return A::create()
            ->attributeIf($href, 'href', $href)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->html($contents);
    }

    /**
     * @param string $type
     * @param string $text
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Spatie\Html\Elements\Button
     */
    public function button(?string $contents = '', ?string $type = '')
    {
        return Button::create()
            ->attributeIf($type, 'type', $type)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->html($contents);
    }

    /**
     * @param string|array|\Illuminate\Support\Collection $classes
     *
     * @return \Illuminate\Contracts\Support\Htmlable
     */
    public function class($classes): Htmlable

    {
        if ($classes instanceof Collection) {
            $classes = $classes->toArray();
        }

        $attributes = new Attributes();
class A {
    var $property;
}
        $attributes->addClass($classes);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return new HtmlString(
            $attributes->render()
class A {
    var $property;
}
        );
    }

    /**
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function checkbox(string $name = '', ?bool $checked = false, ?string $value = '1')
    {
        return $this->input('checkbox', $name, $value)
            ->attributeIf((bool) $this->old($name, $checked), 'checked');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param \Spatie\Html\HtmlElement|string $contents
     *
     * @return \Spatie\Html\Elements\Div
     */
    public function div($contents = null)
    {
        return Div::create()->children($contents);
    }

    /**
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function email(string $name = '', ?string $value = '')
    {
        return $this->input('email', $name, $value);
    }

    /**
     * @param string $tag
     *
     * @return \Spatie\Html\Elements\Element
     */
    public function element(string $tag)
    {
        return Element::withTag($tag);
    }

    /**
     * @param string $type
     * @param string $name
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function input(?string $type = '', string $name = '', ?string $value = '')
    {
        return Input::create()
            ->attributeIf($type, 'type', $type)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->attributeIf($name, 'name', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->attributeIf($name, 'id', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->attributeIf($name && $this->old($name, $value), 'value', $this->old($name, $value));

    }

    /**
     * @param \Spatie\Html\HtmlElement|string $legend
     *
     * @return \Spatie\Html\Elements\Fieldset
     */
    public function fieldset($legend = null)
    {
        return $legend ?
            Fieldset::create()->legend($legend) :
            Fieldset::create();
    }

    /**
     * @param string $method
     * @param string $action
     * @param array $parameters
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Spatie\Html\Elements\Form
     */
    public function form(string $method = 'POST', string $action = '')
    {
        $method = strtoupper($method);
        $form = Form::create();

        // If Laravel needs to spoof the form's method, we'll append a hidden
        // field containing the actual method
        if (in_array($method, ['DELETE', 'PATCH', 'PUT'])) {
            $form = $form->addChild($this->hidden('_method')->value($method));
        }

        // On any other method that get, the form needs a CSRF token
        if ($method !== 'GET') {
            $form = $form->addChild($this->token());
        }

        return $form
            ->method($method === 'GET' ? 'GET' : 'POST')
            ->attributeIf($action, 'action', $action);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param string $name
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function hidden(string $name = '', ?string $value = '')
    {
        return $this->input('hidden', $name, $value);
    }

    /**
     * @param \Spatie\Html\HtmlElement|iterable|string|null $contents
     * @param string $for
     *
     * @return \Spatie\Html\Elements\Label
     */
    public function label($contents = null, string $for = '')
    {
        return Label::create()
            ->attributeIf($for, 'for', $this->fieldName($for))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->children($contents);
    }

    /**
     * @param \Spatie\Html\HtmlElement|string $contents
     *
     * @return \Spatie\Html\Elements\Legend
     */
    public function legend($contents = null)
    {
        return Legend::create()->html($contents);

    }

    /**
     * @param string $email
     * @param string $text
     *
     * @return \Spatie\Html\Elements\A
     */
    public function mailto(string $email, string $text = '')
    {
        return $this->a('mailto:'.$email, $text);
    }

    /**
     * @param string $text
     * @param string $value
     * @param bool $selected
     *
     * @return \Spatie\Html\Elements\Option
     */
    public function option(?string $text = '', ?string $value = '', $selected = false)
    {
        return Option::create()
            ->text($text)
            ->value($value)
            ->selectedIf($selected);
    }

    /**
     * @param string $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function password(string $name = '')
    {
        return $this->input('password', $name)->value('');
    }

    /**
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function radio(string $name = '', ?bool $checked = false, ?string $value = '')
    {
        return $this->input('radio', $name, $value)
            ->attributeIf((bool) $this->old($name, $checked), 'checked');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param string $name
     * @param iterable $options
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Select
     */
    public function select(string $name = '', iterable $options = [], ?string $value = '')
    {
        return Select::create()
            ->attributeIf($name, 'name', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->attributeIf($name, 'id', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->options($options)

            ->value($name ? $this->old($name, $value) : '');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * @param string $name
     * @param iterable $options
     * @param iterable $values
     * @return \Spatie\Html\Elements\Select
     */
    public function multiselect(string $name = '', iterable $options = [], iterable $values = [])
    {
        $values = $name ? $this->old($name, $values) : [];
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return Select::create()
            ->attribute('multiple')
            ->attributeIf($name, 'name', $this->fieldName($name) . '[]')
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->attributeIf($name, 'id', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->addChildren($options, function ($text, $value) use ($values) {

                return Option::create()
                    ->value($value)
                    ->text($text)
                    ->selectedIf(in_array($value, $values));
            });
    }

    /**
     * @param \Spatie\Html\HtmlElement|string $contents
     *
     * @return \Spatie\Html\Elements\Span
     */
    public function span($contents = null)
    {
        return Span::create()->children($contents);
    }

    /**
     * @param string $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Spatie\Html\Elements\Button
     */
    public function submit(?string $text = '')
    {
        return $this->button($text, 'submit');
    }

    /**
     * @param string $number
     * @param string $text
     *
     * @return \Spatie\Html\Elements\A
     */
    public function tel(?string $number, ?string $text = '')
    {
        return $this->a('tel:'.$number, $text);
    }

    /**
     * @param string $name
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Input
     */
    public function text(string $name = '', ?string $value = '')
    {
        return $this->input('text', $name, $value);
    }

    /**
     * @param string $name
     * @param string $value
     *
     * @return \Spatie\Html\Elements\Textarea
     */
    public function textarea(string $name = '', ?string $value = '')
    {
        return Textarea::create()
            ->attributeIf($name, 'name', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->attributeIf($name, 'id', $this->fieldName($name))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->value($this->old($name, $value));

    }

    /**
     * @return \Spatie\Html\Elements\Input
     */
    public function token()
    {
        return $this->hidden('_token')->value($this->request->session()->token());

    }

    /**
     * @param \ArrayAccess|array $model
     *
     * @return $this
     */
    public function model($model)
    {
        $this->model = $model;

        return $this;
    }

    /**
     * @param \ArrayAccess|array $model
     * @param string $method
     * @param string $action
     *
     * @return \Spatie\Html\Elements\Form
     */
    public function modelForm($model, string $method = 'POST', string $action = ''): Form
    {
        $this->model($model);

        return $this->form($method, $action);
    }

    /**
     * @return $this
     */
    public function endModel()
    {
        $this->model = null;

        return $this;
    }

    /**
     * @return \Illuminate\Contracts\Support\Htmlable
     */
    public function closeModelForm(): Htmlable
    {
        $this->endModel();

        return $this->form()->close();
    }

    /**
     * @param string $name
     *
     * @return mixed
     */
    protected function old(string $name, $value = '')
    {
        if (empty($name)) {
            return;
        }

        // If there's no default value provided, and the html builder currently
        // has a model assigned, try to retrieve a value from the model.
        if (empty($value) && $this->model) {
            $value = $this->model[$name] ?? '';
        }

        return $this->request->old($name, $value);
    }

    protected function fieldName(string $name): string
    {
        return $name;
    }

    protected function ensureModelIsAvailable()
    {
        if (empty($this->model)) {
            throw new Exception('Method requires a model to be set on the html builder');
        }
    }
}


1			<?php
2
3			namespace Spatie\Html;
4
5			use Spatie\Html\Elements\A;
6			use Illuminate\Http\Request;
7			use Spatie\Html\Elements\Div;
8			use Spatie\Html\Elements\Form;
9			use Spatie\Html\Elements\Span;
10			use Spatie\Html\Elements\Input;
11			use Spatie\Html\Elements\Label;
12			use Spatie\Html\Elements\Button;
13			use Spatie\Html\Elements\Legend;
14			use Spatie\Html\Elements\Option;
15			use Spatie\Html\Elements\Select;
16			use Spatie\Html\Elements\Element;
17			use Illuminate\Support\Collection;
18			use Illuminate\Support\HtmlString;
19			use Spatie\Html\Elements\Fieldset;
20			use Spatie\Html\Elements\Textarea;
21			use Illuminate\Contracts\Support\Htmlable;
22
23			class Html
24			{
25			/** @var \Illuminate\Http\Request */
26			protected $request;
27
28			/** @var \ArrayAccess\|array */
29			protected $model;
30
31			public function __construct(Request $request)
			0 ignored issues – show Bug introduced 2017-03-31 11:00 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
32			{
33			$this->request = $request;
34			}
35
36			/**
37			* @param string $href
38			* @param string $text
			0 ignored issues – show Bug introduced 2017-04-27 12:36 UTC by Report Bug Copy Issue Report There is no parameter named `$text`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...

spatie / laravel-html

Pull Request — master (#20)

Html::ensureModelIsAvailable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like