Download the PHP package bummzack/sortablefile without Composer
On this page you can find all versions of the php package bummzack/sortablefile. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bummzack/sortablefile
More information about bummzack/sortablefile
Files in bummzack/sortablefile
Package sortablefile
Short Description An extension for SilverStripe that adds sorting to UploadField.
License BSD-3-Clause
Informations about the package sortablefile
Sortable UploadField
An extension for SilverStripe 4.1+ that allows sorting of files attached via UploadField
.
This module decorates the existing UploadField
and adds sorting capabilities to it.
This is meant to be used with a many_many
relation of Files or Images.
Installation
This module only works with SilverStripe 4.1+.
For a version compatible with SilverStripe 3, please use a 1.x
release.
The easiest way is to use composer:
composer require bummzack/sortablefile ^2.0
Run dev/build
afterwards.
Usage
Usage is pretty simple. Just use SortableUploadField
instead of UploadField
to manage your many_many
relations.
To persist the sort-order, an additional extra-field with the sort-order has to be added to the many_many
relation.
You can do so by specifying the sort column via many_many_extraFields
(see example below).
By default the SortableUploadField
assumes that the sort-column is named SortOrder
. If you want to use another
field-name (for example Sort
), you have to explicitly set it:
SortableUploadField::create('Files')->setSortColumn('Sort');
Example setup for many_many
Let's assume we have a PortfolioPage
that has multiple Images
attached.
The PortfolioPage
looks like this:
Once this has been set up like described above, then you should be able to add images in the CMS and sort them by dragging them (use the handle on the left).
Templates
Sorting the Files via a relation table isn't easily achievable via a DataExtension. This is why it's currently up to the user to implement a getter that will return the sorted files, something along the lines of:
And then in your templates use:
Alternatively, you could simply use the sort statement in your template, which will remove the need for a special getter method in your page class.
Many Many Through
The module supports editing many many through lists as well. The advantage of using many_many through
is, that your relations can be versioned properly.
Example Setup
Here's an example setup with the same PortfolioPage
as above, but now using many_many through
instead. If this seems unclear, please also consult the official documentation.
First, the PortfolioPage
class:
The idea of the many_many through
relation is, that you have an intermediate DataObject, that connects your objects. So we add a DataObject named PortfolioImage
:
We should also add the belongs_many_many
relation to the Image
class. This is very easy to do via config. So in your mysite/_config/config.yml
add:
What happened to has_many
support?
Support for has_many
relations has been dropped, since it can lead to a very bad user experience if a file can only be added to a single page.
Imagine a user added an image to Page A
, then adds the same image via Add from files to Page B
.
The file would then be removed from Page A
, without any warning or explanation, which is bad UX.