form-manager/form-manager

PHP-HTML form manager

Wednesday, September 27, 2017
by oscarotero
Repository
13 Watchers
76 Stars
9,561 Installations

PHP
8 Dependents
0 Suggesters
29 Forks
1 Open issues
62 Versions
2 % Grown

The README.md

Form Manager

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

Note: this is the documentation of FormManager 7.x

For v6.x version Click here, _(*2)

Installation:

This package requires PHP>=7.2 and is available on Packagist:, _(*3)

Supports symfony/validator v5, v6 and v7., _(*4)

composer require form-manager/form-manager

Create a field

FormManager is namespaced, but you only need to import a single class into your context:, _(*5)

use FormManager\Factory as F;

Use the imported factory to create all form elements:, _(*6)

// Create an input type="text" element
$name = F::text();

// Create the input with a label
$name = F::text('Please, introduce your name');

// Or with extra attributes
$name = F::text('Please, introduce your name', ['class' => 'name-field']);

// Add or remove attributes
$name->setAttribute('title', 'This is the name input');
$name->removeAttribute('class');
$name->setAttributes([
    'required',
    'readonly',
    'tabindex' => 2,
    'maxlength' => 50
]);

// Set the value
$name->setValue('MyName');

// Use magic properties to get/set/remove attributes
$name->class = 'name-field';
$name->required = false;
unset($name->readonly);

List of all available inputs:

All HTML5 field types are supported:, _(*7)

F::checkbox($label, $attributes)
F::color($label, $attributes)
F::date($label, $attributes)
F::datetimeLocal($label, $attributes)
F::email($label, $attributes)
F::file($label, $attributes)
F::hidden($value, $attributes)
F::month($label, $attributes)
F::number($label, $attributes)
F::password($label, $attributes)
F::radio($label, $attributes)
F::range($label, $attributes)
F::search($label, $attributes)
F::select($label, $options, $attributes)
F::submit($label, $attributes)
F::tel($label, $attributes)
F::text($label, $attributes)
F::textarea($label, $attributes)
F::time($label, $attributes)
F::url($label, $attributes)
F::week($label, $attributes)

Note that all inputs accepts the same arguments except hidden and select., _(*8)

Validation

This library uses internally symfony/validation to perform basic html5 validations and error reporting. HTML5 validation attributes like required, maxlength, minlength, pattern, etc are supported, in addition to intrinsic validations assigned to each input like email, url, date, etc., _(*9)

// Set global default error messages
F::setErrorMessages([
    'required' => 'The field is required'
    'maxlength' => 'The field is too long, it must have {{ limit }} characters or less',
]);

$email = F::email();

// Set per-fied error messages
$email->setErrorMessages([
    'email' => 'The email is not valid',
    'required' => 'The email is required',
    'maxlength' => 'The email is too long, it must have {{ limit }} characters or less',
]);

$email->setValue('invalid-email');

// Validate the value
if ($email->isValid()) {
    return true;
}

// Get the errors
$error = $email->getError();

// Print the first error message
echo $error;

// Iterate through all error messages
foreach ($error as $err) {
    echo $err->getMessage();
}

// And add more symfony constraints
$ip = F::text();
$ip->addConstraint(new Constraints\Ip());

See all supported constraints by symfony/validation., _(*10)

Translations

This package allows you to set your custom Validation instance with Factory::setValidator()., _(*11)

This allows you to use symfony/translations in order to have translations in place., _(*12)

composer require symfony/translations

$validator = Validation::createValidatorBuilder()
    ->setTranslator($translator)
    ->setTranslationDomain('validators')
    ->getValidator();

// Set validator
F::setValidator($validator);

See examples/translations.php to see the full example., _(*13)

Render html

$name = F::text('What is your name?', ['name' => 'name']);

echo $name;

```html What is your name? , _(*14)


Set a custom template using `{{ label }}` and `{{ input }}` placeholders:

```php
$name->setTemplate('{{ label }} <div class="input-content">{{ input }}</div>');
echo $name;

```html What is your name? , _(*15)


If you want to wrap the previous template in a custom html, use the `{{ template }}` placeholder:

```php
$name->setTemplate('<fieldset>{{ template }}</fieldset>');
echo $name;

```html , _(*16)

What is your name?


## Grouping fields

Group the fields to follow a specific data structure:

### Group

Groups allow to place a set of inputs under an specific name:

```php
$group = F::group([
    'name' => F::text('Username'),
    'email' => F::email('Email'),
    'password' => F::password('Password'),
]);

$group->setValue([
    'name' => 'oscar',
    'email' => 'oom@oscarotero.com',
    'password' => 'supersecret',
]);

Radio group

Special case for radios where all inputs share the same name with different values:, _(*17)

$radios = F::radioGroup([
    'red' => 'Red',
    'blue' => 'Blue',
    'green' => 'Green',
]);

$radios->setValue('blue');

If you need the radio group to be required, you should add the required attribute to at least one radio button:, _(*18)

