yiisoft/form

The package helps with implementing data entry forms.

dev-master / 1.0.x-dev 2023-11-30 08:26 UTC

Requires

• php: ^8.1
• ext-mbstring: *
• yiisoft/friendly-exception: ^1.0
• yiisoft/html: ^3.2
• yiisoft/http: ^1.2
• yiisoft/hydrator: dev-master
• yiisoft/hydrator-validator: dev-master
• yiisoft/strings: ^2.0
• yiisoft/validator: ^1.0
• yiisoft/widget: ^2.1

Requires (Dev)

• maglnet/composer-require-checker: ^4.2
• phpunit/phpunit: ^9.5
• rector/rector: ^0.18.3
• roave/infection-static-analysis-plugin: ^1.18
• spatie/phpunit-watcher: ^1.23
• vimeo/psalm: ^4.30|^5.6
• yiisoft/test-support: ^3.0

BSD-3-Clause

• form
• yii

README

Yii Form

The package helps with implementing data entry forms.

Requirements

• PHP 8.1 or higher.
• mbstring PHP extension.

Installation

The package could be installed with composer:

composer require yiisoft/form --prefer-dist

General usage

General topics:

• Creating Forms
• Fields Configuration
• Creating and Using Custom Fields

Fields available out of the box:

• Button
• ButtonGroup
• Checkbox
• CheckboxList
• Date
• DateTime
• DateTimeLocal
• Email
• ErrorSummary
• Fieldset
• File
• Hidden
• Image
• Number
• Password
• RadioList
• Range
• ResetButton
• Select
• SubmitButton
• Telephone
• Text
• Textarea
• Url

Field parts:

• Error
• Hint
• Label

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii Form is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates