kingsquare/json-schema-form

A framework-agnostic PHP Implementation for generating simple forms based on json-schema

Installs: 13

Dependents: 0

Stars: 5

Watchers: 4

Language: PHP

0.6 2014-07-10 12:27 UTC

README

A framework-agnostic PHP Implementation for generating simple forms based on json-schema . This package is compatible with version 4 and may be combined with

Installation

Library

$ wget http://getcomposer.org/composer.phar
$ php composer.phar install --save kingsquare/json-schema-forms

Usage

<?php

// Get the schema and data as objects
$retriever = new JsonSchema\Uri\UriRetriever;
$schema = $retriever->retrieve('file://' . realpath('schema.json'));

// Generate
$formGenerator = new JsonSchemaForm\Generator($schema);
echo $formGenerator->render();
?>

See examples folder for a few more options.

Extra styling and JavaScript is required for proper presentation and validation.

Process form data

To validate any data in the form against the schema, the form data should be casted to the proper datatypes. Validation of form data may look like

<?php
$validator = new JsonSchema\Validator();
$dataParser = new JsonSchemaForm\DataParser();

//cast any posted form-data (strings) to the proper data-types
$data = $dataParser->parse($_POST['root'], $schema);

$validator->check($data, $this->schema);

$message = "The supplied JSON validates against the schema.\n";
if (!$validator->isValid()) {
    $message = "JSON does not validate. Violations:\n";
    foreach ($validator->getErrors() as $error) {
        $message .= print_r($error, true);
    }
}
echo $message;

Running the tests

$ phpunit