Final Class Yiisoft\Html\Tag\Input\File
| Inheritance | Yiisoft\Html\Tag\Input\File » Yiisoft\Html\Tag\Base\InputTag » Yiisoft\Html\Tag\Base\VoidTag » Yiisoft\Html\Tag\Base\Tag |
|---|---|
| Implements | Yiisoft\Html\NoEncodeStringableInterface |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attributes | array | Yiisoft\Html\Tag\Base\Tag |
Public Methods
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| after() | Yiisoft\Html\Tag\Base\Tag | |
| before() | Yiisoft\Html\Tag\Input\File | |
| getName() | Yiisoft\Html\Tag\Base\InputTag | |
| prepareAttributes() | Yiisoft\Html\Tag\Input\File | |
| renderAttributes() | Render the current tag attributes. | Yiisoft\Html\Tag\Base\Tag |
| renderTag() | Yiisoft\Html\Tag\Base\VoidTag |
Method Details
Defined in: Yiisoft\Html\Tag\Base\Tag::__toString()
| public string __toString ( ) |
final public function __toString(): string
{
return $this->render();
}
The accept attribute value is a string that defines the file types the file input should accept. This string is a comma-separated list of unique file type specifiers. Because a given file type may be identified in more than one manner, it's useful to provide a thorough set of type specifiers when you need files of a given format.
| public self accept ( string|null $value ) | ||
| $value | string|null | |
public function accept(?string $value): self
{
$new = clone $this;
$new->attributes['accept'] = $value;
return $new;
}
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\File 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\Html\Tag\Base\Tag::addClass()
Add one or more CSS classes to the tag.
| public Yiisoft\Html\Tag\Input\File 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;
}
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\File 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;
}
| public self addUncheckInputAttributes ( array $attributes ) | ||
| $attributes | array | |
public function addUncheckInputAttributes(array $attributes): self
{
$new = clone $this;
$new->uncheckInputAttributes = array_merge($new->uncheckInputAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Html\Tag\Base\Tag::after()
| protected string after ( ) |
protected function after(): string
{
return '';
}
Defined in: Yiisoft\Html\Tag\Base\Tag::attribute()
Set attribute value.
| public Yiisoft\Html\Tag\Input\File 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\Html\Tag\Base\Tag::attributes()
Replace attributes with a new set.
| public Yiisoft\Html\Tag\Input\File 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;
}
| protected string before ( ) |
protected function before(): string
{
return $this->renderUncheckInput();
}
Defined in: Yiisoft\Html\Tag\Base\Tag::class()
Replace current tag CSS classes with a new set of classes.
| public Yiisoft\Html\Tag\Input\File 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;
}
Defined in: Yiisoft\Html\Tag\Base\InputTag::disabled()
| public Yiisoft\Html\Tag\Input\File 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\Html\Tag\Base\InputTag::form()
| public Yiisoft\Html\Tag\Input\File 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\Html\Tag\Base\InputTag::getName()
| protected string getName ( ) |
protected function getName(): string
{
return 'input';
}
Defined in: Yiisoft\Html\Tag\Base\Tag::id()
Set tag ID.
| public Yiisoft\Html\Tag\Input\File 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;
}
| public self multiple ( boolean $multiple = true ) | ||
| $multiple | boolean |
Whether to allow selecting multiple files. |
public function multiple(bool $multiple = true): self
{
$new = clone $this;
$new->attributes['multiple'] = $multiple;
return $new;
}
Defined in: Yiisoft\Html\Tag\Base\InputTag::name()
| public Yiisoft\Html\Tag\Input\File 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;
}
| protected void prepareAttributes ( ) |
protected function prepareAttributes(): void
{
$this->attributes['type'] = 'file';
}
Defined in: Yiisoft\Html\Tag\Base\InputTag::readonly()
| public Yiisoft\Html\Tag\Input\File 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\Html\Tag\Base\Tag::removeStyle()
Remove CSS styles from the tag.
See also Yiisoft\Html\Html::removeCssStyle().
| public Yiisoft\Html\Tag\Input\File 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\Html\Tag\Base\Tag::render()
| public string render ( ) |
final public function render(): string
{
return $this->before() . $this->renderTag() . $this->after();
}
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);
}
Defined in: Yiisoft\Html\Tag\Base\VoidTag::renderTag()
| protected string renderTag ( ) |
final protected function renderTag(): string
{
return '<' . $this->getName() . $this->renderAttributes() . '>';
}
Defined in: Yiisoft\Html\Tag\Base\InputTag::required()
| public Yiisoft\Html\Tag\Input\File 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;
}
Defined in: Yiisoft\Html\Tag\Base\VoidTag::tag()
| public static Yiisoft\Html\Tag\Input\File tag ( ) |
final public static function tag(): static
{
return new static();
}
| public self uncheckInputAttributes ( array $attributes ) | ||
| $attributes | array | |
public function uncheckInputAttributes(array $attributes): self
{
$new = clone $this;
$new->uncheckInputAttributes = $attributes;
return $new;
}
| public self uncheckValue ( boolean|float|integer|string|\Stringable|null $value ) | ||
| $value | boolean|float|integer|string|\Stringable|null | |
public function uncheckValue(bool|float|int|string|Stringable|null $value): self
{
$new = clone $this;
$new->uncheckValue = $value === null ? null : (string) $value;
return $new;
}
Defined in: Yiisoft\Html\Tag\Base\Tag::unionAttributes()
Union attributes with a new set.
| public Yiisoft\Html\Tag\Input\File 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\Html\Tag\Base\InputTag::value()
| public Yiisoft\Html\Tag\Input\File 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;
}
Signup or Login in order to comment.