idci / simple-metadata-bundle
Symfony SimpleMetadataBundle
Installs: 60 382
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 10
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=5.3.2
- doctrine/doctrine-bundle: ~1.2
- doctrine/orm: ~2.2,>=2.2.3
- jms/serializer-bundle: >=1.0
- symfony/framework-bundle: >=2.7
- twig/twig: ^1.0||^2.0
This package is auto-updated.
Last update: 2024-12-22 00:44:36 UTC
README
Symfony2 simple metadata bundle
Installation
To install this bundle please follow the next steps:
First add the dependency in your composer.json
file:
"require": { ..., "idci/simple-metadata-bundle": "dev-master" },
Then install the bundle with the command:
php composer update
Enable the bundle in your application kernel:
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( ... new IDCI\Bundle\SimpleMetadataBundle\IDCISimpleMetadataBundle(), ); }
Now import the bundle configuration in your app/config/config.yml
imports: ... - { resource: @IDCISimpleMetadataBundle/Resources/config/config.yml }
Now the Bundle is installed and configured.
How to use
OneToOne Relation with a metadata:
In your entity:
/** * @var Metadata * * @ORM\OneToOne(targetEntity="IDCI\Bundle\SimpleMetadataBundle\Entity\Metadata", cascade={"all"}) * @ORM\JoinColumn(name="metadata_id", referencedColumnName="id", onDelete="SET NULL", nullable=true) */ private $metadata;
In this entity form type:
public function buildForm(FormBuilderInterface $builder, array $options) { $builder ... ->add('metadata', 'related_to_one_metadata', array( 'data' => $builder->getData()->getMetadata() )) ... ; }
ManyToMany Relation with a metadata:
In your entity:
/** * @var array<Metadata> * * @ORM\ManyToMany(targetEntity="IDCI\Bundle\SimpleMetadataBundle\Entity\Metadata", cascade={"all"}) * @ORM\JoinTable(name="my_entity_metadata", * joinColumns={@ORM\JoinColumn(name="my_entity_id", referencedColumnName="id", onDelete="cascade")}, * inverseJoinColumns={@ORM\JoinColumn(name="metadata_id", referencedColumnName="id", unique=true, onDelete="cascade")} * ) */ private $metadatas;
In this entity form type:
public function buildForm(FormBuilderInterface $builder, array $options) { $builder ... ->add('metadatas', 'related_to_many_metadata') ... ; }
Without metadata entity relation:
In your entity:
/** * @var string * * @ORM\Column(name="metadata", type="textarea") */ private $metadata;
In this entity form type:
public function buildForm(FormBuilderInterface $builder, array $options) { $builder ... ->add('metadata', 'metadata') ... ; }
Advanced form usage
The metadata
form type accept a fields
options
ex:
$builder ... ->add('metadata', 'metadata', array( 'fields' => array( 'firstName' => array('text'), 'lastName' => array('text'), 'address' => array('text'), 'city' => array('text'), 'country' => array('text'), 'message' => array('textarea') ) )) ... ;
This bundle provide a json
form type which is realy usefull to store a json
(must be used on a Text mapped field).
Custom namespace
You can create your own namespace, without asking it in the form.
First declare them like this:
idci_simple_metadata: namespaces: [tags, features]
If you take a look at the container:debug
you will see that new form type are now available:
$ php app/console container:debug ... form.type.form.type.related_to_one_metadata_features container IDCI\Bundle\SimpleMetadataBundle\Form\Type\RelatedToOneMetadataType form.type.form.type.related_to_one_metadata_tags container IDCI\Bundle\SimpleMetadataBundle\Form\Type\RelatedToOneMetadataType form.type.related_to_many_metadata_features container IDCI\Bundle\SimpleMetadataBundle\Form\Type\RelatedToManyMetadataType form.type.related_to_many_metadata_tags container IDCI\Bundle\SimpleMetadataBundle\Form\Type\RelatedToManyMetadataType ...
simply use them in your form builder:
$builder ... ->add('features', 'related_to_many_metadata_features') ->add('tags', 'related_to_many_metadata_tags') ... ;