The DoctrineSetTypeBundle provides MySQL SET type support for Doctrine in your Symfony application.
MIT License
The DoctrineSetTypeBundle
provides support MySQL SET type for Doctrine2 in your Symfony2 or Symfony3 application.
Using composer
$ composer require raksul/doctrine-set-type-bundle "1.0.0"
Then, enable the bundle by adding the following line in the app/AppKernel.php
file of your project:
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new Raksul\DoctrineSetTypeBundle\RaksulDoctrineSetTypeBundle(),
);
// ...
}
// ...
}
In order to use MySQL SET type, Add the following line in the app/config/confing.yml
doctrine:
dbal:
mapping_types:
set: string
Sample: UserGroupType class
This class is Sample that user has multiple groups which is mysql set type.
Then, create UserGroupType and extend AbstractSetType.
<?php
namespace AppBundle\DBAL\Types;
use Raksul\DoctrineSetTypeBundle\DBAL\Types\AbstractSetType;
class UserGroupType extends AbstractSetType
{
const GROUP1 = 'group1';
const GROUP2 = 'group2';
const GROUP3 = 'group3';
/**
* {@inheritdoc}
*/
protected $name = 'UserGroupType'; // This is Optional. Automatically registered shord class name.
/**
* Define your SET type.
*/
protected static $choices = [
self::GROUP1 => 'Group 1',
self::GROUP2 => 'Group 2',
self::GROUP3 => 'Group 3',
];
}
Or you may define set type definition in entity by overrideing AbstractSetType::getChoices()
method.
class UserGroupType extends AbstractSetType
{
/**
* {@inheritdoc}
*/
public static function getChoices()
{
return User::getGroupChoices();
}
}
class User
{
public static function getGroupChoices()
{
return [
self::GROUP1 => 'Group 1',
self::GROUP2 => 'Group 2',
self::GROUP3 => 'Group 3',
];
}
}
Register UserGroupType in config.yml
doctrine:
dbal:
## ...
types:
UserGroupType: AppBundle\DBAL\Types\UserGroupType
This is annotaion sample.
<?php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
use Doctrine\ORM\Mapping as ORM;
use Raksul\DoctrineSetTypeBundle\Validator\Constraints as DoctrineAssert;
use AppBundle\DBAL\Types\UserGroupType;
/**
* User
*
* @ORM\Table(name="user")
* @ORM\Entity
*/
class User
{
/**
* @var integer
*
* @ORM\Column(name="id", type="integer")
* @ORM\Id
* @ORM\GeneratedValue(strategy="AUTO")
*/
private $id;
/**
* @var string
*
* @ORM\Column(name="username", type="string", length=50)
*/
private $username;
/**
* @var array
*
* @DoctrineAssert\SetType(class="AppBundle\DBAL\Types\UserGroupType")
* @ORM\Column(name="groups", type="UserGroupType", nullable=true) // mapping_type
*/
private $groups;
// ...
/**
* Set groups
*
* @param array $groups
* @return User
*/
public function setGroups(array $groups)
{
$this->groups = $groups;
return $this;
}
/**
* Get groups
*
* @return array
*/
public function getGroups()
{
return $this->groups;
}
}
You can set Groups with array to User entity
$user->setGroups([UserGroupType::GROUP1, UserGroupType::GROUP2]);
And also You can validate your type by adding the following annotation.
/**
* @DoctrineAssert\SetType(class="AppBundle\DBAL\Types\UserGroupType")
*/
private $groups;
Pass null
to the Second argument.
SetTypeGuesser extends ChoiseType and render the field as checkboxes.
So, you can use choice field type option. (see choice Field Type)
$builder->add('groups', null, [
'required' => true,
'invalid_message' => 'Given values are invalid!!'
]);
Following SQL is executed.
CREATE TABLE user (
id INT AUTO_INCREMENT NOT NULL,
username varchar(50) COLLATE utf8_unicode_ci NOT NULL,
groups set('group1','group2') DEFAULT NULL COMMENT '(DC2Type:UserGroupType)',
PRIMARY KEY(id)
) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB
This bundle is under the MIT license. see LICENSE: