Final Class Yiisoft\Form\Field\Date
Represents <input> element of type "date" are let the user enter a date, either with a textbox that validates
the input or a special date picker interface.
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
| public Yiisoft\Form\Field\Date addContainerAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date addContainerClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date addErrorAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date addErrorClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date addHintAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date addHintClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date addInputAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date addInputClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date addInputContainerAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date addInputContainerClass ( string|null $class ) | ||
| $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 void addInputValidationClassToAttributes ( array &$attributes, Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData, boolean|null $hasCustomError = null ) | ||
| $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 Yiisoft\Form\Field\Date addLabelAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date addLabelClass ( string|null $class ) | ||
| $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;
}
Defined in: Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait::addValidationClassToAttributes()
| protected void addValidationClassToAttributes ( array &$attributes, Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData, boolean|null $hasCustomError = null ) | ||
| $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 Yiisoft\Form\Field\Date afterInput ( string|\Stringable $content ) | ||
| $content | string|\Stringable | |
final public function afterInput(string|Stringable $content): static
{
$new = clone $this;
$new->afterInput = $content;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\DateTimeInputField::ariaDescribedBy()
Identifies the element (or elements) that describes the object.
| public Yiisoft\Form\Field\Date ariaDescribedBy ( string|null $value ) | ||
| $value | string|null | |
final public function ariaDescribedBy(?string ...$value): static
{
$new = clone $this;
$new->inputAttributes['aria-describedby'] = array_filter($value, static fn (?string $v): bool => $v !== null);
return $new;
}
Defined in: Yiisoft\Form\Field\Base\DateTimeInputField::ariaLabel()
Defines a string value that labels the current element.
| public Yiisoft\Form\Field\Date ariaLabel ( string|null $value ) | ||
| $value | string|null | |
final public function ariaLabel(?string $value): static
{
$new = clone $this;
$new->inputAttributes['aria-label'] = $value;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\DateTimeInputField::autofocus()
Focus on the control (put cursor into it) when the page loads. Only one form element could be in focus at the same time.
| public Yiisoft\Form\Field\Date autofocus ( boolean $value = true ) | ||
| $value | boolean | |
final public function autofocus(bool $value = true): static
{
$new = clone $this;
$new->inputAttributes['autofocus'] = $value;
return $new;
}
| public Yiisoft\Form\Field\Date beforeInput ( string|\Stringable $content ) | ||
| $content | string|\Stringable | |
final public function beforeInput(string|Stringable $content): static
{
$new = clone $this;
$new->beforeInput = $content;
return $new;
}
| protected void beforeRender ( ) |
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 string|null begin ( ) |
final public function begin(): ?string
{
parent::begin();
$this->isStartedByBegin = true;
$this->beforeRender();
$content = $this->generateBeginContent();
return $this->renderOpenContainerAndContent($content);
}
| public Yiisoft\Form\Field\Date containerAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date containerClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date containerId ( string|null $id ) | ||
| $id | string|null |
Container tag ID. |
final public function containerId(?string $id): static
{
$new = clone $this;
$new->containerAttributes['id'] = $id;
return $new;
}
| public Yiisoft\Form\Field\Date containerTag ( string $tag ) | ||
| $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 Yiisoft\Form\Field\Date disabled ( boolean $disabled = true ) | ||
| $disabled | boolean | |
final public function disabled(bool $disabled = true): static
{
$new = clone $this;
$new->inputAttributes['disabled'] = $disabled;
return $new;
}
| public self enrichFromValidationRules ( boolean $enrich = true ) | ||
| $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 Yiisoft\Form\Field\Date error ( string|null $message, string $messages ) | ||
| $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 Yiisoft\Form\Field\Date errorAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date errorClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date errorConfig ( array $config ) | ||
| $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 Yiisoft\Form\Field\Date errorId ( string|null $id ) | ||
| $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 Yiisoft\Form\Field\Date form ( string|null $value ) | ||
| $value | string|null | |
final public function form(?string $value): static
{
$new = clone $this;
$new->inputAttributes['form'] = $value;
return $new;
}
| protected string formatDateTime ( DateTimeInterface $value ) | ||
| $value | DateTimeInterface | |
protected function formatDateTime(DateTimeInterface $value): string
{
return $value->format('Y-m-d');
}
| protected string generateBeginContent ( ) |
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 string generateBeginInput ( ) |
protected function generateBeginInput(): string
{
return '';
}
| protected string|null generateContent ( ) |
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 string generateEndContent ( ) |
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 string generateEndInput ( ) |
protected function generateEndInput(): string
{
return '';
}
| protected string generateInput ( ) |
final protected function generateInput(): string
{
$value = $this->getValue();
if ($value instanceof DateTimeInterface) {
$value = $this->formatDateTime($value);
} elseif (!is_string($value) && $value !== null) {
throw new InvalidArgumentException(
(new ReflectionClass($this))->getShortName() .
' field requires a string or null value.'
);
}
/** @psalm-suppress MixedArgument We guess that enrichment contain correct values. */
$inputAttributes = array_merge(
$this->enrichment['inputAttributes'] ?? [],
$this->getInputAttributes()
);
return Html::input($this->getInputType(), $this->getName(), $value, $inputAttributes)->render();
}
| protected array getInputAttributes ( ) |
final protected function getInputAttributes(): array
{
$attributes = $this->inputAttributes;
$this->prepareIdInInputAttributes($attributes);
$this->prepareInputAttributes($attributes);
return $attributes;
}
| protected Yiisoft\Form\Field\Base\InputData\InputDataInterface getInputData ( ) |
final protected function getInputData(): InputDataInterface
{
if ($this->inputData === null) {
$this->inputData = new InputData();
}
return $this->inputData;
}
| protected string|null getName ( ) |
final protected function getName(): ?string
{
return $this->useCustomName
? $this->customName
: $this->getInputData()->getName();
}
| protected static array getThemeConfig ( string|null $theme ) | ||
| $theme | string|null | |
final protected static function getThemeConfig(?string $theme): array
{
return ThemeContainer::getTheme($theme)?->getFieldConfig(static::class) ?? [];
}
| protected mixed getValue ( ) |
final protected function getValue(): mixed
{
$value = $this->useCustomValue
? $this->customValue
: $this->getInputData()->getValue();
return $this->prepareValueCallback === null
? $value
: ($this->prepareValueCallback)($value);
}
| protected boolean hasCustomError ( ) |
final protected function hasCustomError(): bool
{
return isset($this->errorConfig['message()']);
}
Defined in: Yiisoft\Form\Field\Base\PartsField::hideLabel()
| public Yiisoft\Form\Field\Date hideLabel ( boolean|null $hide = true ) | ||
| $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 Yiisoft\Form\Field\Date hint ( string|null $content ) | ||
| $content | string|null | |
final public function hint(?string $content): static
{
$new = clone $this;
$new->hintConfig['content()'] = [$content];
return $new;
}
| public Yiisoft\Form\Field\Date hintAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date hintClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date hintConfig ( array $config ) | ||
| $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 Yiisoft\Form\Field\Date hintId ( string|null $id ) | ||
| $id | string|null |
Hint tag ID. |
final public function hintId(?string $id): static
{
$new = clone $this;
$new->hintAttributes['id'] = $id;
return $new;
}
| public Yiisoft\Form\Field\Date inputAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date inputClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date inputContainerAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date inputContainerClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date inputContainerTag ( string|null $tag ) | ||
| $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 Yiisoft\Form\Field\Date inputData ( Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData ) | ||
| $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 Yiisoft\Form\Field\Date inputId ( string|null $inputId ) | ||
| $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 self inputInvalidClass ( string|null $class ) | ||
| $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 self inputValidClass ( string|null $class ) | ||
| $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 self invalidClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date label ( string|null $content ) | ||
| $content | string|null | |
final public function label(?string $content): static
{
$new = clone $this;
$new->label = $content;
return $new;
}
| public Yiisoft\Form\Field\Date labelAttributes ( array $attributes ) | ||
| $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 Yiisoft\Form\Field\Date labelClass ( string|null $class ) | ||
| $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 Yiisoft\Form\Field\Date labelConfig ( array $config ) | ||
| $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 Yiisoft\Form\Field\Date labelId ( string|null $id ) | ||
| $id | string|null |
Label tag ID. |
final public function labelId(?string $id): static
{
$new = clone $this;
$new->labelAttributes['id'] = $id;
return $new;
}
| public Yiisoft\Form\Field\Date max ( string|null $value ) | ||
| $value | string|null | |
final public function max(?string $value): static
{
$new = clone $this;
$new->inputAttributes['max'] = $value;
return $new;
}
| public Yiisoft\Form\Field\Date min ( string|null $value ) | ||
| $value | string|null | |
final public function min(?string $value): static
{
$new = clone $this;
$new->inputAttributes['min'] = $value;
return $new;
}
| public Yiisoft\Form\Field\Date name ( string|null $name ) | ||
| $name | string|null | |
final public function name(?string $name): static
{
$new = clone $this;
$new->customName = $name;
$new->useCustomName = true;
return $new;
}
| protected void prepareContainerAttributes ( array &$attributes ) | ||
| $attributes | array | |
protected function prepareContainerAttributes(array &$attributes): void
{
$this->addValidationClassToAttributes(
$attributes,
$this->getInputData(),
$this->hasCustomError() ? true : null,
);
}
| protected void prepareIdInInputAttributes ( array &$attributes ) | ||
| $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 void prepareInputAttributes ( array &$attributes ) | ||
| $attributes | array | |
protected function prepareInputAttributes(array &$attributes): void
{
$this->addInputValidationClassToAttributes(
$attributes,
$this->getInputData(),
$this->hasCustomError() ? true : null,
);
}
| public Yiisoft\Form\Field\Date prepareValue ( callable|null $callback ) | ||
| $callback | callable|null | |
final public function prepareValue(?callable $callback): static
{
$new = clone $this;
$new->prepareValueCallback = $callback;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\DateTimeInputField::readonly()
A boolean attribute that controls whether the user can edit the form control.
| public Yiisoft\Form\Field\Date readonly ( boolean $value = true ) | ||
| $value | boolean |
Whether to allow the value to be edited by the user. |
final public function readonly(bool $value = true): static
{
$new = clone $this;
$new->inputAttributes['readonly'] = $value;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\BaseField::render()
| public string render ( ) |
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 string renderError ( Yiisoft\Form\Field\Part\Error $error ) | ||
| $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 string renderHint ( Yiisoft\Form\Field\Part\Hint $hint ) | ||
| $hint | Yiisoft\Form\Field\Part\Hint | |
final protected function renderHint(Hint $hint): string
{
return $hint
->inputData($this->getInputData())
->render();
}
| protected string renderLabel ( Yiisoft\Form\Field\Part\Label $label ) | ||
| $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();
}
Defined in: Yiisoft\Form\Field\Base\DateTimeInputField::required()
A boolean attribute. When specified, the element is required.
| public Yiisoft\Form\Field\Date required ( boolean $value = true ) | ||
| $value | boolean |
Whether the control is required for form submission. |
final public function required(bool $value = true): static
{
$new = clone $this;
$new->inputAttributes['required'] = $value;
return $new;
}
| protected boolean shouldHideLabel ( ) |
protected function shouldHideLabel(): bool
{
return false;
}
| public Yiisoft\Form\Field\Date shouldSetInputId ( boolean $value ) | ||
| $value | boolean | |
final public function shouldSetInputId(bool $value): static
{
$new = clone $this;
$new->shouldSetInputId = $value;
return $new;
}
Defined in: Yiisoft\Form\Field\Base\DateTimeInputField::tabIndex()
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 Yiisoft\Form\Field\Date tabIndex ( integer|null $value ) | ||
| $value | integer|null | |
final public function tabIndex(?int $value): static
{
$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 Yiisoft\Form\Field\Date template ( string $template ) | ||
| $template | string | |
final public function template(string $template): static
{
$new = clone $this;
$new->template = $template;
return $new;
}
| public Yiisoft\Form\Field\Date templateBegin ( string $template ) | ||
| $template | string | |
final public function templateBegin(string $template): static
{
$new = clone $this;
$new->templateBegin = $template;
return $new;
}
| public Yiisoft\Form\Field\Date templateEnd ( string $template ) | ||
| $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 Yiisoft\Form\Field\Date token ( string $token, string|\Stringable $value ) | ||
| $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 Yiisoft\Form\Field\Date tokens ( array $tokens ) | ||
| $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 Yiisoft\Form\Field\Date useContainer ( boolean $use ) | ||
| $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 self validClass ( string|null $class ) | ||
| $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 self validationRulesEnricher ( Yiisoft\Form\ValidationRulesEnricherInterface|null $enricher ) | ||
| $enricher | Yiisoft\Form\ValidationRulesEnricherInterface|null | |
public function validationRulesEnricher(?ValidationRulesEnricherInterface $enricher): self
{
$new = clone $this;
$new->validationRulesEnricher = $enricher;
return $new;
}
| public Yiisoft\Form\Field\Date value ( mixed $value ) | ||
| $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.