Documentação do Symfony - versão 3.4
Renderizada do repositório symfony-docs-pt-BR no Github

Configuração do DoctrineBundle (“doctrine”)

  • YAML
      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    doctrine:
        dbal:
            default_connection:   default
            types:
                # A collection of custom types
                # Example
                some_custom_type:
                    class:                Acme\HelloBundle\MyCustomType
                    commented:            true
    
            connections:
                default:
                    dbname:               database
    
                # A collection of different named connections (e.g. default, conn2, etc)
                default:
                    dbname:               ~
                    host:                 localhost
                    port:                 ~
                    user:                 root
                    password:             ~
                    charset:              ~
                    path:                 ~
                    memory:               ~
    
                    # The unix socket to use for MySQL
                    unix_socket:          ~
    
                    # True to use as persistent connection for the ibm_db2 driver
                    persistent:           ~
    
                    # The protocol to use for the ibm_db2 driver (default to TCPIP if omitted)
                    protocol:             ~
    
                    # True to use dbname as service name instead of SID for Oracle
                    service:              ~
    
                    # The session mode to use for the oci8 driver
                    sessionMode:          ~
    
                    # True to use a pooled server with the oci8 driver
                    pooled:               ~
    
                    # Configuring MultipleActiveResultSets for the pdo_sqlsrv driver
                    MultipleActiveResultSets:  ~
                    driver:               pdo_mysql
                    platform_service:     ~
                    logging:              %kernel.debug%
                    profiling:            %kernel.debug%
                    driver_class:         ~
                    wrapper_class:        ~
                    options:
                        # an array of options
                        key:                  []
                    mapping_types:
                        # an array of mapping types
                        name:                 []
                    slaves:
    
                        # a collection of named slave connections (e.g. slave1, slave2)
                        slave1:
                            dbname:               ~
                            host:                 localhost
                            port:                 ~
                            user:                 root
                            password:             ~
                            charset:              ~
                            path:                 ~
                            memory:               ~
    
                            # The unix socket to use for MySQL
                            unix_socket:          ~
    
                            # True to use as persistent connection for the ibm_db2 driver
                            persistent:           ~
    
                            # The protocol to use for the ibm_db2 driver (default to TCPIP if omitted)
                            protocol:             ~
    
                            # True to use dbname as service name instead of SID for Oracle
                            service:              ~
    
                            # The session mode to use for the oci8 driver
                            sessionMode:          ~
    
                            # True to use a pooled server with the oci8 driver
                            pooled:               ~
    
                            # Configuring MultipleActiveResultSets for the pdo_sqlsrv driver
                            MultipleActiveResultSets:  ~
    
        orm:
            default_entity_manager:  ~
            auto_generate_proxy_classes:  false
            proxy_dir:            %kernel.cache_dir%/doctrine/orm/Proxies
            proxy_namespace:      Proxies
            # search for the "ResolveTargetEntityListener" class for a cookbook about this
            resolve_target_entities: []
            entity_managers:
                # A collection of different named entity managers (e.g. some_em, another_em)
                some_em:
                    query_cache_driver:
                        type:                 array # Required
                        host:                 ~
                        port:                 ~
                        instance_class:       ~
                        class:                ~
                    metadata_cache_driver:
                        type:                 array # Required
                        host:                 ~
                        port:                 ~
                        instance_class:       ~
                        class:                ~
                    result_cache_driver:
                        type:                 array # Required
                        host:                 ~
                        port:                 ~
                        instance_class:       ~
                        class:                ~
                    connection:           ~
                    class_metadata_factory_name:  Doctrine\ORM\Mapping\ClassMetadataFactory
                    default_repository_class:  Doctrine\ORM\EntityRepository
                    auto_mapping:         false
                    hydrators:
    
                        # An array of hydrator names
                        hydrator_name:                 []
                    mappings:
                        # An array of mappings, which may be a bundle name or something else
                        mapping_name:
                            mapping:              true
                            type:                 ~
                            dir:                  ~
                            alias:                ~
                            prefix:               ~
                            is_bundle:            ~
                    dql:
                        # a collection of string functions
                        string_functions:
                            # example
                            # test_string: Acme\HelloBundle\DQL\StringFunction
    
                        # a collection of numeric functions
                        numeric_functions:
                            # example
                            # test_numeric: Acme\HelloBundle\DQL\NumericFunction
    
                        # a collection of datetime functions
                        datetime_functions:
                            # example
                            # test_datetime: Acme\HelloBundle\DQL\DatetimeFunction
    
                    # Register SQL Filters in the entity manager
                    filters:
                        # An array of filters
                        some_filter:
                            class:                ~ # Required
                            enabled:              false
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    <?xml version="1.0" encoding="UTF-8" ?>
    <container xmlns="http://symfony.com/schema/dic/services"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:doctrine="http://symfony.com/schema/dic/doctrine"
        xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
                            http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
    
        <doctrine:config>
            <doctrine:dbal default-connection="default">
                <doctrine:connection
                    name="default"
                    dbname="database"
                    host="localhost"
                    port="1234"
                    user="user"
                    password="secret"
                    driver="pdo_mysql"
                    driver-class="MyNamespace\MyDriverImpl"
                    path="%kernel.data_dir%/data.sqlite"
                    memory="true"
                    unix-socket="/tmp/mysql.sock"
                    wrapper-class="MyDoctrineDbalConnectionWrapper"
                    charset="UTF8"
                    logging="%kernel.debug%"
                    platform-service="MyOwnDatabasePlatformService"
                >
                    <doctrine:option key="foo">bar</doctrine:option>
                    <doctrine:mapping-type name="enum">string</doctrine:mapping-type>
                </doctrine:connection>
                <doctrine:connection name="conn1" />
                <doctrine:type name="custom">Acme\HelloBundle\MyCustomType</doctrine:type>
            </doctrine:dbal>
    
            <doctrine:orm default-entity-manager="default" auto-generate-proxy-classes="false" proxy-namespace="Proxies" proxy-dir="%kernel.cache_dir%/doctrine/orm/Proxies">
                <doctrine:entity-manager name="default" query-cache-driver="array" result-cache-driver="array" connection="conn1" class-metadata-factory-name="Doctrine\ORM\Mapping\ClassMetadataFactory">
                    <doctrine:metadata-cache-driver type="memcache" host="localhost" port="11211" instance-class="Memcache" class="Doctrine\Common\Cache\MemcacheCache" />
                    <doctrine:mapping name="AcmeHelloBundle" />
                    <doctrine:dql>
                        <doctrine:string-function name="test_string">Acme\HelloBundle\DQL\StringFunction</doctrine:string-function>
                        <doctrine:numeric-function name="test_numeric">Acme\HelloBundle\DQL\NumericFunction</doctrine:numeric-function>
                        <doctrine:datetime-function name="test_datetime">Acme\HelloBundle\DQL\DatetimeFunction</doctrine:datetime-function>
                    </doctrine:dql>
                </doctrine:entity-manager>
                <doctrine:entity-manager name="em2" connection="conn2" metadata-cache-driver="apc">
                    <doctrine:mapping
                        name="DoctrineExtensions"
                        type="xml"
                        dir="%kernel.root_dir%/../vendor/gedmo/doctrine-extensions/lib/DoctrineExtensions/Entity"
                        prefix="DoctrineExtensions\Entity"
                        alias="DExt"
                    />
                </doctrine:entity-manager>
            </doctrine:orm>
        </doctrine:config>
    </container>
    

