Code Monkey home page Code Monkey logo

alexandresalome_multisitebundle's Introduction

AlexMultisiteBundle - Branding and Internationalization

Build status Latest Stable Version Total Downloads License Monthly Downloads Daily Downloads

This bundle allows you to manage multiple brandings and multiple locales in a Symfony2 application.

Requirements:

  • FrameworkExtraBundle
  • TwigBundle

Features

  • Multiple routes for each site
  • Configuration per site
  • Templates per site

Installation

Add to your composer.json:

{
    "require": {
        "alexandresalome/multisite-bundle": "~0.1"
    }
}

Add the bundle to your kernel:

# app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            # ...
            new Alex\MultisiteBundle\AlexMultisiteBundle(),
        );
    }
}

Configuration

Add this section to your config.yml file:

alex_multisite:
    default_branding: branding_A
    default_locale:   fr_FR
    brandings:
        _defaults:
            register: true
        branding_A:
            en_GB: { host: branding-a.com }
            fr_FR: { host: branding-a.com, prefix: /fr }
        branding_B:
            _defaults:
                register: false
            en_GB: { host: branding-b.com }
            de_DE: { host: branding-b.de, register: false }

In this section, you must configure your brandings and locales.

You can also add extra options, like the register option here.

Declare your routes

In your controllers, substitute

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

with

use Alex\MultisiteBundle\Annotation\Route;

You can then configure a multisite route in two ways:

/**
 * @Route(name="login", paths={
 *   "fr_FR"="/connexion",
 *   "en_GB"="/login"
 * })
 */
public function loginAction()
# ...

The path will be the same for all brandings, but will be localized. If you want a different path for same locale in different sites:

/**
 * @Route(name="login", paths={
 *   "branding_A"={
 *     "fr_FR"="/connexion-on-A",
 *     "en_GB"="/login-on-A",
 *   },
 *   "branding_B"={
 *     "en_GB"="/login-on-B",
 *   },
 * })
 */
public function loginAction()
# ...

Override templates

If you want to change a template for a specific site, create a similarly named file with branding/locale option in it:

Given your default template is AcmeDemoBundle::contact.html.twig.

You can override it with branding, locale, or both:

  • AcmeDemoBundle::_branding_locale/contact.html.twig
  • AcmeDemoBundle::_branding_/contact.html.twig
  • AcmeDemoBundle::__locale/contact.html.twig

Just create the file and it will automatically be loaded in place of the previous one.

Read the site context

From templates, use the global variable site_context, which returns a Alex\MultisiteBundle\Branding\SiteContext instance:

You are currently on {{ site_context.currentBrandingName }}
Your locale is {{ site_context.currentLocale }}

You can also read options from config with:

The option register is {{ site_context.option('register') ? 'enabled': 'not enabled' }}

In your controllers, use service site_context:

public function indexAction()
{
    $this->get('site_context')->getCurrentLocale();
    $this->get('site_context')->getOption('register');
}

Disable route sorting

You might want to rely on natural order of routes. If you're in this case, you can disable the optimization by providing the sort_route option:

alex_multisite:
    sort_routes: false
    # ...

Security

You can combine this bundle with Symfony's SecurityBundle, and use this bundle for your routes for login form page.

But, you must not use the multisite feature for the following routes:

  • login-check
  • logout

alexandresalome_multisitebundle's People

Contributors

seblevdev avatar philsabaty avatar cedricblondeau avatar h4cc avatar pborreli avatar sanderborgman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.