tecnocen/yii2-formgenerator

Yii 2 Library to configure form generator

Tecnocen Form Generator

Library to dynamically generate forms in database., _(*1)

, _(*2)

Travis , _(*3)

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., _(*4)

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., _(*5)

### Installation

You can use composer to install the library tecnocen/yii2-formgenerator by running the command;, _(*6)

composer require tecnocen/yii2-formgenerator, _(*7)

or edit the composer.json file, _(*8)

require: {
    "tecnocen/yii2-formgenerator": "*",
}

Deployment

Then run the required migrations, _(*9)

php yii migrate/up -p=@tecnocen/formgenerator/migrations/tables, _(*10)

Which will install the following table structure, _(*11)

, _(*12)

#### 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., _(*13)

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., _(*14)

• 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., _(*15)

Alternatively you can add the resource routes to your existing version., _(*16)

Running the tests

This library contains tools to set up a testing environment using composer scripts, for more information see Testing Environment section., _(*17)

Break down into end to end tests

Once testing environment is setup, run the following commands., _(*18)

composer deploy-tests

Run tests., _(*19)

composer run-tests

Run tests with coverage., _(*20)

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., _(*21)

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., _(*22)

Use Cases

TO DO, _(*23)

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., _(*24)

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us., _(*25)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*26)

Considering SemVer for versioning rules 9, 10 and 11 talk about pre-releases, they will not be used within the Tecnocen-com., _(*27)

Authors

• Angel Guevara - Initial work - Tecnocen.com
• Carlos Llamosas - Initial work - Tecnocen.com

See also the list of contributors who participated in this project., _(*28)

License

This project is licensed under the MIT License - see the LICENSE.md file for details, _(*29)

Acknowledgments

• TO DO - Hat tip to anyone who's code was used
• TO DO - Inspiration
• TO DO - etc

, _(*30)