DDC-3687: Entities part of a hierarchy seem not to inherit SLC configuration from 'root' Entity #4531

New Issue

Closed

opened 2026-01-22 14:44:10 +01:00 by admin · 15 comments

admin commented 2026-01-22 14:44:10 +01:00

Owner

Copy Link

Originally created by @doctrinebot on GitHub (Apr 13, 2015).

Originally assigned to: @lcobucci on GitHub.

Jira issue originally created by user holtkamp:

When using the Second Level Cache on associations, the documentation states that "the target entity must also be marked as cacheable"

It seems that when this targetEntity is an (possibly abstract) 'root' Entity of an Entity hierarchy, all Entities of that hierarchy need to be marked as cacheable. I would expect that all Entities that are part of the Entity hierarchy, also inherit this cache configuration metadata of the root Entity...

Is this intended behavior?

For example, this does NOT work:

Entity
 - cacheable X-to-many association, targetEntity: RootEntity

RootEntity, SINGLE_TABLE (marked as cacheable)
 - SubEntity1
 - SubEntityN

The generated error:

Array
(
    [type] => 1
    [message] => Call to a member function resolveAssociationEntries() on a non-object
    [file] => /srv/www/code/vendor/doctrine/orm/lib/Doctrine/ORM/Cache/DefaultCollectionHydrator.php
    [line] => 92
)

For example, this does DOES work

Entity
 - cacheable X-to-many association, targetEntity: RootEntity

RootEntity, SINGLE_TABLE 
 - SubEntity1 (marked as cacheable)
 - SubEntityN (marked as cacheable)

