Merge pull request #2457 from Laravel-Backpack/reorder-buttons

[4.0][Feature] Implement orderButtons

Author: tabacitu

src/app/Library/CrudPanel/Traits/Buttons.php

@@ -10,7 +10,51 @@ trait Buttons
     // BUTTONS
     // ------------
 
-    // TODO: $this->crud->reorderButtons('stack_name', ['one', 'two']);
+    /**
+     * Order the CRUD buttons. If certain button names are missing from the given order array
+     * they will be pushed to the end of the button collection.
+     *
+     *
+     * @param string      $stack           Stack where the buttons belongs. Options: top, line, bottom.
+     * @param array       $order           Ordered name of the buttons. ['update', 'delete', 'show']
+     */
+    public function orderButtons(string $stack, array $order)
+    {
+        $newButtons = collect([]);
+        $otherButtons = collect([]);
+
+        // we get the buttons that belong to the specified stack
+        $stackButtons = $this->buttons()->reject(function ($item) use ($stack, $otherButtons) {
+            if ($item->stack != $stack) {
+                // if the button does not belong to this stack we just add it for merging later
+                $otherButtons->push($item);
+
+                return true;
+            }
+
+            return false;
+        });
+
+        // we parse the ordered buttons
+        collect($order)->each(function ($btnKey) use ($newButtons, $stackButtons) {
+            if (! $button = $stackButtons->where('name', $btnKey)->first()) {
+                abort(500, 'Button name [«'.$btnKey.'»] not found.');
+            }
+            $newButtons->push($button);
+        });
+
+        // if the ordered buttons are less than the total number of buttons in the stack
+        // we add the remaining buttons to the end of the ordered ones
+        if (count($newButtons) < count($stackButtons)) {
+            foreach ($stackButtons as $button) {
+                if (! $newButtons->where('name', $button->name)->first()) {
+                    $newButtons->push($button);
+                }
+            }
+        }
+
+        $this->setOperationSetting('buttons', $newButtons->merge($otherButtons));
+    }
 
     /**
      * Add a button to the CRUD table view.

tests/Unit/CrudPanel/CrudPanelButtonsTest.php

@@ -245,6 +245,17 @@ public function testRemoveAllButtonsFromUnknownStack()
         $this->assertEquals(count($this->defaultButtonNames), count($this->crudPanel->buttons()));
     }
 
+    public function testOrderButtons()
+    {
+        $this->crudPanel->addButton('line', 'update', 'view', 'crud::buttons.update', 'end');
+        $this->crudPanel->addButton('line', 'show', 'view', 'crud::buttons.show', 'end');
+        $this->crudPanel->addButton('line', 'test', 'view', 'crud::buttons.test', 'end');
+
+        $this->crudPanel->orderButtons('line', ['show', 'test']);
+
+        $this->assertEquals(['show', 'test', 'update'], $this->crudPanel->buttons()->pluck('name')->toArray());
+    }
+
     private function getButtonByName($name)
     {
         return $this->crudPanel->buttons()->first(function ($value) use ($name) {