mvccore / ext-modelform
MvcCore - Extension - ModelForm - extension to build forms by decorated model classes.
v5.2.5
2024-03-14 13:46 UTC
Requires
- php: >=5.4.0
- mvccore/ext-form: ^5.2.20
- mvccore/ext-model-db: ^5.2.22
- mvccore/mvccore: ^5.2.33
Suggests
- mvccore/ext-cache-*: MvcCore cache extensions to speed up operations driven by class anotations.
- mvccore/ext-form-field-button: MvcCore form extension with button fields and input submit fields.
- mvccore/ext-form-field-date: MvcCore form extension with input field types date, datetime, time, week and month.
- mvccore/ext-form-field-numeric: MvcCore form extension with input field types number and range.
- mvccore/ext-form-field-selection: MvcCore form extension with fields select, country select, checkbox(es) and radios.
- mvccore/ext-form-field-special: MvcCore form extension with input type file and color.
- mvccore/ext-form-field-text: MvcCore form extension with input field types text, email, password, search, tel, url and textarea field.
- mvccore/ext-form-validator-special: MvcCore form extension with special text and numeric validators.
- dev-master
- v5.2.5
- v5.2.4
- v5.2.3
- v5.2.2
- v5.2.1
- v5.2.0
- v5.1.35
- v5.1.34
- v5.1.33
- v5.1.32
- v5.1.31
- v5.1.30
- v5.1.29
- v5.1.28
- v5.1.27
- v5.1.26
- v5.1.25
- v5.1.24
- v5.1.23
- v5.1.22
- v5.1.21
- v5.1.20
- v5.1.19
- v5.1.18
- v5.1.17
- v5.1.16
- v5.1.15
- v5.1.14
- v5.1.13
- v5.1.12
- v5.1.11
- v5.1.10
- v5.1.9
- v5.1.8
- v5.1.7
- v5.1.6
- v5.1.5
- v5.1.4
- v5.1.3
- v5.1.2
This package is auto-updated.
Last update: 2024-10-09 14:47:29 UTC
README
MvcCore form extension to build forms by decorated model classes.
Installation
composer require mvccore/ext-modelform
Features
- Simply creating form instance with fields by decorated model properties
without extending\MvcCore\Ext\Form
or \MvcCore\Ext\ModelForms\Form` class. - Possibility to get model properties metadata by
\MvcCore\Ext\ModelForms\IModel::GetFormsMetaData()
. - Model properties decoration by PHP 8+ attributes or by PHP Docs tags in older PHP versions.
- Possibility to decorate model property by any MvcCore form field with field options.
- Possibility to decorate options loader for fields with options like Select or other...
- Possibility to decorate model property by any MvcCore form validator(s) or by multiple validators with it's options.
- Possibility to decorate local validation method for any field, validation method
could be placed in form, controller or model as instance or static method, method context is configurable. - Possibility to extend model form or it's protected methods to customize fields initiatization.
Basic Example
PHP >= 8 With Attributes Decorations
Bootstrap.php
<?php namespace App; class Bootstrap { public static function Init (): \MvcCore\Application { // ... // PHP 8+ and Attributes anotations are not enabled by default: \MvcCore\Tool::SetAttributesAnotations(TRUE); // ... } }
Model Class
namespace App\Models; use \MvcCore\Ext\Models\Db\Attrs; #[Attrs\Table('cds')] class Album extends \MvcCore\Ext\Models\Db\Models\MySql { use \MvcCore\Ext\ModelForms\Models\Features; #[Attrs\Column('id_album'), Attrs\KeyPrimary] protected int $idAlbum; #[Attrs\Column('title'), Attrs\KeyUnique] #[Fields\Text([ 'label' => 'Title', 'maxLength' => 200, ])] protected string $title; #[Attrs\Column('interpret')] #[Fields\Text([ 'label' => 'Interpret', 'maxLength' => 200, ])] protected string $interpret; #[Attrs\Column('year')] #[Fields\Number([ 'label' => 'Year', 'min' => 1900, 'max' => 2030, ])] #[Validators\Clear] #[Validators\IntNumber] protected ?int $year; // ...getters and setters could be anything... public function GetIdAlbum (): int { return $this->idAlbum; } public static function GetById (int $id): ?static { return self::GetConnection() ->Prepare([ "SELECT c.* ", "FROM cds c ", "WHERE c.id_album = :id;", ]) ->FetchOne([':id' => $id]) ->ToInstance(static::class); } }
Controller Class
namespace App\Controllers; use App\Models; class CdCollection extends \MvcCore\Controller { protected ?\MvcCore\Ext\ModelForms\Form $form = NULL; protected ?\App\Models\Album $album = NULL; public function CreateAction (): void { $this->createForm(TRUE); $this->view->form = $this->form; } public function EditAction (): void { $this->initAlbumByParam(); $this->createForm(FALSE); $this->form->SetModelInstance($this->album); $this->view->form = $this->form; } public function SubmitCreateAction () { $this->createForm(TRUE); $this->submit(); } public function SubmitEditAction () { $this->initAlbumByParam(); $this->createForm(FALSE); $this->form->SetModelInstance($this->album); $this->submit(); } protected function initAlbumByParam () { $id = $this->GetParam('id', '[0-9]', NULL, 'int'); if ($id === NULL) throw new \Exception("Album not found."); $this->album = \App\Models\Album::GetById($id); } protected function submit () { $this->form->Submit(); $this->form->SubmittedRedirect(); } protected function createForm (bool $createNew): void { $this->form = new \MvcCore\Ext\ModelForms\Form; if ($createNew) { $this->form->SetAction($this->Url(':SubmitCreate')); $this->form->SetErrorUrl($this->Url(':Create')); } else { $urlParams = ['id' => $this->album->GetIdAlbum()]; $this->form->SetAction($this->Url(':SubmitEdit', $urlParams)); $this->form->SetErrorUrl($this->Url(':Edit', $urlParams)); } $this->form->SetSuccessUrl($this->Url(':Index')); } }
PHP < 8 With PHP Docs Decorations
Model Class
namespace App\Models; /** * @table cds */ class Album extends \MvcCore\Ext\Models\Db\Models\MySql { /** * @var int * @column idAlbum * @keyPrimary */ protected $idAlbum; /** * @var string * @column title * @keyUnique * @validator Text({ * "label" : "Title", * "maxLength": 200, * }) */ #[Fields\Text([ 'label' => 'Title', 'maxLength' => 200, ])] protected $title; /** * @var string * @column interpret * @validator Text({ * "label" : "Interpret", * "maxLength": 200, * }) */ protected $interpret; /** * @var ?int * @column year * @field Number({ * "label":"Year", * "min" :1900, * "max" :2030 * }) * @validator Clear, IntNumber */ protected $year = NULL; // ...getters and setters could be anything... /** @return int */ public function GetIdAlbum () { return $this->idAlbum; } /** * @param int $id * @return \App\Models\Album|NULL */ public static function GetById ($id) { return self::GetConnection() ->Prepare([ "SELECT c.* ", "FROM cds c ", "WHERE c.id_album = :id;", ]) ->FetchOne([':id' => $id]) ->ToInstance(static::class); } }