0 follower

Final Class Yiisoft\Html\Tag\Input\Range

All Classes | Properties | Methods
InheritanceYiisoft\Html\Tag\Input\Range » Yiisoft\Html\Tag\Base\InputTag » Yiisoft\Html\Tag\Base\VoidTag » Yiisoft\Html\Tag\Base\Tag
ImplementsYiisoft\Html\NoEncodeStringableInterface

An imprecise control for setting the element’s value to a string representing a number.

Protected Properties

Hide inherited properties

Property Type Description Defined By
$attributes array Yiisoft\Html\Tag\Base\Tag

Public Methods

Hide inherited methods

Method Description Defined By
__toString() Yiisoft\Html\Tag\Base\Tag
addAttributes() Add a set of attributes to existing tag attributes. Yiisoft\Html\Tag\Base\Tag
addClass() Add one or more CSS classes to the tag. Yiisoft\Html\Tag\Base\Tag
addOutputAttributes() Yiisoft\Html\Tag\Input\Range
addStyle() Add CSS styles to the tag. Yiisoft\Html\Tag\Base\Tag
attribute() Set attribute value. Yiisoft\Html\Tag\Base\Tag
attributes() Replace attributes with a new set. Yiisoft\Html\Tag\Base\Tag
class() Replace current tag CSS classes with a new set of classes. Yiisoft\Html\Tag\Base\Tag
disabled() Yiisoft\Html\Tag\Base\InputTag
form() Yiisoft\Html\Tag\Base\InputTag
id() Set tag ID. Yiisoft\Html\Tag\Base\Tag
list() ID of element that lists predefined options suggested to the user. Yiisoft\Html\Tag\Input\Range
max() Maximum value. Yiisoft\Html\Tag\Input\Range
min() Minimum value. Yiisoft\Html\Tag\Input\Range
name() Yiisoft\Html\Tag\Base\InputTag
outputAttributes() Yiisoft\Html\Tag\Input\Range
outputTag() Yiisoft\Html\Tag\Input\Range
readonly() Yiisoft\Html\Tag\Base\InputTag
removeStyle() Remove CSS styles from the tag. Yiisoft\Html\Tag\Base\Tag
render() Yiisoft\Html\Tag\Base\Tag
required() Yiisoft\Html\Tag\Base\InputTag
showOutput() Yiisoft\Html\Tag\Input\Range
step() Granularity to be matched by the form control's value. Yiisoft\Html\Tag\Input\Range
tag() Yiisoft\Html\Tag\Base\VoidTag
unionAttributes() Union attributes with a new set. Yiisoft\Html\Tag\Base\Tag
value() Yiisoft\Html\Tag\Base\InputTag

Protected Methods

Hide inherited methods

Method Description Defined By
after() Yiisoft\Html\Tag\Input\Range
before() Yiisoft\Html\Tag\Base\Tag
getName() Yiisoft\Html\Tag\Base\InputTag
prepareAttributes() Yiisoft\Html\Tag\Input\Range
renderAttributes() Render the current tag attributes. Yiisoft\Html\Tag\Base\Tag
renderTag() Yiisoft\Html\Tag\Base\VoidTag

Method Details

Hide inherited methods

__toString() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::__toString()

public string __toString ( )

                final public function __toString(): string
{
    return $this->render();
}
addAttributes() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::addAttributes()

Add a set of attributes to existing tag attributes.

Same named attributes are replaced.

public Yiisoft\Html\Tag\Input\Range addAttributes ( array $attributes )
$attributes array

Name-value set of attributes.

 

                final public function addAttributes(array $attributes): static
{
    $new = clone $this;
    $new->attributes = array_merge($new->attributes, $attributes);
    return $new;
}
addClass() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::addClass()

Add one or more CSS classes to the tag.

public Yiisoft\Html\Tag\Input\Range addClass ( \BackedEnum|string|null $class )
$class \BackedEnum|string|null

One or many CSS classes.

 

                final public function addClass(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->attributes, $class);
    return $new;
}
addOutputAttributes() public method

public self addOutputAttributes ( array $attributes )
$attributes array 

                public function addOutputAttributes(array $attributes): self
{
    $new = clone $this;
    $new->outputAttributes = array_merge($this->outputAttributes, $attributes);
    return $new;
}
addStyle() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::addStyle()

Add CSS styles to the tag.

See also Yiisoft\Html\Html::addCssStyle().

