shapecode/theme-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Provides theming support for Symfony Bundles

dev-master / 1.0.x-dev 2019-07-22 08:36 UTC

Requires

• php: ~5.6|~7.0
• symfony/config: ~2.7|~3.0|~4.0
• symfony/dependency-injection: ~2.7|~3.0|~4.0
• symfony/framework-bundle: ~2.7|~3.0|~4.0
• symfony/http-foundation: ~2.7|~3.0|~4.0
• symfony/http-kernel: ~2.7|~3.0|~4.0
• symfony/templating: ~2.7|~3.0|~4.0
• symfony/twig-bundle: ~2.7|~3.0|~4.0
• twig/twig: ~1.42|~2.11|~3.0

MIT

• Nikita Loges
• Liip AG
• Community contributions

• symfony
• themes
• theming
• bundle
• shapecode

README

This bundle provides you the possibility to add themes to each bundle. In your bundle directory it will look under Resources/themes/<themename> or fall back to the normal Resources/views if no matching file was found.

Installation

Installation is a quick (I promise!) 3 step process:

1. Download ShapecodeThemeBundle
2. Enable the Bundle

Step 1: Install ShapecodeThemeBundle with composer

Run the following composer require command:

$ php composer.phar require shapecode/theme-bundle

Step 2: Enable the bundle

Finally, enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new \Shapecode\Bundle\ThemeBundle\ShapecodeThemeBundle(),
    );
}

Configuration

You will have to set your possible themes and the currently active theme. It is required that the active theme is part of the themes list.

# app/config/config.yml
shapecode_theme:
    themes: ['standardTheme', 'winter_theme', 'weekend']
    active_theme: 'standardTheme'

Get active theme information from cookie

If you want to select the active theme based on a cookie you can add:

# app/config/config.yml
shapecode_theme:
    cookie:
        name: NameOfTheCookie
        lifetime: 31536000 # 1 year in seconds
        path: /
        domain: ~
        secure: false
        http_only: false

Theme Cascading Order

The following order is applied when checking for templates that live in a bundle, for example @BundleName/Resources/template.html.twig with theme name phone is located at:

1. Override themes directory: app/Resources/themes/phone/BundleName/template.html.twig
2. Override view directory: app/Resources/BundleName/views/template.html.twig
3. Bundle theme directory: src/BundleName/Resources/themes/phone/template.html.twig
4. Bundle view directory: src/BundleName/Resources/views/template.html.twig

For example, if you want to integrate some TwigBundle custom error pages regarding your theme architecture, you will have to use this directory structure : app/Resources/themes/phone/TwigBundle/Exception/error404.html.twig

The following order is applied when checking for application-wide base templates, for example ::template.html.twig with theme name phone is located at:

1. Override themes directory: app/Resources/themes/phone/template.html.twig
2. Override view directory: app/Resources/views/template.html.twig

Change Theme Cascading Order

You able change cascading order via configurations directives: path_patterns.app_resource, path_patterns.bundle_resource, path_patterns.bundle_resource_dir. For example:

# app/config/config.yml
shapecode_theme:
    path_patterns:
        app_resource:
            - %%app_path%%/themes/%%current_theme%%/%%template%%
            - %%app_path%%/themes/fallback_theme/%%template%%
            - %%app_path%%/views/%%template%%
        bundle_resource:
            - %%bundle_path%%/Resources/themes/%%current_theme%%/%%template%%
            - %%bundle_path%%/Resources/themes/fallback_theme/%%template%%
        bundle_resource_dir:
            - %%dir%%/themes/%%current_theme%%/%%bundle_name%%/%%template%%
            - %%dir%%/themes/fallback_theme/%%bundle_name%%/%%template%%
            - %%dir%%/%%bundle_name%%/%%override_path%%

Cascading Order Patterns Placeholders

Placeholder	Representation	Example
%app_path%	Path where application resources are located	app/Resources
%bundle_path%	Path where bundle located, for example	src/Vendor/CoolBundle/VendorCoolBundle
%bundle_name%	Name of the bundle	VendorCoolBundle
%dir%	Directory, where resource should looking first
%current_theme%	Name of the current active theme
%template%	Template name	view.html.twig
%override_path%	Like template, but with views directory	views/list.html.twig

Change Active Theme

For that matter have a look at the ThemeRequestListener.

If you are early in the request cycle and no template has been rendered you can still change the theme without problems. For this the theme service exists at:

$activeTheme = $container->get('shapecode_theme.active_theme');
echo $activeTheme->getName();
$activeTheme->setName("phone");

Contribution

Active contribution and patches are very welcome.

First install dependencies:

   composer.phar install --dev