Skip to content

Commit

Permalink
Create env based translations for entity forms
Browse files Browse the repository at this point in the history 
The SAML, OIDC, CCC and RS entities now have translatable edit info
texts based on the environment

See: https://www.pivotaltracker.com/story/show/187940731
  • Loading branch information
@MKodde
MKodde committed Aug 26, 2024
1 parent 8e2f4a0 commit 8fefd06
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 116 deletions.
10 changes: 6 additions & 4 deletions ...iceProviderDashboard/Infrastructure/DashboardBundle/Controller/EntityCreateController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,9 @@ public function create(Request $request, $serviceId, $targetEnvironment, $type):
return $this->render(
'@Dashboard/EntityEdit/edit.html.twig',
[
'form' => $form->createView(),
'type' => $type,
'form' => $form->createView(),
'type' => $type,
'environment' => $targetEnvironment,
]
);
}
Expand Down Expand Up @@ -314,8 +315,9 @@ public function copy(
return $this->render(
'@Dashboard/EntityEdit/edit.html.twig',
[
'form' => $form->createView(),
'type' => $entity->getProtocol()->getProtocol(),
'form' => $form->createView(),
'type' => $entity->getProtocol()->getProtocol(),
'environment' => $targetEnvironment,
]
);
}
Expand Down
5 changes: 3 additions & 2 deletions ...rviceProviderDashboard/Infrastructure/DashboardBundle/Controller/EntityEditController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,9 @@ public function edit(Request $request, string $environment, string $manageId, in
return $this->render(
'@Dashboard/EntityEdit/edit.html.twig',
[
'form' => $form->createView(),
'type' => $entity->getProtocol()->getProtocol(),
'form' => $form->createView(),
'type' => $entity->getProtocol()->getProtocol(),
'environment' => $environment,
]
);
}
Expand Down
132 changes: 23 additions & 109 deletions ...ceProviderDashboard/Infrastructure/DashboardBundle/Resources/translations/messages.en.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,118 +149,32 @@ entity.edit.error.publish: "Unable to publish the entity, try again later"
entity.edit.error.push: "Unable to publish the entity, try again later"
entity.edit.title: Service Provider registration form
entity.edit.info.saml20.title: Info
entity.edit.info.saml20.html: "
<p>Documentation about this SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>
<p>The registration of your Service Provider consists of two parts. A contractual and technical part. This form covers the technical part. The contractual part will be handled by SURFmarket.
In the following pages we will ask you to submit the necessary information that allows us to create a test connection. With the following details ready we estimate this process will take around 20 minutes to complete. Information we need and collect through this form includes:</p>
<ul>
<li>Various contacts responsible for the entity. Support, administrative and technical
should be present.</li>
<li>Information about SAML 2.0 configuration.</li>
<li>Metadata information including URL and logo of your entity.</li>
<li>A list of the attributes your Service Provider requires to operate.</li>
</ul>
<p>
<strong>Publish</strong>
When all fields are filled in correctly you can publish the configuration to the SURFconext test environment. The service will be available directly for testing.
</p>
<p>
<strong>Update</strong>
The configuration can be modified whenever you see fit. Just change the fields, press 'update' and 'confirm'. The changes are available instantenously.
</p>
<p>
<strong>Production</strong>
When tests are successful you can request a production connection. Simply press the button 'to production' to initiate this process.
<strong>Note:</strong> your service can get production status only if the required contracts are in place.
</p>
<p>If there are any questions during completion of the form don’t hesitate to mail to [email protected]. Please add the ticket number to the subject (CXT-...).</p>
"
entity.edit.info.oidc.title: Info
entity.edit.info.oidc.html: "
<p>Documentation about this SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>
<p>The registration of your Service Provider consists of two parts. A contractual and technical part. This form covers the technical part. The contractual part will be handled by SURFmarket.
In the following pages we will ask you to submit the necessary information that allows us to create a test connection. With the following details ready we estimate this process will take around 20 minutes to complete. Information we need and collect through this form includes:</p>
<ul>
<li>Various contacts responsible for the entity. Support, administrative and technical
should be present.</li>
<li>Information about SAML 2.0 configuration.</li>
<li>Metadata information including URL, certificate and logo of your entity.</li>
<li>A list of the attributes your Service Provider requires to operate.</li>
</ul>
<p>
<strong>Publish</strong>
When all fields are filled in correctly you can publish the configuration to the SURFconext test environment. The service will be available directly for testing.
</p>
<p>
<strong>Update</strong>
The configuration can be modified whenever you see fit. Just change the fields, press 'update' and 'confirm'. The changes are available instantenously.
</p>
<p>
<strong>Production</strong>
When tests are successful you can request a production connection. Simply press the button 'to production' to initiate this process.
<strong>Note:</strong> your service can get production status only if the required contracts are in place.
</p>
<p>If there are any questions during completion of the form don’t hesitate to mail to [email protected]. Please add the ticket number to the subject (CXT-...).</p>
"
entity.edit.info.saml20.production.html: "<p>Documentation about this TEST SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.saml20.test.html: "
<p>Documentation about this PROD SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.oidcng.title: Info
entity.edit.info.oidcng.html: "
<p>Documentation about this SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>
<p>The registration of your Service Provider consists of two parts. A contractual and technical part. This form covers the technical part. The contractual part will be handled by SURFmarket.
In the following pages we will ask you to submit the necessary information that allows us to create a test connection. With the following details ready we estimate this process will take around 20 minutes to complete. Information we need and collect through this form includes:</p>
<ul>
<li>Various contacts responsible for the entity. Support, administrative and technical
should be present.</li>
<li>Information about SAML 2.0 configuration.</li>
<li>Metadata information including URL and logo of your entity.</li>
<li>A list of the attributes your Service Provider requires to operate.</li>
</ul>
"
entity.edit.info.oidcng.test.html: "
<p>Documentation about this TEST OIDC RP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.oidcng.production.html: "
<p>Documentation about this PROD OIDC RP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.oauth20_rs.title: Info
entity.edit.info.oauth20_rs.html: "
<p>Documentation about this SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>
<p>The registration of your Service Provider consists of two parts. A contractual and technical part. This form covers the technical part. The contractual part will be handled by SURFmarket.
In the following pages we will ask you to submit the necessary information that allows us to create a test connection. With the following details ready we estimate this process will take around 20 minutes to complete. Information we need and collect through this form includes:</p>
<ul>
<li>Various contacts responsible for the entity. Support, administrative and technical
should be present.</li>
<li>Information about SAML 2.0 configuration.</li>
<li>Metadata information including URL and logo of your entity.</li>
<li>A list of the attributes your Service Provider requires to operate.</li>
</ul>
"
entity.edit.info.oauth20_rs.test.html: "
<p>Documentation about this TEST RS registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.oauth20_rs.production.html: "
<p>Documentation about this PROD RS registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.oauth20_ccc.title: Info
entity.edit.info.oauth20_ccc.html: "
<p>Documentation about this SP registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>
<p>The registration of your Service Provider consists of two parts. A contractual and technical part. This form covers the technical part. The contractual part will be handled by SURFmarket.
In the following pages we will ask you to submit the necessary information that allows us to create a test connection. With the following details ready we estimate this process will take around 20 minutes to complete. Information we need and collect through this form includes:</p>
<ul>
<li>Various contacts responsible for the entity. Support, administrative and technical
should be present.</li>
<li>Information about SAML 2.0 configuration.</li>
<li>Metadata information including URL and logo of your entity.</li>
<li>A list of the attributes your Service Provider requires to operate.</li>
</ul>
"
entity.edit.info.oauth20_ccc.test.html: "
<p>Documentation about this TEST CCC registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.info.oauth20_ccc.production.html: "
<p>Documentation about this PROD CCC registration form can be found at:
<a href=\"https://wiki.surfnet.nl/x/isZWAw\">https://wiki.surfnet.nl/x/isZWAw</a>.</p>"
entity.edit.general.title: General
entity.edit.general.html: "<p>Enter/edit your contact information below. We will use this information in case we have additional questions.</p>"
entity.edit.metadata.fetch.exception: "Unable to load the metadata from the provided import url."
Expand Down
2 changes: 1 addition & 1 deletion templates/EntityEdit/edit.html.twig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
{{ form_errors(form) }}

<h2>{{ ('entity.edit.info.' ~ type ~ '.title')|trans }}</h2>
<div class="wysiwyg">{{ ('entity.edit.info.' ~ type ~ '.html')|trans|wysiwyg }}</div>
<div class="wysiwyg">{{ ('entity.edit.info.' ~ type ~ '.' ~ environment ~ '.html')|trans|wysiwyg }}</div>
</div>

<div class="fieldset card">
Expand Down

0 comments on commit 8fefd06

Please sign in to comment.