Originally created by @doctrinebot on GitHub (Apr 13, 2015). Originally assigned to: @lcobucci on GitHub. Jira issue originally created by user holtkamp: When using the Second Level Cache on associations, the documentation states that ["the target entity must also be marked as cacheable"](http://doctrine-orm.readthedocs.org/en/latest/reference/second-level-cache.html#association-cache-definition) It seems that when this targetEntity is an (possibly abstract) 'root' Entity of an Entity hierarchy, all Entities of that hierarchy need to be marked as cacheable. I would expect that all Entities that are part of the Entity hierarchy, also inherit this cache configuration metadata of the root Entity... Is this intended behavior? For example, this does NOT work: ``` Entity - cacheable X-to-many association, targetEntity: RootEntity RootEntity, SINGLE_TABLE (marked as cacheable) - SubEntity1 - SubEntityN ``` The generated error: ``` Array ( [type] => 1 [message] => Call to a member function resolveAssociationEntries() on a non-object [file] => /srv/www/code/vendor/doctrine/orm/lib/Doctrine/ORM/Cache/DefaultCollectionHydrator.php [line] => 92 ) ``` For example, this does DOES work ``` Entity - cacheable X-to-many association, targetEntity: RootEntity RootEntity, SINGLE_TABLE - SubEntity1 (marked as cacheable) - SubEntityN (marked as cacheable) ```

admin closed this issue 2026-01-22 14:44:10 +01:00

admin commented 2026-01-22 14:44:10 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

• relates to DDC-3689: [GH-1382] Patch second level cache association hydration

@doctrinebot commented on GitHub (Apr 13, 2015): - relates to [DDC-3689: [GH-1382] Patch second level cache association hydration](http://www.doctrine-project.org/jira/browse/DDC-3689)

admin commented 2026-01-22 14:44:11 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by @FabioBatSilva:

Hi [~holtkamp] All subclasses should already Inherit the cache configuration .

Can please attach your entities/mapping ?

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by @FabioBatSilva: Hi [~holtkamp] All subclasses should already [Inherit the cache configuration ](https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Mapping/ClassMetadataFactory.php#L216). Can please attach your entities/mapping ?

admin commented 2026-01-22 14:44:11 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by holtkamp:

Mm, you are right, the cache configuration seems to be inherited. General idea of my Mapping is at the end of this comment.

The error occurs after the cache has been filled (2nd request). The following CollectionCacheEntry is used to lookup the EntityEntries:

identifiers => Array ( [0] => Doctrine\ORM\Cache\EntityCacheKey Object ( [identifier] => Array ( [id] => 357 )
entityClass => Project\Domain\Entity\Cms\Page\SectionAbstract
hash => project.domain.entity.cms.page.sectionabstract_357

This results in a $entityEntries collection with one entry, (which is empty!) as retrieved from cache at:
https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Cache/DefaultCollectionHydrator.php#L84

array(1) {
  [0] =>
  NULL
}

Having a look at the actual content of the SLC cache shows that the entry exists, so the lookup goes wrong. It seems 'DefaultRegion::getMultiple()' contains a bug:

https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Cache/Region/DefaultRegion.php#L122

$returnableItems[$index] = $items[$key];

Should be

$returnableItems[$index] = $items[$index];

Since the $items array uses the same keys as the $keysToRetrieve array, filled at https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Cache/Region/DefaultRegion.php#L106

My mapping (pseudo-code)

/****
 * @Entity
 * @Cache
 */
class Page
{
    /****
     * @OneToMany
     * @Cache
     */
    private $translations;
}

/****
 * @Entity
 * @Cache
 */
class Translation
{
    /****
     * @ManyToOne
     */
    private $page;

    /****
     * @OneToMany
     * @Cache
     */
    private $sections;
}

/****
 * @Entity
 * @Cache
 */
abstract class SectionAbstract
{
    /****
     * @ManyToOne
     */
    private $pageTranslation;
}

/****
 * @Entity
 */
class SectionFaq extends SectionAbstract
{

    /****
     * @var string
     */
    private $answer;

    /****
     * @var string
     */
    private $question;
}

/****
 * @Entity
 */
class SectionText extends SectionAbstract
{
    /****
     * @var string
     */
    private $content;
}

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by holtkamp: Mm, you are right, the cache configuration seems to be inherited. General idea of my Mapping is at the end of this comment. The error occurs after the cache has been filled (2nd request). The following CollectionCacheEntry is used to lookup the EntityEntries: ``` identifiers => Array ( [0] => Doctrine\ORM\Cache\EntityCacheKey Object ( [identifier] => Array ( [id] => 357 ) entityClass => Project\Domain\Entity\Cms\Page\SectionAbstract hash => project.domain.entity.cms.page.sectionabstract_357 ``` This results in a $entityEntries collection with one entry, (which is empty!) as retrieved from cache at: https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Cache/DefaultCollectionHydrator.php#L84 ``` array(1) { [0] => NULL } ``` Having a look at the actual content of the SLC cache shows that the entry exists, so the lookup goes wrong. It seems 'DefaultRegion::getMultiple()' contains a bug: https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Cache/Region/DefaultRegion.php#L122 ``` $returnableItems[$index] = $items[$key]; ``` Should be ``` $returnableItems[$index] = $items[$index]; ``` Since the $items array uses the same keys as the $keysToRetrieve array, filled at https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/Cache/Region/DefaultRegion.php#L106 My mapping (pseudo-code) ``` /**** * @Entity * @Cache */ class Page { /**** * @OneToMany * @Cache */ private $translations; } /**** * @Entity * @Cache */ class Translation { /**** * @ManyToOne */ private $page; /**** * @OneToMany * @Cache */ private $sections; } /**** * @Entity * @Cache */ abstract class SectionAbstract { /**** * @ManyToOne */ private $pageTranslation; } /**** * @Entity */ class SectionFaq extends SectionAbstract { /**** * @var string */ private $answer; /**** * @var string */ private $question; } /**** * @Entity */ class SectionText extends SectionAbstract { /**** * @var string */ private $content; } ```

admin commented 2026-01-22 14:44:12 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by @FabioBatSilva:

Yes, it looks like a bug on DefaultRegion::getMultiple()
Can you try to write a failing test case or/and maybe send a PR ?

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by @FabioBatSilva: Yes, it looks like a bug on **DefaultRegion::getMultiple()** Can you try to write a failing test case or/and maybe send a PR ?

admin commented 2026-01-22 14:44:12 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by holtkamp:

Mm, will try to find some time this week. Not very experienced in writing test cases though...

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by holtkamp: Mm, will try to find some time this week. Not very experienced in writing test cases though...

admin commented 2026-01-22 14:44:12 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by @FabioBatSilva:

Cool,
Take a look at : SecondLevelCacheTest and let me know if you need help..

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by @FabioBatSilva: Cool, Take a look at : [SecondLevelCacheTest](https://github.com/doctrine/doctrine2/blob/master/tests/Doctrine/Tests/ORM/Functional/SecondLevelCacheTest.php) and let me know if you need help..

admin commented 2026-01-22 14:44:12 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by holtkamp:

Ok, challenge accepted, got a test case running in this branch, I used:

php ./vendor/bin/phpunit -v --exclude-group performance,non-cacheable,locking_functional --filter DefaultRegionTest

It seems the way DefaultRegion::getMultiple() works is overcomplicated? Maybe just return the $items array as an end-result?

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by holtkamp: Ok, challenge accepted, got a test case running in [this branch](https://github.com/holtkamp/doctrine2/tree/patch-second-level-cache-association-hydration), I used: ``` php ./vendor/bin/phpunit -v --exclude-group performance,non-cacheable,locking_functional --filter DefaultRegionTest ``` It seems the way DefaultRegion::getMultiple() works is overcomplicated? Maybe just return the $items array as an end-result?

admin commented 2026-01-22 14:44:14 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 13, 2015):

Comment created by @FabioBatSilva:

If you want to refactory it some how, that will be great..
DefaultRegion::getMultiple tries to check if all keys are found in the cache, and then maps it back to the original key
If any of then are missing it will return null which will trigger a new database query to reload the entries and repopulate the cache.

Overall you branch seems good, Can you send a PR please ?

@doctrinebot commented on GitHub (Apr 13, 2015): Comment created by @FabioBatSilva: If you want to refactory it some how, that will be great.. **DefaultRegion::getMultiple** tries to check if all keys are found in the cache, and then maps it back to the original key If any of then are missing it will return null which will trigger a new database query to reload the entries and repopulate the cache. Overall you branch seems good, Can you send a PR please ?

admin commented 2026-01-22 14:44:14 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 14, 2015):

Comment created by holtkamp:

Ok, I gave it a shot at https://github.com/doctrine/doctrine2/pull/1382, AFAIK the index of the resulting array can just be numeric, right?

@doctrinebot commented on GitHub (Apr 14, 2015): Comment created by holtkamp: Ok, I gave it a shot at https://github.com/doctrine/doctrine2/pull/1382, AFAIK the index of the resulting array can just be numeric, right?

admin commented 2026-01-22 14:44:14 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 14, 2015):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-1382] was labeled:
https://github.com/doctrine/doctrine2/pull/1382

@doctrinebot commented on GitHub (Apr 14, 2015): Comment created by @doctrinebot: A related Github Pull-Request [GH-1382] was labeled: https://github.com/doctrine/doctrine2/pull/1382

admin commented 2026-01-22 14:44:14 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 14, 2015):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-1382] was assigned:
https://github.com/doctrine/doctrine2/pull/1382

@doctrinebot commented on GitHub (Apr 14, 2015): Comment created by @doctrinebot: A related Github Pull-Request [GH-1382] was assigned: https://github.com/doctrine/doctrine2/pull/1382

admin commented 2026-01-22 14:44:14 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 14, 2015):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-1382] was merged:
https://github.com/doctrine/doctrine2/pull/1382

