The class Doctrine\ORM\Mapping\Driver\DatabaseDriver is deprecated without replacement.
Add Doctrine\ORM\Query\OutputWalker interface, deprecate Doctrine\ORM\Query\SqlWalker::getExecutor()
Output walkers should implement the new \Doctrine\ORM\Query\OutputWalker interface and create
Doctrine\ORM\Query\Exec\SqlFinalizer instances instead of Doctrine\ORM\Query\Exec\AbstractSqlExecutors.
The output walker must not base its workings on the query firstResult/maxResult values, so that the
SqlFinalizer can be kept in the query cache and used regardless of the actual firstResult/maxResult values.
Any operation dependent on firstResult/maxResult should take place within the SqlFinalizer::createExecutor()
method. Details can be found at #11188.
The class Doctrine\ORM\Exception\NotSupported is deprecated without replacement.
Relying on SequenceGenerator implementing the Serializable is deprecated
because that interface won't be implemented in ORM 4 anymore.
The following methods are deprecated:
SequenceGenerator::serialize()SequenceGenerator::unserialize()
That option behaves as a no-op, and is deprecated. It will be removed in 4.0.
The properties $indexes and $uniqueConstraints have been deprecated since they had no effect at all.
The preferred way of defining indices and unique constraints is by
using the \Doctrine\ORM\Mapping\UniqueConstraint and \Doctrine\ORM\Mapping\Index attributes.
This class is deprecated and will be removed in 4.0.
Instead, use Doctrine\Persistence\Reflection\EnumReflectionProperty from
doctrine/persistence.
Passing null to Doctrine\ORM\ClassMetadata::fullyQualifiedClassName() is
deprecated and will no longer be possible in 4.0.
Using array access on instances of the following classes is deprecated:
Doctrine\ORM\Mapping\DiscriminatorColumnMappingDoctrine\ORM\Mapping\EmbedClassMappingDoctrine\ORM\Mapping\FieldMappingDoctrine\ORM\Mapping\JoinColumnMappingDoctrine\ORM\Mapping\JoinTableMapping
BC BREAK: Calling ClassMetadata::getAssociationMappedByTargetField() with the owning side of an association now throws an exception
Previously, calling
Doctrine\ORM\Mapping\ClassMetadata::getAssociationMappedByTargetField() with
the owning side of an association returned null, which was undocumented, and
wrong according to the phpdoc of the parent method.
If you do not know whether you are on the owning or inverse side of an association,
you can use Doctrine\ORM\Mapping\ClassMetadata::isAssociationInverseSide()
to find out.
Make sure to use the former when writing a type declaration or an instanceof check.
Minor BC BREAK: Changed order of arguments passed to OneToOne, ManyToOne and Index mapping PHP attributes
To keep PHP mapping attributes consistent, order of arguments passed to above attributes has been changed
so $targetEntity is a first argument now. This change affects only non-named arguments usage.
BC BREAK: AUTO keyword for identity generation defaults to IDENTITY for PostgreSQL when using doctrine/dbal 4
When using the AUTO strategy to let Doctrine determine the identity generation mechanism for
an entity, and when using doctrine/dbal 4, PostgreSQL now uses IDENTITY
instead of SEQUENCE or SERIAL.
- If you want to upgrade your existing tables to identity columns, you will need to follow migration to identity columns on PostgreSQL
- If you want to keep using SQL sequences, you need to configure the ORM this way:
use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\Mapping\ClassMetadata;
assert($configuration instanceof Configuration);
$configuration->setIdentityGenerationPreferences([
PostgreSQLPlatform::CLASS => ClassMetadata::GENERATOR_TYPE_SEQUENCE,
]);There are only a few attributes allowed on an embeddable such as #[Column] or
#[Embedded]. Previously all others that target entity classes where ignored,
now they throw an exception.
WARNING: This was relaxed in ORM 3.2 when partial was re-allowed for array-hydration.
- The
PARTIALkeyword in DQL no longer exists (reintroduced in ORM 3.2) Doctrine\ORM\Query\AST\PartialObjectExpressionis removed. (reintroduced in ORM 3.2)Doctrine\ORM\Query\SqlWalker::HINT_PARTIAL(reintroduced in ORM 3.2) andDoctrine\ORM\Query::HINT_FORCE_PARTIAL_LOADare removed.Doctrine\ORM\EntityManager*::getPartialReference()is removed.
BC BREAK: Doctrine\ORM\Persister\Entity\EntityPersister::executeInserts() return type changed to void
Implementors should adapt to the new signature, and should call
UnitOfWork::assignPostInsertId() for each entry in the previously returned
array.
It is no longer possible to call methods, constants or properties inherited
from that class on a ProxyFactory instance.
Doctrine\ORM\Proxy\ProxyFactory::createProxyDefinition() and
Doctrine\ORM\Proxy\ProxyFactory::resetUninitializedProxy() are removed as well.
Doctrine\ORM\Configuration::setLazyGhostObjectEnabled() and
Doctrine\ORM\Configuration::isLazyGhostObjectEnabled() are now no-ops and
will be deprecated in 3.1.0
Doctrine\ORM\Configuration::setRejectIdCollisionInIdentityMap() and
Doctrine\ORM\Configuration::isRejectIdCollisionInIdentityMapEnabled() are now
no-ops and will be deprecated in 3.1.0.
Lifecycle callback mapping on embedded classes produced no effect, and is now explicitly forbidden to point out mistakes.
You should use DEFERRED_EXPLICIT instead.
The third argument to
Doctrine\ORM\Mapping\Driver\XmlDriver::__construct() was introduced to
let users opt-in to XML validation, that is now always enabled by default.
As a consequence, the same goes for
Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver, and for
Doctrine\ORM\ORMSetup::createXMLMetadataConfiguration().
The second argument to
Doctrine\ORM\Mapping\Driver\AttributeDriver::__construct() was introduced to
let users opt-in to a new behavior, that is now always enforced, regardless of
the value of that argument.
The $dqlQuery argument of Doctrine\ORM\Query::setDQL() must always be a
string.
The $firstResult argument of Doctrine\ORM\Query::setFirstResult() must
always be an integer.
orm:schema-tool:update now behaves as if --complete was provided,
regardless of whether it is provided or not.
Use Doctrine\Persistence\Proxy instead to check whether proxies are initialized.
As stated in the documentation, fields and associations may only be overridden when being inherited
from mapped superclasses. Overriding them for parent entity classes now throws a MappingException.
As soon as an entity class inherits from another entity class, inheritance has to be declared by adding the appropriate configuration for the root entity.
Removed getEntityManager() in Doctrine\ORM\Event\OnClearEventArgs and Doctrine\ORM\Event\*FlushEventArgs
Use getObjectManager() instead.
Use Doctrine\ORM\Mapping\ClassMetadata instead.
Use one of the dedicated event classes instead:
Doctrine\ORM\Event\PrePersistEventArgsDoctrine\ORM\Event\PreUpdateEventArgsDoctrine\ORM\Event\PreRemoveEventArgsDoctrine\ORM\Event\PostPersistEventArgsDoctrine\ORM\Event\PostUpdateEventArgsDoctrine\ORM\Event\PostRemoveEventArgsDoctrine\ORM\Event\PostLoadEventArgs
- If you need to change the behavior of
AttributeDriver::isTransient(), override that method instead. - The attribute reader is internal to the driver and should not be accessed from outside.
The AST parser will create a InListExpression or a InSubselectExpression when
encountering an IN () DQL expression instead of a generic InExpression.
As a consequence, SqlWalker::walkInExpression() has been replaced by
SqlWalker::walkInListExpression() and SqlWalker::walkInSubselectExpression().
BC BREAK: Changed EntityManagerInterface#refresh($entity), EntityManagerDecorator#refresh($entity) and UnitOfWork#refresh($entity) signatures
The new signatures of these methods add an optional LockMode|int|null $lockMode
param with default null value (no lock).
The annotation driver and anything related to annotation has been removed. Please migrate to another mapping driver.
The Doctrine\ORM\Mapping\Annotation maker interface has been removed in favor of the new
Doctrine\ORM\Mapping\MappingAttribute interface.
The constructor of EntityManager is now public and must be used instead of the create() method.
However, the constructor expects a Connection while create() accepted an array with connection parameters.
You can pass that array to DBAL's Doctrine\DBAL\DriverManager::getConnection() method to bootstrap the
connection.
The following QueryBuilder constants and methods have been removed:
SELECT,DELETE,UPDATE,STATE_DIRTY,STATE_CLEAN,getState(),getType().
BC BREAK: Omitting only the alias argument for QueryBuilder::update and QueryBuilder::delete is not supported anymore
When building an UPDATE or DELETE query and when passing a class/type to the function, the alias argument must not be omitted.
$qb = $em->createQueryBuilder()
->delete('User u')
->where('u.id = :user_id')
->setParameter('user_id', 1);$qb = $em->createQueryBuilder()
->delete('User', 'u')
->where('u.id = :user_id')
->setParameter('user_id', 1);SqlWalker and its child classes don't implement the TreeWalker interface
anymore.
The following methods have been removed from the TreeWalker interface and
from the TreeWalkerAdapter and TreeWalkerChain classes:
setQueryComponent()walkSelectClause()walkFromClause()walkFunction()walkOrderByClause()walkOrderByItem()walkHavingClause()walkJoin()walkSelectExpression()walkQuantifiedExpression()walkSubselect()walkSubselectFromClause()walkSimpleSelectClause()walkSimpleSelectExpression()walkAggregateExpression()walkGroupByClause()walkGroupByItem()walkDeleteClause()walkUpdateClause()walkUpdateItem()walkWhereClause()walkConditionalExpression()walkConditionalTerm()walkConditionalFactor()walkConditionalPrimary()walkExistsExpression()walkCollectionMemberExpression()walkEmptyCollectionComparisonExpression()walkNullComparisonExpression()walkInExpression()walkInstanceOfExpression()walkLiteral()walkBetweenExpression()walkLikeExpression()walkStateFieldPathExpression()walkComparisonExpression()walkInputParameter()walkArithmeticExpression()walkArithmeticTerm()walkStringPrimary()walkArithmeticFactor()walkSimpleArithmeticExpression()walkPathExpression()walkResultVariable()getExecutor()
The following changes have been made to the abstract TreeWalkerAdapter class:
- The method
setQueryComponent()is now protected. - The method
_getQueryComponents()has been removed in favor ofgetQueryComponents().
If the platform you are using does not support identity columns, you should
switch to the SEQUENCE strategy.
The following methods require an argument when being called. Pass null
instead of omitting the argument.
Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs::setFoundMetadata()Doctrine\ORM\AbstractQuery::setHydrationCacheProfile()Doctrine\ORM\AbstractQuery::setResultCache()Doctrine\ORM\AbstractQuery::setResultCacheProfile()
<?php
class MyStrategy implements NamingStrategy
{
/**
* @param string $propertyName A property name.
*/
public function joinColumnName($propertyName): string
{
// …
}
}The class-string type for $className can be inherited from the signature of
the interface.
<?php
class MyStrategy implements NamingStrategy
{
/**
* {@inheritdoc}
*/
public function joinColumnName(string $propertyName, string $className): string
{
// …
}
}Use Doctrine\Persistence\Mapping\Driver\StaticPHPDriver and
Doctrine\Persistence\Mapping\Driver\MappingDriverChain from
doctrine/persistence instead.
The second argument to UnderscoreNamingStrategy::__construct() was dropped,
the strategy can no longer be unaware of numbers.
No replacement is provided.
This feature was deprecated in DBAL 3.3.0 and will be removed in DBAL 4.0. The value conversion methods are now called regardless of the type.
The MappingException::sqlConversionNotAllowedForIdentifiers() method has been removed
as no longer relevant.
The documentation explains how the console tools can be bootstrapped for standalone usage:
https://www.doctrine-project.org/projects/doctrine-orm/en/stable/reference/tools.html
The method ConsoleRunner::printCliConfigTemplate() has been removed as well
because it was only useful in the context of the doctrine binary.
All console commands require a $entityManagerProvider to be passed via the
constructor. Commands won't try to get the entity manager from a previously
registered em console helper.
The following classes have been removed:
Doctrine\ORM\Tools\Console\EntityManagerProvider\HelperSetManagerProviderDoctrine\ORM\Tools\Console\Helper\EntityManagerHelper
The following breaking changes have been applied to Doctrine\ORM\Tools\Console\ConsoleRunner:
- The method
createHelperSet()has been removed. - The methods
run()andcreateApplication()don't accept an instance ofHelperSetas first argument anymore. - The method
addCommands()requires an instance ofEntityManagerProvideras second argument now.
All methods in Doctrine\ORM\ORMException have been extracted to dedicated exceptions.
missingMappingDriverImpl()=>Exception\MissingMappingDriverImplementation::create()unrecognizedField()=>Persisters\Exception\UnrecognizedField::byName()unexpectedAssociationValue()=>Exception\UnexpectedAssociationValue::create()invalidOrientation()=>Persisters\Exception\InvalidOrientation::fromClassNameAndField()entityManagerClosed()=>Exception\EntityManagerClosed::create()invalidHydrationMode()=>Exception\InvalidHydrationMode::fromMode()mismatchedEventManager()=>Exception\MismatchedEventManager::create()findByRequiresParameter()=>Repository\Exception\InvalidMagicMethodCall::onMissingParameter()invalidMagicCall()=>Repository\Exception\InvalidMagicMethodCall::becauseFieldNotFoundIn()invalidFindByInverseAssociation()=>Repository\Exception\InvalidFindByCall::fromInverseSideUsage()invalidResultCacheDriver()=>Cache\Exception\InvalidResultCacheDriver::create()notSupported()=>Exception\NotSupported::create()queryCacheNotConfigured()=>QueryCacheNotConfigured::create()metadataCacheNotConfigured()=>Cache\Exception\MetadataCacheNotConfigured::create()queryCacheUsesNonPersistentCache()=>Cache\Exception\QueryCacheUsesNonPersistentCache::fromDriver()metadataCacheUsesNonPersistentCache()=>Cache\Exception\MetadataCacheUsesNonPersistentCache::fromDriver()proxyClassesAlwaysRegenerating()=>Exception\ProxyClassesAlwaysRegenerating::create()invalidEntityRepository()=>Exception\InvalidEntityRepository::fromClassName()missingIdentifierField()=>Exception\MissingIdentifierField::fromFieldAndClass()unrecognizedIdentifierFields()=>Exception\UnrecognizedIdentifierFields::fromClassAndFieldNames()cantUseInOperatorOnCompositeKeys()=>Persisters\Exception\CantUseInOperatorOnCompositeKeys::create()
All methods in Doctrine\ORM\Cache\CacheException have been extracted to dedicated exceptions.
updateReadOnlyCollection()=>Cache\Exception\CannotUpdateReadOnlyCollection::fromEntityAndField()updateReadOnlyEntity()=>Cache\Exception\CannotUpdateReadOnlyEntity::fromEntity()nonCacheableEntity()=>Cache\Exception\NonCacheableEntity::fromEntity()nonCacheableEntityAssociation()=>Cache\Exception\NonCacheableEntityAssociation::fromEntityAndField()
Although undocumented, it was possible to configure a custom repository
class that implements ObjectRepository but does not extend the
EntityRepository base class. Repository classes have to extend
EntityRepository now.
EntityManager::getRepository()no longer accepts the entity namespace alias notation.Configuration::addEntityNamespace()andConfiguration::getEntityNamespace()have been removed.
The following protected methods of
Doctrine\ORM\Cache\Persister\Collection\AbstractCollectionPersister
have been removed.
evictCollectionCache()evictElementCache()
This class has been removed without replacement.
The following methods have been removed from the class metadata because
quoting is handled by implementations of Doctrine\ORM\Mapping\QuoteStrategy:
getQuotedIdentifierColumnNames()getQuotedColumnName()getQuotedTableName()getQuotedJoinTableName()
Merge semantics was a poor fit for the PHP "share-nothing" architecture. In addition to that, merging caused multiple issues with data integrity in the managed entity graph, which was constantly spawning more edge-case bugs/scenarios.
The method UnitOfWork::merge() has been removed. The method
EntityManager::merge() will throw an exception on each call.
The following methods don't accept a single entity or an array of entities anymore:
Doctrine\ORM\EntityManager::flush()Doctrine\ORM\Decorator\EntityManagerDecorator::flush()Doctrine\ORM\UnitOfWork::commit()
The semantics of flush() and commit() will remain the same, but the change
tracking will be performed on all entities managed by the unit of work, and not
just on the provided entities, as the parameter is now completely ignored.
- Passing an argument other than
nulltoEntityManager::clear()will raise an exception. - The unit of work cannot be cleared partially anymore. Passing an argument to
UnitOfWork::clear()does not have any effect anymore; the unit of work is cleared completely. - The method
EntityRepository::clear()has been removed. - The methods
getEntityClass()andclearsAllEntities()have been removed fromOnClearEventArgs.
The Doctrine Cache library is not supported anymore. The following methods
have been removed from Doctrine\ORM\Configuration:
getQueryCacheImpl()setQueryCacheImpl()getHydrationCacheImpl()setHydrationCacheImpl()getMetadataCacheImpl()setMetadataCacheImpl()
The methods have been replaced by PSR-6 compatible counterparts
(just strip the Impl suffix from the old name to get the new one).
This functionality has been moved to the new ORMSetup class. Call
Doctrine\ORM\ORMSetup::createDefaultAnnotationDriver() to create
a new annotation driver.
In our effort to migrate from Doctrine Cache to PSR-6, the Setup class which
accepted a Doctrine Cache instance in each method has been removed.
The replacement is Doctrine\ORM\ORMSetup which accepts a PSR-6
cache instead.
All APIs related to named queries have been removed.
The following methods have been removed from AbstractQuery:
setResultCacheDriver()getResultCacheDriver()useResultCache()getResultCacheLifetime()getResultCacheId()
The following methods have been removed from Query:
setQueryCacheDriver()getQueryCacheDriver()
The interface has been merged into Doctrine\ORM\Cache\Region.
- Implementations of
AbstractIdGeneratorhave to implement the methodgenerateId(). - The method
generate()has been removed fromAbstractIdGenerator.
Doctrine does not provide its own cache implementation anymore and relies on the PSR-6 standard instead. As a consequence, we cannot determine anymore whether a given cache adapter is suitable for a production environment. Because of that, functionality that aims to do so has been removed:
Configuration::ensureProductionSettings()- the
orm:ensure-production-settingsconsole command
The second level cache has been reworked to consume a PSR-6 cache. Using a Doctrine Cache instance is not supported anymore.
DefaultCacheFactory: The constructor expects a PSR-6 cache item pool as second argument now.DefaultMultiGetRegion: This class has been removed.DefaultRegion:- The constructor expects a PSR-6 cache item pool as second argument now.
- The protected
$cacheproperty is removed. - The properties
$nameand$lifetimeas well as the constantREGION_KEY_SEPARATORand the methodgetCacheEntryKey()areprivatenow. - The method
getCache()has been removed.
Use StaticPHPDriver instead when you want to programmatically configure
entity metadata.
This method has been replaced by Doctrine\ORM\EntityManagerInterface#wrapInTransaction().
The ORM no longer attempts to emulate schemas on SQLite.
Use Composer's autoloader instead.
If your code relies on YamlDriver or SimpleYamlDriver, you MUST migrate to
attribute, annotation or XML drivers instead.
You can use the orm:convert-mapping command to convert your metadata mapping to XML
before upgrading to 3.0:
php doctrine orm:convert-mapping xml /path/to/mapping-path-converted-to-xmlThese console commands have been removed:
orm:convert-d1-schemaorm:convert-mappingorm:generate:entitiesorm:generate-repositories
These classes have been deprecated:
Doctrine\ORM\Tools\ConvertDoctrine1SchemaDoctrine\ORM\Tools\EntityGeneratorDoctrine\ORM\Tools\EntityRepositoryGenerator
The entire Doctrine\ORM\Tools\Export namespace has been removed as well.
Use Composer's runtime API if you really need to check the version of the ORM package at runtime.
The argument $criteria of Doctrine\ORM\EntityRepository::count() is now
optional. Overrides in child classes should be made compatible.
Doctrine\ORM\ORMExceptionhas been removedDoctrine\ORM\Exception\ORMExceptionis now an interface
The following methods were using func_get_args() to simulate a variadic argument:
Doctrine\ORM\Query\Expr#andX()Doctrine\ORM\Query\Expr#orX()Doctrine\ORM\QueryBuilder#select()Doctrine\ORM\QueryBuilder#addSelect()Doctrine\ORM\QueryBuilder#where()Doctrine\ORM\QueryBuilder#andWhere()Doctrine\ORM\QueryBuilder#orWhere()Doctrine\ORM\QueryBuilder#groupBy()Doctrine\ORM\QueryBuilder#andGroupBy()Doctrine\ORM\QueryBuilder#having()Doctrine\ORM\QueryBuilder#andHaving()Doctrine\ORM\QueryBuilder#orHaving()A variadic argument is now actually used in their signatures signature (...$x). Signatures of overridden methods should be changed accordingly
Method Doctrine\ORM\EntityManagerInterface#copy() never got its implementation and is removed in 3.0.
The following classes have been removed:
Doctrine\ORM\Id\TableGeneratorDoctrine\ORM\Id\UuidGenerator
Using the UUID strategy for generating identifiers is not supported anymore.
The deprecated method Query::iterate() has been removed along with the
following classes and methods:
AbstractHydrator::iterate()AbstractHydrator::hydrateRow()IterableResult
Use toIterable() instead.
Add Doctrine\ORM\Query\OutputWalker interface, deprecate Doctrine\ORM\Query\SqlWalker::getExecutor()
Output walkers should implement the new \Doctrine\ORM\Query\OutputWalker interface and create
Doctrine\ORM\Query\Exec\SqlFinalizer instances instead of Doctrine\ORM\Query\Exec\AbstractSqlExecutors.
The output walker must not base its workings on the query firstResult/maxResult values, so that the
SqlFinalizer can be kept in the query cache and used regardless of the actual firstResult/maxResult values.
Any operation dependent on firstResult/maxResult should take place within the SqlFinalizer::createExecutor()
method. Details can be found at #11188.
Property hooks are not supported yet by Doctrine ORM. Until support is added, they are explicitly forbidden because the support would result in a breaking change in behavior.
Progress on this is tracked at #11624 .
Use of the PARTIAL keyword is not deprecated anymore in DQL, because we will be able to support PARTIAL objects with PHP 8.4 Lazy Objects and Symfony/VarExporter in a better way. When we decided to remove this feature these two abstractions did not exist yet.
WARNING: If you want to upgrade to 3.x and still use PARTIAL keyword in DQL with array or object hydrators, then you have to directly migrate to ORM 3.3.x or higher. PARTIAL keyword in DQL is not available in 3.0, 3.1 and 3.2 of ORM.
Use the \Doctrine\ORM\Query::HINT_CUSTOM_OUTPUT_WALKER query hint to set the output walker
class instead of setting it through the \Doctrine\ORM\Query\Parser::setCustomOutputTreeWalker() method
on the parser instance.
Deprecate calling ClassMetadata::getAssociationMappedByTargetField() with the owning side of an association
Calling
Doctrine\ORM\Mapping\ClassMetadata::getAssociationMappedByTargetField() with
the owning side of an association returns null, which is undocumented, and
wrong according to the phpdoc of the parent method.
If you do not know whether you are on the owning or inverse side of an association,
you can use Doctrine\ORM\Mapping\ClassMetadata::isAssociationInverseSide()
to find out.
Use Doctrine\ORM\Query\TokenType::T_* instead.
The following classes have been deprecated:
Doctrine\ORM\Mapping\NamedNativeQueriesDoctrine\ORM\Mapping\NamedNativeQueryDoctrine\ORM\Mapping\NamedQueriesDoctrine\ORM\Mapping\NamedQuery
Use Doctrine\ORM\Query\Exec\AbstractSqlExecutor::sqlStatements instead.
It will be a full-fledged class, no longer extending
Doctrine\Common\Proxy\Autoloader in 3.0.x.
Deprecated: reliance on the non-optimal defaults that come with the AUTO identifier generation strategy
When the AUTO identifier generation strategy was introduced, the best
strategy at the time was selected for each database platform.
A lot of time has passed since then, and with ORM 3.0.0 and DBAL 4.0.0, support
for better strategies will be added.
Because of that, it is now deprecated to rely on the historical defaults when they differ from what we will be recommended in the future.
Instead, you should pick a strategy for each database platform you use, and it
will be used when using AUTO. As of now, only PostgreSQL is affected by this.
It is recommended that PostgreSQL users configure their existing and new
applications to use SEQUENCE until doctrine/dbal 4.0.0 is released:
use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
use Doctrine\ORM\Configuration;
assert($configuration instanceof Configuration);
$configuration->setIdentityGenerationPreferences([
PostgreSQLPlatform::CLASS => ClassMetadata::GENERATOR_TYPE_SEQUENCE,
]);When DBAL 4 is released, AUTO will result in IDENTITY, and the above
configuration should be removed to migrate to it.
This method does not have a replacement and will be removed in 3.0.
Not enabling lazy ghost objects is deprecated. In ORM 3.0, they will be always enabled.
Ensure Doctrine\ORM\Configuration::setLazyGhostObjectEnabled(true) is called to enable them.
For any given entity class and ID value, there should be only one object instance representing the entity.
In #10785, a check was added that will guard this in the identity map. The most probable cause for violations of this rule are collisions of application-provided IDs.
In ORM 2.16.0, the check was added by throwing an exception. In ORM 2.16.1, this will be
changed to a deprecation notice. ORM 3.0 will make it an exception again. Use
\Doctrine\ORM\Configuration::setRejectIdCollisionInIdentityMap() if you want to opt-in
to the new mode.
In #10547, the commit order computation was improved
to fix a series of bugs where a correct (working) commit order was previously not found.
Also, the new computation may get away with fewer queries being executed: By inserting
referred-to entities first and using their ID values for foreign key fields in subsequent
INSERT statements, additional UPDATE statements that were previously necessary can be
avoided.
When using database-provided, auto-incrementing IDs, this may lead to IDs being assigned to entities in a different order than it was previously the case.
Persisters implementing \Doctrine\ORM\Persisters\Entity\EntityPersister should no longer
return an array of post insert IDs from their ::executeInserts() method. Make the
persister call Doctrine\ORM\UnitOfWork::assignPostInsertId() instead.
In ORM 3.0, a change will be made regarding how the AttributeDriver reports field mappings.
This change is necessary to be able to detect (and reject) some invalid mapping configurations.
To avoid surprises during 2.x upgrades, the new mode is opt-in. It can be activated on the
AttributeDriver and AnnotationDriver by setting the $reportFieldsWhereDeclared
constructor parameter to true. It will cause MappingExceptions to be thrown when invalid
configurations are detected.
Not enabling the new mode will cause a deprecation notice to be raised. In ORM 3.0, only the new mode will be available.
For one-to-one associations, the side using the mappedBy attribute is the inverse side.
The owning side is the entity with the table containing the foreign key. Using JoinColumn
configuration on the inverse side now triggers a deprecation notice and will be an error
in 3.0.
As stated in the documentation, fields and associations may only be overridden when being inherited from mapped superclasses. Overriding them for parent entity classes now triggers a deprecation notice and will be an error in 3.0.
As soon as an entity class inherits from another entity class, inheritance has to be declared by adding the appropriate configuration for the root entity.
This third way of mapping class inheritance was never implemented. Code stubs are now deprecated and will be removed in 3.0.
\Doctrine\ORM\Mapping\ClassMetadataInfo::INHERITANCE_TYPE_TABLE_PER_CLASSconstant\Doctrine\ORM\Mapping\ClassMetadataInfo::isInheritanceTypeTablePerClass()method- Using
TABLE_PER_CLASSas the value for theInheritanceTypeattribute or annotation or in XML configuration files.
Use Doctrine\ORM\Persisters\Exception\UnrecognizedField::byFullyQualifiedName($className, $field) instead.
The following public constants have been deprecated:
CommitOrderCalculator::NOT_VISITEDCommitOrderCalculator::IN_PROGRESSCommitOrderCalculator::VISITED
These constants were used for internal purposes. Relying on them is discouraged.
The AST parser will create a InListExpression or a InSubselectExpression when
encountering an IN () DQL expression instead of a generic InExpression.
As a consequence, SqlWalker::walkInExpression() has been deprecated in favor of
SqlWalker::walkInListExpression() and SqlWalker::walkInSubselectExpression().
The Doctrine\ORM\Cache\CacheKey class has an explicit constructor now with
an optional parameter $hash. That parameter will become mandatory in 3.0.
If you need to change the behavior of AttributeDriver::isTransient(),
override that method instead.
Using orm:schema-tool:update without passing the --complete flag is
deprecated. Use schema asset filtering if you need to preserve assets not
managed by DBAL.
Likewise, calling SchemaTool::updateSchema() or
SchemaTool::getUpdateSchemaSql() with a second argument is deprecated.
Please switch to one of the other mapping drivers. Native attributes which PHP supports since version 8.0 are probably your best option.
As a consequence, the following methods are deprecated:
ORMSetup::createAnnotationMetadataConfigurationORMSetup::createDefaultAnnotationDriver
The marker interface Doctrine\ORM\Mapping\Annotation is deprecated as well.
All annotation/attribute classes implement
Doctrine\ORM\Mapping\MappingAttribute now.
Use Doctrine\Persistence\Proxy instead to check whether proxies are initialized.
It will be removed in 3.0. Use one of the dedicated event classes instead:
Doctrine\ORM\Event\PrePersistEventArgsDoctrine\ORM\Event\PreUpdateEventArgsDoctrine\ORM\Event\PreRemoveEventArgsDoctrine\ORM\Event\PostPersistEventArgsDoctrine\ORM\Event\PostUpdateEventArgsDoctrine\ORM\Event\PostRemoveEventArgsDoctrine\ORM\Event\PostLoadEventArgs
The constructor of EntityManager is now public and should be used instead of the create() method.
However, the constructor expects a Connection while create() accepted an array with connection parameters.
You can pass that array to DBAL's Doctrine\DBAL\DriverManager::getConnection() method to bootstrap the
connection.
- The
QueryBuilder::getState()method has been deprecated as the builder state is an internal concern. - Relying on the type of the query being built by using
QueryBuilder::getType()has been deprecated. If necessary, track the type of the query being built outside of the builder.
The following QueryBuilder constants related to the above methods have been deprecated:
SELECT,DELETE,UPDATE,STATE_DIRTY,STATE_CLEAN.
When building an UPDATE or DELETE query and when passing a class/type to the function, the alias argument must not be omitted.
$qb = $em->createQueryBuilder()
->delete('User u')
->where('u.id = :user_id')
->setParameter('user_id', 1);$qb = $em->createQueryBuilder()
->delete('User', 'u')
->where('u.id = :user_id')
->setParameter('user_id', 1);If identity columns are emulated with sequences on the platform you are using,
you should switch to the SEQUENCE strategy.
$query->setFirstResult(null); is equivalent to $query->setFirstResult(0).
The following methods will require an argument in 3.0. Pass null instead of
omitting the argument.
Doctrine\ORM\Event\OnClassMetadataNotFoundEventArgs::setFoundMetadata()Doctrine\ORM\AbstractQuery::setHydrationCacheProfile()Doctrine\ORM\AbstractQuery::setResultCache()Doctrine\ORM\AbstractQuery::setResultCacheProfile()
Calling AbstractQuery::setFetchMode() with anything else than
Doctrine\ORM\Mapping::FETCH_EAGER results in
Doctrine\ORM\Mapping::FETCH_LAZY being used. Relying on that behavior is
deprecated and will result in an exception in 3.0.
Deprecated getEntityManager() in Doctrine\ORM\Event\OnClearEventArgs and Doctrine\ORM\Event\*FlushEventArgs
This method has been deprecated in:
Doctrine\ORM\Event\OnClearEventArgsDoctrine\ORM\Event\OnFlushEventArgsDoctrine\ORM\Event\PostFlushEventArgsDoctrine\ORM\Event\PreFlushEventArgs
It will be removed in 3.0. Use getObjectManager() instead.
In 3.0, SqlWalker and its child classes won't implement the TreeWalker
interface anymore. Relying on that inheritance is deprecated.
The following methods of the TreeWalker interface have been deprecated:
setQueryComponent()walkSelectClause()walkFromClause()walkFunction()walkOrderByClause()walkOrderByItem()walkHavingClause()walkJoin()walkSelectExpression()walkQuantifiedExpression()walkSubselect()walkSubselectFromClause()walkSimpleSelectClause()walkSimpleSelectExpression()walkAggregateExpression()walkGroupByClause()walkGroupByItem()walkDeleteClause()walkUpdateClause()walkUpdateItem()walkWhereClause()walkConditionalExpression()walkConditionalTerm()walkConditionalFactor()walkConditionalPrimary()walkExistsExpression()walkCollectionMemberExpression()walkEmptyCollectionComparisonExpression()walkNullComparisonExpression()walkInExpression()walkInstanceOfExpression()walkLiteral()walkBetweenExpression()walkLikeExpression()walkStateFieldPathExpression()walkComparisonExpression()walkInputParameter()walkArithmeticExpression()walkArithmeticTerm()walkStringPrimary()walkArithmeticFactor()walkSimpleArithmeticExpression()walkPathExpression()walkResultVariable()getExecutor()
The following changes have been made to the abstract TreeWalkerAdapter class:
- All implementations of now-deprecated
TreeWalkermethods have been deprecated as well. - The method
setQueryComponent()will become protected in 3.0. Calling it publicly is deprecated. - The method
_getQueryComponents()is deprecated, callgetQueryComponents()instead.
On the TreeWalkerChain class, all implementations of now-deprecated
TreeWalker methods have been deprecated as well. However, SqlWalker is
unaffected by those deprecations and will continue to implement all of those
methods.
Doing $query->setDQL(null); achieves nothing.
When implementing NamingStrategy, it is deprecated to implement
joinColumnName() with only one argument.
<?php
class MyStrategy implements NamingStrategy
{
/**
* @param string $propertyName A property name.
*/
public function joinColumnName($propertyName): string
{
// …
}
}For backward-compatibility reasons, the parameter has to be optional, but can
be documented as guaranteed to be a class-string.
<?php
class MyStrategy implements NamingStrategy
{
/**
* @param string $propertyName A property name.
* @param class-string $className
*/
public function joinColumnName($propertyName, $className = null): string
{
// …
}
}The following methods have been deprecated:
Doctrine\ORM\Query\ResultSetMappingBuilder::addNamedNativeQueryMapping()Doctrine\ORM\Query\ResultSetMappingBuilder::addNamedNativeQueryResultClassMapping()Doctrine\ORM\Query\ResultSetMappingBuilder::addNamedNativeQueryResultSetMapping()Doctrine\ORM\Query\ResultSetMappingBuilder::addNamedNativeQueryEntityResultMapping()
The following classes have been deprecated:
Doctrine\ORM\Tools\ConvertDoctrine1SchemaDoctrine\ORM\Tools\DisconnectedClassMetadataFactory
It is deprecated to pass Doctrine\ORM\Mapping\ClassMetadataInfo instances
that are not also instances of Doctrine\ORM\ClassMetadata to the following
methods:
Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder::__construct()Doctrine\ORM\Mapping\Driver\DatabaseDriver::loadMetadataForClass()Doctrine\ORM\Tools\SchemaValidator::validateClass()
The documentation explains how the console tools can be bootstrapped for standalone usage.
The method ConsoleRunner::printCliConfigTemplate() is deprecated because it
was only useful in the context of the doctrine binary.
To make it easier to identify understand the cause for that exception, it is
deprecated to omit the class name when calling
ORMInvalidArgumentException::invalidIdentifierBindingEntity().
Using a console helper to provide the ORM's console commands with one or
multiple entity managers had been deprecated with 2.9 already. This leaves
The EntityManagerHelper class with no purpose which is why it is now
deprecated too. Applications that still rely on the em console helper, can
easily recreate that class in their own codebase.
Although undocumented, it is currently possible to configure a custom repository
class that implements ObjectRepository but does not extend the
EntityRepository base class.
This is now deprecated. Please extend EntityRepository instead.
-$config = $entityManager->getConfiguration();
-$config->addEntityNamespace('CMS', 'My\App\Cms');
+use My\App\Cms\CmsUser;
-$entityManager->getRepository('CMS:CmsUser');
+$entityManager->getRepository(CmsUser::class);That method was inherited from the abstract AnnotationDriver class of
doctrine/persistence, and does not seem to serve any purpose.
Because no forward-compatible new proxy solution had been implemented yet, the current proxy mechanism is not considered deprecated anymore for the time being. This applies to the following interfaces/classes:
Doctrine\ORM\Proxy\ProxyDoctrine\ORM\Proxy\ProxyFactory
These methods have been un-deprecated:
Doctrine\ORM\Configuration::getAutoGenerateProxyClasses()Doctrine\ORM\Configuration::getProxyDir()Doctrine\ORM\Configuration::getProxyNamespace()
Note that the Doctrine\ORM\Proxy\Autoloader remains deprecated and will be removed in 3.0.
The following protected methods of
Doctrine\ORM\Cache\Persister\Collection\AbstractCollectionPersister
are not in use anymore and will be removed.
evictCollectionCache()evictElementCache()
This class won't have a replacement.
These methods will be removed in 3.0 along with the ability to partially clear the entity manager.
This functionality has been moved to the new ORMSetup class. Call
Doctrine\ORM\ORMSetup::createDefaultAnnotationDriver() to create
a new annotation driver.
In our effort to migrate from Doctrine Cache to PSR-6, the Setup class which
accepted a Doctrine Cache instance in each method has been deprecated.
The replacement is Doctrine\ORM\ORMSetup which accepts a PSR-6
cache instead.
The interface will be merged with Doctrine\ORM\Cache\Region in 3.0.
Implementations of AbstractIdGenerator have to override the method
generateId() without calling the parent implementation. Not doing so is
deprecated. Calling generate() on any AbstractIdGenerator implementation
is deprecated.
The second level cache has been reworked to consume a PSR-6 cache. Using a Doctrine Cache instance is deprecated.
DefaultCacheFactory: The constructor expects a PSR-6 cache item pool as second argument now.DefaultMultiGetRegion: This class is deprecated in favor ofDefaultRegion.DefaultRegion:- The constructor expects a PSR-6 cache item pool as second argument now.
- The protected
$cacheproperty is deprecated. - The properties
$nameand$lifetimeas well as the constantREGION_KEY_SEPARATORand the methodgetCacheEntryKey()are flagged as@internalnow. They all will becomeprivatein 3.0. - The method
getCache()is deprecated without replacement.
Use StaticPHPDriver instead when you want to programmatically configure
entity metadata.
You can convert mappings with the orm:convert-mapping command or more simply
in this case, include the metadata file from the loadMetadata static method
used by the StaticPHPDriver.
Use Composer's autoloader instead.
Following the deprecation of the method AbstractHydrator::iterate(), the
method hydrateRow() has been deprecated as well.
Doctrine does not provide its own cache implementation anymore and relies on the PSR-6 standard instead. As a consequence, we cannot determine anymore whether a given cache adapter is suitable for a production environment. Because of that, functionality that aims to do so has been deprecated:
Configuration::ensureProductionSettings()- the
orm:ensure-production-settingsconsole command
When calling the following methods, you are now supposed to use the result of
spl_object_id(), and not spl_object_hash():
UnitOfWork::clearEntityChangeSet()UnitOfWork::setOriginalEntityProperty()
The implementation was unfinished for 14 years. It is now deprecated to rely on:
Doctrine\ORM\Id\TableGenerator;Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_TABLE;Doctrine\ORM\Mapping\ClassMetadata::$tableGeneratorDefinition;- or
Doctrine\ORM\Mapping\ClassMetadata::isIdGeneratorTable().
Works the same as Doctrine\ORM\EntityManagerInterface#transactional() but returns any value returned from $func closure rather than just non-empty value returned from the closure or true.
Because of BC policy, the method does not exist on the interface yet. This is the example of safe usage:
function foo(EntityManagerInterface $entityManager, callable $func) {
if (method_exists($entityManager, 'wrapInTransaction')) {
return $entityManager->wrapInTransaction($func);
}
return $entityManager->transactional($func);
}Doctrine\ORM\EntityManagerInterface#transactional() has been deprecated.
The following methods were not in use and are very unlikely to be used by downstream packages or applications, and were consequently removed:
ORMException::entityMissingForeignAssignedIdORMException::entityMissingAssignedIdForFieldORMException::invalidFlushMode
DB-generated UUIDs are deprecated as of doctrine/dbal 2.8.
As a consequence, using the UUID strategy for generating identifiers is deprecated as well.
Furthermore, relying on the following classes and methods is deprecated:
Doctrine\ORM\Id\UuidGeneratorDoctrine\ORM\Mapping\ClassMetadataInfo::isIdentifierUuid()
The type declaration of the $stmt parameter of AbstractHydrator::toIterable() has been removed. This change might
break custom hydrator implementations that override this very method.
Overriding this method is not recommended, which is why the method is documented as @final now.
- public function toIterable(ResultStatement $stmt, ResultSetMapping $resultSetMapping, array $hints = []): iterable
+ public function toIterable($stmt, ResultSetMapping $resultSetMapping, array $hints = []): iterableEntity namespace aliases are deprecated, use the magic ::class constant to abbreviate full class names in EntityManager, EntityRepository and DQL.
- $entityManager->find('MyBundle:User', $id);
+ $entityManager->find(User::class, $id);With the deprecation of doctrine/cache, the setup tool might no longer work as expected without a different cache implementation. To work around this:
- Install symfony/cache:
composer require symfony/cache. This will keep previous behaviour without any changes - Instantiate caches yourself: to use a different cache implementation, pass a cache instance when calling any
configuration factory in the setup tool:
- $config = Setup::createAnnotationMetadataConfiguration($paths, $isDevMode, $proxyDir); + $cache = \Doctrine\Common\Cache\Psr6\DoctrineProvider::wrap($anyPsr6Implementation); + $config = Setup::createAnnotationMetadataConfiguration($paths, $isDevMode, $proxyDir, $cache);
- As a quick workaround, you can lock the doctrine/cache dependency to work around this:
composer require doctrine/cache ^1.11. Note that this is only recommended as a bandaid fix, as future versions of ORM will no longer work with doctrine/cache 1.11.
The Doctrine\ORM\Configuration#setMetadataCacheImpl() method is deprecated and should no longer be used. Please use
Doctrine\ORM\Configuration#setMetadataCache() with any PSR-6 cache adapter instead.
To support PSR-6 caches, the --flush option for the orm:clear-cache:metadata command is ignored. Metadata cache is
now always cleared regardless of the cache adapter being used.
Method Doctrine\ORM\UnitOfWork#commit() can throw an OptimisticLockException when a commit silently fails and returns false
since Doctrine\DBAL\Connection#commit() signature changed from returning void to boolean
The method Doctrine\ORM\AbstractQuery#iterate() is deprecated in favor of Doctrine\ORM\AbstractQuery#toIterable().
Note that toIterable() yields results of the query, unlike iterate() which yielded each result wrapped into an array.
Added Doctrine\ORM\AbstractQuery#enableResultCache() and Doctrine\ORM\AbstractQuery#disableResultCache() methods
Method Doctrine\ORM\AbstractQuery#useResultCache() which could be used for both enabling and disabling the cache
(depending on passed flag) was split into two.
Minor BC BREAK: paginator output walkers aren't be called anymore on sub-queries for queries without max results
To optimize DB interaction, Doctrine\ORM\Tools\Pagination\Paginator no longer fetches identifiers to be able to
perform the pagination with join collections when max results isn't set in the query.
When generating schema diffs, if a source table is filtered out by a schema_filter expression, then a CREATE TABLE was
always generated, even if the table already existed. This has been changed in this release and the table will no longer
be created.
In the last patch of the v2.6.x series, we fixed a bug that was not converting names properly when they had numbers
(e.g.: base64Encoded was wrongly converted to base64encoded instead of base64_encoded).
In order to not break BC we've introduced a way to enable the fixed behavior using a boolean constructor argument. This argument will be removed in 3.0 and the default behavior will be the fixed one.
Method Doctrine\ORM\AbstractQuery#useResultCache() is deprecated because it is split into enableResultCache()
and disableResultCache(). It will be removed in 3.0.
These console commands have been deprecated:
orm:convert-mappingorm:generate:entitiesorm:generate-repositories
These classes have been deprecated:
Doctrine\ORM\Tools\EntityGeneratorDoctrine\ORM\Tools\EntityRepositoryGenerator
Whole Doctrine\ORM\Tools\Export namespace with all its members have been deprecated as well.
Proxy objects in Doctrine ORM 3.0 will no longer implement Doctrine\ORM\Proxy\Proxy nor
Doctrine\Persistence\Proxy: instead, they implement
ProxyManager\Proxy\GhostObjectInterface.
These related classes have been deprecated:
Doctrine\ORM\Proxy\ProxyFactoryDoctrine\ORM\Proxy\Autoloader- we suggest using the composer autoloader instead
These methods have been deprecated:
Doctrine\ORM\Configuration#getAutoGenerateProxyClasses()Doctrine\ORM\Configuration#getProxyDir()Doctrine\ORM\Configuration#getProxyNamespace()
The Doctrine\ORM\Version class is now deprecated and will be removed in Doctrine ORM 3.0:
please refrain from checking the ORM version at runtime or use Composer's runtime API.
Merge semantics was a poor fit for the PHP "share-nothing" architecture. In addition to that, merging caused multiple issues with data integrity in the managed entity graph, which was constantly spawning more edge-case bugs/scenarios.
The following API methods were therefore deprecated:
EntityManager#merge()UnitOfWork#merge()
An alternative to EntityManager#merge() will not be provided by ORM 3.0, since the merging
semantics should be part of the business domain rather than the persistence domain of an
application. If your application relies heavily on CRUD-alike interactions and/or PATCH
restful operations, you should look at alternatives such as JMSSerializer.
Final keyword will be added to the EntityManager::class in Doctrine ORM 3.0 in order to ensure that EntityManager
is not used as valid extension point. Valid extension point should be EntityManagerInterface.
If your code relies on clearing a single entity type via EntityManager#clear($entityName),
the signature has been changed to EntityManager#clear().
The main reason is that partial clears caused multiple issues with data integrity in the managed entity graph, which was constantly spawning more edge-case bugs/scenarios.
If your code relies on single entity flushing optimisations via
EntityManager#flush($entity), the signature has been changed to
EntityManager#flush().
Said API was affected by multiple data integrity bugs due to the fact that change tracking was being restricted upon a subset of the managed entities. The ORM cannot support committing subsets of the managed entities while also guaranteeing data integrity, therefore this utility was removed.
The flush() semantics will remain the same, but the change tracking will be performed
on all entities managed by the unit of work, and not just on the provided
$entity or $entities, as the parameter is now completely ignored.
The same applies to UnitOfWork#commit($entity), which will simply be
UnitOfWork#commit().
If you would still like to perform batching operations over small UnitOfWork
instances, it is suggested to follow these paths instead:
- eagerly use
EntityManager#clear()in conjunction with a specific second level cache configuration (see http://docs.doctrine-project.org/projects/doctrine-orm/en/stable/reference/second-level-cache.html) - use an explicit change tracking policy (see http://docs.doctrine-project.org/projects/doctrine-orm/en/stable/reference/change-tracking-policies.html)
If your code relies on YamlDriver or SimpleYamlDriver, you MUST change to
annotation or XML drivers instead.
Method Doctrine\ORM\EntityManagerInterface#copy() never got its implementation and is deprecated.
It will be removed in 3.0.
Doctrine\ORM\EntityRepository::count() has been added. This new method has different
signature than Countable::count() (required parameter) and therefore are not compatible.
If your repository implemented the Countable interface, you will have to use
$repository->count([]) instead and not implement Countable interface anymore.
Since it's just an utilitarian class and should not be inherited.
Method Doctrine\ORM\Query\QueryException::associationPathInverseSideNotSupported()
now has a required parameter $pathExpr.
Method Doctrine\ORM\Query\Parser#isInternalFunction() was removed because
the distinction between internal function and user defined DQL was removed.
#6500
Method Doctrine\ORM\Query\Parser#overwriteInternalDQLFunctionNotAllowed() was
removed because of the choice to allow users to overwrite internal functions, ie
AVG, SUM, COUNT, MIN and MAX. #6500
Doctrine 2.6 now requires PHP 7.1 or newer.
As a consequence, automatic cache setup in Doctrine\ORM\Tools\Setup::create*Configuration() was changed:
- APCu extension (ext-apcu) will now be used instead of abandoned APC (ext-apc).
- Memcached extension (ext-memcached) will be used instead of obsolete Memcache (ext-memcache).
- XCache support was dropped as it doesn't work with PHP 7.
Method Doctrine\ORM\Query\SqlWalker#walkCaseExpression() was unused and part
of the internal API of the ORM, so it was removed. #5600.
Minor BC BREAK: removed $className parameter on AbstractEntityInheritancePersister#getSelectJoinColumnSQL()
As $className parameter was not used in the method, it was safely removed.
As of 2.5.5, the QueryCacheEntry#time property will contain a float value
instead of an integer in order to have more precision and also to be consistent
with the TimestampCacheEntry#time.
It is now required that you declare the root of an inheritance in the discriminator map.
When declaring an inheritance map, it was previously possible to skip the root of the inheritance in the discriminator map. This was actually a validation mistake by Doctrine2 and led to problems when trying to persist instances of that class.
If you don't plan to persist instances some classes in your inheritance, then either:
- make those classes
abstract - map those classes as
MappedSuperclass
As of 2.5, classes requiring the EntityManager in any method signature will now require
an EntityManagerInterface instead.
If you are extending any of the following classes, then you need to check following
signatures:
Doctrine\ORM\Tools\DebugUnitOfWorkListener#dumpIdentityMap(EntityManagerInterface $em)Doctrine\ORM\Mapping\ClassMetadataFactory#setEntityManager(EntityManagerInterface $em)
As of 2.5, AbstractHydrator does not enforce the usage of cache as part of
API, and now provides you a clean API for column information through the method
hydrateColumnInfo($column).
Cache variable being passed around by reference is no longer needed since
Hydrators are per query instantiated since Doctrine 2.4.
Whenever EntityManager#clear() method gets called with a given entity class
name, until 2.4, it was only detaching the specific requested entity.
As of 2.5, EntityManager will follow configured cascades, providing a better
memory management since associations will be garbage collected, optimizing
resources consumption on long running jobs.
- A new method
embeddedFieldToColumnName($propertyName, $embeddedColumnName)
This method generates the column name for fields of embedded objects. If you implement your custom NamingStrategy, you now also need to implement this new method.
- A change to method
joinColumnName()to include the $className
In Doctrine 2.4, if you modified properties of an entity scheduled for deletion, UnitOfWork would
produce an UPDATE statement to be executed right before the DELETE statement. The entity in question
was therefore present in UnitOfWork#entityUpdates, which means that preUpdate and postUpdate
listeners were (quite pointlessly) called. In preFlush listeners, it used to be possible to undo
the scheduled deletion for updated entities (by calling persist() if the entity was found in both
entityUpdates and entityDeletions). This does not work any longer, because the entire changeset
calculation logic is optimized away.
A misconception concerning default lock mode values in method signatures lead to unexpected behaviour
in SQL statements on SQL Server. With a default lock mode of LockMode::NONE throughout the
method signatures in ORM, the table lock hint WITH (NOLOCK) was appended to all locking related
queries by default. This could result in unpredictable results because an explicit WITH (NOLOCK)
table hint tells SQL Server to run a specific query in transaction isolation level READ UNCOMMITTED
instead of the default READ COMMITTED transaction isolation level.
Therefore there now is a distinction between LockMode::NONE and null to be able to tell
Doctrine whether to add table lock hints to queries by intention or not. To achieve this, the following
method signatures have been changed to declare $lockMode = null instead of $lockMode = LockMode::NONE:
Doctrine\ORM\Cache\Persister\AbstractEntityPersister#getSelectSQL()Doctrine\ORM\Cache\Persister\AbstractEntityPersister#load()Doctrine\ORM\Cache\Persister\AbstractEntityPersister#refresh()Doctrine\ORM\Decorator\EntityManagerDecorator#find()Doctrine\ORM\EntityManager#find()Doctrine\ORM\EntityRepository#find()Doctrine\ORM\Persisters\BasicEntityPersister#getSelectSQL()Doctrine\ORM\Persisters\BasicEntityPersister#load()Doctrine\ORM\Persisters\BasicEntityPersister#refresh()Doctrine\ORM\Persisters\EntityPersister#getSelectSQL()Doctrine\ORM\Persisters\EntityPersister#load()Doctrine\ORM\Persisters\EntityPersister#refresh()Doctrine\ORM\Persisters\JoinedSubclassPersister#getSelectSQL()
You should update signatures for these methods if you have subclassed one of the above classes. Please also check the calling code of these methods in your application and update if necessary.
Note:
This in fact is really a minor BC BREAK and should not have any affect on database vendors
other than SQL Server because it is the only one that supports and therefore cares about
LockMode::NONE. It's really just a FIX for SQL Server environments using ORM.
As of PHP 5.6, instantiation of new entities is deferred to the
doctrine/instantiator library, which will avoid calling __clone
or any public API on instantiated objects.
Please implement the Doctrine\ORM\Repository\RepositoryFactory interface instead of extending
the Doctrine\ORM\Repository\DefaultRepositoryFactory.
BC BREAK: New object expression DQL queries now respects user provided aliasing and not return consumed fields
When executing DQL queries with new object expressions, instead of returning DTOs numerically indexes, it will now respect user provided aliases. Consider the following query:
SELECT new UserDTO(u.id,u.name) as user,new AddressDTO(a.street,a.postalCode) as address, a.id as addressId FROM User u INNER JOIN u.addresses a WITH a.isPrimary = true
Previously, your result would be similar to this:
array(
0=>array(
0=>{UserDTO object},
1=>{AddressDTO object},
2=>{u.id scalar},
3=>{u.name scalar},
4=>{a.street scalar},
5=>{a.postalCode scalar},
'addressId'=>{a.id scalar},
),
...
)
From now on, the resultset will look like this:
array(
0=>array(
'user'=>{UserDTO object},
'address'=>{AddressDTO object},
'addressId'=>{a.id scalar}
),
...
)
Minor BC BREAK: added second parameter $indexBy in EntityRepository#createQueryBuilder method signature
Added way to access the underlying QueryBuilder#from() method's 'indexBy' parameter when using EntityRepository#createQueryBuilder()
In Doctrine 2.3 it was possible to use the new matching($criteria)
functionality by adding constraints for assocations based on ID:
Criteria::expr()->eq('association', $assocation->getId());
This functionality does not work on InMemory collections however, because
in memory criteria compares object values based on reference.
As of 2.4 the above code will throw an exception. You need to change
offending code to pass the $assocation reference directly:
Criteria::expr()->eq('association', $assocation);
The test suite now runs with composer autoloading. Support for PEAR, and tarball autoloading is deprecated. Support for GIT submodules is removed.
Before 2.4 the postFlush and onFlush events were only called when there were actually entities that changed. Now these events are called no matter if there are entities in the UoW or changes are found.
Before 2.4 parenthesis are not considered in arithmetic primary expression. That's conceptually wrong, since it might result in wrong values. For example:
The DQL:
SELECT 100 / ( 2 * 2 ) FROM MyEntity
Before 2.4 it generates the SQL:
SELECT 100 / 2 * 2 FROM my_entity
Now parenthesis are considered, the previous DQL will generate:
SELECT 100 / (2 * 2) FROM my_entity
The new feature to detect discriminator maps automatically when none
are provided breaks userland implementations doing this with a
listener in loadClassMetadata event.
Previous to 2.3, calling EntityManager#find() would be delegated to
EntityRepository#find(). This has lead to some unexpected behavior in the
core of Doctrine when people have overwritten the find method in their
repositories. That is why this behavior has been reversed in 2.3, and
EntityRepository#find() calls EntityManager#find() instead.
When generating an add*() method for a collection the EntityGenerator will now not use the Type-Hint to get the singular for the collection name, but use the field-name and strip a trailing "s" character if there is one.
When merging an entity in UoW not only mapped properties are copied, but also others.
From now on, parameters in queries is an ArrayCollection instead of a simple array. This affects heavily the usage of setParameters(), because it will not append anymore parameters to query, but will actually override the already defined ones. Whenever you are retrieving a parameter (ie. $query->getParameter(1)), you will receive an instance of Query\Parameter, which contains the methods "getName", "getValue" and "getType". Parameters are also only converted to when necessary, and not when they are set.
Also, related functions were affected:
- execute($parameters, $hydrationMode) the argument $parameters can be either an key=>value array or an ArrayCollection instance
- iterate($parameters, $hydrationMode) the argument $parameters can be either an key=>value array or an ArrayCollection instance
- setParameters($parameters) the argument $parameters can be either an key=>value array or an ArrayCollection instance
- getParameters() now returns ArrayCollection instead of array
- getParameter($key) now returns Parameter instance instead of parameter value
Internal changes were made to DQL and SQL generation. If you have implemented your own TreeWalker, you probably need to update it. The method walkJoinVariableDeclaration is now named walkJoin.
Two methods getQueryComponents() and setQueryComponent() were added to the TreeWalker interface and all its implementations including TreeWalkerAdapter, TreeWalkerChain and SqlWalker. If you have your own implementation not inheriting from one of the above you must implement these new methods.
Metadata drivers have been rewritten to reuse code from Doctrine\Persistence. Anyone who is using the
Doctrine\ORM\Mapping\Driver\Driver interface should instead refer to
Doctrine\Persistence\Mapping\Driver\MappingDriver. Same applies to
Doctrine\ORM\Mapping\Driver\AbstractFileDriver: you should now refer to
Doctrine\Persistence\Mapping\Driver\FileDriver.
Also, following mapping drivers have been deprecated, please use their replacements in Doctrine\Common as listed:
Doctrine\ORM\Mapping\Driver\DriverChain=>Doctrine\Persistence\Mapping\Driver\MappingDriverChainDoctrine\ORM\Mapping\Driver\PHPDriver=>Doctrine\Persistence\Mapping\Driver\PHPDriverDoctrine\ORM\Mapping\Driver\StaticPHPDriver=>Doctrine\Persistence\Mapping\Driver\StaticPHPDriver
The result cache is completely rewritten and now works on the database result level, not inside the ORM AbstractQuery anymore. This means that for result cached queries the hydration will now always be performed again, regardless of the hydration mode. Affected areas are:
- Fixes the problem that entities coming from the result cache were not registered in the UnitOfWork leading to problems during EntityManager#flush. Calls to EntityManager#merge are not necessary anymore.
- Affects the array hydrator which now includes the overhead of hydration compared to caching the final result.
The API is backwards compatible however most of the getter methods on the AbstractQuery object are now
deprecated in favor of calling AbstractQuery#getQueryCacheProfile(). This method returns a Doctrine\DBAL\Cache\QueryCacheProfile
instance with access to result cache driver, lifetime and cache key.
Entities returned from EntityManager#getPartialReference() are now marked as read-only if they haven't been in the identity map before. This means objects of this kind never lead to changes in the UnitOfWork.
Fields of an entity that are not returned from a partial DQL Query or native SQL query will never be updated through an UPDATE statement.
The onUpdate foreign key handling makes absolutely no sense in an ORM. Additionally Oracle doesn't even support it. Support for it is removed.
There have been some changes to the annotation handling in Common 2.2 again, that affect how people with old configurations
from 2.0 have to configure the annotation driver if they don't use Configuration::newDefaultAnnotationDriver():
// Register the ORM Annotations in the AnnotationRegistry
AnnotationRegistry::registerFile('path/to/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php');
$reader = new \Doctrine\Common\Annotations\SimpleAnnotationReader();
$reader->addNamespace('Doctrine\ORM\Mapping');
$reader = new \Doctrine\Common\Annotations\CachedReader($reader, new ArrayCache());
$driver = new AnnotationDriver($reader, (array)$paths);
$config->setMetadataDriverImpl($driver);
You are now allowed to mark scalar SELECT expressions as HIDDEN an they are not hydrated anymore. Example:
SELECT u, SUM(a.id) AS HIDDEN numArticles FROM User u LEFT JOIN u.Articles a ORDER BY numArticles DESC HAVING numArticles > 10
Your result will be a collection of Users, and not an array with key 0 as User object instance and "numArticles" as the number of articles per user
When hydrating to array or even a mixed result in object hydrator, previously you had the 0 index holding you entity instance. You are now allowed to alias this, providing more flexibility for you code. Example:
SELECT u AS user FROM User u
Will now return a collection of arrays with index "user" pointing to the User object instance.
Thousands of lines were completely reviewed and optimized for best performance. Removed redundancy and improved code readability made now internal Doctrine code easier to understand. Also, Doctrine 2.2 now is around 10-15% faster than 2.1.
Previously EntityManager#find(null) returned null. It now throws an exception.
The EntityRepository now has an interface Doctrine\Persistence\ObjectRepository. This means that your classes that override EntityRepository and extend find(), findOneBy() or findBy() must be adjusted to follow this interface.
The annotation reader was heavily refactored between 2.0 and 2.1-RC1. In theory the operation of the new reader should be backwards compatible, but it has to be setup differently to work that way:
// new call to the AnnotationRegistry
\Doctrine\Common\Annotations\AnnotationRegistry::registerFile('/doctrine-src/src/Mapping/Driver/DoctrineAnnotations.php');
$reader = new \Doctrine\Common\Annotations\AnnotationReader();
$reader->setDefaultAnnotationNamespace('Doctrine\ORM\Mapping\\');
// new code necessary starting here
$reader->setIgnoreNotImportedAnnotations(true);
$reader->setEnableParsePhpImports(false);
$reader = new \Doctrine\Common\Annotations\CachedReader(
new \Doctrine\Common\Annotations\IndexedReader($reader), new ArrayCache()
);
This is already done inside the $config->newDefaultAnnotationDriver, so everything should automatically work if you are using this method. You can verify if everything still works by executing a console command such as schema-validate that loads all metadata into memory.
We changed how the XML Driver allows to define the change-tracking-policy. The working case is now:
<entity change-tracking-policy="DEFERRED_IMPLICT" />
As of Beta3 you can now serialize uninitialized proxies, an exception will only be thrown when
trying to access methods on the unserialized proxy as long as it has not been re-attached to the
EntityManager using EntityManager#merge(). See this example:
$proxy = $em->getReference('User', 1);
$serializedProxy = serialize($proxy);
$detachedProxy = unserialized($serializedProxy);
echo $em->contains($detachedProxy); // FALSE
try {
$detachedProxy->getId(); // uninitialized detached proxy
} catch(Exception $e) {
}
$attachedProxy = $em->merge($detachedProxy);
echo $attackedProxy->getId(); // works!
The DBAL Type "datetime" included the Timezone Offset in both Postgres and Oracle. As of this version they are now generated without Timezone (TIMESTAMP WITHOUT TIME ZONE instead of TIMESTAMP WITH TIME ZONE). See this comment to Ticket DBAL-22 for more details as well as migration issues for PostgreSQL and Oracle.
Both Postgres and Oracle will throw Exceptions during hydration of Objects with "DateTime" fields unless migration steps are taken!
The support for implicit joins in DQL through the multi-dot/Deep Path Expressions was dropped. For example:
SELECT u FROM User u WHERE u.group.name = ?1
See the "u.group.id" here is using multi dots (deep expression) to walk through the graph of objects and properties. Internally the DQL parser would rewrite these queries to:
SELECT u FROM User u JOIN u.group g WHERE g.name = ?1
This explicit notation will be the only supported notation as of now. The internal handling of multi-dots in the DQL Parser was very complex, error prone in edge cases and required special treatment for several features we added. Additionally it had edge cases that could not be solved without making the DQL Parser even much more complex. For this reason we will drop the support for the deep path expressions to increase maintainability and overall performance of the DQL parsing process. This will benefit any DQL query being parsed, even those not using deep path expressions.
Note that the generated SQL of both notations is exactly the same! You don't loose anything through this.
The default allocation size for sequences has been changed from 10 to 1. This step was made to not cause confusion with users and also because it is partly some kind of premature optimization.
There are no backwards incompatible changes in this release.
Instead of accessing protected variables for the EntityManager in a custom EntityRepository it is now required to use the getter methods for all the three instance variables:
$this->_emnow accessible through$this->getEntityManager()$this->_classnow accessible through$this->getClassMetadata()$this->_entityNamenow accessible through$this->getEntityName()
Important: For Beta 2 the protected visibility of these three properties will be changed to private!
The Doctrine CLI has been replaced by Symfony Console Configuration
Instead of having to specify:
[php]
$cliConfig = new CliConfiguration();
$cliConfig->setAttribute('em', $entityManager);
You now have to configure the script like:
[php]
$helperSet = new \Symfony\Components\Console\Helper\HelperSet(array(
'db' => new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($em->getConnection()),
'em' => new \Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper($em)
));
In previous versions you had to specify the --from and --from-path options to show where your mapping paths are from the console. However this information is already known from the Mapping Driver configuration, so the requirement for this options were dropped.
Instead for each console command all the entities are loaded and to restrict the operation to one or more sub-groups you can use the --filter flag.
In conjunction with the recent changes to Console we realized that the annotations driver being a default metadata driver lead to lots of glue code in the console components to detect where entities lie and how to load them for batch updates like SchemaTool and other commands. However the annotations driver being a default driver does not really help that much anyways.
Therefore we decided to break backwards compatibility in this issue and drop the support for Annotations as Default Driver and require our users to specify the driver explicitly (which allows us to ask for the path to all entities).
If you are using the annotations metadata driver as default driver, you have to add the following lines to your bootstrap code:
$driverImpl = $config->newDefaultAnnotationDriver(array(__DIR__."/Entities"));
$config->setMetadataDriverImpl($driverImpl);
You have to specify the path to your entities as either string of a single path or array of multiple paths to your entities. This information will be used by all console commands to access all entities.
Xml and Yaml Drivers work as before!
It is now mandatory that the owning side of a bidirectional association specifies the 'inversedBy' attribute that points to the name of the field on the inverse side that completes the association. Example:
[php]
// BEFORE (ALPHA4 AND EARLIER)
class User
{
//...
/** @OneToOne(targetEntity="Address", mappedBy="user") */
private $address;
//...
}
class Address
{
//...
/** @OneToOne(targetEntity="User") */
private $user;
//...
}
// SINCE BETA1
// User class DOES NOT CHANGE
class Address
{
//...
/** @OneToOne(targetEntity="User", inversedBy="address") */
private $user;
//...
}
Thus, the inversedBy attribute is the counterpart to the mappedBy attribute. This change was necessary to enable some simplifications and further performance improvements. We apologize for the inconvenience.
The "default" option for database column defaults has been removed. If desired, database column defaults can be implemented by using the columnDefinition attribute of the @Column annotation (or the appropriate XML and YAML equivalents). Prefer PHP default values, if possible.
Querying for partial objects now has a new syntax. The old syntax to query for partial objects now has a different meaning. This is best illustrated by an example. If you previously had a DQL query like this:
[sql]
SELECT u.id, u.name FROM User u
Since BETA1, simple state field path expressions in the select clause are used to select object fields as plain scalar values (something that was not possible before). To achieve the same result as previously (that is, a partial object with only id and name populated) you need to use the following, explicit syntax:
[sql]
SELECT PARTIAL u.{id,name} FROM User u
The 'inheritance-type' attribute changed to take last bit of ClassMetadata constant names, i.e. NONE, SINGLE_TABLE, INHERITANCE_TYPE_JOINED
The way to specify lifecycle callbacks in YAML Mapping driver was changed to allow for multiple callbacks per event. The Old syntax ways:
[yaml]
lifecycleCallbacks:
doStuffOnPrePersist: prePersist
doStuffOnPostPersist: postPersist
The new syntax is:
[yaml]
lifecycleCallbacks:
prePersist: [ doStuffOnPrePersist, doOtherStuffOnPrePersistToo ]
postPersist: [ doStuffOnPostPersist ]
Event Listeners listening to the 'preUpdate' event can only affect the primitive values of entity changesets
by using the API on the PreUpdateEventArgs instance passed to the preUpdate listener method. Any changes
to the state of the entitys properties won't affect the database UPDATE statement anymore. This gives drastic
performance benefits for the preUpdate event.
The Collection interface in the Common package has been updated with some missing methods that were present only on the default implementation, ArrayCollection. Custom collection implementations need to be updated to adhere to the updated interface.
CLI main object changed its name and namespace. Renamed from Doctrine\ORM\Tools\Cli to Doctrine\Common\Cli\CliController. Doctrine\Common\Cli\CliController now only deals with namespaces. Ready to go, Core, Dbal and Orm are available and you can subscribe new tasks by retrieving the namespace and including new task. Example:
[php]
$cli->getNamespace('Core')->addTask('my-example', '\MyProject\Tools\Cli\Tasks\MyExampleTask');
Tasks have implemented a new way to build documentation. Although it is still possible to define the help manually by extending the basicHelp and extendedHelp, they are now optional. With new required method AbstractTask::buildDocumentation, its implementation defines the TaskDocumentation instance (accessible through AbstractTask::getDocumentation()), basicHelp and extendedHelp are now not necessary to be implemented.
* A bunch of Methods on both Doctrine\DBAL\Platforms\AbstractPlatform and Doctrine\DBAL\Schema\AbstractSchemaManager
have changed quite significantly by adopting the new Schema instance objects.
* Doctrine\ORM\AbstractQuery::setExpireResultCache() -> expireResultCache()
* Doctrine\ORM\Query::setExpireQueryCache() -> expireQueryCache()
* "doctrine schema-tool --drop" now always drops the complete database instead of
only those tables defined by the current database model. The previous method had
problems when foreign keys of orphaned tables pointed to tables that were scheduled
for deletion.
* Use "doctrine schema-tool --update" to get a save incremental update for your
database schema without deleting any unused tables, sequences or foreign keys.
* Use "doctrine schema-tool --complete-update" to do a full incremental update of
your schema.
This section details the changes made to Doctrine 2.0-ALPHA3 to make it easier for you to upgrade your projects to use this version.
The $args variable used in the cli-config.php for configuring the Doctrine CLI has been renamed to $globalArguments.
You are now required to make supply some minimalist configuration with regards to proxy objects. That involves 2 new configuration options. First, the directory where generated proxy classes should be placed needs to be specified. Secondly, you need to configure the namespace used for proxy classes. The following snippet shows an example:
[php]
// step 1: configure directory for proxy classes
// $config instanceof Doctrine\ORM\Configuration
$config->setProxyDir('/path/to/myproject/lib/MyProject/Generated/Proxies');
$config->setProxyNamespace('MyProject\Generated\Proxies');
Note that proxy classes behave exactly like any other classes when it comes to class loading. Therefore you need to make sure the proxy classes can be loaded by some class loader. If you place the generated proxy classes in a namespace and directory under your projects class files, like in the example above, it would be sufficient to register the MyProject namespace on a class loader. Since the proxy classes are contained in that namespace and adhere to the standards for class loading, no additional work is required. Generating the proxy classes into a namespace within your class library is the recommended setup.
Entities with initialized proxy objects can now be serialized and unserialized properly from within the same application.
For more details refer to the Configuration section of the manual.
The allowPartialObjects configuration option together with the Configuration#getAllowPartialObjects and Configuration#setAllowPartialObjects methods have been removed.
The new behavior is as if the option were set to FALSE all the time, basically disallowing partial objects globally. However, you can still use the Query::HINT_FORCE_PARTIAL_LOAD query hint to force a query to return partial objects for optimization purposes.
- Doctrine\ORM\Configuration#getCacheDir() to getProxyDir()
- Doctrine\ORM\Configuration#setCacheDir($dir) to setProxyDir($dir)