guesser.md

Custom Guesser

If you want to implement your own locale guesser, you need the following steps:

1. Define the guesser class

---

Add the following parameter to your service definition:

<parameter key="lunetics_locale.acme_guesser.class">Acme\AcmeBundle\LocaleGuesser\AcmeLocaleGuesser</parameter>

2. Add the guesser as service

---

It is important that you add exactly this tag name.

Also be sure to inject the metavalidator, which checks if the locale is valid and allowed by configuration.

<service id="lunetics_locale.acme_guesser" class="%lunetics_locale.acme_guesser.class%">
    <argument type="service" id="lunetics_locale.validator.meta" />
    <tag name="lunetics_locale.guesser" alias="acme" />
</service>

3. Build your guesser class

---

You need to build the guesser class. The class must implement the LocaleGuesserInterface.

If a locale is identified, the guessLocale function must set the locale in the object and return the string value of the locale. If no locale was found, the guessLocale function must return false.

// src/Acme/AcmeBundle/LocaleGuesser/AcmeLocaleGuesser.php
<?php
namespace Acme\AcmeBundle\LocaleGuesser;

use Symfony\Component\HttpFoundation\Request;
use Lunetics\LocaleBundle\LocaleGuesser\LocaleGuesserInterface;
use Lunetics\LocaleBundle\Validator\MetaValidator

class AcmeLocaleGuesser implements LocaleGuesserInterface
{
    private $identifiedLocale;

    private $metaValidator;

    public function guessLocale(Request $request)
    {
        // Code to identify the locale, if found:
        if ($this->metaValidator->isAllowed($foundLocale)) {
            $this->identifiedLocale = $foundLocale;
            return $this->identifiedLocale;
        }

        return false;
    }

    public function getIdentifiedLocale()
    {
        return $this->identifiedLocale;
    }
}

4. Add the guesser to the config

---

Add the Service alias tag name to the order in app/config/config.yml:

lunetics_locale:
    guessing_order:
        - session
        - cookie
        - acme
        - ...