Skip to content
Email address form input for Nette forms.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitattributes
.gitignore
.phpcs.xml.dist
.travis.yml
LICENSE.md
README.md
composer.json
phpstan.neon.dist
phpstan.tests.neon.dist

README.md

Email address form input

Build Status Coverage Status Downloads this Month Latest stable

Installation

Via Composer:

$ composer require nepada/email-address-input

Option A: install form container extension method via DI extension

extensions:
    - Nepada\Bridges\EmailAddressInputDI\EmailAddressInputExtension

It will register extension method addEmailAddress($name, $label) to Nette\Forms\Container.

Option B: use trait in your base form/container class

You can also use TEmailAddressInput trait in your base form/container class to add method addEmailAddress($name, $label).

Example:


trait TFormControls
{

    use Nepada\Bridges\EmailAddressInputForms\TEmailAddressInput;

    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 TFormControls;

}

class Form extends Nette\Forms\Form
{

    use TFormControls;

}

Usage

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(EmailAddress::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');
You can’t perform that action at this time.