README

Gallery Creator Bundle

Frontend and backend extension for Contao CMS

This extension can be used to create, display and manage photo albums in your Contao installation. The Gallery Creator Bundle offers an album listing and an album detail view. Since version 2.0.0 markdown can be used to create the album description.

Gallery.Creator.mp4

Installation

Please use the Contao Manager or run composer require markocupic/gallery-creator-bundle in your CLI to install the extension.

CHMOD

Go to the Contao Backend Settings and select a default album owner, a default album owner group and set the default access rights

Important: If you keep the "album owner" field empty, the currently logged in backend user automatically becomes the album owner when creating a new album.

Lightbox

As a lightbox we strongly recommend Glightbox. Simply run the composer require inspiredminds/contao-glightbox command in your CLI. Please ensure, that you have activated the lightbox template in the layout settings of your theme in the Contao backend.

CSS

Gallery Creator will add the .gc-listing-view and/or the .gc-detail-view to the body tag. This will help you display or hide items you don't want to show in both modes (listing- & detail-view).

/** SASS
 * Do not display ce elements headline in detail mode
 *
 */
body.gc-detail-view {
  .ce_gallery_creator {
    h2:not([class^="gc-album-detail-name"]) {
      display: none;
    }
  }
}

Configuration

This gallery extension is shipped with a default configuration. If you want to override these settings, you can do this in your common configuration file located in config/config.yml.

# config/config.yml
# Gallery Creator (default settings)
markocupic_gallery_creator:
  upload_path: 'files/gallery_creator_albums'
  copy_images_on_import: true
  read_exif_meta_data: false
  valid_extensions: ['jpg', 'jpeg', 'gif', 'png', 'webp', 'svg', 'svgz']

# Contao configuration
contao:
 url_suffix: ''
 #....

"galleryCreatorGenerateFrontendTemplate" - Hook

Use the "galleryCreatorGenerateFrontendTemplate" hook to adapt the frontend output.

The "galleryCreatorGenerateFrontendTemplate" hook is triggered before the gallery creator front end template is parsed. It passes the content element object, the template object and the album object of the active album (if there is one). The "galleryCreatorGenerateFrontendTemplate" hook expects no return value.

<?php
// src/EventListener/GalleryCreatorFrontendTemplateListener.php
declare(strict_types=1);

namespace App\EventListener;

use Contao\CoreBundle\ServiceAnnotation\Hook;
use Contao\Template;
use Markocupic\GalleryCreatorBundle\Controller\ContentElement\AbstractContentElementController;
use Markocupic\GalleryCreatorBundle\Model\GalleryCreatorAlbumsModel;

/**
 * @Hook(GalleryCreatorFrontendTemplateListener::HOOK, priority=100)
 */
class GalleryCreatorFrontendTemplateListener
{
    public const HOOK = 'galleryCreatorGenerateFrontendTemplate';

    public function __invoke(AbstractContentElementController $contentElement, Template $template, ?GalleryCreatorAlbumsModel $activeAlbum = null)
    {
        $template->foo = 'bar';
    }
}

"galleryCreatorImagePostInsert" - Hook

Use the "galleryCreatorImagePostInsert" hook to adapt the picture entity when uploading new images to an album.

The "galleryCreatorImagePostInsert" is executed right after an image has been uploaded and has been written to the database. It passes the pictures model and expects no return value.

<?php
// src/EventListener/GalleryCreatorImagePostInsertListener.php
declare(strict_types=1);

namespace App\EventListener;

use Contao\BackendUser;
use Contao\CoreBundle\ServiceAnnotation\Hook;
use Markocupic\GalleryCreatorBundle\Model\GalleryCreatorPicturesModel;
use Symfony\Component\Security\Core\Security;

/**
 * @Hook(GalleryCreatorImagePostInsertListener::HOOK, priority=100)
 */
class GalleryCreatorImagePostInsertListener
{
    public const HOOK = 'galleryCreatorImagePostInsert';

    private Security $security;

    public function __construct(Security $security)
    {
        $this->security = $security;
    }

    public function __invoke(GalleryCreatorPicturesModel $picturesModel): void
    {
        $user = $this->security->getUser();

        // Automatically add a caption to the uploaded image
        if ($user instanceof BackendUser && $user->name) {
            $picturesModel->caption = 'Holidays '.date('Y').', Photo: '.$user->name;
            $picturesModel->save();
        }
    }
}

Have fun!

markocupic / gallery-creator-bundle

Maintainers

Details