Skip to content

BUGFIX: Wrap {formValues.message} in f:format.raw tag and update code style #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlubitz merged 1 commit into from
May 9, 2026
Merged

BUGFIX: Wrap {formValues.message} in f:format.raw tag and update code style #181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 17 additions & 18 deletions Documentation/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,15 @@ If you want to build a form with PHP, the skeleton for building a form looks as
use Neos\Flow\Annotations as Flow;
use Neos\Form\Core\Model\FormDefinition;

class QuickstartFactory extends \Neos\Form\Factory\AbstractFormFactory {

class QuickstartFactory extends \Neos\Form\Factory\AbstractFormFactory
{
/**
* @param array $factorySpecificConfiguration
* @param string $presetName
* @return \Neos\Form\Core\Model\FormDefinition
*/
public function build(array $factorySpecificConfiguration, $presetName) {
public function build(array $factorySpecificConfiguration, $presetName)
{
$formConfiguration = $this->getPresetConfiguration($presetName);
$form = new FormDefinition('yourFormIdentifier', $formConfiguration);
// Now, build your form here
Expand All @@ -84,7 +85,8 @@ needs to return the :api-core-model:`FormDefinition`.

Lets add the one page and input fields for *name*, *email* and *message* of our contact form::

public function build(array $factorySpecificConfiguration, $presetName) {
public function build(array $factorySpecificConfiguration, $presetName)
{
$formConfiguration = $this->getPresetConfiguration($presetName);
$form = new FormDefinition('contactForm', $formConfiguration);

Expand Down Expand Up @@ -169,7 +171,7 @@ For this example we might want to send the data to an email address, and we can
the :api-finishers:`EmailFinisher` for that::

$emailFinisher = new \Neos\Form\Finishers\EmailFinisher();
$emailFinisher->setOptions(array(
$emailFinisher->setOptions([
'templatePathAndFilename' => 'resource://Your.Package/Private/Templates/ContactForm/NotificationEmail.txt',
'recipientAddress' => 'your@example.com',
'senderAddress' => 'mailer@example.com',
Expand All @@ -178,7 +180,7 @@ the :api-finishers:`EmailFinisher` for that::
'blindCarbonCopyAddress' => 'blindcopy@example.com',
'subject' => 'Contact Request',
'format' => \Neos\Form\Finishers\EmailFinisher::FORMAT_PLAINTEXT
));
]);
$form->addFinisher($emailFinisher);


Expand All @@ -189,17 +191,15 @@ The corresponding ``NotificationEmail.txt`` template could look like this::
From: {formValues.name} ({formValues.email})
Message:

{formValues.message}
<f:format.raw>{formValues.message}</f:format.raw>

.. note:: Form values can be accessed via `formValues.*`

And afterwards we want to redirect the user to some confirmation action, thus
we add the :api-finishers:`RedirectFinisher`::

$redirectFinisher = new \Neos\Form\Finishers\RedirectFinisher();
$redirectFinisher->setOptions(
array('action' => 'confirmation')
);
$redirectFinisher->setOptions(['action' => 'confirmation']);
$form->addFinisher($redirectFinisher);

Summary
Expand All @@ -217,14 +217,15 @@ That's it for the quickstart. The complete code of your form factory should look
/**
* Flow\Scope("singleton")
*/
class QuickstartFactory extends \Neos\Form\Factory\AbstractFormFactory {

class QuickstartFactory extends \Neos\Form\Factory\AbstractFormFactory
{
/**
* @param array $factorySpecificConfiguration
* @param string $presetName
* @return \Neos\Form\Core\Model\FormDefinition
*/
public function build(array $factorySpecificConfiguration, $presetName) {
public function build(array $factorySpecificConfiguration, $presetName)
{
$formConfiguration = $this->getPresetConfiguration($presetName);
$form = new FormDefinition('contactForm', $formConfiguration);

Expand All @@ -245,7 +246,7 @@ That's it for the quickstart. The complete code of your form factory should look
$comments->addValidator(new \Neos\Flow\Validation\Validator\StringLengthValidator(array('minimum' => 3)));

$emailFinisher = new \Neos\Form\Finishers\EmailFinisher();
$emailFinisher->setOptions(array(
$emailFinisher->setOptions([
'templatePathAndFilename' => 'resource://Your.Package/Private/Templates/ContactForm/NotificationEmail.txt',
'recipientAddress' => 'your@example.com',
'senderAddress' => 'mailer@example.com',
Expand All @@ -254,13 +255,11 @@ That's it for the quickstart. The complete code of your form factory should look
'blindCarbonCopyAddress' => 'blindcopy@example.com',
'subject' => 'Contact Request',
'format' => \Neos\Form\Finishers\EmailFinisher::FORMAT_PLAINTEXT
));
]);
$form->addFinisher($emailFinisher);

$redirectFinisher = new \Neos\Form\Finishers\RedirectFinisher();
$redirectFinisher->setOptions(
array('action' => 'confirmation')
);
$redirectFinisher->setOptions(['action' => 'confirmation']);
$form->addFinisher($redirectFinisher);

return $form;
Expand Down
Loading