README

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Install

Via Composer

$ composer require evista/formista

Usage

Simple form

To create a form, simply add a new class with any name that extends BaseForm class:

use Evista\Formista\ValueObject\FormField;
use Evista\Formista\Form\BaseForm;


class ExampleForm extends BaseForm
{
  //...
}

This class is not very useful without form elements. To add any field, for example a hidden input you have to implement a class method, called generateFields().

 public function generateFields(){
        // Name field
        $name = new FormField(FormField::TYPE_TEXT_INPUT);
        $name
            ->setName('name')
            ->setAttributes(['placeholder' => 'Minta János', 'id' => 'name']);
      
        $this->formFields['name'] = $name;
    }

Now your ExampleForm has an input field, called name. If you want do display the form, just use this class:

$form = new ExampleForm();

print '<input type="'.$form->getField('name')->getType().'" name="'.$form->getField('name')->getName().'" value="'.$form->getField('name')->getValue().'"/>';

After the user posts this to the server, you can rebuild the form the same way as before: ```php $form = new ExampleForm(); ``` But this time every field value will be populated with what the user sent. ```php $form->getField('name')->getValue() // Bálint ``` It’s not just more convenient but makes your code more readable and conceivable. But Fom API can do even more: you can set up validations; ```php // Phone $phone = new FormField(FormField::TYPE_TEXT_INPUT); $phone ->setName('phone') ->setAttributes(['placeholder' => '+36 30 111 2222', 'id' => 'phone']) ->setSanitizationCallback(function($value){ // only numbers, whitespaces and + return trim(preg_replace($this->phoneNumberPattern, '', $value)); }) ->setValidationCallback( function($value){ // Length constrain if(strlen($value)<5){ return 'Telephone number is not valid'; } // Regex constrain if(preg_match($this->phoneNumberPattern, $value)){ return 'Telephone number is not valid'; } // False means it's OK! return false; } ) ->setMandatory(true); $this->formFields['phone'] = $phone; ``` With setValidationCallback() method you can define a function that gets the submitted value as $value. Returning false means that there’s no problem with the submitted data. The form will run all validations on all input when you call the validate() method. ```php $form->validate(); ``` Any field can be set mandatory with the setMandatory() method.Validation is not automatic so don’t forget to call the validate() method. ```php $form = new ExampleForm(); if(count($errors = $form->validate()) > 0){ //something is wrong, the messages are in the $errors array } // It's valid yeah ``` You can set santitization callback which will be called autmoatically when you instantiate a form. Csrf protection is fully automatic also so you don’t need to do anything.

Ajax forms

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email sera.balint@e-vista.hu instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

evista / formista

Maintainers

Details