@doctrinebot commented on GitHub (Apr 14, 2015): Comment created by @doctrinebot: A related Github Pull-Request [GH-1382] was merged: https://github.com/doctrine/doctrine2/pull/1382

admin commented 2026-01-22 14:44:14 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 15, 2015):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-1382] was unassigned:
https://github.com/doctrine/doctrine2/pull/1382

@doctrinebot commented on GitHub (Apr 15, 2015): Comment created by @doctrinebot: A related Github Pull-Request [GH-1382] was unassigned: https://github.com/doctrine/doctrine2/pull/1382

admin commented 2026-01-22 14:44:15 +01:00

Author

Owner

Copy Link

@doctrinebot commented on GitHub (Apr 15, 2015):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-1382] was assigned:
https://github.com/doctrine/doctrine2/pull/1382

@doctrinebot commented on GitHub (Apr 15, 2015): Comment created by @doctrinebot: A related Github Pull-Request [GH-1382] was assigned: https://github.com/doctrine/doctrine2/pull/1382

admin commented 2026-01-22 14:44:15 +01:00

Author

Owner

Copy Link

@lcobucci commented on GitHub (Jan 20, 2017):

Fixed by #1382

@lcobucci commented on GitHub (Jan 20, 2017): Fixed by #1382

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

3.6.x