$radios = F::radioGroup([
    'red' => F::radio('Red', ['required' => true]),
    'blue' => 'Blue',
    'green' => 'Green',
]);

Submit group

Special case to group several submit buttons under the same name but different values:, _(*19)

$buttons = F::submitGroup([
    'save' => 'Save the row',
    'duplicate' => 'Save as new row',
]);

$buttons->setName('action');

Group collection

Is a collection of values using the same group:, _(*20)

$groupCollection = F::groupCollection(
    f::group([
        'name' => F::text('Name'),
        'genre' => F::radioGroup([
            'm' => 'Male',
            'f' => 'Female',
            'o' => 'Other',
        ]),
    ])
]);

$groupCollection->setValue([
    [
        'name' => 'Oscar',
        'genre' => 'm'
    ],[
        'name' => 'Laura',
        'genre' => 'f'
    ],
])

Multiple group collection

Is a collection of values using various groups, using the field type to identify which group is used by each row:, _(*21)

$multipleGroupCollection = F::multipleGroupCollection(
    'text' => f::group([
        'type' => F::hidden(),
        'title' => F::text('Title'),
        'text' => F::textarea('Body'),
    ]),
    'image' => f::group([
        'type' => F::hidden(),
        'file' => F::file('Image file'),
        'alt' => F::text('Alt text'),
        'text' => F::textarea('Caption'),
    ]),
    'link' => f::group([
        'type' => F::hidden(),
        'text' => F::text('Link text'),
        'href' => F::url('Url'),
        'target' => F::select([
            '_blank' => 'New window',
            '_self' => 'The same window',
        ]),
    ]),
]);

$multipleGroupCollection->setValue([
    [
        'type' => 'text',
        'title' => 'Welcome to my page',
        'text' => 'I hope you like it',
    ],[
        'type' => 'image',
        'file' => 'avatar.jpg',
        'alt' => 'Image of mine',
        'text' => 'This is my photo',
    ],[
        'type' => 'link',
        'text' => 'Go to my webpage',
        'href' => 'https://oscarotero.com',
        'target' => '_self',
    ],
]);

Datalist

Datalists are also allowed, just use the createDatalist() method:, _(*22)

$input = F::search();

$datalist = $input->createDatalist([
    'female' => 'Female',
    'male' => 'Male'
]);

echo $input;
echo $datalist;

Forms

We need a form to put all this things together., _(*23)

$loginForm = F::form([
    'username' => F::text('User name'),
    'password' => F::password('Password'),
    '' => F::submit('Login'),
]);

$loginForm->setAttributes([
    'action' => 'login.php',
    'method' => 'post',
]);

// mLoad data from globals $_GET, $_POST, $_FILES
$loginForm->loadFromGlobals();

// Load data passing the arrays
$loginForm->loadFromArrays($_GET, $_POST, $_FILES);

// Or load from PSR-7 server request
$loginForm->loadFromServerRequest($serverRequest);

// Get loaded data
$data = $loginForm->getValue();

// Print the form
echo $loginForm;

// Access to specific inputs:
echo $loginForm->getOpeningTag();
echo '

Login:

';

echo $loginForm['username'];
echo '



';
echo $loginForm['password'];
echo '



';
echo $loginForm[''];
echo $loginForm->getClosingTag();

echo $loginForm->getOpeningTag();
echo '

Login:

';

//nIterate through all inputs
foreach ($loginForm as $input) {
    echo "

{$input}

";
}
echo $loginForm->getClosingTag();

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details., _(*24)

The MIT License (MIT). Please see LICENSE for more information., _(*25)

The Versions

27/09 2017

dev-master

9999999-dev https://github.com/oscarotero/form-manager

PHP-HTML form manager

library form-manager

PHP-HTML form manager

form-manager/form-manager

The README.md

Form Manager

Note: this is the documentation of FormManager 7.x

Installation:

Create a field

List of all available inputs:

Validation

Translations

Render html

Radio group

Submit group

Group collection

Multiple group collection

Datalist

Forms

Login:

Login:

The Versions

dev-master

The Requires

The Development Requires

by Oscar Otero

v5.1.3

The Requires

The Development Requires

by Oscar Otero

v5.1.2

The Requires

The Development Requires

by Oscar Otero

v5.1.1

The Requires

The Development Requires

by Oscar Otero

v5.1.0

The Requires

The Development Requires

by Oscar Otero

v5.0.4

The Requires

The Development Requires

by Oscar Otero

v5.0.3

The Requires

The Development Requires

by Oscar Otero

v5.0.2

The Requires

The Development Requires

by Oscar Otero

v5.0.1

The Requires

The Development Requires

by Oscar Otero

v5.0

The Requires

The Development Requires

by Oscar Otero

4.x-dev

The Requires

The Development Requires

by Oscar Otero

v4.7.3

The Requires

The Development Requires

by Oscar Otero

v4.7.2

The Requires

The Development Requires

by Oscar Otero

v4.7.1

The Requires

The Development Requires

by Oscar Otero

4.7.0

The Requires

The Development Requires