0 follower

Final Class Yiisoft\Html\Tag\Input\File

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

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
accept() 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. Yiisoft\Html\Tag\Input\File
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
addStyle() Add CSS styles to the tag. Yiisoft\Html\Tag\Base\Tag
addUncheckInputAttributes() Yiisoft\Html\Tag\Input\File
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
multiple() Yiisoft\Html\Tag\Input\File
name() Yiisoft\Html\Tag\Base\InputTag
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
tag() Yiisoft\Html\Tag\Base\VoidTag
uncheckInputAttributes() Yiisoft\Html\Tag\Input\File
uncheckValue() Yiisoft\Html\Tag\Input\File
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\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

Hide inherited methods

__toString() public method

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

public __toString( ): string

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

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 accept( string|null $value ): self
$value string|null 

                public function accept(?string $value): self
{
    $new = clone $this;
    $new->attributes['accept'] = $value;
    return $new;
}
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 addAttributes( array $attributes ): Yiisoft\Html\Tag\Input\File
$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 addClass( \BackedEnum|string|null $class ): Yiisoft\Html\Tag\Input\File
$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;
}
addStyle() public method

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

Add CSS styles to the tag.

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

public addStyle( string|string[] $style, boolean $overwrite = true ): Yiisoft\Html\Tag\Input\File
$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;
}
addUncheckInputAttributes() public method

public addUncheckInputAttributes( array $attributes ): self
$attributes array 

                public function addUncheckInputAttributes(array $attributes): self
{
    $new = clone $this;
    $new->uncheckInputAttributes = array_merge($new->uncheckInputAttributes, $attributes);
    return $new;
}
after() protected method

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

protected after( ): string

                protected function after(): string
{
    return '';
}
attribute() public method

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

Set attribute value.

public attribute( string $name, mixed $value ): Yiisoft\Html\Tag\Input\File
$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 attributes( array $attributes ): Yiisoft\Html\Tag\Input\File
$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

protected before( ): string

                protected function before(): string
{
    return $this->renderUncheckInput();
}
class() public method

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

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

public class( \BackedEnum|string|null $class ): Yiisoft\Html\Tag\Input\File
$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 disabled( boolean $disabled = true ): Yiisoft\Html\Tag\Input\File
$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 form( string|null $formId ): Yiisoft\Html\Tag\Input\File
$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 getName( ): string

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

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

Set tag ID.

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

Tag ID.

 

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

public multiple( boolean $multiple = true ): self
$multiple boolean

Whether to allow selecting multiple files.

 

                public function multiple(bool $multiple = true): self
{
    $new = clone $this;
    $new->attributes['multiple'] = $multiple;
    return $new;
}
name() public method

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

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

Name of the input.

 

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

protected prepareAttributes( ): void

                protected function prepareAttributes(): void
{
    $this->attributes['type'] = 'file';
}
readonly() public method

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

public readonly( boolean $readOnly = true ): Yiisoft\Html\Tag\Input\File
$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 removeStyle( string|string[] $properties ): Yiisoft\Html\Tag\Input\File
$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 render( ): string

                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 renderAttributes( ): string

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

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

protected renderTag( ): string

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

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

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

Whether input is required.

 

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

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

public static tag( ): Yiisoft\Html\Tag\Input\File

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

public uncheckInputAttributes( array $attributes ): self
$attributes array 

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

public uncheckValue( boolean|float|integer|string|\Stringable|null $value ): self
$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;
}
unionAttributes() public method

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

Union attributes with a new set.

public unionAttributes( array $attributes ): Yiisoft\Html\Tag\Input\File
$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 value( boolean|float|integer|string|\Stringable|null $value ): Yiisoft\Html\Tag\Input\File
$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;
}