tecnocen / yii2-formgenerator
Yii 2 Library to configure form generator
Installs: 5 744
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 8
Forks: 5
Open Issues: 3
Type:yii2-extension
Requires
- php: ^7.1
- tecnocen/yii2-rmdb: *
- tecnocen/yii2-roa: ~0.5.0
- yiisoft/yii2: ~2.0.21
Requires (Dev)
- codeception/base: ^2.2.11
- codeception/verify: ~1.0.0
- flow/jsonpath: ~0.3
- phpunit/php-code-coverage: 5.3.*
- yiisoft/yii2-debug: *
README
Library to dynamically generate forms in database.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
- Install PHP 7.1 or higher
- Composer Installed
The rest of the requirements are checked by composer when installing the repository on the next step.
Installation
You can use composer to install the library tecnocen/yii2-formgenerator
by running
the command;
composer require tecnocen/yii2-formgenerator
or edit the composer.json
file
require: { "tecnocen/yii2-formgenerator": "*", }
Deployment
Then run the required migrations
php yii migrate/up -p=@tecnocen/formgenerator/migrations/tables
Which will install the following table structure
ROA Backend Usage
The ROA support is very simple and can be done by just adding a module version to the api container which will be used to hold the resources.
class Api extends \tecnocen\roa\modules\ApiContainer { $versions = [ // other versions 'fg1' => ['class' => 'tecnocen\formgenerator\roa\modules\Version'], ]; }
You can then access the module to check the available resources.
- data-type
- field
- field/<field_id:\d+>/rule
- field/<field_id:\d+>/rule/<rule_id:\d+>/property
- form
- form/<form_id:\d+>/section
- form/<form_id:\d+>/section/<section_id:\d+>/field
- form/<form_id:\d+>/solicitude
- form/<form_id:\d+>/solicitude/<solicitude_id:\d+>/value
Which will implement CRUD functionalities for a formgenerator.
Alternatively you can add the resource routes to your existing version.
Running the tests
This library contains tools to set up a testing environment using composer scripts, for more information see Testing Environment section.
Break down into end to end tests
Once testing environment is setup, run the following commands.
composer deploy-tests
Run tests.
composer run-tests
Run tests with coverage.
composer run-coverage
Live Demo
You can run a live demo on a freshly installed project to help you run testing or understand the responses returned by the server. The live demo is initialized with the command.
php -S localhost:8000 -t tests/_app
Where :8000
is the port number which can be changed. This allows you call ROA
services on a browser or REST client.
Use Cases
TO DO
Built With
- Yii 2: The Fast, Secure and Professional PHP Framework http://www.yiiframework.com
Code of Conduct
Please read CODE_OF_CONDUCT.md for details on our code of conduct.
Contributing
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Considering SemVer for versioning rules 9, 10 and 11 talk about pre-releases, they will not be used within the Tecnocen-com.
Authors
- Angel Guevara - Initial work - Tecnocen.com
- Carlos Llamosas - Initial work - Tecnocen.com
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- TO DO - Hat tip to anyone who's code was used
- TO DO - Inspiration
- TO DO - etc