2.20.x

dependabot/github_actions/2.20.x/doctrine/dot-github/dot-github/workflows/composer-lint.yml-14.0.0

3.7.x

4.0.x

2.21.x

old-prototype-3.x

3.6.2

3.6.1

3.6.0

2.20.9

3.5.8

3.5.7

3.5.6

3.5.5

2.20.8

3.5.4

3.5.3

2.20.7

3.5.2

2.20.6

3.5.1

3.5.0

3.4.4

3.4.3

3.4.2

2.20.5

3.4.1

3.4.0

3.3.4

2.20.4

3.3.3

2.20.3

3.3.2

2.20.2

3.3.1

2.20.1

3.3.0

3.2.3

2.20.0

2.19.8

3.2.2

2.19.7

3.2.1

2.19.6

3.2.0

3.1.4

3.1.3

2.19.5

3.1.2

2.19.4

3.1.1

2.19.3

2.19.2

2.19.1

3.1.0

2.19.0

3.0.3

2.18.3

3.0.2

2.18.2

3.0.1

2.18.1

3.0.0

2.18.0

2.17.5

3.0.0-RC1

2.17.4

2.17.3

2.17.2

2.17.1

3.0.0-beta2

2.17.0

2.16.3

3.0.0-beta1

2.16.2

2.16.1

2.16.0

2.15.5

2.15.4

2.15.3

2.15.2

2.15.1

2.15.0

2.14.3

2.14.2

2.14.1

2.14.0

2.13.5

2.13.4

2.13.3

2.13.2

2.13.1

2.13.0

2.12.4

2.12.3

2.12.2

2.12.1

2.12.0

2.11.3

2.11.2

2.11.1

2.11.0

2.10.5

2.10.4

2.10.3

2.10.2

2.10.1

2.10.0

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.5

2.7.4

v2.7.3

v2.7.2

v2.7.1

v2.7.0

v2.6.6

v2.6.5

v2.6.4

v2.6.3

v2.6.2

v2.6.1

v2.6.0

v2.5.14

v2.5.13

v2.5.12

v2.5.11

v2.5.10

v2.5.9

v2.5.8

v2.5.7

v2.5.6

v2.5.5

v2.5.4

v2.5.3

v2.5.2

v2.4.8

v2.5.1

v2.5.0

v2.5.0-RC2

v2.5.0-RC1

v2.5.0-beta1

v2.5.0-alpha2

v2.5.0-alpha1

v2.4.7

v2.4.6

v2.4.5

v2.4.4

v2.4.3

v2.3.6

v2.4.2

2.3.5

v2.4.1

v2.4.0

2.4.0-RC2

2.4.0-RC1

2.4.0-BETA2

2.3.4

2.3.3

2.4.0-BETA1

2.3.2

2.3.1

2.3.0

2.3.0-RC4

2.3.0-RC3

2.3.0-RC2

2.2.3

2.3.0-RC1

2.3.0-BETA1

2.1.7

2.2.2

2.2.1

2.1.6

2.2.0

2.2.0-RC1

2.2.0-BETA2

2.2.0-BETA1

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.0.7

2.1.0

2.1.0RC3

2.1.0RC2

2.1.0RC1

2.0.6

2.1.0BETA1

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

2.0.0RC2

2.0.0RC1

2.0.0-BETA4

2.0.0-BETA3

2.0.0-BETA2

2.0.0-BETA1

Labels

Clear labels

BC Break

Bug

Can't Fix

Deprecation

Documentation

DQL

Duplicate

Failing Test

Hacktoberfest

Improvement

Improvement

Incomplete

Invalid

Missing Tests

New Feature

PR Created

pull-request

Mirrored from GitHub Pull Request

Question

Regression

Status: Waiting feedback

Waiting feedback

WIP

Won't Fix

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

admin

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#4531