Basic Mapping

Creating Classes for the Database

Every PHP object that you want to save in the database using Doctrine is called an Entity. The term "Entity" describes objects that have an identity over many independent requests. This identity is usually achieved by assigning a unique identifier to an entity. In this tutorial the following Message PHP class will serve as the example Entity:

1
<?php
class Message
{
    private $id;
    private $text;
    private $postedAt;
}
2
3
4
5
6
7

Because Doctrine is a generic library, it only knows about your entities because you will describe their existence and structure using mapping metadata, which is configuration that tells Doctrine how your entity should be stored in the database. The documentation will often speak of "mapping something", which means writing the mapping metadata that describes your entity.

Doctrine provides several different ways to specify object-relational mapping metadata:

• Attributes
• Docblock Annotations
• XML
• PHP code
• YAML (deprecated and will be removed in doctrine/orm 3.0.)

This manual will usually show mapping metadata via attributes, though many examples also show the equivalent configuration in annotations, YAML and XML.

Marking our Message class as an entity for Doctrine is straightforward:

1
<?php
use Doctrine\ORM\Mapping\Entity;

#[Entity]
class Message
{
    // ...
}
2
3
4
5
6
7
8

1
<?php
use Doctrine\ORM\Mapping\Entity;

/** @Entity */
class Message
{
    // ...
}
2
3
4
5
6
7
8

1
<doctrine-mapping>
  <entity name="Message">
      <!-- ... -->
  </entity>
</doctrine-mapping>
2
3
4
5

1
Message:
  type: entity
  # ...
2
3

With no additional information, Doctrine expects the entity to be saved into a table with the same name as the class in our case Message. You can change this by configuring information about the table:

1
<?php
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\Table;

#[Entity]
#[Table(name: 'message')]
class Message
{
    // ...
}
2
3
4
5
6
7
8
9
10

1
<?php
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\Table;

/**
 * @Entity
 * @Table(name="message")
 */
class Message
{
    // ...
}
2
3
4
5
6
7
8
9
10
11
12

1
<doctrine-mapping>
  <entity name="Message" table="message">
      <!-- ... -->
  </entity>
</doctrine-mapping>
2
3
4
5

1
Message:
  type: entity
  table: message
  # ...
2
3
4

Now the class Message will be saved and fetched from the table message.

Property Mapping

The next step is mapping its properties to columns in the table.

To configure a property use the Column attribute. The type argument specifies the Doctrine Mapping Type to use for the field. If the type is not specified, string is used as the default.

1
<?php
use Doctrine\ORM\Mapping\Column;
use Doctrine\DBAL\Types\Types;

#[Entity]
class Message
{
    #[Column(type: Types::INTEGER)]
    private $id;
    #[Column(length: 140)]
    private $text;
    #[Column(name: 'posted_at', type: Types::DATETIME)]
    private $postedAt;
}
2
3
4
5
6
7
8
9
10
11
12
13
14

1
<?php
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\Column;

/** @Entity */
class Message
{
    /** @Column(type="integer") */
    private $id;
    /** @Column(length=140) */
    private $text;
    /** @Column(type="datetime", name="posted_at") */
    private $postedAt;
}
2
3
4
5
6
7
8
9
10
11
12
13
14

1
<doctrine-mapping>
  <entity name="Message">
    <field name="id" type="integer" />
    <field name="text" length="140" />
    <field name="postedAt" column="posted_at" type="datetime" />
  </entity>
</doctrine-mapping>
2
3
4
5
6
7

1
Message:
  type: entity
  fields:
    id:
      type: integer
    text:
      length: 140
    postedAt:
      type: datetime
      column: posted_at
2
3
4
5
6
7
8
9
10

When we don't explicitly specify a column name via the name option, Doctrine assumes the field name is also the column name. So in this example:

• the id property will map to the column id using the type integer;
• the text property will map to the column text with the default mapping type string;
• the postedAt property will map to the posted_at column with the datetime type.

Here is a complete list of Columns attributes (all optional):

• type (default: 'string'): The mapping type to use for the column.
• name (default: name of property): The name of the column in the database.
• length (default: 255): The length of the column in the database. Applies only if a string-valued column is used.
• unique (default: false): Whether the column is a unique key.
• nullable (default: false): Whether the column is nullable.
• insertable (default: true): Whether the column should be inserted.
• updatable (default: true): Whether the column should be updated.
• enumType (requires PHP 8.1 and doctrine/orm 2.11): The PHP enum class name to convert the database value into.
• precision (default: 0): The precision for a decimal (exact numeric) column (applies only for decimal column), which is the maximum number of digits that are stored for the values.
• scale (default: 0): The scale for a decimal (exact numeric) column (applies only for decimal column), which represents the number of digits to the right of the decimal point and must not be greater than precision.
• columnDefinition: Allows to define a custom DDL snippet that is used to create the column. Warning: This normally confuses the SchemaTool to always detect the column as changed.
• options: Key-value pairs of options that get passed to the underlying database platform when generating DDL statements.

Doctrine Mapping Types

The type option used in the @Column accepts any of the existing Doctrine types or even your own custom types. A Doctrine type defines the conversion between PHP and SQL types, independent from the database vendor you are using. All Mapping Types that ship with Doctrine are fully portable between the supported database systems.