Visão Geral da Configuração

O exemplo de configuração a seguir mostra toda a configuração padrão que o ORM interpreta para:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
doctrine:
    orm:
        auto_mapping: true
        # the standard distribution overrides this to be true in debug, false otherwise
        auto_generate_proxy_classes: false
        proxy_namespace: Proxies
        proxy_dir: "%kernel.cache_dir%/doctrine/orm/Proxies"
        default_entity_manager: default
        metadata_cache_driver: array
        query_cache_driver: array
        result_cache_driver: array

Existem muitas outras opções de configuração que você pode usar para sobrescrever certas classes, mas essas são somente para casos de uso avançados.

Fazendo Cache dos Drivers

Para realizar o cache dos drivers você pode especificar os valores “array”, “apc”, “memcache”, “memcached”, “xcache” ou “service”.

O exemplo a seguir mostra uma visão geral das configurações de cache:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
doctrine:
    orm:
        auto_mapping: true
        metadata_cache_driver: apc
        query_cache_driver:
            type: service
            id: my_doctrine_common_cache_service
        result_cache_driver:
            type: memcache
            host: localhost
            port: 11211
            instance_class: Memcache

Mapeando a Configuração

Definir explicitamente todas as entidades mapeadas é a única configuração necessário para o ORM e existem diversas outras opções de configurações que você pode controlar. As configurações abaixo existem para o mapeamento.

  • type Em annotation, xml, yml, php ou staticphp. Especifica que tipo de metadado seu mapeamento usa.
  • dir Caminho para o mapeamento ou para os arquivos de entidades (dependendo do driver utilizado). Se esse caminho for relativo assume-se que ele seja relativo à raiz do bundle. Isso somente irá funcionar se o nome do mapeamento for o mesmo nome do próprio Bundle. Se você quiser usar essa opção para especificar um caminho absoluto você deve prefixar esse caminho com os parâmetros de kernel que existe no DIC (por exemplo %kernel.root_dir%).
  • prefix Um prefixo comum que todas as entidades desse mapeamento compartilham share. This prefix should never conflict with prefixes of other defined mappings otherwise some of your entities cannot be found by Doctrine. This option defaults to the bundle namespace + Entity, for example for an application bundle called AcmeHelloBundle prefix would be Acme\HelloBundle\Entity.
  • alias O Doctrine oeferece uma forma para apelidar os nomes das entidades para algo mais simples, ou seja, nomes mais curtos que serão usados nas instruções DQL ou no acesso através dos repositórios. Ao usar um bundle o apelido padrão é igual ao nome do bundle.
  • is_bundle Essa opção é uma valor derivado de dir e true caso o diretório seja relativo, sendo verificado por um retorno false do método file_exists(). Ele será falso se a verificação através do método retornar true. Nesse caso um caminho absoluto foi especificado e os arquivos de metadados provavelmente estarão em algum diretório exterior ao bundle.

