GridFieldBulkEditingTools/README.md

63 lines
3.6 KiB
Markdown
Raw Normal View History

GridField Bulk Editing Tools
============================
2013-12-05 18:42:17 +01:00
Set of SilverStripe 3 GridField components to facilitate bulk image upload & record editing.
![preview](screenshots/preview.png)
Components included:
* [Bulk Image Upload](#bulk-image-upload): Upload multiple images at once into DataObjects with on the fly fields editing
* [Bulk Manager](#bulk-manager): Handles actions for multiple records straight from the GridField (comes with unlink, delete and edit)
[More screenshots here.](screenshots)
2012-09-06 18:05:16 +02:00
2013-04-16 19:06:24 +02:00
## Requirements
2013-05-07 19:07:45 +02:00
* SilverStripe 3.1 (version master / 1.+)
2013-04-16 19:06:24 +02:00
* Silverstripe 3.0 (version [0.5](https://github.com/colymba/GridFieldBulkEditingTools/tree/0.5))
2012-07-18 01:27:28 +02:00
2013-06-16 16:20:19 +02:00
## Development notes
The master branch will try to be compatible with the latest SilverStripe release/pre-release. Please submit pull request against the master branch. Older branches are kept for compatibility but may not be maintained.
2012-07-18 01:27:28 +02:00
## Installation
* Download and copy module in SilverStripe root directory and name it whatever you want
2013-12-05 18:42:17 +01:00
* run ?flush to regenerate the manifest
2012-07-18 01:27:28 +02:00
2012-09-06 18:05:16 +02:00
## Bulk Image Upload
2013-12-05 18:42:17 +01:00
Upload multiple images at once into DataObjects. Perfect for galleries and the like.
$config->addComponent(new GridFieldBulkImageUpload());
See [BULK_IMAGE_UPLOAD.md](BULK_IMAGE_UPLOAD.md) for detailed configuration.
2012-09-06 18:05:16 +02:00
## Bulk Manager
2013-12-05 18:42:17 +01:00
Perform actions on multiple records straight from the GridField
$config->addComponent(new GridFieldBulkManager());
See [BULK_MANAGER.md](BULK_MANAGER.md) for detailed configuration.
2012-09-05 22:40:59 +02:00
2012-09-06 18:05:16 +02:00
## Notes
2013-06-16 16:20:19 +02:00
* The Record edit form uses the Model's getCMSFields()
2012-07-18 01:27:28 +02:00
2014-03-15 14:53:20 +01:00
#### @TODO
2012-07-19 14:00:11 +02:00
* Add individual actions for each upload (update + cancel)
* Handle and display errors better for: creation, update, cancel
2013-08-04 15:21:06 +02:00
* Make it work not only for images but Files too
2014-03-15 14:53:20 +01:00
## Translations
Translations of the natural language strings are managed through a third party translation interface, transifex.com.
Please use [https://www.transifex.com/projects/p/gridfieldbulkeditingtools/](https://www.transifex.com/projects/p/gridfieldbulkeditingtools/) to contribute translations, rather than sending pull requests with YAML/JS files.
2013-08-04 15:21:06 +02:00
## License (BSD Simplified)
Copyright (c) 2013, Thierry Francois (colymba)
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Thierry Francois, colymba nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.