Skip to main content

FormLabel


  • Full name: \TwbsHelper\Form\View\Helper\FormLabel
  • Parent class: FormLabel

Properties

requiredFormat

protected string $requiredFormat

Methods

__invoke

Generate a form label, optionally with content

public __invoke(\Laminas\Form\ElementInterface $element = null, null|string $labelContent = null, string $position = null): string|\TwbsHelper\Form\View\Helper\FormLabel

Always generates a "for" statement, as we cannot assume the form input will be provided in the $labelContent.

Parameters:

ParameterTypeDescription
$element\Laminas\Form\ElementInterface
$labelContentnull|string
$positionstring

renderPartial

Render element's label

public renderPartial(\Laminas\Form\ElementInterface $element): string

Parameters:

ParameterTypeDescription
$element\Laminas\Form\ElementInterface

prepareLabelAttributes

protected prepareLabelAttributes(\Laminas\Form\ElementInterface $element): iterable

Parameters:

ParameterTypeDescription
$element\Laminas\Form\ElementInterface

getLabelClasses

protected getLabelClasses(\Laminas\Form\ElementInterface $element, \TwbsHelper\View\HtmlAttributesSet $labelAttributes): iterable

Parameters:

ParameterTypeDescription
$element\Laminas\Form\ElementInterface
$labelAttributes\TwbsHelper\View\HtmlAttributesSet

Inherited methods

prepareAttributes

protected prepareAttributes(array $attributes): array

Parameters:

ParameterTypeDescription
$attributesarray

setClassesToElement

protected setClassesToElement(\Laminas\Form\ElementInterface $element, iterable $addClasses = [], iterable $removeClasses = []): \Laminas\Form\ElementInterface

Parameters:

ParameterTypeDescription
$element\Laminas\Form\ElementInterface
$addClassesiterable
$removeClassesiterable