public Yiisoft\Html\Tag\Input\Range addStyle ( string|string[] $style, boolean $overwrite = true )
$style string|string[]

The new style string (e.g. 'width: 100px; height: 200px') or array (e.g. ['width' => '100px', 'height' => '200px']).
$overwrite boolean

Whether to overwrite existing CSS properties if the new style contain them too.

 

                final public function addStyle(array|string $style, bool $overwrite = true): static
{
    $new = clone $this;
    Html::addCssStyle($new->attributes, $style, $overwrite);
    return $new;
}
after() protected method

protected string after ( )

                protected function after(): string
{
    if (!$this->showOutput) {
        return '';
    }
    return "\n" . CustomTag::name($this->outputTag)
            ->attributes($this->outputAttributes)
            ->content((string) ($this->attributes['value'] ?? '-'))
            ->id($this->outputId)
            ->render();
}
attribute() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::attribute()

Set attribute value.

public Yiisoft\Html\Tag\Input\Range attribute ( string $name, mixed $value )
$name string

Name of the attribute.
$value mixed

Value of the attribute.

 

                final public function attribute(string $name, mixed $value): static
{
    $new = clone $this;
    $new->attributes[$name] = $value;
    return $new;
}
attributes() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::attributes()

Replace attributes with a new set.

public Yiisoft\Html\Tag\Input\Range attributes ( array $attributes )
$attributes array

Name-value set of attributes.

 

                final public function attributes(array $attributes): static
{
    $new = clone $this;
    $new->attributes = $attributes;
    return $new;
}
before() protected method

Defined in: Yiisoft\Html\Tag\Base\Tag::before()

protected string before ( )

                protected function before(): string
{
    return '';
}
class() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::class()

Replace current tag CSS classes with a new set of classes.

public Yiisoft\Html\Tag\Input\Range class ( \BackedEnum|string|null $class )
$class \BackedEnum|string|null

One or many CSS classes.

 

                final public function class(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    unset($new->attributes['class']);
    Html::addCssClass($new->attributes, $class);
    return $new;
}
disabled() public method

Defined in: Yiisoft\Html\Tag\Base\InputTag::disabled()

public Yiisoft\Html\Tag\Input\Range disabled ( boolean $disabled = true )
$disabled boolean

Whether input is disabled.

 

                public function disabled(bool $disabled = true): static
{
    $new = clone $this;
    $new->attributes['disabled'] = $disabled;
    return $new;
}
form() public method

Defined in: Yiisoft\Html\Tag\Base\InputTag::form()

public Yiisoft\Html\Tag\Input\Range form ( string|null $formId )
$formId string|null

ID of the form input belongs to.

 

                public function form(?string $formId): static
{
    $new = clone $this;
    $new->attributes['form'] = $formId;
    return $new;
}
getName() protected method

Defined in: Yiisoft\Html\Tag\Base\InputTag::getName()

protected string getName ( )

                protected function getName(): string
{
    return 'input';
}
id() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::id()

Set tag ID.

public Yiisoft\Html\Tag\Input\Range id ( string|null $id )
$id string|null

Tag ID.

 

                final public function id(?string $id): static
{
    $new = clone $this;
    $new->attributes['id'] = $id;
    return $new;
}
list() public method

ID of element that lists predefined options suggested to the user.

public self list ( string|null $id )
$id string|null 

                public function list(?string $id): self
{
    $new = clone $this;
    $new->attributes['list'] = $id;
    return $new;
}
max() public method

Maximum value.

public self max ( float|integer|string|\Stringable|null $value )
$value float|integer|string|\Stringable|null 

                public function max(float|int|string|Stringable|null $value): self
{
    $new = clone $this;
    $new->attributes['max'] = $value;
    return $new;
}
min() public method

Minimum value.

public self min ( float|integer|string|\Stringable|null $value )
$value float|integer|string|\Stringable|null 

                public function min(float|int|string|Stringable|null $value): self
{
    $new = clone $this;
    $new->attributes['min'] = $value;
    return $new;
}
name() public method

Defined in: Yiisoft\Html\Tag\Base\InputTag::name()

public Yiisoft\Html\Tag\Input\Range name ( string|null $name )
$name string|null

Name of the input.

 

                public function name(?string $name): static
{
    $new = clone $this;
    $new->attributes['name'] = $name;
    return $new;
}
outputAttributes() public method

