From 21a6f3c8e85c657f1b79a6ed9bb99c276222a7ae Mon Sep 17 00:00:00 2001 From: UndefinedOffset Date: Mon, 11 Sep 2017 11:37:22 -0300 Subject: [PATCH] Updated documentation and examples to correctly state namespaces used. --- README.md | 19 ++++++++++++++----- docs/HasManyExample.md | 22 ++++++++++++++-------- docs/ManyManyExample.md | 24 +++++++++++++++--------- docs/ModelAdminExample.md | 18 ++++++++++++------ 4 files changed, 55 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 1f1e29f..6cc2a70 100644 --- a/README.md +++ b/README.md @@ -29,19 +29,20 @@ public function getMyManyManyRelationship() { ``` -To enable drag and drop sorting on the grid field add the following to your grid field's config -*Grid Field Config* +To enable drag and drop sorting on the grid field add the following to your grid field's config, also make sure you add the namespace ``UndefinedOffset\SortableGridField\Forms`` to your file. ```php +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; //Namespaces should be added to the top of your file + $myGridConfig->addComponent(new GridFieldSortableRows('{Column to store sort}')); ``` To move an item to another page drag the row over the respective move to page button which appear on the left and right of the GridField and release. #### Full code Examples -* [has_many relationship] (https://github.com/UndefinedOffset/SortableGridField/blob/master/docs/HasManyExample.md) -* [many_many relationship] (https://github.com/UndefinedOffset/SortableGridField/blob/master/docs/ManyManyExample.md) -* [ModelAdmin implementation] (https://github.com/UndefinedOffset/SortableGridField/blob/master/docs/ModelAdminExample.md) +* [has_many relationship](https://github.com/UndefinedOffset/SortableGridField/blob/master/docs/HasManyExample.md) +* [many_many relationship](https://github.com/UndefinedOffset/SortableGridField/blob/master/docs/ManyManyExample.md) +* [ModelAdmin implementation](https://github.com/UndefinedOffset/SortableGridField/blob/master/docs/ModelAdminExample.md) #### Events GridFieldSortableRows provides 4 "events" onBeforeGridFieldRowSort(), onAfterGridFieldRowSort(), onBeforeGridFieldPageSort() and onAfterGridFieldPageSort(). These "events" are passed a clone of the DataList used in GridFieldSortableRows, in the case of page sorting this list has a limit that shows you the current page plus/minus one object. For GridFieldSortableRows that are on ModelAdmin decendents these events are called on the ModelAdmin if they do not have a owner DataObject, if you are using GridFieldSortableRows on a GridField for a DataObject's relationship the events are called on that DataObject. @@ -49,6 +50,8 @@ GridFieldSortableRows provides 4 "events" onBeforeGridFieldRowSort(), onAfterGri #### Appending to the top instead of the bottom By default GridFieldSortableRows appends to the bottom of the list for performance on large data sets, however you can set new records to append new records to the top by calling setAppendToTop(true) on your GridFieldSortableRows instance. ```php +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; //Namespaces should be added to the top of your file + $myGridConfig->addComponent($sortable=new GridFieldSortableRows('SortOrder')); $sortable->setAppendToTop(true); ``` @@ -56,6 +59,8 @@ $sortable->setAppendToTop(true); #### Working with versioned records By default GridFieldSortableRows does not update any other stage for versioned than the base stage. However you can enable this by calling setUpdateVersionedStage() and passing in the name of the stage you want to update along with the base stage. For example passing in "Live" will also update the "Live" stage when any sort happens. ```php +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; //Namespaces should be added to the top of your file + $myGridConfig->addComponent($sortable=new GridFieldSortableRows('SortOrder')); $sortable->setUpdateVersionedStage('Live'); ``` @@ -63,6 +68,8 @@ $sortable->setUpdateVersionedStage('Live'); #### Overriding the default relationship name By default the relationship name comes from the name of the GridField, however you can override this lookup by calling setCustomRelationName() and passing in the name of the relationship. This allows for you to have multiple GridFields on the same form interacting with the same many_many list maybe filtered slightly differently. ```php +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; //Namespaces should be added to the top of your file + $myGridConfig->addComponent($sortable=new GridFieldSortableRows('SortOrder')); $sortable->setCustomRelationName('MyRelationship'); @@ -74,6 +81,8 @@ When you're reporting an issue please ensure you specify what version of SilverS ### Notes * When using with GridFieldManyRelationHandler make sure that you add GridFieldSortableRows to your config before for example GridFieldManyRelationHandler: ```php +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; //Namespaces should be added to the top of your file + $config->addComponent(new GridFieldSortableRows('SortOrder'), 'GridFieldManyRelationHandler'); ``` diff --git a/docs/HasManyExample.md b/docs/HasManyExample.md index a0ba2ff..e963477 100644 --- a/docs/HasManyExample.md +++ b/docs/HasManyExample.md @@ -2,35 +2,41 @@ has_many Example ================= ```php /*** TestPage.php ***/ +use SilverStripe\Forms\GridField\GridField; +use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor; +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; + class TestPage extends Page { private static $has_many=array( 'TestObjects'=>'TestObject' ); - + public function getCMSFields() { $fields=parent::getCMSFields(); - - $conf=GridFieldConfig_RelationEditor::create(10); + + $conf=GridFieldConfig_RecordEditor::create(10); $conf->addComponent(new GridFieldSortableRows('SortOrder')); - + $fields->addFieldToTab('Root.TestObjects', new GridField('TestObjects', 'TestObjects', $this->TestObjects(), $conf)); - + return $fields; } } /*** TestObject.php ***/ +use SilverStripe\ORM\DataObject; + class TestObject extends DataObject { private static $db=array( 'Title'=>'Text', 'SortOrder'=>'Int' ); - + private static $has_one=array( 'Parent'=>'TestPage' ); - + private static $default_sort='SortOrder'; } -``` \ No newline at end of file +``` diff --git a/docs/ManyManyExample.md b/docs/ManyManyExample.md index d6f62b9..aaa24bb 100644 --- a/docs/ManyManyExample.md +++ b/docs/ManyManyExample.md @@ -2,29 +2,33 @@ many_many Example ================= ```php /*** TestPage.php ***/ +use SilverStripe\Forms\GridField\GridField; +use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor; +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; + class TestPage extends Page { private static $many_many=array( 'TestObjects'=>'TestObject' ); - + private static $many_many_extraFields=array( 'TestObjects'=>array( 'SortOrder'=>'Int' ) ); - - + + public function getCMSFields() { $fields=parent::getCMSFields(); - + $conf=GridFieldConfig_RelationEditor::create(10); $conf->addComponent(new GridFieldSortableRows('SortOrder')); - + $fields->addFieldToTab('Root.TestObjects', new GridField('TestObjects', 'TestObjects', $this->TestObjects(), $conf)); - + return $fields; } - + public function TestObjects() { return $this->getManyManyComponents('TestObjects')->sort('SortOrder'); } @@ -32,13 +36,15 @@ class TestPage extends Page { /*** TestObject.php ***/ +use SilverStripe\ORM\DataObject; + class TestObject extends DataObject { private static $db=array( 'Title'=>'Text' ); - + private static $belongs_many_many=array( 'TestPages'=>'TestPage' ); } -``` \ No newline at end of file +``` diff --git a/docs/ModelAdminExample.md b/docs/ModelAdminExample.md index b4bdad5..26fffea 100644 --- a/docs/ModelAdminExample.md +++ b/docs/ModelAdminExample.md @@ -2,17 +2,21 @@ ModelAdmin implementation Example ================= ```php /**** MyModelAdmin.php ****/ +use SilverStripe\Admin\ModelAdmin; +use SilverStripe\Forms\GridField\GridField; +use UndefinedOffset\SortableGridField\Forms\GridFieldSortableRows; + class MyModelAdmin extends ModelAdmin { private static $menu_title='My Model Admin'; private static $url_segment='my-model-admin'; - + private static $managed_models=array( 'MATestObject' ); - + public function getEditForm($id = null, $fields = null) { $form=parent::getEditForm($id, $fields); - + //This check is simply to ensure you are on the managed model you want adjust accordingly if($this->modelClass=='MATestObject' && $gridField=$form->Fields()->dataFieldByName($this->sanitiseClassName($this->modelClass))) { //This is just a precaution to ensure we got a GridField from dataFieldByName() which you should have @@ -20,18 +24,20 @@ class MyModelAdmin extends ModelAdmin { $gridField->getConfig()->addComponent(new GridFieldSortableRows('SortOrder')); } } - + return $form; } } /**** MATestObject.php ****/ +use SilverStripe\ORM\DataObject; + class MATestObject extends DataObject { private static $db=array( 'Title'=>'Varchar', 'SortOrder'=>'Int' ); - + private static $default_sort='SortOrder'; } -``` \ No newline at end of file +```