[5.x] Implement NavCreating / NavSaving / NavCreated events (#10604)

src/Events/NavCreated.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Statamic\Events;
+
+class NavCreated extends Event
+{
+ public $nav;
+
+ public function __construct($nav)
+ {
+ $this->nav = $nav;
+ }
+}

src/Events/NavCreating.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Statamic\Events;
+
+class NavCreating extends Event
+{
+ public $nav;
+
+ public function __construct($nav)
+ {
+ $this->nav = $nav;
+ }
+
+ /**
+ * Dispatch the event with the given arguments, and halt on first non-null listener response.
+ *
+ * @return mixed
+ */
+ public static function dispatch()
+ {
+ return event(new static(...func_get_args()), [], true);
+ }
+}

src/Events/NavSaving.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Statamic\Events;
+
+class NavSaving extends Event
+{
+ public $nav;
+
+ public function __construct($nav)
+ {
+ $this->nav = $nav;
+ }
+
+ /**
+ * Dispatch the event with the given arguments, and halt on first non-null listener response.
+ *
+ * @return mixed
+ */
+ public static function dispatch()
+ {
+ return event(new static(...func_get_args()), [], true);
+ }
+}

src/Structures/Nav.php

@@ -7,9 +7,12 @@
 use Statamic\Contracts\Structures\NavTreeRepository;
 use Statamic\Data\ExistsAsFile;
 use Statamic\Events\NavBlueprintFound;
+use Statamic\Events\NavCreated;
+use Statamic\Events\NavCreating;
 use Statamic\Events\NavDeleted;
 use Statamic\Events\NavDeleting;
 use Statamic\Events\NavSaved;
+use Statamic\Events\NavSaving;
 use Statamic\Facades;
 use Statamic\Facades\Blink;
 use Statamic\Facades\Blueprint;
@@ -27,8 +30,22 @@ class Nav extends Structure implements Contract
 
  public function save()
  {
+ $isNew = ! Facades\Nav::find($this->handle());
+
+ if ($isNew && NavCreating::dispatch($this) === false) {
+ return false;
+ }
+
+ if (NavSaving::dispatch($this) === false) {
+ return false;
+ }
+
  Facades\Nav::save($this);
 
+ if ($isNew) {
+ NavCreated::dispatch($this);
+ }
+
  NavSaved::dispatch($this);
 
  return true;

tests/Data/Structures/NavTest.php

@@ -7,8 +7,12 @@
 use Illuminate\Support\Facades\Event;
 use PHPUnit\Framework\Attributes\Test;
 use Statamic\Contracts\Entries\Collection as StatamicCollection;
+use Statamic\Events\NavCreated;
+use Statamic\Events\NavCreating;
 use Statamic\Events\NavDeleted;
 use Statamic\Events\NavDeleting;
+use Statamic\Events\NavSaved;
+use Statamic\Events\NavSaving;
 use Statamic\Facades;
 use Statamic\Facades\Site;
 use Statamic\Facades\User;
@@ -101,11 +105,84 @@ public function it_gets_and_sets_the_title()
  #[Test]
  public function it_saves_the_nav_through_the_api()
  {
- $nav = $this->structure();
+ $nav = $this->structure('test');
+
+ Facades\Nav::shouldReceive('find')->with('test');
+ Facades\Nav::shouldReceive('save')->with($nav)->once();
+
+ $this->assertTrue($nav->save());
+ }
+
+ #[Test]
+ public function it_dispatches_nav_creating()
+ {
+ Event::fake();
+
+ $nav = $this->structure('test');
+
+ Facades\Nav::shouldReceive('find')->with('test')->once();
+ Facades\Nav::shouldReceive('save')->with($nav)->once();
+
+ $this->assertTrue($nav->save());
+
+ Event::assertDispatched(NavCreating::class, function ($event) use ($nav) {
+ return $event->nav === $nav;
+ });
+ }
+
+ #[Test]
+ public function if_creating_event_returns_false_the_nav_doesnt_save()
+ {
+ Event::fake([NavCreated::class]);
+
+ Event::listen(NavCreating::class, function () {
+ return false;
+ });
 
+ $nav = $this->structure('test');
+
+ Facades\Nav::shouldReceive('find')->with('test')->once();
+ Facades\Nav::shouldReceive('save')->with($nav)->never();
+
+ $this->assertFalse($nav->save());
+
+ Event::assertNotDispatched(NavCreated::class);
+ }
+
+ #[Test]
+ public function it_dispatches_nav_saving()
+ {
+ Event::fake();
+
+ $nav = $this->structure('test');
+
+ Facades\Nav::shouldReceive('find')->with('test')->once();
  Facades\Nav::shouldReceive('save')->with($nav)->once();
 
  $this->assertTrue($nav->save());
+
+ Event::assertDispatched(NavSaving::class, function ($event) use ($nav) {
+ return $event->nav === $nav;
+ });
+ }
+
+ #[Test]
+ public function if_saving_event_returns_false_the_nav_doesnt_save()
+ {
+ Event::fake([NavSaved::class]);
+
+ Event::listen(NavSaving::class, function () {
+ return false;
+ });
+
+ $nav = $this->structure('test');
+
+ Facades\Nav::shouldReceive('find')->with('test')->once();
+ Facades\Nav::shouldReceive('save')->with($nav)->never();
+
+ $this->assertFalse($nav->save());
+
+ Event::assertNotDispatched(NavSaved::class);
  }
 
  #[Test]

tests/Stache/FeatureTest.php

@@ -205,6 +205,7 @@ public function it_saves_structures()
  {
  $structure = Structure::find('footer');
 
+ NavRepository::shouldReceive('find')->with('footer');
  NavRepository::shouldReceive('save')->with($structure)->once();
 
  $structure->save();