Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Adds drag and drop functionality to SilverStripe 3.0's GridField
PHP JavaScript Scheme
branch: master

This branch is 14 commits ahead, 77 commits behind UndefinedOffset:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
code/forms
css
docs
images
javascript
lang
templates/Includes NEW setForceRedraw() to determine post-drop action
tests/forms Fixed issue 23 where GridFieldSortableRowsTest would fail because the…
.gitignore
README.md
_config.php
composer.json

README.md

SortableGridField

Adds drag and drop functionality to SilverStripe 3's GridField

Requirements

  • SilverStripe 3.x

Installation

  • Download the module from here https://github.com/UndefinedOffset/SortableGridField/downloads
  • Extract the downloaded archive into your site root so that the destination folder is called SortableGridField, opening the extracted folder should contain _config.php in the root along with other files/folders
  • Run dev/build?flush=all to regenerate the manifest
  • Upon entering the cms and using GridFieldSortableRows component for the first time you make need to add ?flush=all to the end of the address to force the templates to regenerate

Usage

To enable sorting on a has_many relationship set up an integer field on your data object. Also for has_many relationships make sure to set the $default_sort on the dataobject to this new integer field to ensure that the sort order is applied when the relationship is requested. For many_many relationships you must add a $many_many_extraFields static to the data object defining the relationship, see the SilverStripe documentation for more information on this. If you are using a many_many relationship you will need to do a custom getter to set the sort order of this relationship for use on the front end see bellow for an example. For new DataObjects you do not need to increment the Sort order yourself in your DataObject GridFieldSortableRows will automatically do this the next time the grid is displayed.

public function getMyManyManyRelationship() {
    return $this->getManyManyComponents('MyManyManyRelationship')->sort('SortColumn');
}

To enable drag and drop sorting on the grid field add the following to your grid field's config Grid Field Config

$myGridConfig->addComponent(new GridFieldSortableRows('{Column to store sort}'));

To move an item to another page drag the row over the respective page button and release.

Full code Examples

Migrating from SilverStripe 2.4 and Data Object Manager's SortableDataObject

SortableGridField is not the same as SortableDataObject, since it is only a component of GridField it does not have the ability to catch the object when it is saved for the first time. So SortableGridField uses 1 as the first sort index because 0 is the default for an integer field/column in the database. For migrations from 2.4 with SortableDataObject you need to setup your DataObject based on the instructions above however you must name your sort column "SortOrder" to maintain your sort indexes defined by SortableDataObject. Then you need to run the following query on the table containing your sort field, for many_many relationships this will be something like {RelationshipClass}_{RelationshipName}. This query will maintain your sort order from SortableDataObject but increment the index by 1 giving it a starting number of 1.

UPDATE YourTable SET SortOrder=SortOrder+1;

@TODO

  • Optimize re-ordering of a has_many relationship when sorting on a single page
Something went wrong with that request. Please try again.