POC for laravel/framework#31778 add consequence lockUpdate new feature and sync trait

Author: Pantea Marius-ciclistu

src/Models/BaseModel.php

@@ -600,6 +600,55 @@ public function unique($key = null, $strict = false): Collection
                 };
     }
 
+    /**
+     * Prevent updates
+     * Note that relations can be loaded and updated during the lock
+     */
+    public function lockUpdates(bool $checkDirty = true): bool
+    {
+        if (
+            !$this->exists
+            || $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts !== null
+            || ($checkDirty && $this->isDirty())
+        ) {
+            return false;
+        }
+
+        $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = [];
+
+        return true;
+    }
+
+    /**
+     * Unlock updates
+     *
+     * To reset the model's $attributes and get the changes from dirty applied during the lock use:
+     *
+     * if ($this->unlockUpdate()) {
+     *  $dirty = $this->getDirty();
+     *  $this->attributes = $this->original;
+     *  $this->classCastCache = [];
+     *  $this->attributeCastCache = [];
+     * }
+     *
+     * Note that relations can be loaded during the lock
+     */
+    public function unlockUpdate(): bool
+    {
+        if ($this->isUnlockedForUpdate()) {
+            return false;
+        }
+
+        $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
+
+        return true;
+    }
+
+    public function isUnlockedForUpdate(): bool
+    {
+        return $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts !== [];
+    }
+
     /**
      * Get all of the current attributes on the model.
      * @param bool $withoutMergeAttributesFromCachedCasts

src/Models/ExcessiveSetOptimizerOnSaveTrait.php

@@ -43,6 +43,55 @@ public function __call($method, $parameters)
         return parent::__call($method, $parameters);
     }
 
+    /**
+     * Prevent updates
+     * Note that relations can be loaded and updated during the lock
+     */
+    public function lockUpdates(bool $checkDirty = true): bool
+    {
+        if (
+            !$this->exists
+            || $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts !== null
+            || ($checkDirty && $this->isDirty())
+        ) {
+            return false;
+        }
+
+        $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = [];
+
+        return true;
+    }
+
+    /**
+     * Unlock updates
+     *
+     * To reset the model's $attributes and get the changes from dirty applied during the lock use:
+     *
+     * if ($this->unlockUpdate()) {
+     *  $dirty = $this->getDirty();
+     *  $this->attributes = $this->original;
+     *  $this->classCastCache = [];
+     *  $this->attributeCastCache = [];
+     * }
+     *
+     * Note that relations can be loaded during the lock
+     */
+    public function unlockUpdate(): bool
+    {
+        if ($this->isUnlockedForUpdate()) {
+            return false;
+        }
+
+        $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
+
+        return true;
+    }
+
+    public function isUnlockedForUpdate(): bool
+    {
+        return $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts !== [];
+    }
+
     /**
      * Get all of the current attributes on the model.
      * @param bool $withoutMergeAttributesFromCachedCasts
@@ -247,18 +296,18 @@ protected function performUpdate(Builder $query): bool
         // Once we have run the update operation, we will fire the "updated" event for
         // this model instance. This will allow developers to hook into these after
         // models are updated, giving them a chance to do any special processing.
-        $dirty = $this->getDirtyForUpdate();
+        if ([] === $dirty = $this->getDirtyForUpdate()) {
+            return false;
+        }
 
-        if ([] !== $dirty) {
-            $this->setKeysForSaveQuery($query)->update($dirty);
+        $this->setKeysForSaveQuery($query)->update($dirty);
 
-            $this->syncChanges();
+        $this->syncChanges();
 
-            $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
-            $this->tmpOriginalBeforeAfterEvents = $this->attributes;
+        $this->tmpDirtyIfAttributesAreSyncedFromCashedCasts = null;
+        $this->tmpOriginalBeforeAfterEvents = $this->attributes;
 
-            $this->fireModelEvent('updated', false);
-        }
+        $this->fireModelEvent('updated', false);
 
         return true;
     }