Skip to content

dachcom-digital/pimcore-i18n

Repository files navigation

Pimcore - i18n Manager

Software License Latest Release Tests PhpStan

i18n

Scheme

i18n scheme

Introduction

Pimcore already comes with some great features to build internationalized websites. But there are some gaps we have to handle by ourselves: search engine guidelines, geo based redirects, dynamic link handling for internal documents and of course: full qualified URLs for and in every context. This bundle helps you to master this challenges and gives you the freedom to elaborate complex URL building and (country) based localization strategies. Please read the read the I18n overview page before starting!

Release Plan

Release Supported Pimcore Versions Supported Symfony Versions Release Date Maintained Branch
5.x 11.0 6.2 09.10.2023 Feature Branch dev-master
4.x 10.1 - 10.6 5.4 12.11.2021 Bugfixes 4.x
3.x 6.0 - 6.3, 6.5 - 6.9 3.4, ^4.4 18.07.2019 Unsupported 3.x
2.4 5.4, 5.5, 5.6, 5.7, 5.8 3.4 24.05.2019 Unsupported 2.4

Installation

"require" : {
    "dachcom-digital/i18n" : "~5.0.0"
}

Add Bundle to bundles.php:

return [
    I18nBundle\I18nBundle::class => ['all' => true],
];
  • Execute: $ bin/console pimcore:bundle:install I18nBundle

Upgrading

  • Execute: $ bin/console doctrine:migrations:migrate --prefix 'I18nBundle\Migrations'

Features

  • Generate fully qualified URLs in any context with symfony's default router
  • Geo redirects (read more about the redirector adapter here)
  • Thanks to the hardlink element you can easily create copies of webpages with additional country information without adding and maintaining duplicate content
  • Manage href-lang tags
  • Domain mapping (domain.com) and/or language slug (/en) strategies
  • front page mapping for hardlink trees

Before you start

When using this bundle, you should:

  • not using any router but the default RouterInterface object.
  • not using pimcore_url or $staticRoute->assemble() but using the default RouterInterface instead
  • extend your LinkGeneratorInterface objects with the I18nLinkGeneratorInterface and adjust dem accordingly
  • read the How I18nBundle works section

Preparation

  • If you're using system as your locale_adapter, which is the default, you need to enable all required locales in pimcore system settings
  • Always be sure that every document translation is connected via the localization tool.
  • If you're using the country detection, you need a valid maxmind geo ip data provider

Further Information

Copyright and License

Copyright: DACHCOM.DIGITAL
For licensing details please visit LICENSE.md

Upgrade Info

Before updating, please check our upgrade notes!