public self outputAttributes ( array $attributes )
$attributes array 

                public function outputAttributes(array $attributes): self
{
    $new = clone $this;
    $new->outputAttributes = $attributes;
    return $new;
}
outputTag() public method

public self outputTag ( string $tagName )
$tagName string 

                public function outputTag(string $tagName): self
{
    if ($tagName === '') {
        throw new InvalidArgumentException('The output tag name it cannot be empty value.');
    }
    $new = clone $this;
    $new->outputTag = $tagName;
    return $new;
}
prepareAttributes() protected method

protected void prepareAttributes ( )

                protected function prepareAttributes(): void
{
    $this->attributes['type'] = 'range';
    if ($this->showOutput) {
        $this->fillOutputId();
        $this->attributes['oninput'] = 'document.getElementById("' . $this->outputId . '").innerHTML=this.value';
    }
}
readonly() public method

Defined in: Yiisoft\Html\Tag\Base\InputTag::readonly()

public Yiisoft\Html\Tag\Input\Range readonly ( boolean $readOnly = true )
$readOnly boolean

Whether input is read only.

 

                public function readonly(bool $readOnly = true): static
{
    $new = clone $this;
    $new->attributes['readonly'] = $readOnly;
    return $new;
}
removeStyle() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::removeStyle()

Remove CSS styles from the tag.

See also Yiisoft\Html\Html::removeCssStyle().

public Yiisoft\Html\Tag\Input\Range removeStyle ( string|string[] $properties )
$properties string|string[]

The CSS properties to be removed. You may use a string if you are removing a single property.

 

                final public function removeStyle(string|array $properties): static
{
    $new = clone $this;
    Html::removeCssStyle($new->attributes, $properties);
    return $new;
}
render() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::render()

public string render ( )

                final public function render(): string
{
    return $this->before() . $this->renderTag() . $this->after();
}
renderAttributes() protected method

Defined in: Yiisoft\Html\Tag\Base\Tag::renderAttributes()

Render the current tag attributes.

See also Yiisoft\Html\Html::renderTagAttributes().

protected string renderAttributes ( )

                final protected function renderAttributes(): string
{
    $this->prepareAttributes();
    return Html::renderTagAttributes($this->attributes);
}
renderTag() protected method

Defined in: Yiisoft\Html\Tag\Base\VoidTag::renderTag()

protected string renderTag ( )

                final protected function renderTag(): string
{
    return '<' . $this->getName() . $this->renderAttributes() . '>';
}
required() public method

Defined in: Yiisoft\Html\Tag\Base\InputTag::required()

public Yiisoft\Html\Tag\Input\Range required ( boolean $required = true )
$required boolean

Whether input is required.

 

                public function required(bool $required = true): static
{
    $new = clone $this;
    $new->attributes['required'] = $required;
    return $new;
}
showOutput() public method

public self showOutput ( boolean $show = true )
$show boolean 

                public function showOutput(bool $show = true): self
{
    $new = clone $this;
    $new->showOutput = $show;
    return $new;
}
step() public method

Granularity to be matched by the form control's value.

public self step ( float|integer|string|\Stringable|null $value )
$value float|integer|string|\Stringable|null 

                public function step(float|int|string|Stringable|null $value): self
{
    $new = clone $this;
    $new->attributes['step'] = $value;
    return $new;
}
tag() public static method

Defined in: Yiisoft\Html\Tag\Base\VoidTag::tag()

public static Yiisoft\Html\Tag\Input\Range tag ( )

                final public static function tag(): static
{
    return new static();
}
unionAttributes() public method

Defined in: Yiisoft\Html\Tag\Base\Tag::unionAttributes()

Union attributes with a new set.

public Yiisoft\Html\Tag\Input\Range unionAttributes ( array $attributes )
$attributes array

Name-value set of attributes.

 

                final public function unionAttributes(array $attributes): static
{
    $new = clone $this;
    $new->attributes += $attributes;
    return $new;
}
value() public method

Defined in: Yiisoft\Html\Tag\Base\InputTag::value()

public Yiisoft\Html\Tag\Input\Range value ( boolean|float|integer|string|\Stringable|null $value )
$value boolean|float|integer|string|\Stringable|null

Value of the input.

 

                public function value(bool|float|int|string|Stringable|null $value): static
{
    $new = clone $this;
    $new->attributes['value'] = $value;
    return $new;
}