Download the PHP package undefinedoffset/sortablegridfield without Composer
On this page you can find all versions of the php package undefinedoffset/sortablegridfield. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download undefinedoffset/sortablegridfield
More information about undefinedoffset/sortablegridfield
Files in undefinedoffset/sortablegridfield
Package sortablegridfield
Short Description Adds drag and drop functionality to SilverStripe 4.x's GridField
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sortablegridfield
SortableGridField
Adds drag and drop functionality to Silverstripe's GridField
Requirements
- Silverstripe 4.11+ or 5.0+
Installation
Installation is supported via composer only
- Run
dev/build?flush=allto regenerate the manifest - Upon entering the cms and using
GridFieldSortableRowscomponent for the first time you make need to add?flush=allto 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 DataObject 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 below for an example. As well for many_many relationships
the name of the GridField must be the same as the relationship name other wise error's will occur. 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.
To enable drag and drop sorting on the GridField add the following to your GridField's config, also make sure you add
the namespace UndefinedOffset\SortableGridField\Forms to your file.
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
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 descendants these events are called on the
ModelAdmin if they do not have an owner DataObject, if you are using GridFieldSortableRows on a GridField for a
DataObject's relationship the events are called on that DataObject.
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.
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.
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.
Reporting an issue
When you're reporting an issue please ensure you specify what version of SilverStripe you are using i.e. 3.0.5, 3.1beta3, 3.0-master etc. Also be sure to include any JavaScript or PHP errors you receive, for PHP errors please ensure you include the full stack trace. Also please include your implementation code (where your setting up your grid field) as well as how you produced the issue. You may also be asked to provide some of the classes to aid in re-producing the issue. Stick with the issue, remember that you seen the issue not the maintainer of the module so it may take a lot of questions to arrive at a fix or answer.
Notes
- When using with GridFieldManyRelationHandler make sure that you add GridFieldSortableRows to your config before for
example
GridFieldManyRelationHandler:
Contributing
Translations
Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.
Please use https://www.transifex.com/projects/p/silverstripe-sortablegridfield to contribute translations, rather than sending pull requests with YAML files.