Configurações do Doctrine DBAL

O DoctrineBundle suporta todos os parametros que os drivers padrões do doctrine aceitam, convertidos para os padrões de XML ou YAML encorajados pelo Symfony. Veja a seção DBAL documentation para maiores informações. O bloco a seguir mostra todas as possiveis configurações:

  • YAML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    doctrine:
        dbal:
            dbname:               database
            host:                 localhost
            port:                 1234
            user:                 user
            password:             secret
            driver:               pdo_mysql
            # the DBAL driverClass option
            driver_class:         MyNamespace\MyDriverImpl
            # the DBAL driverOptions option
            options:
                foo: bar
            path:                 "%kernel.data_dir%/data.sqlite"
            memory:               true
            unix_socket:          /tmp/mysql.sock
            # the DBAL wrapperClass option
            wrapper_class:        MyDoctrineDbalConnectionWrapper
            charset:              UTF8
            logging:              "%kernel.debug%"
            platform_service:     MyOwnDatabasePlatformService
            mapping_types:
                enum: string
            types:
                custom: Acme\HelloBundle\MyCustomType
            # the DBAL keepSlave option
            keep_slave:           false
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    <!-- xmlns:doctrine="http://symfony.com/schema/dic/doctrine" -->
    <!-- xsi:schemaLocation="http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd"> -->
    
    <doctrine:config>
        <doctrine:dbal
            name="default"
            dbname="database"
            host="localhost"
            port="1234"
            user="user"
            password="secret"
            driver="pdo_mysql"
            driver-class="MyNamespace\MyDriverImpl"
            path="%kernel.data_dir%/data.sqlite"
            memory="true"
            unix-socket="/tmp/mysql.sock"
            wrapper-class="MyDoctrineDbalConnectionWrapper"
            charset="UTF8"
            logging="%kernel.debug%"
            platform-service="MyOwnDatabasePlatformService"
        >
            <doctrine:option key="foo">bar</doctrine:option>
            <doctrine:mapping-type name="enum">string</doctrine:mapping-type>
            <doctrine:type name="custom">Acme\HelloBundle\MyCustomType</doctrine:type>
        </doctrine:dbal>
    </doctrine:config>
    

Caso você queira configurar multiplas conecções com YAML, coloque-as dentro da chave connections e forneça a elas um nome unico:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
doctrine:
    dbal:
        default_connection:       default
        connections:
            default:
                dbname:           Symfony2
                user:             root
                password:         null
                host:             localhost
            customer:
                dbname:           customer
                user:             root
                password:         null
                host:             localhost

O serviço database_connection sempre se refere a conexão default, que a primeira definida ou a que esteja configurada através do parâmetro default_connection.

Cada conexão também pode ser acessada pelo serviço doctrine.dbal.[name]_connection onde [name] deve ser substituído pelo nome da conexão.