model events docs, add syncToCurrentVersion events

indracollective · Oct 11, 2024 · 5656aa7 · 5656aa7
1 parent 972b8f1
commit 5656aa7
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 87 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -35,7 +35,14 @@ export default defineConfig({
                             {text: "Preparing your Models", link: "/preparing-your-models"},
                             {text: "Managing Context", link: "/managing-context"},
                             {text: "Publishing", link: "/publishing"},
-                            {text: "Versioning", link: "/versioning"}
+                            {text: "Versioning", link: "/versioning"},
+                            {text: "Model Events", link: "/model-events"}
+                        ],
+                    },
+                    {
+                        text: "Integrations",
+                        items: [
+                            {text: "FilamentPHP", link: "/filament-php"},
                         ],
                     },
                 ],

diff --git a/docs/filament-php.md b/docs/filament-php.md
@@ -0,0 +1 @@
+# FilamentPHP
diff --git a/docs/model-events.md b/docs/model-events.md
@@ -0,0 +1,34 @@
+# Model Events
+
+Laravel Revisor provides several model events for you hook into key publishing and versioning events.
+
+All events are fired on the Draft record, and pass the relevant published or versioned record as an argument to your
+callback (if applicable).
+
+Event listeners can be registered using static methods on the Model class that correspond to the event name.
+
+```php
+Page::published(function (Page $page, Page $publishedRecord) {
+    ...
+});
+```
+
+## Publishing Events
+
+| Event        | Description                       |
+|--------------|-----------------------------------|
+| publishing   | Fired before publishing a Model   |
+| published    | Fired after publishing a Model    |
+| unpublishing | Fired before unpublishing a Model |
+| unpublished  | Fired after unpublishing a Model  |
+
+## Versioning Events
+
+| Event                   | Description                                 |
+|-------------------------|---------------------------------------------|
+| savingNewVersion        | Fired before saving a new Version           |
+| savedNewVersion         | Fired after saving a new Version            |
+| syncingToCurrentVersion | Fired before syncing to the current Version |
+| syncedToCurrentVersion  | Fired after syncing to the current Version  |
+| revertingToVersion      | Fired before reverting to a Version         |
+| revertedToVersion       | Fired after reverting to a Version          |
diff --git a/docs/modes-and-dynamic-tables.md b/docs/modes-and-dynamic-tables.md
diff --git a/docs/page.md b/docs/page.md
diff --git a/src/Concerns/HasVersioning.php b/src/Concerns/HasVersioning.php
@@ -117,7 +117,7 @@ public function saveNewVersion(): HasRevisorContract|bool
 
         $this->pruneVersions();
 
-        $this->fireModelEvent('savedNewVersion');
+        $this->fireModelEvent('savedNewVersion', $version);
 
         return $this;
     }
@@ -248,6 +248,7 @@ public function syncToCurrentVersionRecord(): HasRevisorContract|bool
         if (! $this->currentVersionRecord) {
             return $this->saveNewVersion();
         }
+        $this->fireModelEvent('syncingToCurrentVersion', $this->currentVersionRecord);
 
         $attributes = collect($this->attributes)
             ->except([$this->getKeyName(), 'version_number'])
@@ -263,6 +264,8 @@ public function syncToCurrentVersionRecord(): HasRevisorContract|bool
                 ->update(['is_published' => 0]);
         }
 
+        $this->fireModelEvent('syncedToCurrentVersion', $this->currentVersionRecord);
+
         return $this;
     }
 
@@ -354,6 +357,22 @@ public static function savedNewVersion(string|Closure $callback): void
         static::registerModelEvent('savedNewVersion', $callback);
     }
 
+    /**
+     * Register a "syncingToCurrentVersion" model event callback with the dispatcher.
+     */
+    public static function syncingToCurrentVersion(string|Closure $callback): void
+    {
+        static::registerModelEvent('syncingToCurrentVersion', $callback);
+    }
+
+    /**
+     * Register a "syncedToCurrentVersion" model event callback with the dispatcher.
+     */
+    public static function syncedToCurrentVersion(string|Closure $callback): void
+    {
+        static::registerModelEvent('syncedToCurrentVersion', $callback);
+    }
+
     /**
      * Register a "revertingToVersion" model event callback with the dispatcher.
      */