Download the PHP package apollo29/forms-engine without Composer

FormsEngine

Library to build forms on basis of Bootstrap 4 templates. This library includes customizable templates to use also other frameworks than Bootstrap, has multilanguage support and configurable ways to persist the form data.

• Install
• Usage
• Dependencies
• Configuration
  • set Prefix directory
  • get Configuration variable
• Translations
• Templates
• Option FormsEngine\Questions\Element\Option
• Elements FormsEngine\Questions\Element
  • Text, E-Mail, Number, Date, DateTime
  • Textarea
  • Hidden
  • Typeahead
  • Radio
  • RadioGroup
  • Checkbox
  • CheckboxGroup
  • Select
  • YesNo
  • Paragraph
  • Title
  • Button, Reset, Submit
• De-/Serialization of form definitions FormsEngine\Questions\Loader
• Pagination FormsEngine\Questions\Pagination
• API and Persistence FormsEngine\Answers\Persistence
  • CSV
  • E-Mail
  • JSON
  • JSONDB
  • MySQL
  • XLSX
  • Implement own Persistence

Install

Install using composer.

Usage

In your index.php you have to create a new FormsEngine instance first.

Then add some Elements to create your form, and render it.

Dependencies

A List of all Dependencies used by this Library.

CSS/JS

• bootstrap
• material
• jquery-typeahead
• Parsley.JS Input validation
• JOII (JavaScript Object Inheritance Implementation used for JS Objects of FormsEngine\Questions\Element

PHP

• twig/twig templating
• myclabs/php-enum
• phpcollection/phpcollection Sets, Sequences, Collections
• philipp15b/php-i18n i18n
• slim/slim RESTful
• nategood/httpful HTTP calls
• league/csv CSV
• rakibtg/sleekdb JSONDB
• phpmailer/phpmailer E-Mail
• phpoffice/phpspreadsheet Excel

Configuration

Set a session var with name configFile and the path and json-filename of your own config.json. See below the standardconfig.json as an example. If your happy with the standard config.json, you don't need to set the session var.

config.json

set Prefix directory

todo

get Configuration variable

todo

Translations

todo

Templates

todo

Option FormsEngine\Questions\Element\Option

Used for RadioGroup, CheckboxGroup, Typeahead and Select Elements.

Usage

Public Methods

• __construct() constructor
• add($label, $value, $selected = false) add values to Option Element
• addAll($options) add an Array of Option Elements
• all() get All Elements
• static create($label, $value, $selected = false) returns an Option Element
• serialize() get serialized Element for persistence, array with all attributes and values.
• static deserialize($object) deserialize Object to Element

Private Methods

• static camelCase($str, array $noStrip = []) get String camelCased, used for id

Elements FormsEngine\Questions\Element

All Elements are - mostly - standard HTML5 input fields and have the following methods:

Public Methods

• ___construct($label) when not otherwise stated, this is the default constructor
• serialize() get serialized Element for persistence, array with all attributes and values.
• prepare() see serialize()
• static deserialize($object) deserialize Object to Element
• toObjectVar($key, $value, $class = null) used to map an array to key/value of Element.
• script() get all JavaScript code to render.
• required() set Element as required
• readonly() set Element as readonly
• disabled() set Element as disabled
• inputmask($mask,$type = 'mask') set Inputmask (see Dependencies for further Documentation)
• addStyle($style)add additional CSS class
• attr($attr, $value) add attributes

Private Methods

• setId($id,$isName = false) set id and optional also name attribute
• setName($name) set name attribute
• static camelCase($str, array $noStrip = []) get String camelCased, used for setId and setName

Text, E-Mail, Number, Date, DateTime

Extends from Input

Usage

Template/HTML (type is different according to Element)

Public Methods

• __construct($label, $placeholder = null, $helptext = null) constructor
• render($twig) render Method for Twig Template Engine

Textarea

Extends from Input

Usage

Template/HTML

Public Methods

• __construct($label, $helptext = null) constructor
• render($twig) render Method for Twig Template Engine

Hidden

Extends from Element

Usage

Template/HTML

Public Methods

• __construct($id, $value = null) constructor
• render($twig) render Method for Twig Template Engine

Typeahead

Extends from Text

Usage, with Array

Usage, with Option. See Option for more information

Template/HTML

Public Methods

• __construct($label, $options, $placeholder = null, $helptext = null) constructor
• render($twig) render Method for Twig Template Engine

Radio

Extends from Element

Usage

Template/HTML

Public Methods

• __construct($label, $value, $name, $checked = false) constructor
• render($twig) render Method for Twig Template Engine

RadioGroup

Extends from Element

Usage, see Option for more information

Template/HTML

Public Methods

• __construct($label, $options, $name = null) constructor
• render($twig) render Method for Twig Template Engine

Checkbox

Extends from Element

Usage

Template/HTML

Public Methods

• __construct($label, $value, $checked = false) constructor
• render($twig) render Method for Twig Template Engine

CheckboxGroup

Extends from Element

Usage, see Option for more information

Template/HTML

Public Methods

• __construct($label, $options) constructor
• render($twig) render Method for Twig Template Engine
• elementKeys() all Option Keys

Select

Extends from Element

Usage, see Option for more information

Template/HTML

Public Methods

• __construct($label,$options,$nullable = false,$helptext = null) constructor
• render($twig) render Method for Twig Template Engine

YesNo

Renders a Yes/No Radio Element, with "Yes" / "No" or boolean values.

Extends from ElementGroup

Usage

Template/HTML, see Radio Element

Public Methods

• __construct($name, $booleans = false) constructor
• render($twig) render Method for Twig Template Engine

Paragraph

Extends from Element

Usage

Template/HTML

Public Methods

• __construct($title=null,$description=null) constructor
• render($twig) render Method for Twig Template Engine

Title

There is only one Title Element allowed per Form.

Extends from Paragraph

Usage

Template/HTML

Public Methods

• __construct($title,$description=null) constructor
• render($twig) render Method for Twig Template Engine

Button, Reset, Submit

See #26.

Extends from Element

Usage

Template/HTML

Public Methods

• __construct($label,$buttonType=null) constructor
• render($twig) render Method for Twig Template Engine

De-/Serialization of form definitions FormsEngine\Questions\Loader

todo

Pagination FormsEngine\Questions\Pagination

todo

API and Persistence FormsEngine\Answers\Persistence

todo

CSV

E-Mail

JSON

JSONDB

MySQL

XLSX

Implement own Persistence