Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berliozframework/form
Berlioz Form is a PHP library to manage your forms.
https://github.com/berliozframework/form
Last synced: about 1 month ago
JSON representation
Berlioz Form is a PHP library to manage your forms.
- Host: GitHub
- URL: https://github.com/berliozframework/form
- Owner: BerliozFramework
- License: mit
- Created: 2017-08-11T14:18:16.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-18T11:20:52.000Z (2 months ago)
- Last Synced: 2024-11-20T04:28:22.016Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 295 KB
- Stars: 2
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Berlioz Form
[](https://github.com/BerliozFramework/Form/releases)
[](https://github.com/BerliozFramework/Form/blob/main/LICENSE)
[](https://github.com/BerliozFramework/Form/actions/workflows/tests.yml?query=branch%3Amain)
[](https://app.codacy.com/gh/BerliozFramework/Form)
[](https://packagist.org/packages/BerliozFramework/Form)
**Berlioz Form** is a PHP library to manage your forms.
## Installation
### Composer
You can install **Berlioz Form** with [Composer](https://getcomposer.org/), it's the recommended installation.
```bash
$ composer require berlioz/form
```
### Dependencies
* **PHP** ^8.0
* Packages:
* **berlioz/helpers**
* **psr/http-message**
## Description
3 types of elements exists in **Berlioz Form**:
- `AbstractType`: it's a form control
- `Group`: represents an object in OOP
- `Collection`: represents a collection of AbstractType or Group
Input types available:
- `Button`
- `Checkbox`
- `Choice`
- `Date`
- `DateTime`
- `Email`
- `File`
- `Hidden`
- `Month`
- `Number`
- `Password`
- `Range`
- `Reset`
- `Search`
- `Submit`
- `Tel`
- `Text`
- `TextArea`
- `Time`
- `Url`
- `Week`
## Usage
### Form creation
Constructor of `Form` object accept 3 parameters:
- Name of form
- Mapped object
- Array of options
Example:
```php
$form = new Form('my_form', null, ['method' => 'post']);
```
### Declare form control
`add` method accept 3 parameters:
- Name of control (must be the same that the mapped element)
- Type (class name or object)
- Array of options
Options are different between controls.
Example:
```php
$form->add('my_control', Text::class, ['label' => 'My control']);
```
### Handle
**Berlioz Form** implements **PSR-7** (HTTP message interfaces). You must give the server request to the `handle`
method.
```php
$form = new Form('my_form', null, ['method' => 'post']);
// ...
$form->handle($request);
if ($form->isSubmitted() && $form->isValid()) {
// ...
}
```
### Group
Example for an postal address:
```php
$addressGroup = new Group(['type' => 'address']);
$addressGroup
->add('address', Text::class, ['label' => 'Address'])
->add(
'address_next',
Text::class,
['label' => 'Address (next)',
'required' => false]
)
->add('postal_code', Text::class, ['label' => 'Postal code'])
->add('city', Text::class, ['label' => 'City']);
$form->add('address', $addressGroup);
```
### Collection
Example for a list of addresses:
```php
// Create group
$addressGroup = new Group(['type' => 'address']);
$addressGroup
->add('address', Text::class, ['label' => 'Address'])
->add(
'address_next',
Text::class,
['label' => 'Address (next)',
'required' => false]
)
->add('postal_code', Text::class, ['label' => 'Postal code'])
->add('city', Text::class, ['label' => 'City']);
// Create collection
$collection = new Collection([
'prototype' => $addressGroup,
'data_type' => ArrayObject::class
]);
// Add collection to form
$form->add('addresses', $collection);
```