Final Class Yiisoft\Form\Field\File
Represents <input> element of type "file" are ley the user choose one or more files from their device storage.
Protected Properties
Public Methods
Protected Methods
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| BUILTIN_TOKENS | [ '{input}', '{label}', '{hint}', '{error}', ] | Yiisoft\Form\Field\Base\PartsField |
Method Details
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->inputAttributes['accept'] = $value;
return $new;
}
| public addContainerAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function addContainerAttributes(array $attributes): static
{
$new = clone $this;
$new->containerAttributes = array_merge($new->containerAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\BaseField::addContainerClass()
Add one or more CSS classes to the container tag.
| public addContainerClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function addContainerClass(?string ...$class): static
{
$new = clone $this;
Html::addCssClass($new->containerAttributes, $class);
return $new;
}
| public addErrorAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function addErrorAttributes(array $attributes): static
{
$new = clone $this;
$new->errorAttributes = array_merge($new->errorAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::addErrorClass()
Add one or more CSS classes to the error tag.
| public addErrorClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function addErrorClass(?string ...$class): static
{
$new = clone $this;
Html::addCssClass($new->errorAttributes, $class);
return $new;
}
| public addHintAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function addHintAttributes(array $attributes): static
{
$new = clone $this;
$new->hintAttributes = array_merge($new->hintAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::addHintClass()
Add one or more CSS classes to the hint tag.
| public addHintClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function addHintClass(?string ...$class): static
{
$new = clone $this;
Html::addCssClass($new->hintAttributes, $class);
return $new;
}
| public addInputAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function addInputAttributes(array $attributes): static
{
$new = clone $this;
$new->inputAttributes = array_merge($new->inputAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\InputField::addInputClass()
Add one or more CSS classes to the input tag.
| public addInputClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function addInputClass(?string ...$class): static
{
$new = clone $this;
Html::addCssClass($new->inputAttributes, $class);
return $new;
}
| public addInputContainerAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function addInputContainerAttributes(array $attributes): static
{
$new = clone $this;
$new->inputContainerAttributes = array_merge($new->inputContainerAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::addInputContainerClass()
Add one or more CSS classes to the input container tag.
| public addInputContainerClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function addInputContainerClass(?string ...$class): static
{
$new = clone $this;
Html::addCssClass($new->inputContainerAttributes, $class);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::addInputValidationClassToAttributes()
| protected addInputValidationClassToAttributes( array &$attributes, Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData, boolean|null $hasCustomError = null ): void | ||
| $attributes | array | |
| $inputData | Yiisoft\Form\Field\Base\InputData\InputDataInterface | |
| $hasCustomError | boolean|null | |
protected function addInputValidationClassToAttributes(
array &$attributes,
InputDataInterface $inputData,
?bool $hasCustomError = null,
): void {
$this->addClassesToAttributes(
$attributes,
$inputData,
$hasCustomError,
$this->inputInvalidClass,
$this->inputValidClass,
);
}
| public addLabelAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function addLabelAttributes(array $attributes): static
{
$new = clone $this;
$new->labelAttributes = array_merge($new->labelAttributes, $attributes);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::addLabelClass()
Add one or more CSS classes to the label tag.
| public addLabelClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function addLabelClass(?string ...$class): static
{
$new = clone $this;
Html::addCssClass($new->labelAttributes, $class);
return $new;
}
| 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;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::addValidationClassToAttributes()
| protected addValidationClassToAttributes( array &$attributes, Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData, boolean|null $hasCustomError = null ): void | ||
| $attributes | array | |
| $inputData | Yiisoft\Form\Field\Base\InputData\InputDataInterface | |
| $hasCustomError | boolean|null | |
protected function addValidationClassToAttributes(
array &$attributes,
InputDataInterface $inputData,
?bool $hasCustomError = null,
): void {
$this->addClassesToAttributes(
$attributes,
$inputData,
$hasCustomError,
$this->invalidClass,
$this->validClass,
);
}
Defined in: Yiisoft\Form\Field\Base\PartsField::afterInput()
| public afterInput( string|\Stringable $content ): Yiisoft\Form\Field\File | ||
| $content | string|\Stringable | |
final public function afterInput(string|Stringable $content): static
{
$new = clone $this;
$new->afterInput = $content;
return $new;
}
Identifies the element (or elements) that describes the object.
| public ariaDescribedBy( string|null $value ): self | ||
| $value | string|null | |
public function ariaDescribedBy(?string ...$value): self
{
$new = clone $this;
$new->inputAttributes['aria-describedby'] = array_filter($value, static fn(?string $v): bool => $v !== null);
return $new;
}
Defines a string value that labels the current element.
| public ariaLabel( string|null $value ): self | ||
| $value | string|null | |
public function ariaLabel(?string $value): self
{
$new = clone $this;
$new->inputAttributes['aria-label'] = $value;
return $new;
}
| public beforeInput( string|\Stringable $content ): Yiisoft\Form\Field\File | ||
| $content | string|\Stringable | |
final public function beforeInput(string|Stringable $content): static
{
$new = clone $this;
$new->beforeInput = $content;
return $new;
}
| protected beforeRender( ): void |
protected function beforeRender(): void
{
if ($this->enrichFromValidationRules) {
$this->enrichment = $this
->validationRulesEnricher
?->process($this, $this->getInputData()->getValidationRules())
?? [];
}
}
Defined in: Yiisoft\Form\Field\Base\BaseField::begin()
| public begin( ): string|null |
final public function begin(): ?string
{
parent::begin();
$this->isStartedByBegin = true;
$this->beforeRender();
$content = $this->generateBeginContent();
return $this->renderOpenContainerAndContent($content);
}
| public containerAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function containerAttributes(array $attributes): static
{
$new = clone $this;
$new->containerAttributes = $attributes;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\BaseField::containerClass()
Replace container tag CSS classes with a new set of classes.
| public containerClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function containerClass(?string ...$class): static
{
$new = clone $this;
$new->containerAttributes['class'] = array_filter($class, static fn($c) => $c !== null);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\BaseField::containerId()
Set container tag ID.
| public containerId( string|null $id ): Yiisoft\Form\Field\File | ||
| $id | string|null |
Container tag ID. |
final public function containerId(?string $id): static
{
$new = clone $this;
$new->containerAttributes['id'] = $id;
return $new;
}
| public containerTag( string $tag ): Yiisoft\Form\Field\File | ||
| $tag | string | |
final public function containerTag(string $tag): static
{
if ($tag === '') {
throw new InvalidArgumentException('Tag name cannot be empty.');
}
$new = clone $this;
$new->containerTag = $tag;
return $new;
}
| public disabled( boolean $disabled = true ): self | ||
| $disabled | boolean |
Whether select input is disabled. |
public function disabled(bool $disabled = true): self
{
$new = clone $this;
$new->inputAttributes['disabled'] = $disabled;
return $new;
}
| public enrichFromValidationRules( boolean $enrich = true ): self | ||
| $enrich | boolean | |
public function enrichFromValidationRules(bool $enrich = true): self
{
$new = clone $this;
$new->enrichFromValidationRules = $enrich;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::error()
| public error( string|null $message, string $messages ): Yiisoft\Form\Field\File | ||
| $message | string|null | |
| $messages | string | |
final public function error(?string $message, string ...$messages): static
{
$new = clone $this;
$new->errorConfig['message()'] = [$message, ...$messages];
return $new;
}
| public errorAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function errorAttributes(array $attributes): static
{
$new = clone $this;
$new->errorAttributes = $attributes;
$new->replaceErrorAttributes = true;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::errorClass()
Replace error tag CSS classes with a new set of classes.
| public errorClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function errorClass(?string ...$class): static
{
$new = clone $this;
$new->errorAttributes['class'] = $class;
$new->replaceErrorClass = true;
return $new;
}
| public errorConfig( array $config ): Yiisoft\Form\Field\File | ||
| $config | array | |
final public function errorConfig(array $config): static
{
$new = clone $this;
$new->errorConfig = $config;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::errorId()
Set error tag ID.
| public errorId( string|null $id ): Yiisoft\Form\Field\File | ||
| $id | string|null |
Error tag ID. |
final public function errorId(?string $id): static
{
$new = clone $this;
$new->errorAttributes['id'] = $id;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\InputField::form()
Specifies the form element the tag input element belongs to. The value of this attribute must be the ID attribute of a form element in the same document.
| public form( string|null $value ): Yiisoft\Form\Field\File | ||
| $value | string|null | |
final public function form(?string $value): static
{
$new = clone $this;
$new->inputAttributes['form'] = $value;
return $new;
}
| protected generateBeginContent( ): string |
final protected function generateBeginContent(): string
{
$parts = [
'{input}' => $this->generateBeginInput(),
'{label}' => ($this->hideLabel ?? $this->shouldHideLabel()) ? '' : $this->generateLabel(),
'{hint}' => $this->generateHint(),
'{error}' => $this->generateError(),
];
return $this->makeContent($this->templateBegin, $parts);
}
| protected generateBeginInput( ): string |
protected function generateBeginInput(): string
{
return '';
}
| protected generateContent( ): string|null |
final protected function generateContent(): ?string
{
$parts = [
'{input}' => $this->generateInputContainerBegin()
. $this->beforeInput
. $this->generateInput()
. $this->afterInput
. $this->generateInputContainerEnd(),
'{label}' => ($this->hideLabel ?? $this->shouldHideLabel()) ? '' : $this->generateLabel(),
'{hint}' => $this->generateHint(),
'{error}' => $this->generateError(),
];
return $this->makeContent($this->template, $parts);
}
| protected generateEndContent( ): string |
final protected function generateEndContent(): string
{
$parts = [
'{input}' => $this->generateEndInput(),
'{label}' => ($this->hideLabel ?? $this->shouldHideLabel()) ? '' : $this->generateLabel(),
'{hint}' => $this->generateHint(),
'{error}' => $this->generateError(),
];
return $this->makeContent($this->templateEnd, $parts);
}
| protected generateEndInput( ): string |
protected function generateEndInput(): string
{
return '';
}
| protected generateInput( ): string |
protected function generateInput(): string
{
/** @psalm-suppress MixedArgument We guess that enrichment contain correct values. */
$inputAttributes = array_merge(
$this->enrichment['inputAttributes'] ?? [],
$this->getInputAttributes(),
);
$tag = Html::file($this->getName(), attributes: $inputAttributes);
if ($this->uncheckValue !== null) {
$tag = $tag->uncheckValue($this->uncheckValue);
if (!empty($this->uncheckInputAttributes)) {
$tag = $tag->addUncheckInputAttributes($this->uncheckInputAttributes);
}
}
return $tag->render();
}
| protected getInputAttributes( ): array |
final protected function getInputAttributes(): array
{
$attributes = $this->inputAttributes;
$this->prepareIdInInputAttributes($attributes);
$this->prepareInputAttributes($attributes);
return $attributes;
}
| protected getInputData( ): Yiisoft\Form\Field\Base\InputData\InputDataInterface |
final protected function getInputData(): InputDataInterface
{
if ($this->inputData === null) {
$this->inputData = new InputData();
}
return $this->inputData;
}
| protected getName( ): string|null |
final protected function getName(): ?string
{
return $this->useCustomName
? $this->customName
: $this->getInputData()->getName();
}
| protected static getThemeConfig( string|null $theme ): array | ||
| $theme | string|null | |
final protected static function getThemeConfig(?string $theme): array
{
return ThemeContainer::getTheme($theme)?->getFieldConfig(static::class) ?? [];
}
| protected getValue( ): mixed |
final protected function getValue(): mixed
{
$value = $this->useCustomValue
? $this->customValue
: $this->getInputData()->getValue();
return $this->prepareValueCallback === null
? $value
: ($this->prepareValueCallback)($value);
}
| protected hasCustomError( ): boolean |
final protected function hasCustomError(): bool
{
return isset($this->errorConfig['message()']);
}
Defined in: Yiisoft\Form\Field\Base\PartsField::hideLabel()
| public hideLabel( boolean|null $hide = true ): Yiisoft\Form\Field\File | ||
| $hide | boolean|null | |
final public function hideLabel(?bool $hide = true): static
{
$new = clone $this;
$new->hideLabel = $hide;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::hint()
| public hint( string|null $content ): Yiisoft\Form\Field\File | ||
| $content | string|null | |
final public function hint(?string $content): static
{
$new = clone $this;
$new->hintConfig['content()'] = [$content];
return $new;
}
| public hintAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function hintAttributes(array $attributes): static
{
$new = clone $this;
$new->hintAttributes = $attributes;
$new->replaceHintAttributes = true;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::hintClass()
Replace hint tag CSS classes with a new set of classes.
| public hintClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function hintClass(?string ...$class): static
{
$new = clone $this;
$new->hintAttributes['class'] = $class;
$new->replaceHintClass = true;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::hintConfig()
| public hintConfig( array $config ): Yiisoft\Form\Field\File | ||
| $config | array | |
final public function hintConfig(array $config): static
{
$new = clone $this;
$new->hintConfig = $config;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::hintId()
Set hint tag ID.
| public hintId( string|null $id ): Yiisoft\Form\Field\File | ||
| $id | string|null |
Hint tag ID. |
final public function hintId(?string $id): static
{
$new = clone $this;
$new->hintAttributes['id'] = $id;
return $new;
}
| public inputAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function inputAttributes(array $attributes): static
{
$new = clone $this;
$new->inputAttributes = $attributes;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\InputField::inputClass()
Replace input tag CSS classes with a new set of classes.
| public inputClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function inputClass(?string ...$class): static
{
$new = clone $this;
$new->inputAttributes['class'] = array_filter($class, static fn($c) => $c !== null);
return $new;
}
| public inputContainerAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function inputContainerAttributes(array $attributes): static
{
$new = clone $this;
$new->inputContainerAttributes = $attributes;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::inputContainerClass()
Replace input container tag CSS classes with a new set of classes.
| public inputContainerClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function inputContainerClass(?string ...$class): static
{
$new = clone $this;
$new->inputContainerAttributes['class'] = array_filter($class, static fn($c) => $c !== null);
return $new;
}
| public inputContainerTag( string|null $tag ): Yiisoft\Form\Field\File | ||
| $tag | string|null | |
final public function inputContainerTag(?string $tag): static
{
if ($tag === '') {
throw new InvalidArgumentException('Tag name cannot be empty.');
}
$new = clone $this;
$new->inputContainerTag = $tag;
return $new;
}
| public inputData( Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData ): Yiisoft\Form\Field\File | ||
| $inputData | Yiisoft\Form\Field\Base\InputData\InputDataInterface | |
final public function inputData(InputDataInterface $inputData): static
{
$new = clone $this;
$new->inputData = $inputData;
$new->useCustomName = false;
$new->useCustomValue = false;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\InputField::inputId()
| public inputId( string|null $inputId ): Yiisoft\Form\Field\File | ||
| $inputId | string|null | |
final public function inputId(?string $inputId): static
{
$new = clone $this;
$new->inputId = $inputId;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::inputInvalidClass()
Set invalid CSS class for input tag.
| public inputInvalidClass( string|null $class ): self | ||
| $class | string|null | |
public function inputInvalidClass(?string $class): self
{
$new = clone $this;
$new->inputInvalidClass = $class;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::inputValidClass()
Set valid CSS class for input tag.
| public inputValidClass( string|null $class ): self | ||
| $class | string|null | |
public function inputValidClass(?string $class): self
{
$new = clone $this;
$new->inputValidClass = $class;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::invalidClass()
Set invalid CSS class.
| public invalidClass( string|null $class ): self | ||
| $class | string|null | |
public function invalidClass(?string $class): self
{
$new = clone $this;
$new->invalidClass = $class;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::label()
| public label( string|null $content ): Yiisoft\Form\Field\File | ||
| $content | string|null | |
final public function label(?string $content): static
{
$new = clone $this;
$new->label = $content;
return $new;
}
| public labelAttributes( array $attributes ): Yiisoft\Form\Field\File | ||
| $attributes | array | |
final public function labelAttributes(array $attributes): static
{
$new = clone $this;
$new->labelAttributes = $attributes;
$new->replaceLabelAttributes = true;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::labelClass()
Replace label tag CSS classes with a new set of classes.
| public labelClass( string|null $class ): Yiisoft\Form\Field\File | ||
| $class | string|null |
One or many CSS classes. |
final public function labelClass(?string ...$class): static
{
$new = clone $this;
$new->labelAttributes['class'] = $class;
$new->replaceLabelClass = true;
return $new;
}
| public labelConfig( array $config ): Yiisoft\Form\Field\File | ||
| $config | array | |
final public function labelConfig(array $config): static
{
$new = clone $this;
$new->labelConfig = $config;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::labelId()
Set label tag ID.
| public labelId( string|null $id ): Yiisoft\Form\Field\File | ||
| $id | string|null |
Label tag ID. |
final public function labelId(?string $id): static
{
$new = clone $this;
$new->labelAttributes['id'] = $id;
return $new;
}
| 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->inputAttributes['multiple'] = $multiple;
return $new;
}
| public name( string|null $name ): Yiisoft\Form\Field\File | ||
| $name | string|null | |
final public function name(?string $name): static
{
$new = clone $this;
$new->customName = $name;
$new->useCustomName = true;
return $new;
}
| protected prepareContainerAttributes( array &$attributes ): void | ||
| $attributes | array | |
protected function prepareContainerAttributes(array &$attributes): void
{
$this->addValidationClassToAttributes(
$attributes,
$this->getInputData(),
$this->hasCustomError() ? true : null,
);
}
| protected prepareIdInInputAttributes( array &$attributes ): void | ||
| $attributes | array | |
final protected function prepareIdInInputAttributes(array &$attributes): void
{
$idFromTag = $attributes['id'] ?? null;
if ($idFromTag !== null) {
$this->inputIdFromTag = (string) $idFromTag;
}
if ($this->shouldSetInputId) {
if ($this->inputId !== null) {
$attributes['id'] = $this->inputId;
} elseif ($idFromTag === null) {
$attributes['id'] = $this->getInputData()->getId();
}
}
}
| protected prepareInputAttributes( array &$attributes ): void | ||
| $attributes | array | |
protected function prepareInputAttributes(array &$attributes): void
{
$this->addInputValidationClassToAttributes(
$attributes,
$this->getInputData(),
$this->hasCustomError() ? true : null,
);
}
| public prepareValue( callable|null $callback ): Yiisoft\Form\Field\File | ||
| $callback | callable|null | |
final public function prepareValue(?callable $callback): static
{
$new = clone $this;
$new->prepareValueCallback = $callback;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\BaseField::render()
| public render( ): string |
final public function render(): string
{
if ($this->isStartedByBegin) {
$this->isStartedByBegin = false;
return $this->renderEnd();
}
$this->beforeRender();
$content = $this->generateContent();
if ($content === null) {
$this->enrichment = [];
return '';
}
$result = $this->renderOpenContainerAndContent($content);
if ($this->useContainer) {
$result .= "\n" . Html::closeTag($this->containerTag);
}
$this->enrichment = [];
return $result;
}
| protected renderError( Yiisoft\Form\Field\Part\Error $error ): string | ||
| $error | Yiisoft\Form\Field\Part\Error | |
final protected function renderError(Error $error): string
{
return $error
->inputData($this->getInputData())
->render();
}
Defined in: Yiisoft\Form\Field\Base\InputField::renderHint()
| protected renderHint( Yiisoft\Form\Field\Part\Hint $hint ): string | ||
| $hint | Yiisoft\Form\Field\Part\Hint | |
final protected function renderHint(Hint $hint): string
{
return $hint
->inputData($this->getInputData())
->render();
}
| protected renderLabel( Yiisoft\Form\Field\Part\Label $label ): string | ||
| $label | Yiisoft\Form\Field\Part\Label | |
final protected function renderLabel(Label $label): string
{
$label = $label->inputData($this->getInputData());
if ($this->shouldSetInputId === false) {
$label = $label->useInputId(false);
}
if ($this->inputId !== null) {
$label = $label->forId($this->inputId);
} elseif ($this->inputIdFromTag !== null) {
$label = $label->forId($this->inputIdFromTag);
}
return $label->render();
}
A boolean attribute. When specified, the element is required.
| public required( boolean $value = true ): self | ||
| $value | boolean |
Whether the control is required for form submission. |
public function required(bool $value = true): self
{
$new = clone $this;
$new->inputAttributes['required'] = $value;
return $new;
}
| protected shouldHideLabel( ): boolean |
protected function shouldHideLabel(): bool
{
return false;
}
| public shouldSetInputId( boolean $value ): Yiisoft\Form\Field\File | ||
| $value | boolean | |
final public function shouldSetInputId(bool $value): static
{
$new = clone $this;
$new->shouldSetInputId = $value;
return $new;
}
The tabindex attribute indicates that its element can be focused, and where it participates in sequential
keyboard navigation (usually with the Tab key, hence the name).
It accepts an integer as a value, with different results depending on the integer's value:
- A negative value (usually
tabindex="-1") means that the element is not reachable via sequential keyboard navigation, but could be focused with Javascript or visually. It's mostly useful to create accessible widgets with JavaScript. tabindex="0"means that the element should be focusable in sequential keyboard navigation, but its order is defined by the document's source order.- A positive value means the element should be focusable in sequential keyboard navigation, with its order
defined by the value of the number. That is,
tabindex="4"is focused beforetabindex="5", but aftertabindex="3".
| public tabIndex( integer|null $value ): self | ||
| $value | integer|null | |
public function tabIndex(?int $value): self
{
$new = clone $this;
$new->inputAttributes['tabindex'] = $value;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::template()
Set layout template for render a field.
| public template( string $template ): Yiisoft\Form\Field\File | ||
| $template | string | |
final public function template(string $template): static
{
$new = clone $this;
$new->template = $template;
return $new;
}
| public templateBegin( string $template ): Yiisoft\Form\Field\File | ||
| $template | string | |
final public function templateBegin(string $template): static
{
$new = clone $this;
$new->templateBegin = $template;
return $new;
}
| public templateEnd( string $template ): Yiisoft\Form\Field\File | ||
| $template | string | |
final public function templateEnd(string $template): static
{
$new = clone $this;
$new->templateEnd = $template;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::token()
| public token( string $token, string|\Stringable $value ): Yiisoft\Form\Field\File | ||
| $token | string | |
| $value | string|\Stringable | |
final public function token(string $token, string|Stringable $value): static
{
$this->validateToken($token);
$new = clone $this;
$new->extraTokens[$token] = $value;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\PartsField::tokens()
| public tokens( array $tokens ): Yiisoft\Form\Field\File | ||
| $tokens | array | |
final public function tokens(array $tokens): static
{
$new = clone $this;
foreach ($tokens as $token => $value) {
if (!is_string($token)) {
throw new InvalidArgumentException(
sprintf(
'Token should be string. %s given.',
get_debug_type($token),
),
);
}
if (!is_string($value) && !$value instanceof Stringable) {
throw new InvalidArgumentException(
sprintf(
'Token value should be string or Stringable. %s given.',
get_debug_type($value),
),
);
}
$this->validateToken($token);
$new->extraTokens[$token] = $value;
}
return $new;
}
| public uncheckInputAttributes( array $attributes ): self | ||
| $attributes | array | |
public function uncheckInputAttributes(array $attributes): self
{
$new = clone $this;
$new->uncheckInputAttributes = $attributes;
return $new;
}
| public uncheckValue( boolean|float|integer|string|\Stringable|null $value ): self | ||
| $value | boolean|float|integer|string|\Stringable|null |
Value that corresponds to "unchecked" state of the input. |
public function uncheckValue(bool|float|int|string|Stringable|null $value): self
{
$new = clone $this;
$new->uncheckValue = $value;
return $new;
}
| public useContainer( boolean $use ): Yiisoft\Form\Field\File | ||
| $use | boolean | |
final public function useContainer(bool $use): static
{
$new = clone $this;
$new->useContainer = $use;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::validClass()
Set valid CSS class.
| public validClass( string|null $class ): self | ||
| $class | string|null | |
public function validClass(?string $class): self
{
$new = clone $this;
$new->validClass = $class;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\EnrichFromValidationRules\EnrichFromValidationRulesTrait::validationRulesEnricher()
| public validationRulesEnricher( Yiisoft\Form\ValidationRulesEnricherInterface|null $enricher ): self | ||
| $enricher | Yiisoft\Form\ValidationRulesEnricherInterface|null | |
public function validationRulesEnricher(?ValidationRulesEnricherInterface $enricher): self
{
$new = clone $this;
$new->validationRulesEnricher = $enricher;
return $new;
}
| public value( mixed $value ): Yiisoft\Form\Field\File | ||
| $value | mixed | |
final public function value(mixed $value): static
{
$new = clone $this;
$new->customValue = $value;
$new->useCustomValue = true;
return $new;
}
Signup or Login in order to comment.