186 lines
5.8 KiB
PHP
186 lines
5.8 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Form;
|
|
|
|
use Symfony\Component\Form\Extension\Core\CoreExtension;
|
|
|
|
/**
|
|
* Entry point of the Form component.
|
|
*
|
|
* Use this class to conveniently create new form factories:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\Form\Forms;
|
|
*
|
|
* $formFactory = Forms::createFormFactory();
|
|
*
|
|
* $form = $formFactory->createBuilder()
|
|
* ->add('firstName', 'text')
|
|
* ->add('lastName', 'text')
|
|
* ->add('age', 'integer')
|
|
* ->add('gender', 'choice', array(
|
|
* 'choices' => array('m' => 'Male', 'f' => 'Female'),
|
|
* ))
|
|
* ->getForm();
|
|
* </code>
|
|
*
|
|
* You can also add custom extensions to the form factory:
|
|
*
|
|
* <code>
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new AcmeExtension())
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* If you create custom form types or type extensions, it is
|
|
* generally recommended to create your own extensions that lazily
|
|
* load these types and type extensions. In projects where performance
|
|
* does not matter that much, you can also pass them directly to the
|
|
* form factory:
|
|
*
|
|
* <code>
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addType(new PersonType())
|
|
* ->addType(new PhoneNumberType())
|
|
* ->addTypeExtension(new FormTypeHelpTextExtension())
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* Support for CSRF protection is provided by the CsrfExtension.
|
|
* This extension needs a CSRF provider with a strong secret
|
|
* (e.g. a 20 character long random string). The default
|
|
* implementation for this is DefaultCsrfProvider:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\Form\Extension\Csrf\CsrfExtension;
|
|
* use Symfony\Component\Form\Extension\Csrf\CsrfProvider\DefaultCsrfProvider;
|
|
*
|
|
* $secret = 'V8a5Z97e...';
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new CsrfExtension(new DefaultCsrfProvider($secret)))
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* Support for the HttpFoundation is provided by the
|
|
* HttpFoundationExtension. You are also advised to load the CSRF
|
|
* extension with the driver for HttpFoundation's Session class:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\HttpFoundation\Session\Session;
|
|
* use Symfony\Component\Form\Extension\HttpFoundation\HttpFoundationExtension;
|
|
* use Symfony\Component\Form\Extension\Csrf\CsrfExtension;
|
|
* use Symfony\Component\Form\Extension\Csrf\CsrfProvider\SessionCsrfProvider;
|
|
*
|
|
* $session = new Session();
|
|
* $secret = 'V8a5Z97e...';
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new HttpFoundationExtension())
|
|
* ->addExtension(new CsrfExtension(new SessionCsrfProvider($session, $secret)))
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* Support for the Validator component is provided by ValidatorExtension.
|
|
* This extension needs a validator object to function properly:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\Validator\Validation;
|
|
* use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
|
|
*
|
|
* $validator = Validation::createValidator();
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new ValidatorExtension($validator))
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* Support for the Templating component is provided by TemplatingExtension.
|
|
* This extension needs a PhpEngine object for rendering forms. As second
|
|
* argument you should pass the names of the default themes. Here is an
|
|
* example for using the default layout with "<div>" tags:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
|
|
*
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new TemplatingExtension($engine, null, array(
|
|
* 'FrameworkBundle:Form',
|
|
* )))
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* The next example shows how to include the "<table>" layout:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
|
|
*
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new TemplatingExtension($engine, null, array(
|
|
* 'FrameworkBundle:Form',
|
|
* 'FrameworkBundle:FormTable',
|
|
* )))
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* If you also loaded the CsrfExtension, you should pass the CSRF provider
|
|
* to the extension so that you can render CSRF tokens in your templates
|
|
* more easily:
|
|
*
|
|
* <code>
|
|
* use Symfony\Component\Form\Extension\Csrf\CsrfExtension;
|
|
* use Symfony\Component\Form\Extension\Csrf\CsrfProvider\DefaultCsrfProvider;
|
|
* use Symfony\Component\Form\Extension\Templating\TemplatingExtension;
|
|
*
|
|
*
|
|
* $secret = 'V8a5Z97e...';
|
|
* $csrfProvider = new DefaultCsrfProvider($secret);
|
|
* $formFactory = Forms::createFormFactoryBuilder()
|
|
* ->addExtension(new CsrfExtension($csrfProvider))
|
|
* ->addExtension(new TemplatingExtension($engine, $csrfProvider, array(
|
|
* 'FrameworkBundle:Form',
|
|
* )))
|
|
* ->getFormFactory();
|
|
* </code>
|
|
*
|
|
* @author Bernhard Schussek <bschussek@gmail.com>
|
|
*/
|
|
final class Forms
|
|
{
|
|
/**
|
|
* Creates a form factory with the default configuration.
|
|
*
|
|
* @return FormFactoryInterface The form factory.
|
|
*/
|
|
public static function createFormFactory()
|
|
{
|
|
return self::createFormFactoryBuilder()->getFormFactory();
|
|
}
|
|
|
|
/**
|
|
* Creates a form factory builder with the default configuration.
|
|
*
|
|
* @return FormFactoryBuilderInterface The form factory builder.
|
|
*/
|
|
public static function createFormFactoryBuilder()
|
|
{
|
|
$builder = new FormFactoryBuilder();
|
|
$builder->addExtension(new CoreExtension());
|
|
|
|
return $builder;
|
|
}
|
|
|
|
/**
|
|
* This class cannot be instantiated.
|
|
*/
|
|
private function __construct()
|
|
{
|
|
}
|
|
}
|