FlexModelBundle

, _(*1)

FlexModel integration for Symfony., _(*2)

Installation using Composer

Run the following command to add the package to the composer.json of your project:, _(*3)

``` bash $ composer require flexmodel/flexmodel-bundle, _(*4)


### Enable the bundle
Enable the bundle in the kernel:

``` php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FlexModel\FlexModelBundle\FlexModelBundle(),
        // ...
    );
}

Configure the bundle

Add the following configuration to your config.yml file:, _(*5)

``` yml, _(*6)

app/config/config.yml

flex_model: bundle_name: AppBundle # optional, defaults to 'AppBundle' resource: "%kernel.root_dir%/../src/AppBundle/Resources/config/flexmodel.xml", _(*7)


The `resource` should refer to the location of your FlexModel configuration file.


## Usage

### Generating Doctrine ORM mapping
Run the following command to generate Doctrine ORM mapping and entity classes from your FlexModel configuration:

``` bash
$ php bin/console flexmodel:generate

After generating the Doctrine ORM mapping you need to update your database schema:, _(*8)

``` bash $ php bin/console doctrine:schema:update --force, _(*9)


### Creating a Form
To create a form from a FlexModel form configuration you need to use the `FlexModelFormType` class.

The class will retrieve the form configuration based on the name of the entity and provided 'form_name' option.

``` php
// src/AppBundle/Controller/DefaultController.php

public function newAction()
{
    $entity = ...;
    $form = $this->createForm(FlexModelFormType::class, $entity, array(
        'form_name' => '',
    ));
}

For more information on creating forms, please see the Symfony documentation., _(*10)

File uploads

The FlexModelBundle provides support for file uploads within FlexModel forms., _(*11)

To activate this support you need to complete the following steps:, _(*12)

1. Configure the FlexModelBundle for file uploads

The bundle requires a location to store the file uploads. Configure the location with the existing FlexModelBundle configuration in your config.yml file:, _(*13)

``` yml, _(*14)

app/config/config.yml

flex_model: resource: "%kernel.root_dir%/../src/AppBundle/Resources/config/flexmodel.xml" file_upload_path: "%kernel.root_dir%/../../some-directory-outside-of-the-project/%kernel.environment%", _(*15)


#### 2. Modify your Doctrine entity class
To activate file uploads for a Doctrine entity you need to implement the `UploadObjectInterface` and add getters and setters for the form fields.

For ease of use the FlexModelBundle provides an `UploadTrait` to implement both the interface and the getters and setters:

``` php
namespace AppBundle\Entity;

use FlexModel\FlexModelBundle\Model\UploadObjectInterface;
use FlexModel\FlexModelBundle\Model\UploadTrait;

class Entity implements UploadObjectInterface
{
    use UploadTrait {
        getFileUpload as getImageUpload;
        setFileUpload as setImageUpload;
        getFileUpload as getAnotherImageUpload;
        setFileUpload as setAnotherImageUpload;
    }
}

In the above example you see the UploadTrait with getters and setters for two file upload fields implemented. Here the getImageUpload method maps to a FlexModel field called 'image' and getAnotherImageUpload maps to 'another_image'., _(*16)