README

Thank you for your interest in Formagic. The source files within are subject to the new BSD license that is bundled with this package in the file LICENSE.

SYSTEM REQUIREMENTS

There are not many requirements for using Formagic, PHP 5.1 and above will do (PHP 4 is not supported). Formagic will run with any php.ini settings. It is designed to run without errors or warnings down to E_STRICT level.

INSTALLATION

The easiest way to include Formagic into your project is using Composer. This will download the necessary sources and create the autoloader for you, so you can just start using Formagic without further ado.

{
    "require": {
        "formagic/formagic": "1.5.6"
    }
}

You can also just unpack the ZIP-File you can download at GitHub into a directory of your choice and include the Formagic autoloader in your code:

<?php
require_once '/path/to/formagic/src/Formagic/Autoloader/Autoloader.php';
Formagic_Autoloader::register();

USAGE

Please visit http://www.formagic-php.net for examples and How-Tos. Here is a very short example of Formagic to get you started:

<?php

$form = new Formagic();
$form
    ->addItem(
        'input', 
        'myInput', 
        array(
            'label' => 'My first input',
            'rules' => 'mandatory'
            )
        )
    ->addItem(
        'submit', 
        'mySubmit', 
        array(
            'label' => 'Send'
        )
    );

// check if form only contains valid values
if ($form->validate()) {
    echo "submitted and ok<br />";
    $form->setReadonly(true);
}

// displays the form
echo $form->render();

Of course there is much more to Formagic than this, but this will get you a picture how easy it is to create HTML forms with Formagic.

API DOCUMENTATION

The API documentation is created using phpDocumentor. You will find the current API documentation here: http://www.formagic-php.net/docs/api/

FORMAGIC LINKS

You will find the official Formagic project site here: http://www.formagic-php.net