unclecheese/betterbuttons

Adds new form actions and buttons to GridField detail form for usability enhancements.

Much of this module is getting merged into core

https://github.com/silverstripe/silverstripe-admin/issues/436, _(*1)

But I want to use it now!

If you're looking to use it in SS4 ahead of the merge, you can use this branch., _(*2)

, _(*3)

, _(*4)

Modifies the detail form of GridFields to use more user-friendly actions, including:

• Save and add another: Create a record, and go right to adding another one, without having to click the back button, and then add again.
• Save and close: Save the record and go back to list view
• User-friendly delete: Extracted from the tray of constructive actions and moved away so is less likely to be clicked accidentally. Includes inline confirmation of action instead of browser alert box.
• 
• Cancel: Same as the back button, but in a more convenient location
• Previous/Next record: Navigate to the previous or next record in the list without returning to list view
• Frontend Links: If your DataObject has a Link() method, get links to the draft site and published site to view the record in context in a single click
• 
• Versioning: Save, Save & Publish, Rollback, Unpublish
• 
• Configurable UI: Add buttons to the top (utilities) or bottom (actions).
• Disambiguated tabs: In model admin, the top tabs toggle between the models. On the detail view, they toggle between the groups of fields, creating a confusing user exierience. Better Buttons groups the fields as they are in CMSMain, using a tabset within the main editing area.
• 
• Add your own custom actions!

Create custom actions the detail view

, _(*5)

Requirements

SilverStripe 4.0 or higher, _(*6)

Installation

composer require unclecheese/betterbuttons 2.x-dev

Customising the button collections

Preferences for which buttons should appear where will vary from user to user. BetterButtons comes with a default set of button collections for the "create" and "edit" views in a GridField detail form, but these can be easily overridden in a config.yml file., _(*7)

The default configuration:, _(*8)

BetterButtonsUtils:
  edit:
    BetterButtonPrevNextAction: true
    BetterButton_New: true
  versioned_edit:
    BetterButtonPrevNextAction: true
    BetterButton_New: true

BetterButtonsActions:
  create:
    BetterButton_Save: true
    BetterButton_SaveAndClose: true

  edit:
    BetterButton_Save: true
    BetterButton_SaveAndClose: true
    BetterButton_Delete: true
    BetterButtonFrontendLinksAction: true

  versioned_create:
    BetterButton_SaveDraft: true
    BetterButton_Publish: true
  versioned_edit:
    BetterButton_SaveDraft: true
    BetterButton_Publish: true
    Group_Versioning: true
    BetterButton_Delete: true
    BetterButtonFrontendLinksAction: true

BetterButtonsGroups:
  SaveAnd:
    label: Save and...
    buttons:
      BetterButton_SaveAndAdd: true
      BetterButton_SaveAndClose: true
      BetterButton_SaveAndNext: true
      BetterButton_SaveAndPrev: true
  Versioning:
    label: Versioning...
    buttons:
      BetterButton_Rollback: true
      BetterButton_Unpublish: true

Each button type is assigned a symbol in the YAML definition. It can be placed anywhere any number of times. Further, it can be placed in a named group, provided that group has been defined in the BetterButtonsGroups node. A button group is a single button with a label that exposes a series of options on click., _(*9)

Because of the idiosyncracies of the Config layer merging arrays, the buttons must be defined as on or off (true or false). To remove a button from the default configuration, you must explicitly set it to false in your project configuration. Here is an example custom configuration., _(*10)

BetterButtonsActions:
  edit:
    BetterButton_Save: false
    Group_SaveAnd: false
    Group_MyGroup: true
BetterButtonsGroups:
  MyGroup:
    label: This is a group
    buttons:
      BetterButton_Save: true
      BetterButton_SaveAndNext: true

When creating groups, be sure not to duplicate any buttons that are outside the group, as form fields with the same name cannot appear twice in a form., _(*11)

Creating a custom action

In the example below, we'll create a custom action in the GridField detail form that updates a DataObject to be "approved" or "denied.", _(*12)

We can add the action in one of two places: * Actions at the bottom of the form (e.g. save, cancel) * Utils at the top right of the form (e.g. new record, prev/next), _(*13)

First, we'll overload the model's getBetterButtonsActions or getBetterButtonsUtils method, depending on where we want the button to appear in the UI., _(*14)

    public function getBetterButtonsActions() {
        $fields = parent::getBetterButtonsActions();
        if($this->IsApproved) {
            $fields->push(BetterButtonCustomAction::create('deny', 'Deny'));
        }
        else {
            $fields->push(BetterButtonCustomAction::create('approve', 'Approve'));
        }
        return $fields;
    }

The BetterButtonCustomAction object takes parameters for the method name ("deny" or "approve") to invoke on the model, as well as a label for the button., _(*15)

Now let's add the methods to the DataObject., _(*16)

    public function approve() {
        $this->IsApproved = true;
        $this->write();
    }

    public function deny() {
        $this->IsApproved = false;
        $this->write();
    }

Lastly, for security reasons, we need to whitelist these methods as callable by the GridField form. This works a lot like $allowed_actions in controllers., _(*17)

    private static $better_buttons_actions = array (
        'approve',
        'deny'
    );

Now we have a new button in the UI!, _(*18)

, _(*19)

Customising the user experience

Let's ensure that the form refreshes after clicking "approve" or "deny"., _(*20)

  $fields->push(
    BetterButtonCustomAction::create('deny', 'Deny')
      ->setRedirectType(BetterButtonCustomAction::REFRESH)
  );

The redirect type can use the constants:, _(*21)

BetterButtonCustomAction::REFRESH
BetterButtonCustomAction::GOBACK

To refresh the form, or go back to list view, respectively., _(*22)

Additionally, we can add a success message that will render on completion of the action by returning a message in our method., _(*23)

    public function deny() {
        $this->IsApproved = false;
        $this->write();

        return 'Denied for publication';
    }

Defining arbitrary links

Sometimes, you might not want to sent a request to the controller at all. For that, there's the much simpler BetterButtonLink class., _(*24)

    $fields->push(
        new BetterButtonLink(
          'View on Meetup.com',
           $this->MeetUpLink
        )
    );

, _(*25)

Creating nested forms

You may have an action that needs to prompt for user input, for example "Send this customer message" on an Order record. For complex actions like these, you can use BetterButtonNestedForm., _(*26)

    public function getBetterButtonsActions() {
        $f = parent::getBetterButtonsActions();
        $f->push(BetterButtonNestedForm::create('sendmessage','Send this customer a message', FieldList::create(
            TextareaField::create('Content')
        )));

        return $f;
    }

In this case, your action handler receives $data and $form, just like a controller would., _(*27)

    public function sendmessage ($data, $form) {
        $message = Message::create(array (
            'OrderID' => $this->ID,
            'Content' => $data['Content']
        ));

        $message->write();
        $form->sessionMessage('Message sent','good');
    }

Disabling Better Buttons

Sometimes you might find it necessary to disable better buttons on certain classes. You can do this by changing the static better_buttons_enabled to be false via YML configuration., _(*28)

MyBetterButtonLessClass
  better_buttons_enabled: false