README

Introduction

Provides basic image gallery functionality to a Silverstripe site.

Designed to provide a simple, fool-proof way for users to add image galleries to their website.

Applies Basic Image Gallery Extension to a PhotoGalleryPage page type, and includes a PhotoGalleryHolder type.

Maintainer Contact

• James Cocker (ssmodulesgithub@pswd.biz)

Requirements

• Silverstripe 6

Installation Instructions

1. Install:

   composer require purplespider/basic-galleries ^4
   

2. Visit yoursite.com/dev/build to rebuild the database.

3. Log in the CMS, and create a new Photo Gallery Holder page.

4. On the holder's Photo Galleries tab, click "Add new Image Gallery". Galleries are managed from this tab, using Lumberjack, rather than appearing in the site tree.

5. On a Photo Gallery Page, click on the Image Gallery tab, then click Bulk Upload to add images.

Screenshot

Config

You can customise the CMS tab that the gallery appears on, as well as the title of the gallery displayed in the CMS:

HomePage:
extensions: - PurpleSpider\BasicGalleries\PhotoGalleryExtension
gallery-title: Image Gallery
gallery-cms-tab: Main

Keep Galleries in the Site Tree

To list galleries in the site tree instead of on the holder's Photo Galleries tab:

---
Name: custom-basic-galleries
After: basic-galleries
---
PurpleSpider\BasicGalleries\PhotoGalleryPage:
    show_in_sitetree: true

Automatically Delete Image Files

To automatically delete image files when an image is deleted from a gallery:

---
Name: custom-basic-gallery-extension
After: basic-gallery-extension
---
PurpleSpider\BasicGalleryExtension\PhotoGalleryImage:
    ondelete_delete_image_files: true

This uses Delete Asset If Unused Extension to detect if the image is being used elsewhere on the site, and will only delete it if it isn't. There are caveats though, so check this module's readme, i.e. you might not want to use this on sites that have been upgraded from Silverstripe 3.

Version Details

• 0.* = SilverStripe 3
• 1.* = Silverstripe 4
• 2.* = Silverstripe 4 (Uses newer version of PhotoGalleryExtension with a polymorphic relation, so upgrading from 1 to 2 will break existing galleries.)
• 3.* = Silverstripe 5
• 4.* = Silverstripe 6

Upgrade Notes

To v1 or higher (extension moved to seperate module)

• Change any references to the extension, e.g. if applied to the Homepage type, from PurpleSpider\BasicGalleries\PhotoGalleryExtension to PurpleSpider\BasicGalleryExtension\PhotoGalleryExtension
• PurpleSpider\BasicGalleries\PhotoGalleryImage is now PurpleSpider\BasicGalleryExtension\PhotoGalleryImage (in case you applied your own extension to it)
• Run dev/build to update table names automatically (via legacy.yml)

to v2 or higher (individual page and elemental relations changed to a single polymorphic relation)

• Complete "To v1" upgrade instructions, inc dev/build
• Run the upgrade-basic-galleries task to update database for existing galleries. On Silverstripe 6 that's sake tasks:upgrade-basic-galleries, or visit /dev/tasks/upgrade-basic-galleries.
• Until the task has run, existing galleries render empty with no error. It's safe to re-run.

to v3 (Silverstripe 5)

• Nothing extra required, just change version to ^3.

to v4 (Silverstripe 6)

• From v2 or v3, nothing extra required, just change version to ^4.
• From v1, also follow the "to v2" notes above, as those database changes still need to happen: sake db:build --flush, then sake tasks:upgrade-basic-galleries.

to v4.1

• Galleries move from the site tree to a Photo Galleries tab on their holder, which has an "Add new Image Gallery" button. No database changes. See "Keep Galleries in the Site Tree" to opt out.
• A site that registers PurpleSpider\BasicGalleryExtension\CustomLumberjack on the holder itself can remove that, though leaving it does no harm.