|
1 | 1 | # Stepped Form for Laravel & Lumen |
2 | 2 |
|
| 3 | +[](https://github.com/lexalium/laravel-stepped-form/actions/workflows/tests.yml) |
| 4 | + |
3 | 5 | The package is based on the |
4 | | -[HTTP Stepped Form](https://github.com/alexxxxkkk/http-stepped-form) |
| 6 | +[HTTP Stepped Form](https://github.com/lexalium/http-stepped-form) |
5 | 7 | and built for the Laravel & Lumen framework. |
6 | 8 |
|
| 9 | +<a id="readme-top" mame="readme-top"></a> |
| 10 | + |
| 11 | +Table of Contents |
| 12 | + |
| 13 | +1. [Requirements](#requirements) |
| 14 | +2. [Installation](#installation) |
| 15 | +3. [Configuration](#configuration) |
| 16 | + - [Publish the config](#publish-the-config) |
| 17 | + - [Available config options](#available-config-options) |
| 18 | +4. [Usage](#usage) |
| 19 | +5. [License](#license) |
| 20 | + |
7 | 21 | ## Requirements |
8 | 22 |
|
9 | | -**PHP:** ^8.0 |
| 23 | +**PHP:** >=8.1 |
| 24 | + |
| 25 | +**Laravel:** ^9.0 || ^10.0 |
| 26 | + |
| 27 | +## Installation |
| 28 | + |
| 29 | +Via Composer |
| 30 | + |
| 31 | +``` |
| 32 | +composer require lexal/laravel-stepped-form |
| 33 | +``` |
| 34 | + |
| 35 | +### Additional changes for Lumen framework |
| 36 | + |
| 37 | +Add the following snippet to the `bootstrap/app.php` file under the providers section as follows: |
| 38 | + |
| 39 | +```php |
| 40 | +$app->register(Lexal\LaravelSteppedForm\ServiceProvider\ServiceProvider::class); |
| 41 | +``` |
| 42 | + |
| 43 | +<div style="text-align: right">(<a href="#readme-top">back to top</a>)</div> |
| 44 | + |
| 45 | +## Configuration |
| 46 | + |
| 47 | +### Publish the config |
| 48 | + |
| 49 | +Run the following command to publish the package config file: |
| 50 | + |
| 51 | +```shell |
| 52 | +php artisan vendor:publish --provider="Lexal\LaravelSteppedForm\ServiceProvider\ServiceProvider" |
| 53 | +``` |
| 54 | + |
| 55 | +### Available config options |
| 56 | + |
| 57 | +The configuration file `config/stepped-form.php` has the following options: |
| 58 | + |
| 59 | +1. `renderer` - contains Renderer class, instance or service alias that will translate step's template definition |
| 60 | + to the response. Must implement RendererInterface; |
| 61 | +2. `redirector` - contains Redirector class, instance or service alias that will redirect user between different |
| 62 | + steps. Must implement RedirectorInterface; |
| 63 | +3. `entity_copy` - contains Entity Copy class, instance or service alias that will clone entity of the given step. |
| 64 | + Must implement EntityCopyInterface; |
| 65 | +4. `event_dispatcher` - contains Event Dispatcher class, instance or service alias that will dispatch form events. |
| 66 | + Must implement EventDispatcherInterface; |
| 67 | +5. `exception_normalizers` - contains exception normalizers that the form will use to normalize SteppedFormException |
| 68 | + into the Response instance. Read more about them in the [HTTP Stepped Form](https://github.com/lexalium/http-stepped-form#exception-normalizers) |
| 69 | + docs; |
| 70 | +6. `forms` - contains array of all application forms definitions. Form definition must have builder class |
| 71 | + for dynamic forms or array of steps for the static forms, settings class and storage where the form will store data. |
| 72 | + |
| 73 | +<div style="text-align: right">(<a href="#readme-top">back to top</a>)</div> |
| 74 | + |
| 75 | +## Usage |
| 76 | + |
| 77 | +1. [Publish configuration file](#publish-the-config). |
| 78 | +2. Replace with custom implementation of redirector, renderer and entity copy if necessary. Add custom exception |
| 79 | + normalizers if necessary. |
| 80 | +3. Declare your form settings. |
| 81 | + ```php |
| 82 | + use Lexal\HttpSteppedForm\Settings\FormSettingsInterface; |
| 83 | + use Lexal\SteppedForm\Step\StepKey; |
| 84 | + |
| 85 | + final class FormSettings implements FormSettingsInterface |
| 86 | + { |
| 87 | + public function getStepUrl(StepKey $key): string |
| 88 | + { |
| 89 | + // return step URL |
| 90 | + } |
| 91 | + |
| 92 | + public function getUrlBeforeStart(): string |
| 93 | + { |
| 94 | + // returns a URL to redirect to when there is no previously renderable step |
| 95 | + } |
| 96 | + |
| 97 | + public function getUrlAfterFinish(): string |
| 98 | + { |
| 99 | + // return a URL to redirect to when the form was finishing |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + $formSettings = new FormSettings(); |
| 104 | + ``` |
| 105 | + |
| 106 | +4. Add forms definitions. |
| 107 | + - Static form |
| 108 | + ```php |
| 109 | + return [ |
| 110 | + // ... |
| 111 | + |
| 112 | + 'forms' => [ |
| 113 | + 'customer' => [ |
| 114 | + 'steps' => [ |
| 115 | + 'customer' => CustomerStep::class, |
| 116 | + 'broker' => BrokerStep::class, |
| 117 | + 'confirmation' => ConfirmationStep::class, |
| 118 | + // other steps |
| 119 | + ], |
| 120 | + 'settings_class' => FormSettings::class, |
| 121 | + 'storage' => SessionStorage::class, |
| 122 | + 'session_storage' => SessionSessionKeyStorage::class, |
| 123 | + ], |
| 124 | + ], |
| 125 | + |
| 126 | + // ... |
| 127 | + ]; |
| 128 | + ``` |
| 129 | + - Dynamic form |
| 130 | + ```php |
| 131 | + return [ |
| 132 | + // ... |
| 133 | + |
| 134 | + 'forms' => [ |
| 135 | + 'customer' => [ |
| 136 | + 'builder_class' => CustomBuilder::class, |
| 137 | + 'settings_class' => FormSettings::class, |
| 138 | + 'storage' => SessionStorage::class, |
| 139 | + 'session_storage' => SessionSessionKeyStorage::class, |
| 140 | + ], |
| 141 | + ], |
| 142 | + |
| 143 | + // ... |
| 144 | + ]; |
| 145 | + ``` |
| 146 | + |
| 147 | +5. Use Stepped Form in you controller. Stepped Form will have service alias as "stepped-form." + form key form |
| 148 | + configuration. |
| 149 | + |
| 150 | + **ServiceProvider.php** |
| 151 | + ```php |
| 152 | + use Lexal\HttpSteppedForm\SteppedFormInterface; |
| 153 | + |
| 154 | + $this->app->when(CustomerController::class) |
| 155 | + ->needs(SteppedFormInterface::class) |
| 156 | + ->give('stepped-form.customer'); |
| 157 | + ``` |
| 158 | + |
| 159 | + **CustomerController.php** |
| 160 | + ```php |
| 161 | + use Lexal\HttpSteppedForm\SteppedFormInterface; |
| 162 | + |
| 163 | + final class CustomerController |
| 164 | + { |
| 165 | + public function __construct(private readonly SteppedFormInterface $form) |
| 166 | + { |
| 167 | + } |
| 168 | + |
| 169 | + // POST /customers |
| 170 | + public function start(): Response |
| 171 | + { |
| 172 | + return $this->form->start(new Customer(), /* nothing or customer id to split different sessions */); |
| 173 | + } |
| 174 | + |
| 175 | + // GET /customers/step/{step-key} |
| 176 | + public function render(string $key): Response |
| 177 | + { |
| 178 | + return $this->form->render($key); |
| 179 | + } |
10 | 180 |
|
11 | | -**Laravel:** ^8.0 || ^9.0 || ^10.0 |
| 181 | + // POST /customers/step/{step-key} |
| 182 | + public function handle(Request $request, string $key): Response |
| 183 | + { |
| 184 | + return $this->form->handle($key, $request); |
| 185 | + } |
12 | 186 |
|
13 | | -## Resources |
| 187 | + // POST /customers/cansel |
| 188 | + public function cancel(): Response |
| 189 | + { |
| 190 | + return $this->form->cancel(route('customer.index')); |
| 191 | + } |
| 192 | + } |
| 193 | + ``` |
14 | 194 |
|
15 | | -1. [Installation](docs/INSTALLATION.md). |
16 | | -2. [Configuration](docs/CONFIGURATION.md). |
| 195 | +See configuration file for more information. |
17 | 196 |
|
18 | | ---- |
| 197 | +<div style="text-align: right">(<a href="#readme-top">back to top</a>)</div> |
19 | 198 |
|
20 | 199 | ## License |
21 | 200 |
|
22 | | -Laravel & Lumen Stepped Form is licensed under the MIT License. See |
23 | | -[LICENSE](LICENSE) for the full license text. |
| 201 | +Laravel & Lumen Stepped Form is licensed under the MIT License. See [LICENSE](LICENSE) for the full license text. |
0 commit comments