AbstractForm.md

AbstractForm

\WebServCo\Framework\AbstractForm

---

Examples

Implementation

filter and validate are called in the parent constructor, so make sure to do all initialization before calling it.

class MyForm extends \WebServCo\Framework\AbstractForm
{
    public function __construct($defaultData = [])
    {
        // custom code, before calling parent constructor

        parent::__construct(
            [
                'meta' => [
                    'name' => __('Name'),
                    'email' => __('Email address'),
                ],
                'required' => [
                    'name',
                    'email',
                ],
                'trim' => [
                    'name',
                    'email',
                ],
                'minimumLength' => [
                    'name' => 2,
                    'email' => 5,
                ],
            ], // settings
            $defaultData,
            ['submitFieldName1', 'submitFieldName2'] // submitFields
        );
    }

    protected function filter()
    {
        foreach ($this->setting('trim', []) as $item) {
            $this->setData($item, trim($this->data($item)));
        }
        foreach ($this->setting('filterNumeric', []) as $item) {
            $this->setData($item, preg_replace('/[^0-9]/', '', $this->data($item)));
        }
        foreach ($this->setting('numberFix', []) as $item) {
            $this->setData($item, floatval(str_replace(',', '.', $this->data($item))) ?: '');
        }
        return true;
    }

    public function validate()
    {
        foreach ($this->setting('required', []) as $item) {
            if (empty($this->data($item))) {
                $this->errors[$item][] = sprintf(__('This field is mandatory: %s'), $this->setting('meta/'.$item, ''));
            }
        }
        foreach ($this->setting('minimumLength', []) as $item => $minimumLength) {
            if (mb_strlen((string) $this->data($item)) < $minimumLength) {
                $this->errors[$item][] = sprintf(
                    __('This field is too short: %s'),
                    $this->setting('meta/'.$item, '')
                );
            }
        }
        if (!empty($this->errors)) {
            return false;
        }

        return true;
    }
}

Usage

$defaultData = [
    'name' => 'test',
    'email' => 'test@test.test',
];
$form = new MyForm($defaultData);
if ($form->isSent() && $form->isValid()) {
    // ok, go for processing

    // get the name of the submit field
    $submitField = $form->getSubmitField();
    // use a form field named "email"
    $email = $form->data('email');
}

Frontend

<form id="myForm" class="form " action="" method="post" enctype="multipart/form-data">
    <div class="form-group">
        <label for="email"><?=$form->meta('email')?></label>
        <input type="text" class="form-control<?=$form->errors('email')?' is-invalid':''?>"
            id="email" name="email" placeholder="<?=$form->meta('email')?>" aria-describedby="emailHelp"
            value="<?=$form->data('email')?>"<?=$form->required('email')?' required':''?>>
        <?php if ($form->errors('email')) { ?>
            <div class="invalid-feedback text-danger"><?=implode('<br>', $form->errors('email'))?></div>
        <?php } else { ?>
            <?php if ($form->help('email')) { ?>
                <small id="emailHelp" class="form-text text-muted"><?=$form->help('email')?></small>
            <?php } ?>
        <?php } ?>
    </div>
    <button type="submit" name="Submit">Submit</button>
</form>

---