Via Composer:
$ composer require nepada/email-address-inputextensions:
- Nepada\Bridges\EmailAddressInputDI\EmailAddressInputExtensionIt will register extension method addEmailAddress($name, $label, $caseSensitive = false) to Nette\Forms\Container.
You can also use EmailAddressInputMixin trait in your base form/container class to add method addEmailAddress($name, $label, $caseSensitive = false).
Example:
trait FormControls
{
use Nepada\Bridges\EmailAddressInputForms\EmailAddressInputMixin;
public function addContainer($name)
{
$control = new Container;
$control->setCurrentGroup($this->getCurrentGroup());
if ($this->currentGroup !== null) {
$this->currentGroup->add($control);
}
return $this[$name] = $control;
}
}
class Container extends Nette\Forms\Container
{
use FormControls;
}
class Form extends Nette\Forms\Form
{
use FormControls;
}EmailAddressInput is form control that uses email address value object to represent its value (see nepada/email-address for further details).
It automatically validates the user input and getValue() method always returns EmailAddress instance, or null if the input is not filled.
$emailAddressInput = $form->addEmailAddress('E-mail');
// set value using EmailAddress value object
$emailAddressInput->setValue(CaseInsensitiveEmailAddress::fromString('example@example.com'));
// set value using string with a valid email address (it is internally converted to EmailAddress value object)
$emailAddressInput->setValue('example@example.com');
// Get EmailAddress instance for example@example.com
$emailAddressInput->getValue();
// InvalidEmailAddressException is thrown
$emailAddressInput->setValue('42');By default the input returns instance of CaseInsensitiveEmailAddress, i.e. the value object that treats the whole email address as case insensitive.
You can change this behaviour by calling EmailAddressInput::setCaseSensitive(true), or by passing $caseSensitive = true when creating the input. With enabled case sensitivity the input's value will be represented as RfcEmailAddress instance.
For further details see the readme of nepada/email-address.
