Adds drag and drop functionality to SilverStripe's GridField
Go to file
2012-12-18 16:08:25 -04:00
code/forms Merge remote-tracking branch 'lrcremote/bug-fix' 2012-10-13 12:46:39 -03:00
css MINOR: Added label to the "Allow Drag and Drop" text so that clicking this will activate the checkbox 2012-05-31 19:50:33 -03:00
docs Syntax highlighting for github 2012-10-10 10:40:53 -03:00
images Added missing image 2012-05-18 19:28:13 -03:00
javascript BUGFIX renamed the Items array that is sent in post, as it was being overriden by another postvar called Items, containing GridState data. The array of Item Ids used by SortableGridField is now called ItemIDs 2012-09-10 13:38:00 +10:00
lang Merge pull request #14 from ARNHOE/master 2012-11-16 15:11:25 -08:00
templates/Includes BUGFIX: Fixed issue were the allow drag and drop checkbox would trigger the form changed flag (Issue 3) thanks dasplan 2012-07-31 09:28:09 -03:00
tests/forms Added missing yml file for auto sort test 2012-09-06 12:29:31 -03:00
_config.php Removed Director::absoluteBaseURL() as it is not required 2012-10-13 12:51:55 -03:00
.gitignore Update .gitignore 2012-11-15 15:48:12 -04:00
composer.json Update composer.json 2012-12-18 16:08:25 -04:00
README.md Consistent links, seems github has many issues with relative urls 2012-11-24 14:24:24 -04:00

SortableGridField

Adds drag and drop functionality to SilverStripe 3.0's GridField

Requirements

  • SilverStripe 3.0

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