Final Class Yiisoft\Html\Tag\Input\Range
| Inheritance | Yiisoft\ |
|---|---|
| Implements | Yiisoft\ |
An imprecise control for setting the element’s value to a string representing a number.
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attributes | array | Yiisoft\ |
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| after() | Yiisoft\ |
|
| before() | Yiisoft\ |
|
| getName() | Yiisoft\ |
|
| prepareAttributes() | Yiisoft\ |
|
| renderAttributes() | Render the current tag attributes. | Yiisoft\ |
| renderTag() | Yiisoft\ |
Method Details
Defined in:
Yiisoft\
| public mixed __construct ( ) |
final public function __construct() {}
Defined in:
Yiisoft\
| public string __toString ( ) |
final public function __toString(): string
{
return $this->render();
}
Defined in:
Yiisoft\
Add a set of attributes to existing tag attributes.
Same named attributes are replaced.
| public static 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;
}
Defined in:
Yiisoft\
Add one or more CSS classes to the tag.
| public static addClass ( \ | ||
| $class | \ |
One or many CSS classes. |
final public function addClass(BackedEnum|string|null ...$class): static
{
$new = clone $this;
Html::addCssClass($new->attributes, $class);
return $new;
}
| 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;
}
Defined in:
Yiisoft\
Add CSS styles to the tag.
See also Yiisoft\
| public static addStyle ( string|string[] $style, boolean $overwrite = true ) | ||
| $style | string|string[] |
The new style string (e.g. |
| $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;
}
| protected string after ( ) |
protected function after(): string
{
if (!$this->showOutput) {
return '';
}
return "\n" . (new CustomTag($this->outputTag))
->attributes($this->outputAttributes)
->content((string) ($this->attributes['value'] ?? '-'))
->id($this->outputId)
->render();
}
Defined in:
Yiisoft\
Set attribute value.
| public static 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;
}
Defined in:
Yiisoft\
Replace attributes with a new set.
| public static 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;
}
Defined in:
Yiisoft\
| protected string before ( ) |
protected function before(): string
{
return '';
}
Defined in:
Yiisoft\
Replace current tag CSS classes with a new set of classes.
| public static class ( \ | ||
| $class | \ |
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;
}
Defined in:
Yiisoft\
| public static 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;
}
Defined in:
Yiisoft\
| public static 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;
}
Defined in:
Yiisoft\
| protected string getName ( ) |
protected function getName(): string
{
return 'input';
}
Defined in:
Yiisoft\
Set tag ID.
| public static id ( string|null $id ) | ||
| $id | string|null |
Non-empty tag ID. |
final public function id(?string $id): static
{
/** @psalm-suppress TypeDoesNotContainType */
if ($id === '') {
throw new LogicException('The tag id cannot be an empty string.');
}
$new = clone $this;
$new->attributes['id'] = $id;
return $new;
}
ID of element that lists predefined options suggested to the user.
| public self list ( ?string $id ) | ||
| $id | ?string | |
public function list(?string $id): self
{
$new = clone $this;
$new->attributes['list'] = $id;
return $new;
}
Maximum value.
| public self max ( float|integer|string|\ | ||
| $value | float|integer|string|\ |
|
public function max(float|int|string|Stringable|null $value): self
{
$new = clone $this;
$new->attributes['max'] = $value;
return $new;
}
Minimum value.
| public self min ( float|integer|string|\ | ||
| $value | float|integer|string|\ |
|
public function min(float|int|string|Stringable|null $value): self
{
$new = clone $this;
$new->attributes['min'] = $value;
return $new;
}
Defined in:
Yiisoft\
| public static 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;
}
| public self outputAttributes ( array $attributes ) | ||
| $attributes | array | |
public function outputAttributes(array $attributes): self
{
$new = clone $this;
$new->outputAttributes = $attributes;
return $new;
}
| 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;
}
| 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';
}
}
Defined in:
Yiisoft\
| public static 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;
}
Defined in:
Yiisoft\
Remove CSS styles from the tag.
See also Yiisoft\
| public static 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;
}
Defined in:
Yiisoft\
| public string render ( ) |
final public function render(): string
{
return $this->before() . $this->renderTag() . $this->after();
}
Defined in:
Yiisoft\
Render the current tag attributes.
See also Yiisoft\
| protected string renderAttributes ( ) |
final protected function renderAttributes(): string
{
$this->prepareAttributes();
return Html::renderTagAttributes($this->attributes);
}
Defined in:
Yiisoft\
| protected string renderTag ( ) |
final protected function renderTag(): string
{
return '<' . $this->getName() . $this->renderAttributes() . '>';
}
Defined in:
Yiisoft\
| public static 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;
}
| public self showOutput ( boolean $show = true ) | ||
| $show | boolean | |
public function showOutput(bool $show = true): self
{
$new = clone $this;
$new->showOutput = $show;
return $new;
}
Granularity to be matched by the form control's value.
| public self step ( float|integer|string|\ | ||
| $value | float|integer|string|\ |
|
public function step(float|int|string|Stringable|null $value): self
{
$new = clone $this;
$new->attributes['step'] = $value;
return $new;
}
Defined in:
Yiisoft\
| public static static tag ( ) |
final public static function tag(): static
{
return new static();
}
Defined in:
Yiisoft\
Union attributes with a new set.
| public static 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;
}
Defined in:
Yiisoft\
| public static value ( boolean|float|integer|string|\ | ||
| $value | boolean|float|integer|string|\ |
Value of the input. |
public function value(bool|float|int|string|Stringable|null $value): static
{
$new = clone $this;
$new->attributes['value'] = $value;
return $new;
}
User Contributed Notes
Leave a comment
Join the conversation to share a note.