make findTranslation consistent to find

[dbu]

As discussed here https://github.com/doctrine/phpcr-odm/pull/555/files#r17139257 the findTranslation resets translated fields to the stored fields unless you are switching to another locale that before was snapshoted with bindTranslation. It would be more consistent to always do the same as find, which is to return the current state of the object. Not specifying a locale would make no sense, and specifying the locale that the document already is in would be no real operation.

To reset translated fields, DocumentManager::refresh should be used to reset the whole document to database state.

this is a BC break for code that relied on this inconsistent behaviour, but i think its better to fix this than to keep being inconsistent.

see also #556 for more discussion

[lsmith77]

did you start on a solution for this?

[dbu]

no, won't have the time in the next 2 weeks. lets release as is. i will work on it for 1.3

[lsmith77]

ok .. I came up with the following change, but realized that I have no idea how I could actually cause this to ever be triggered:

diff --git a/lib/Doctrine/ODM/PHPCR/UnitOfWork.php b/lib/Doctrine/ODM/PHPCR/UnitOfWork.php
index 093488e..c913ca6 100644
--- a/lib/Doctrine/ODM/PHPCR/UnitOfWork.php
+++ b/lib/Doctrine/ODM/PHPCR/UnitOfWork.php
@@ -3372,8 +3372,18 @@ class UnitOfWork

         $currentLocale = $this->getCurrentLocale($document, $metadata);

-        // if no locale is specified, we reset the current translation
-        $locale = $locale ?: $currentLocale;
+        $oid = spl_object_hash($document);
+        if (null === $locale) {
+            if (!$refresh
+                && isset($this->documentTranslations[$oid])
+                && array_key_exists($currentLocale, $this->documentTranslations[$oid])
+            ) {
+                return;
+            }
+
+            $locale = $currentLocale;
+        }
+

         if (!$refresh && $this->doLoadPendingTranslation($document, $metadata, $locale)) {
             $localeUsed = $locale;
@@ -3383,7 +3393,6 @@ class UnitOfWork

         $this->doBindTranslation($document, $localeUsed, $metadata, true);

-        $oid = spl_object_hash($document);
         foreach ($metadata->translatableFields as $fieldName) {
             $this->originalData[$oid][$fieldName] = $this->originalTranslatedData[$oid][$localeUsed][$fieldName]
                 = $metadata->getFieldValue($document, $fieldName);

[lsmith77]

@dbu ping?