Merge pull request #54 from Alloboissons/feature/i18n

I18N for Templates and more

Author: skurfuerst

Classes/Controller/LoginController.php

@@ -3,6 +3,7 @@
 
 use Neos\Error\Messages\Error;
 use Neos\Error\Messages\Message;
+use Neos\Flow\I18n\Translator;
 use Neos\Flow\Mvc\Controller\ControllerContext;
 use Neos\Flow\Security\Exception\AuthenticationRequiredException;
 use Sandstorm\UserManagement\Domain\Service\RedirectTargetServiceInterface;
@@ -37,18 +38,58 @@ class LoginController extends AbstractAuthenticationController
      */
     protected $uriFactory;
 
+    /**
+     * @Flow\Inject
+     * @var Translator
+     */
+    protected $translator;
+
     /**
      * @var string
      * @Flow\InjectConfiguration(path="authFailedMessage.title")
      */
     protected $loginFailedTitle;
 
+    /**
+     * @return string
+     */
+    protected function getLoginFailedTitle()
+    {
+        return $this->loginFailedTitle === 'i18n'
+            ? $this->translator->translateById(
+                'authFailedMessage.title',
+                [],
+                null,
+                null,
+                'Main',
+                'Sandstorm.UserManagement'
+            )
+            : $this->loginFailedTitle;
+    }
+
     /**
      * @var string
      * @Flow\InjectConfiguration(path="authFailedMessage.body")
      */
     protected $loginFailedBody;
 
+    /**
+     * @return string
+     */
+    protected function getLoginFailedBody()
+    {
+        return $this->loginFailedBody === 'i18n'
+            ? $this->translator->translateById(
+                'authFailedMessage.body',
+                [],
+                null,
+                null,
+                'Main',
+                'Sandstorm.UserManagement'
+            )
+            : $this->loginFailedBody;
+    }
+
     /**
      * SkipCsrfProtection is needed here because we will have errors otherwise if we render multiple
      * plugins on the same page
@@ -101,7 +142,7 @@ protected function onAuthenticationSuccess(ActionRequest $originalRequest = null
     protected function onAuthenticationFailure(AuthenticationRequiredException $exception = null)
     {
         $this->emitAuthenticationFailure($this->controllerContext, $exception);
-        $this->addFlashMessage($this->loginFailedBody, $this->loginFailedTitle,Message::SEVERITY_ERROR, [], ($exception === null ? 1347016771 : $exception->getCode()));
+        $this->addFlashMessage($this->getLoginFailedBody(), $this->getLoginFailedTitle(),Message::SEVERITY_ERROR, [], ($exception === null ? 1347016771 : $exception->getCode()));
     }
 
     /**

Classes/Controller/RegistrationController.php

@@ -1,6 +1,7 @@
 <?php
 namespace Sandstorm\UserManagement\Controller;
 
+use Neos\Flow\I18n\Translator;
 use Sandstorm\TemplateMailer\Domain\Service\EmailService;
 use Sandstorm\UserManagement\Domain\Model\RegistrationFlow;
 use Sandstorm\UserManagement\Domain\Repository\RegistrationFlowRepository;
@@ -32,12 +33,35 @@ class RegistrationController extends ActionController
      */
     protected $emailService;
 
+    /**
+     * @Flow\Inject
+     * @var Translator
+     */
+    protected $translator;
+
     /**
      * @var string
      * @Flow\InjectConfiguration(path="email.subjectActivation")
      */
     protected $subjectActivation;
 
+    /**
+     * @return string
+     */
+    protected function getSubjectActivation()
+    {
+        return $this->subjectActivation === 'i18n'
+            ? $this->translator->translateById(
+                'email.subjectActivation',
+                [],
+                null,
+                null,
+                'Main',
+                'Sandstorm.UserManagement'
+            )
+            : $this->subjectActivation;
+    }
+
 
     /**
      * @Flow\SkipCsrfProtection
@@ -69,7 +93,7 @@ public function registerAction(RegistrationFlow $registrationFlow)
 
         $this->emailService->sendTemplateEmail(
             'ActivationToken',
-            $this->subjectActivation,
+            $this->getSubjectActivation(),
             [$registrationFlow->getEmail()],
             [
                 'activationLink' => $activationLink,

Classes/Controller/ResetPasswordController.php

@@ -1,6 +1,7 @@
 <?php
 namespace Sandstorm\UserManagement\Controller;
 
+use Neos\Flow\I18n\Translator;
 use Neos\Flow\Property\TypeConverter\PersistentObjectConverter;
 use Sandstorm\UserManagement\Domain\Model\ResetPasswordFlow;
 use Sandstorm\UserManagement\Domain\Repository\ResetPasswordFlowRepository;
@@ -39,12 +40,34 @@ class ResetPasswordController extends ActionController
      */
     protected $emailService;
 
+    /**
+     * @Flow\Inject
+     * @var Translator
+     */
+    protected $translator;
+
     /**
      * @var string
      * @Flow\InjectConfiguration(path="email.subjectResetPassword")
      */
     protected $subjectResetPassword;
 
