Spatie\Html\Html

Complexity

Total Complexity

45

Size/Duplication

Total Lines	423
Duplicated Lines	4.02 %

Coupling/Cohesion

Components	1
Dependencies	18

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	a()	0	6	1
A	button()	0	6	1
A	class()	0	13	2
A	checkbox()	0	5	1
A	div()	0	4	1
A	email()	0	4	1
A	element()	0	4	1
A	input()	0	8	2
A	fieldset()	0	6	2
A	form()	0	20	4
A	hidden()	0	4	1
A	label()	0	6	1
A	legend()	0	4	1
A	mailto()	0	4	1
A	multiselect()	9	9	2
A	option()	0	7	1
A	password()	0	4	1
A	radio()	0	5	1
A	select()	8	8	2
A	span()	0	4	1
A	submit()	0	4	1
A	tel()	0	4	1
A	text()	0	4	1
A	textarea()	0	7	1
A	token()	0	4	1
A	model()	0	6	1
A	modelForm()	0	6	1
A	endModel()	0	6	1
A	closeModelForm()	0	6	1
A	old()	0	14	4
A	fieldName()	0	4	1
A	ensureModelIsAvailable()	0	6	2

<?php

namespace Spatie\Html;

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

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

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

    public function __construct(Request $request)

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().

    {
        $this->request = $request;
    }

    /**
     * @param string|null $href
     * @param string|null $text

There is no parameter named $text. Was it maybe removed?

     *
     * @return \Spatie\Html\Elements\A
     */
    public function a($href = null, $contents = null)
    {
        return A::create()
            ->attributeIf($href, 'href', $href)

$href is of type string|null, but the function expects a boolean.

            ->html($contents);
    }

    /**
     * @param string|null $type
     * @param string|null $text

There is no parameter named $text. Was it maybe removed?

     *
     * @return \Spatie\Html\Elements\Button
     */
    public function button($contents = null, $type = null)
    {
        return Button::create()
            ->attributeIf($type, 'type', $type)

$type is of type string|null, but the function expects a boolean.

            ->html($contents);
    }

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

Possible parse error: non-abstract method defined as abstract

It is generally advisable to only define one property per statement.

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

        $attributes = new Attributes();

The visibility should be declared for property $attributes.

        $attributes->addClass($classes);

It is generally advisable to only define one property per statement.

The visibility should be declared for property $attributes.

        return new HtmlString(
            $attributes->render()

The visibility should be declared for property $attributes.

        );
    }

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

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

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

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

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

$type is of type string|null, but the function expects a boolean.

            ->attributeIf($name, 'name', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->attributeIf($name, 'id', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->attributeIf($name && $this->old($name, $value), 'value', $this->old($name, $value));

It seems like $this->old($name, $value) targeting Spatie\Html\Html::old() can also be of type array; however, Spatie\Html\BaseElement::attributeIf() does only seem to accept string|null, maybe add an additional type check?

The expression $name of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

    }

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

    /**
     * @param string $method
     * @param string|null $action
     *
     * @return \Spatie\Html\Elements\Form
     */
    public function form($method = 'POST', $action = null)
    {
        $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);

$action is of type string|null, but the function expects a boolean.

    }

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

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

$for is of type string|null, but the function expects a boolean.

            ->children($contents);
    }

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

It seems like $contents defined by parameter $contents on line 212 can also be of type object<Spatie\Html\HtmlElement>; however, Spatie\Html\BaseElement::html() does only seem to accept string|null, maybe add an additional type check?

    }

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

    /**
     * @param string|null $name
     * @param iterable $options
     * @param string|iterable|null $value
     *
     * @return \Spatie\Html\Elements\Select
     */
    public function multiselect($name = null, $options = [], $value = null)

This method seems to be duplicated in your project.

    {
        return Select::create()
            ->attributeIf($name, 'name', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->attributeIf($name, 'id', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->options($options)

It seems like $options defined by parameter $options on line 235 can also be of type array; however, Spatie\Html\Elements\Select::options() does only seem to accept object<Spatie\Html\Elements\iterable>, maybe add an additional type check?

            ->value($name ? $this->old($name, $value) : $value)
            ->multiple();
    }

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

    /**
     * @param string|null $value

There is no parameter named $value. Was it maybe removed?

     *
     * @return \Spatie\Html\Elements\Input
     */
    public function password($name = null)
    {
        return $this->input('password', $name);
    }

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

    /**
     * @param string|null $name
     * @param iterable $options
     * @param string|iterable|null $value
     *
     * @return \Spatie\Html\Elements\Select
     */
    public function select($name = null, $options = [], $value = null)

This method seems to be duplicated in your project.

    {
        return Select::create()
            ->attributeIf($name, 'name', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->attributeIf($name, 'id', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->options($options)

It seems like $options defined by parameter $options on line 290 can also be of type array; however, Spatie\Html\Elements\Select::options() does only seem to accept object<Spatie\Html\Elements\iterable>, maybe add an additional type check?

            ->value($name ? $this->old($name, $value) : $value);
    }

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

    /**
     * @param string|null $test

There is no parameter named $test. Was it maybe removed?

     *
     * @return \Spatie\Html\Elements\Button
     */
    public function submit($text = null)
    {
        return $this->button($text, 'submit');
    }

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

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

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

$name is of type string|null, but the function expects a boolean.

            ->attributeIf($name, 'id', $this->fieldName($name))

$name is of type string|null, but the function expects a boolean.

            ->value($this->old($name, $value));

It seems like $this->old($name, $value) targeting Spatie\Html\Html::old() can also be of type array; however, Spatie\Html\Elements\Textarea::value() does only seem to accept string|null, maybe add an additional type check?

    }

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

The method token() does not seem to exist on object<Symfony\Component\HttpFoundation\Session\SessionInterface>.

    }

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

        return $this;
    }

    /**
     * @param \ArrayAccess|array $model
     * @param string|null $method
     * @param string|null $action
     *
     * @return \Spatie\Html\Elements\Form
     */
    public function modelForm($model, $method = 'POST', $action = null): 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
     * @param mixed $value
     *
     * @return mixed
     */
    protected function old($name, $value = null)
    {
        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);
    }

    /**
     * @param string $name
     * 
     * @return string
     */
    protected function fieldName($name)
    {
        return $name;
    }

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