As an example, the Doctrine Mapping Type string defines the mapping from a PHP string to a SQL VARCHAR (or VARCHAR2 etc. depending on the RDBMS brand). Here is a quick overview of the built-in mapping types:

• string: Type that maps a SQL VARCHAR to a PHP string.
• integer: Type that maps a SQL INT to a PHP integer.
• smallint: Type that maps a database SMALLINT to a PHP integer.
• bigint: Type that maps a database BIGINT to a PHP string.
• boolean: Type that maps a SQL boolean or equivalent (TINYINT) to a PHP boolean.
• decimal: Type that maps a SQL DECIMAL to a PHP string.
• date: Type that maps a SQL DATETIME to a PHP DateTime object.
• time: Type that maps a SQL TIME to a PHP DateTime object.
• datetime: Type that maps a SQL DATETIME/TIMESTAMP to a PHP DateTime object.
• datetimetz: Type that maps a SQL DATETIME/TIMESTAMP to a PHP DateTime object with timezone.
• text: Type that maps a SQL CLOB to a PHP string.
• object: Type that maps a SQL CLOB to a PHP object using serialize() and unserialize()
• array: Type that maps a SQL CLOB to a PHP array using serialize() and unserialize()
• simple_array: Type that maps a SQL CLOB to a PHP array using implode() and explode(), with a comma as delimiter. IMPORTANT Only use this type if you are sure that your values cannot contain a ",".
• json_array: Type that maps a SQL CLOB to a PHP array using json_encode() and json_decode()
• float: Type that maps a SQL Float (Double Precision) to a PHP double. IMPORTANT: Works only with locale settings that use decimal points as separator.
• guid: Type that maps a database GUID/UUID to a PHP string. Defaults to varchar but uses a specific type if the platform supports it.
• blob: Type that maps a SQL BLOB to a PHP resource stream

A cookbook article shows how to define your own custom mapping types.

Identifiers / Primary Keys

Every entity class must have an identifier/primary key. You can select the field that serves as the identifier with the #[Id] attribute.

1
<?php
class Message
{
    #[Id]
    #[Column(type: 'integer')]
    #[GeneratedValue]
    private int|null $id = null;
    // ...
}
2
3
4
5
6
7
8
9

1
<?php
class Message
{
    /**
     * @Id
     * @Column(type="integer")
     * @GeneratedValue
     */
    private int|null $id = null;
    // ...
}
2
3
4
5
6
7
8
9
10
11

1
<doctrine-mapping>
  <entity name="Message">
    <id name="id" type="integer">
        <generator strategy="AUTO" />
    </id>
    <!-- -->
  </entity>
</doctrine-mapping>
2
3
4
5
6
7
8

1
Message:
  type: entity
  id:
    id:
      type: integer
      generator:
        strategy: AUTO
  fields:
    # fields here
2
3
4
5
6
7
8
9

In most cases using the automatic generator strategy (#[GeneratedValue]) is what you want. It defaults to the identifier generation mechanism your current database vendor prefers: AUTO_INCREMENT with MySQL, sequences with PostgreSQL and Oracle and so on.

1
<?php
class Message
{
    #[Id]
    #[GeneratedValue(strategy: 'SEQUENCE')]
    #[SequenceGenerator(sequenceName: 'message_seq', initialValue: 1, allocationSize: 100)]
    protected int|null $id = null;
    // ...
}
2
3
4
5
6
7
8
9

1
<?php
class Message
{
    /**
     * @Id
     * @GeneratedValue(strategy="SEQUENCE")
     * @SequenceGenerator(sequenceName="message_seq", initialValue=1, allocationSize=100)
     */
    protected int|null $id = null;
    // ...
}
2
3
4
5
6
7
8
9
10
11

1
<doctrine-mapping>
  <entity name="Message">
    <id name="id" type="integer">
        <generator strategy="SEQUENCE" />
        <sequence-generator sequence-name="message_seq" allocation-size="100" initial-value="1" />
    </id>
  </entity>
</doctrine-mapping>
2
3
4
5
6
7
8

1
Message:
  type: entity
  id:
    id:
      type: integer
      generator:
        strategy: SEQUENCE
      sequenceGenerator:
        sequenceName: message_seq
        allocationSize: 100
        initialValue: 1
2
3
4
5
6
7
8
9
10
11

Quoting Reserved Words

Sometimes it is necessary to quote a column or table name because of reserved word conflicts. Doctrine does not quote identifiers automatically, because it leads to more problems than it would solve. Quoting tables and column names needs to be done explicitly using ticks in the definition.

1
<?php

#[Column(name: '`number`', type: 'integer')]
private $number;
2
3
4

Doctrine will then quote this column name in all SQL statements according to the used database platform.

For more control over column quoting the Doctrine\ORM\Mapping\QuoteStrategy interface was introduced in ORM. It is invoked for every column, table, alias and other SQL names. You can implement the QuoteStrategy and set it by calling Doctrine\ORM\Configuration#setQuoteStrategy().

The ANSI Quote Strategy was added, which assumes quoting is not necessary for any SQL name. You can use it with the following code:

1
<?php
use Doctrine\ORM\Mapping\AnsiQuoteStrategy;

$configuration->setQuoteStrategy(new AnsiQuoteStrategy());
2
3
4