Symfony 5 compatibility and Switch to SyliusThemeBundle (#19)

.gitignore

@@ -1,5 +1,7 @@
 /Tests/Application/var/*
 /vendor/
+.env.local
+.env.*.local
 /composer.phar
 /composer.lock
 .php_cs.cache

.travis.yml

@@ -9,7 +9,7 @@ cache:
 
 matrix:
   include:
-    - php: 7.2
+    - php: 7.3
       env:
         - COMPOSER_FLAGS="--prefer-lowest --prefer-stable --prefer-dist --no-interaction"
     - php: 7.4

DependencyInjection/CompilerPass/ImageFormatCompilerPass.php

@@ -11,8 +11,8 @@
 
 namespace Sulu\Bundle\ThemeBundle\DependencyInjection\CompilerPass;
 
-use Liip\ThemeBundle\ActiveTheme;
 use Sulu\Bundle\MediaBundle\DependencyInjection\AbstractImageFormatCompilerPass;
+use Sylius\Bundle\ThemeBundle\Repository\ThemeRepositoryInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
@@ -25,14 +25,13 @@ class ImageFormatCompilerPass extends AbstractImageFormatCompilerPass
      */
     protected function getFiles(ContainerBuilder $container)
     {
-        $files = [];
-
-        /** @var ActiveTheme $activeTheme */
-        $activeTheme = $container->get('liip_theme.active_theme');
+        /** @var ThemeRepositoryInterface $themeRepository */
+        $themeRepository = $container->get('sylius.repository.theme');
         $bundles = $container->getParameter('kernel.bundles');
         $configPath = 'config/image-formats.xml';
 
-        foreach ($activeTheme->getThemes() as $theme) {
+        $files = [];
+        foreach ($themeRepository->findAll() as $theme) {
             foreach ($bundles as $bundleName => $bundle) {
                 $bundleReflection = new \ReflectionClass($bundle);
                 $fileName = $bundleReflection->getFileName();
@@ -44,7 +43,7 @@ protected function getFiles(ContainerBuilder $container)
                 $path = sprintf(
                     '%s/Resources/themes/%s/%s',
                     dirname($fileName),
-                    $theme,
+                    $theme->getName(),
                     $configPath
                 );
 

EventListener/SetThemeEventListener.php

@@ -11,29 +11,36 @@
 
 namespace Sulu\Bundle\ThemeBundle\EventListener;
 
-use Liip\ThemeBundle\ActiveTheme;
 use Sulu\Bundle\PreviewBundle\Preview\Events\PreRenderEvent;
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Sylius\Bundle\ThemeBundle\Context\SettableThemeContext;
+use Sylius\Bundle\ThemeBundle\Repository\ThemeRepositoryInterface;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 /**
  * Listener which applies the configured theme.
  */
 class SetThemeEventListener
 {
     /**
-     * @var ActiveTheme
+     * @var ThemeRepositoryInterface
      */
-    private $activeTheme;
+    private $themeRepository;
 
-    public function __construct(ActiveTheme $activeTheme)
+    /**
+     * @var SettableThemeContext
+     */
+    private $themeContext;
+
+    public function __construct(ThemeRepositoryInterface $themeRepository, SettableThemeContext $themeContext)
     {
-        $this->activeTheme = $activeTheme;
+        $this->themeRepository = $themeRepository;
+        $this->themeContext = $themeContext;
     }
 
     /**
      * Set the active theme if there is a portal.
      */
-    public function setActiveThemeOnRequest(GetResponseEvent $event): void
+    public function setActiveThemeOnRequest(RequestEvent $event): void
     {
         if (null === ($attributes = $event->getRequest()->get('_sulu'))
             || null === ($webspace = $attributes->getAttribute('webspace'))
@@ -42,14 +49,20 @@ public function setActiveThemeOnRequest(GetResponseEvent $event): void
             return;
         }
 
-        $this->activeTheme->setName($theme);
+        $theme = $this->themeRepository->findOneByName($theme);
+        if (null !== $theme) {
+            $this->themeContext->setTheme($theme);
+        }
     }
 
     /**
      * Set the active theme for a preview rendering.
      */
     public function setActiveThemeOnPreviewPreRender(PreRenderEvent $event): void
     {
-        $this->activeTheme->setName($event->getAttribute('webspace')->getTheme());
+        $theme = $this->themeRepository->findOneByName($event->getAttribute('webspace')->getTheme());
+        if (null !== $theme) {
+            $this->themeContext->setTheme($theme);
+        }
     }
 }

README.md

@@ -1,5 +1,152 @@
-# SuluThemeBundle
+<h1 align="center">SuluThemeBundle</h1>
 
-[![Build Status](https://travis-ci.org/sulu/SuluThemeBundle.svg?branch=develop)](https://travis-ci.org/sulu/SuluThemeBundle)
+<p align="center">
+    <a href="https://sulu.io/" target="_blank">
+        <img width="30%" src="https://sulu.io/uploads/media/800x/00/230-Official%20Bundle%20Seal.svg?v=2-6&inline=1" alt="Official Sulu Bundle Badge">
+    </a>
+</p>
 
-This package enables a basic theming for sulu. It uses liip/theme-bundle to extend the discovery feature of twig.
+<p align="center">
+    <a href="https://github.com/sulu/SuluThemeBundle/releases" target="_blank">
+        <img src="https://img.shields.io/github/tag/sulu/SuluThemeBundle.svg" alt="GitHub tag (latest SemVer)">
+    </a>
+    <a href="https://github.com/sulu/SuluThemeBundle/blob/master/LICENSE" target="_blank">
+        <img src="https://img.shields.io/github/license/sulu/SuluThemeBundle.svg" alt="GitHub license">
+    </a>
+    <a href="https://github.com/sulu/sulu/releases" target="_blank">
+        <img src="https://img.shields.io/badge/sulu%20compatibility-%3E=2.0-52b6ca.svg" alt="Sulu compatibility">
+    </a>
+</p>
+<br/>
+
+The **SuluThemeBundle** provides the functionality to add multiple themes for different look and feel using multiple 
+webspaces in the [Sulu](https://sulu.io/) content management system. 
+
+To achieve this, the bundle uses the [SyliusThemeBundle](https://github.com/Sylius/SyliusThemeBundle) to render different
+twig templates and asset files. Each webspace can have it's own theme.
+
+## 🚀&nbsp; Installation and Usage
+
+### Install the bundle
+
+Execute the following [composer](https://getcomposer.org/) command to add the bundle to the dependencies of your 
+project:
+
+```bash
+composer require sulu/theme-bundle
+```
+
+### Enable the bundle 
+
+Enable the bundle by adding it to the list of registered bundles in the `config/bundles.php` file of your project:
+
+```php
+return [
+    /* ... */
+    Sulu\Bundle\ThemeBundle\SuluThemeBundle::class => ['all' => true],
+];
+```
+
+
+### Configure the SyliusThemeBundle
+
+In order to use the bundle you have to add at least the following default configuration:
+
+```yaml
+# ./config/packages/sylius_theme.yaml
+
+sylius_theme:
+    sources:
+        filesystem: ~
+```
+
+By default, the bundle seeks for the themes in the `%kernel.project_dir%/themes` directory and looks for a
+theme configuration file named `composer.json`. This can be changed via the yaml configuration:
+
+```yaml
+sylius_theme:
+    sources:
+        filesystem:
+            filename: theme.json
+```
+
+For more detailed information about the configuration sources go to the [SyliusThemeBundle documentation](https://github.com/Sylius/SyliusThemeBundle/blob/master/docs/configuration_sources.md).
+
+### Configure your themes
+
+Every theme must have its own configuration file in form of a `theme.json`.
+Go to the [Theme Configuration Reference](https://github.com/Sylius/SyliusThemeBundle/blob/master/docs/theme_configuration_reference.md)
+for the detailed documentation about the configuration options.
+
+The minimal configuration for a theme would be the following:
+
+```json
+// ./themes/<theme-name-1>/theme.json
+
+{
+  "name": "vendor/<theme-name-1>"
+}
+```
+
+It is important, that the `name` matches the naming convention of composer (`vendor/name`). 
+
+### Create a theme
+First you have to create the directory `themes` inside your project.
+To create a theme you have to create a new directory in the themes folder with the name of the new theme. 
+In the newly created directory you have to add the theme configuration file `theme.json`.
+See [Configure your themes](#configure-your-themes). Additonally you have to create the `templates` directory next to 
+the `theme.json`. Afterwards you have to fill this folder with all the used templates and assets for this theme. 
+
+This results in the following project structure:
+
+```
+ProjectName
+├── composer.json
+├── assets
+├── bin
+├── config
+├── templates
+├── themes
+│   ├── <theme-name-1>
+│   │   ├── templates
+│   │   │   └── base.html.twig
+│   │   └── theme.json
+│   └── <theme-name-2>
+│       ├── templates
+│       │   └── base.html.twig
+│       └── theme.json
+├── ...
+└── ...
+```
+
+### Add one of your themes to a webspace
+
+Each webspace can use a different theme. A theme can be enabled for a specific webspace by adding the theme name
+`<theme>vendor/theme-name</theme>` to your webspace:
+
+```xml
+<!-- ./config/webspaces/example.xml -->
+<webspace xmlns="http://schemas.sulu.io/webspace/webspace"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://schemas.sulu.io/webspace/webspace http://schemas.sulu.io/webspace/webspace-1.1.xsd">
+    <name>example.com</name>
+    <key>example</key>
+    ...
+    <theme>vendor/theme-name</theme>
+    ...    
+</webspace>
+```
+
+## ❤️&nbsp; Support and Contributions
+
+The Sulu content management system is a **community-driven open source project** backed by various partner companies. 
+We are committed to a fully transparent development process and **highly appreciate any contributions**. 
+
+In case you have questions, we are happy to welcome you in our official [Slack channel](https://sulu.io/services-and-support).
+If you found a bug or miss a specific feature, feel free to **file a new issue** with a respective title and description 
+on the the [sulu/SuluThemeBundle](https://github.com/sulu/SuluThemeBundle) repository.
+
+
+## 📘&nbsp; License
+
+The Sulu content management system is released under the under terms of the [MIT License](LICENSE).

Resources/config/admin.xml

@@ -5,7 +5,8 @@
     <services>
         <service id="sulu_website.event_listener.set_theme"
                  class="Sulu\Bundle\ThemeBundle\EventListener\SetThemeEventListener">
-            <argument type="service" id="liip_theme.active_theme"/>
+            <argument type="service" id="sylius.repository.theme"/>
+            <argument type="service" id="sylius.theme.context.settable"/>
 
             <tag name="kernel.event_listener" event="%sulu_preview.events.pre-render%"
                  method="setActiveThemeOnPreviewPreRender"/>

Resources/config/website.xml

@@ -2,11 +2,11 @@
 <container xmlns="http://symfony.com/schema/dic/services"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
-
     <services>
         <service id="sulu_theme.event_listener.set_theme"
                  class="Sulu\Bundle\ThemeBundle\EventListener\SetThemeEventListener">
-            <argument type="service" id="liip_theme.active_theme"/>
+            <argument type="service" id="sylius.repository.theme"/>
+            <argument type="service" id="sylius.theme.context.settable"/>
 
             <tag name="kernel.event_listener" event="kernel.request" method="setActiveThemeOnRequest"/>
         </service>