+    /**
+     * @return string
+     */
+    protected function getSubjectResetPassword()
+    {
+        return $this->subjectResetPassword === 'i18n'
+            ? $this->translator->translateById(
+                'email.subjectResetPassword',
+                [],
+                null,
+                null,
+                'Main',
+                'Sandstorm.UserManagement'
+            )
+            : $this->subjectResetPassword;
+    }
 
     /**
      * @Flow\SkipCsrfProtection
@@ -88,7 +111,7 @@ public function requestTokenAction(ResetPasswordFlow $resetPasswordFlow)
 
             $this->emailService->sendTemplateEmail(
                 'ResetPasswordToken',
-                $this->subjectResetPassword,
+                $this->getSubjectResetPassword(),
                 [$resetPasswordFlow->getEmail()],
                 [
                     'resetPasswordLink' => $resetPasswordLink,

Configuration/Settings.yaml

@@ -5,10 +5,14 @@ Sandstorm:
     # Validity timespan for the token used to reset passwords.
     resetPasswordTokenTimeout: '4 hours'
     # The message that appears if a user could not be logged in.
+    # Set the value to 'i18n' to enable translations
+    # using 'authFailedMessage.title and authFailedMessage.body as id.
     authFailedMessage:
       title: 'Login nicht möglich'
       body: 'Sie haben ungültige Zugangsdaten eingegeben. Bitte versuchen Sie es noch einmal.'
     # Email settings
+    # Set the value to 'i18n' to enable translations
+    # using 'email.subjectActivation' and 'email.subjectResetPassword' as id.
     email:
       subjectActivation: 'Please confirm your account'
       # Subject line for the password reset email

README.md

@@ -105,6 +105,19 @@ Sandstorm:
     rolesForNewUsers: []
 ```
 
+### I18N
+It is possible to use i18n for the messages configured in the settings. Simply by setting the values to 'i18n'.
+```
+Sandstorm:
+  UserManagement:
+    authFailedMessage:
+      title: 'i18n'
+      body: 'i18n'
+    email:
+      subjectActivation: 'i18n'
+      subjectResetPassword: 'i18n'
+```
+
 ## Additional Settings for usage in Neos
 You should switch the implementation of the Redirect and User Creation Services to the Neos services. Add this to your `Objects.yaml`:
 ```
@@ -366,7 +379,6 @@ Feel free to submit issues/PRs :)
 
 # 6. TODOs
 
-* I18N for Templates.
 * More Tests.
 
 # 7. FAQ

Resources/Private/Partials/LogoutForm.html

@@ -5,9 +5,9 @@
       lang="en">
 
 <f:section name="Logout">
-  <p>Sie sind eingeloggt als <strong>{account.accountIdentifier}</strong>.</p>
+  <p><f:translate id="logout.loggedAs" arguments="{0: '{account.accountIdentifier}'}"></f:translate></p>
   <f:form action="logout" method="post" additionalAttributes="{role:'form'}">
-    <f:form.submit value="Ausloggen" class="button primary" />
+    <f:form.submit value="{f:translate(id: 'logout')}" class="button primary" />
   </f:form>
 </f:section>
 

Resources/Private/Templates/Login/Login.html

@@ -17,12 +17,12 @@
     <f:else>
       <f:form action="authenticate" method="post">
         <fieldset>
-          <input placeholder="test@example.com" name="__authentication[Neos][Flow][Security][Authentication][Token][UsernamePassword][username]" type="email" autofocus>
-          <input placeholder="Passwort" name="__authentication[Neos][Flow][Security][Authentication][Token][UsernamePassword][password]" type="password" value="">
-          <input type="submit" value="Login" class="button large primary" />
+          <input placeholder="{f:translate(id: 'email')}" name="__authentication[Neos][Flow][Security][Authentication][Token][UsernamePassword][username]" type="email" autofocus>
+          <input placeholder="{f:translate(id: 'password')}" name="__authentication[Neos][Flow][Security][Authentication][Token][UsernamePassword][password]" type="password" value="">
+          <input type="submit" value="{f:translate(id: 'login')}" class="button large primary" />
         </fieldset>
       </f:form>
-      <f:link.action action="index" controller="ResetPassword">Passwort vergessen?</f:link.action>
+      <f:link.action action="index" controller="ResetPassword"><f:translate id="passwordForgotten"></f:translate></f:link.action>
     </f:else>
   </usermanagement:ifAuthenticated>
 </f:section>

Resources/Private/Templates/Registration/ActivateAccount.html

@@ -18,28 +18,28 @@
 
   <f:if condition="{tokenNotFound}">
     <div class="callout alert">
-      <p>Der Aktivierungslink war nicht gültig.
-        <f:link.action action="index" controller="Registration" package="Sandstorm.UserManagement">Bitte registrieren Sie sich erneut.</f:link.action>
+      <p><f:translate id="activation.linkNotValid"></f:translate>
+        <f:link.action action="index" controller="Registration" package="Sandstorm.UserManagement"><f:translate id="activation.registerAgain"></f:translate></f:link.action>
       </p>
     </div>
   </f:if>
 
   <f:if condition="{tokenTimeout}">
     <div class="callout alert">
-      <p>Der Aktivierungslink ist nicht mehr gültig.
-        <f:link.action action="index" controller="Registration" package="Sandstorm.UserManagement">Bitte registrieren Sie sich erneut.</f:link.action>
+      <p><f:translate id="activation.linkExpired"></f:translate>
+        <f:link.action action="index" controller="Registration" package="Sandstorm.UserManagement"><f:translate id="activation.registerAgain"></f:translate></f:link.action>
       </p>
     </div>
   </f:if>
 
   <f:if condition="{success}">
     <div class="callout success">
-      <p>Sie sind nun aktiviert und können sich auf unserer Website anmelden.
+      <p><f:translate id="activation.successMessage"></f:translate>
       </p>
     </div>
     <!-- This can cause issues in the Neos use case, as then the Login Form will be displayed in the registration plugin's subcontext, which might
     not make sense. Therefore, deactivated for the time being. Feel free to uncomment in your own template. -->
-    <!--<f:link.action controller="Login" action="login" package="Sandstorm.UserManagement" class="button large primary">Zum Login</f:link.action>-->
+    <!--<f:link.action controller="Login" action="login" package="Sandstorm.UserManagement" class="button large primary"><f:translate id="toTheLogin"></f:translate></f:link.action>-->
   </f:if>
 
 </f:section>

Resources/Private/Templates/Registration/Index.html

@@ -16,41 +16,41 @@
       <f:form action="register" method="post" objectName="registrationFlow">
         <fieldset>
           <label>
-            E-Mail-Adresse
+            <f:translate id="emailAddress"></f:translate>
             <f:form.textfield property="email" placeholder="test@example.com" name="__authentication[Neos][Flow][Security][Authentication][Token][UsernamePassword][username]" type="email" required="true"/>
             <f:render partial="FormErrors" section="ValidationResults" arguments="{for: 'registrationFlow.email'}"/>
           </label>
 
           <label>
-            Passwort
-            <f:form.password placeholder="Ihr Passwort" property="passwordDto.password" required="true"/>
+            <f:translate id="password"></f:translate>
+            <f:form.password placeholder="{f:translate(id: 'yourPassword')}" property="passwordDto.password" required="true"/>
             <f:render partial="FormErrors" section="ValidationResults" arguments="{for: 'registrationFlow.passwordDto.password'}"/>
           </label>
 
           <label>
-            Passwortbestätigung
-            <f:form.password placeholder="Passwort wiederholen" property="passwordDto.passwordConfirmation" required="true"/>
+            <f:translate id="registration.confirmPassword"></f:translate>
+            <f:form.password placeholder="{f:translate(id: 'registration.repeatPassword')}" property="passwordDto.passwordConfirmation" required="true"/>
           </label>
 
           <label>
-            Anrede
-            <f:form.select options="{'m': 'Herr', 'f': 'Frau'}" property="attributes.salutation" />
+            <f:translate id="registration.salutation"></f:translate>
+            <f:form.select options="{'m': 'Mr.', 'f': 'Ms.'}" translate="{by: 'id', prefix: 'registration.salutationOptions.'}" property="attributes.salutation" />
             <f:render partial="FormErrors" section="ValidationResults" arguments="{for: 'registrationFlow.attributes.salutation'}"/>
           </label>
 
           <label>
-            Vorname
+            <f:translate id="firstName"></f:translate>
             <f:form.textfield placeholder="Manfred" property="attributes.firstName" required="true"/>
             <f:render partial="FormErrors" section="ValidationResults" arguments="{for: 'registrationFlow.attributes.firstName'}"/>
           </label>
 
           <label>
-            Nachname
+            <f:translate id="lastName"></f:translate>
             <f:form.textfield placeholder="Mustermann" property="attributes.lastName"/>
             <f:render partial="FormErrors" section="ValidationResults" arguments="{for: 'registrationFlow.attributes.lastName'}"/>
           </label>
 
-          <input type="submit" value="Registrieren" class="button large primary"/>
+          <input type="submit" value="{f:translate(id: 'registration.register')}" class="button large primary"/>
         </fieldset>
       </f:form>
     </f:else>

Resources/Private/Templates/Registration/Register.html

@@ -9,7 +9,7 @@
 
 <f:section name="Content">
   <div class="callout success">
-    <p>Wir haben eine E-Mail zur Bestätigung der Registrierung an <strong>{registrationFlow.email}</strong> gesendet. Bitte folgen Sie der Anleitung in der E-Mail, um die Registrierung zu bestätigen.</p>
+    <p><f:translate id="registration.confirmationEmailSent" arguments="{registrationFlow.email}"></f:translate></p>
   </div>
 </f:section>