Save action classes (#5878)

Enable the usage of classes to describe the save actions. This allow more flexibility and easy to extend and/or configure behaviour.

Author: pxpm

src/app/Library/CrudPanel/SaveActions/AbstractSaveAction.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Backpack\CRUD\app\Library\CrudPanel\SaveActions;
+
+use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
+use Illuminate\Http\Request;
+
+abstract class AbstractSaveAction implements SaveActionInterface
+{
+    protected ?int $order = null;
+
+    public function __construct(?int $order = null)
+    {
+        if ($order !== null) {
+            $this->order = $order;
+        }
+    }
+
+    public function getOrder(): ?int
+    {
+        return $this->order;
+    }
+
+    public function setOrder(int $order): void
+    {
+        $this->order = $order;
+    }
+
+    public function isVisible(CrudPanel $crud): bool
+    {
+        return true;
+    }
+
+    public function getRedirectUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        return null;
+    }
+
+    public function getReferrerUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        return null;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'name' => $this->getName(),
+            'button_text' => $this->getButtonText(),
+            'visible' => fn (CrudPanel $crud) => $this->isVisible($crud),
+            'redirect' => fn (CrudPanel $crud, Request $request, $itemId = null) => $this->getRedirectUrl($crud, $request, $itemId),
+            'referrer_url' => fn (CrudPanel $crud, Request $request, $itemId = null) => $this->getReferrerUrl($crud, $request, $itemId),
+            'order' => $this->getOrder(),
+            '_handler' => $this,
+        ];
+    }
+}

src/app/Library/CrudPanel/SaveActions/SaveActionInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Backpack\CRUD\app\Library\CrudPanel\SaveActions;
+
+use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
+use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Http\Request;
+
+interface SaveActionInterface extends Arrayable
+{
+    public function getName(): string;
+
+    public function getButtonText(): string;
+
+    public function isVisible(CrudPanel $crud): bool;
+
+    public function getRedirectUrl(CrudPanel $crud, Request $request, $itemId = null): ?string;
+
+    public function getReferrerUrl(CrudPanel $crud, Request $request, $itemId = null): ?string;
+
+    public function getOrder(): ?int;
+
+    public function setOrder(int $order): void;
+}

src/app/Library/CrudPanel/SaveActions/SaveAndBack.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Backpack\CRUD\app\Library\CrudPanel\SaveActions;
+
+use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
+use Illuminate\Http\Request;
+
+class SaveAndBack extends AbstractSaveAction
+{
+    protected ?int $order = 1;
+
+    public function getName(): string
+    {
+        return 'save_and_back';
+    }
+
+    public function getButtonText(): string
+    {
+        return trans('backpack::crud.save_action_save_and_back');
+    }
+
+    public function isVisible(CrudPanel $crud): bool
+    {
+        return $crud->hasAccess('list');
+    }
+
+    public function getRedirectUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        return $request->has('_http_referrer') ? $request->get('_http_referrer') : $crud->route;
+    }
+}

src/app/Library/CrudPanel/SaveActions/SaveAndEdit.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Backpack\CRUD\app\Library\CrudPanel\SaveActions;
+
+use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
+use Illuminate\Http\Request;
+
+class SaveAndEdit extends AbstractSaveAction
+{
+    protected ?int $order = 2;
+
+    public function getName(): string
+    {
+        return 'save_and_edit';
+    }
+
+    public function getButtonText(): string
+    {
+        return trans('backpack::crud.save_action_save_and_edit');
+    }
+
+    public function isVisible(CrudPanel $crud): bool
+    {
+        return $crud->hasAccess('update');
+    }
+
+    public function getRedirectUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        $itemId = $itemId ?: $request->get('id');
+
+        if (! $itemId) {
+            return $crud->route;
+        }
+
+        $redirectUrl = rtrim($crud->route, '/').'/'.$itemId.'/edit';
+
+        if ($request->has('_locale')) {
+            $redirectUrl .= '?_locale='.$request->get('_locale');
+        }
+
+        if ($request->has('_current_tab')) {
+            $redirectUrl .= '#'.$request->get('_current_tab');
+        }
+
+        return $redirectUrl;
+    }
+
+    public function getReferrerUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        $itemId = $itemId ?: $request->get('id');
+
+        if (! $itemId) {
+            return null;
+        }
+
+        return url(rtrim($crud->route, '/').'/'.$itemId.'/edit');
+    }
+}

src/app/Library/CrudPanel/SaveActions/SaveAndList.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Backpack\CRUD\app\Library\CrudPanel\SaveActions;
+
+use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
+use Illuminate\Http\Request;
+
+class SaveAndList extends AbstractSaveAction
+{
+    protected ?int $order = 5;
+
+    public function getName(): string
+    {
+        return 'save_and_list';
+    }
+
+    public function getButtonText(): string
+    {
+        return trans('backpack::crud.save_action_save_and_list');
+    }
+
+    public function isVisible(CrudPanel $crud): bool
+    {
+        return $crud->hasAccess('list');
+    }
+
+    public function getRedirectUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        return $crud->route;
+    }
+}

src/app/Library/CrudPanel/SaveActions/SaveAndNew.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Backpack\CRUD\app\Library\CrudPanel\SaveActions;
+
+use Backpack\CRUD\app\Library\CrudPanel\CrudPanel;
+use Illuminate\Http\Request;
+
+class SaveAndNew extends AbstractSaveAction
+{
+    protected ?int $order = 3;
+
+    public function getName(): string
+    {
+        return 'save_and_new';
+    }
+
+    public function getButtonText(): string
+    {
+        return trans('backpack::crud.save_action_save_and_new');
+    }
+
+    public function isVisible(CrudPanel $crud): bool
+    {
+        return $crud->hasAccess('create');
+    }
+
+    public function getRedirectUrl(CrudPanel $crud, Request $request, $itemId = null): ?string
+    {
+        return $crud->route.'/create';
+    }
+}