0 follower

Interface Yiisoft\Form\Field\Base\InputData\InputDataInterface

All Classes | Methods

Implemented by	Yiisoft\Form\PureField\InputData

Represents some common information about input and its validation rules / state.

Public Methods

Method	Description	Defined By
getHint()	Complimentary text explaining certain details regarding this input.	Yiisoft\Form\Field\Base\InputData\InputDataInterface
getId()		Yiisoft\Form\Field\Base\InputData\InputDataInterface
getLabel()	The label associated with this field (visible to the end user).	Yiisoft\Form\Field\Base\InputData\InputDataInterface
getName()	Unique name of an input within the form (not visible to the end user).	Yiisoft\Form\Field\Base\InputData\InputDataInterface
getPlaceholder()	The value used as an example to help user fill the actual value.	Yiisoft\Form\Field\Base\InputData\InputDataInterface
getValidationErrors()	The list of validation errors for this attribute.	Yiisoft\Form\Field\Base\InputData\InputDataInterface
getValidationRules()	Validation rules in any format. They are intended to be processed by Yiisoft\Form\ValidationRulesEnricherInterface::process().	Yiisoft\Form\Field\Base\InputData\InputDataInterface
getValue()	Filled value that is about to be sent to the server.	Yiisoft\Form\Field\Base\InputData\InputDataInterface
isValidated()	Validation state (whether the input has been already validated).	Yiisoft\Form\Field\Base\InputData\InputDataInterface

getHint() public abstract method

Complimentary text explaining certain details regarding this input.

public abstract getHint( ): string\|null
return	string\|null	Input hint or null if missing.

                public function getHint(): ?string;

getId() public abstract method

public abstract getId( ): string\|null
return	string\|null	ID of the input or null if missing.

                public function getId(): ?string;

getLabel() public abstract method

The label associated with this field (visible to the end user).

public abstract getLabel( ): string\|null
return	string\|null	Input label or null if missing.

                public function getLabel(): ?string;

getName() public abstract method

Unique name of an input within the form (not visible to the end user).

public abstract getName( ): string\|null
return	string\|null	Name of the input or null if missing.

                public function getName(): ?string;

getPlaceholder() public abstract method

The value used as an example to help user fill the actual value.

public abstract getPlaceholder( ): string\|null
return	string\|null	Input placeholder or null if no placeholder is used.

                public function getPlaceholder(): ?string;

getValidationErrors() public abstract method

The list of validation errors for this attribute.

public abstract getValidationErrors( ): string[]
return	string[]	Input validation errors.

                public function getValidationErrors(): array;

getValidationRules() public abstract method

Validation rules in any format. They are intended to be processed by Yiisoft\Form\ValidationRulesEnricherInterface::process().

public abstract getValidationRules( ): mixed
return	mixed	Input validation rules.

                public function getValidationRules(): mixed;

getValue() public abstract method

Filled value that is about to be sent to the server.

public abstract getValue( ): mixed
return	mixed	Value of the input.

                public function getValue(): mixed;

isValidated() public abstract method

Validation state (whether the input has been already validated).

public abstract isValidated( ): boolean
return	boolean	Whether input was validated.

                public function isValidated(): bool;