Developed with love by KnpLabs Hire us for your project!
35

DoctrineSetTypeBundle

by okapon

The DoctrineSetTypeBundle provides MySQL SET type support for Doctrine2 in your Symfony application.

DoctrineSetTypeBundle

The DoctrineSetTypeBundle provides support MySQL SET type for Doctrine2 in your Symfony2 or Symfony3 application.

Latest Stable Version
Total Downloads
Build Status
Scrutinizer Code Quality
Code Coverage

License

Features

  • SET type mapping for mysql
  • SET type validation
  • Doctrine migrations

Requirements

  • PHP ~5.5
  • Symfony ~2.6 or ~3.0
  • Doctrine ~2.3

Supported platforms

  • MySQL

Installation

Step 1: Download the Bundle

Using composer

$ composer require okapon/doctrine-set-type-bundle "0.5.0"

Step 2: Enable the Bundle

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 Okapon\DoctrineSetTypeBundle\OkaponDoctrineSetTypeBundle(),
        );

        // ...
    }

    // ...
}

Step 3: Enable the mapping_type

In order to use MySQL SET type, Add the following line in the app/config/confing.yml

doctrine:
    dbal:
        mapping_types:
            set: string

Usage

Create your SET type class

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 Okapon\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
{
    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 your type

Register UserGroupType in config.yml

doctrine:
    dbal:
        ## ...
        types:
            UserGroupType: AppBundle\DBAL\Types\UserGroupType

Add mapping data to entity

This is annotaion sample.

<?php

namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Doctrine\ORM\Mapping as ORM;
use Okapon\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;

Building the form

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!!'
]);

Doctrine migrations

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
The MIT License (MIT)

Copyright (c) 2014 Yuichi Okada

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Update README.md
    By web-flow, 4 years ago
  • Update README.md
    By web-flow, 4 years ago
  • Update .travis.yml to support symfony version ~3.0
    By okapon, 4 years ago
  • Update README.md
    By web-flow, 4 years ago
  • Update README.md
    By web-flow, 4 years ago
  • Delete useless code.
    By okapon, 4 years ago
  • support symfony3
    By okapon, 4 years ago
  • Update README.md
    By okapon, 5 years ago
  • Merge pull request #6 from okapon/add-missing-test
    By okapon, 5 years ago
  • Add missing test
    By okapon, 5 years ago
  • Merge pull request #5 from okapon/change-support-version
    By okapon, 5 years ago
  • Change test support version to symfony2.6+, PHP5.5+
    By okapon, 5 years ago
  • Update Changelog.md
    By okapon, 5 years ago
  • Add Changelog.md
    By okapon, 5 years ago
  • Update README.md
    By okapon, 5 years ago
  • Merge pull request #4 from okapon/fix-test
    By okapon, 5 years ago
  • Change test code to follow Symfony test code.
    By okapon, 5 years ago
  • Fix SetTypeGusserTest
    By okapon, 5 years ago
  • Merge pull request #3 from Metabor/patch-2
    By okapon, 5 years ago
  • Merge pull request #2 from Metabor/patch-1
    By okapon, 5 years ago
  • use generic CLOB if platform is not MySQL
    By Metabor, 5 years ago
  • Form Type Guesser should return null if it is not a SET ENUM
    By Metabor, 5 years ago
  • Allow to store and load SET from SQLite DB
    By Metabor, 5 years ago
  • not support for hhvm
    By okapon, 5 years ago
  • Update README.md
    By okapon, 5 years ago
  • Merge pull request #1 from okapon/0.2.0
    By okapon, 5 years ago
  • Upgrade 0.2.0
    By okapon, 5 years ago
  • Update README.md
    By okapon, 5 years ago
  • Update README.md
    By okapon, 5 years ago
  • Add InvalidClassSpecifiedException and SetTypeGuesserTest
    By okapon, 5 years ago