Error on Cookbook

[ajouve]

I don't know if this is really an error, on this page:
https://github.com/symfony/symfony-docs/blob/master/cookbook/form/data_transformers.rst

or

http://symfony.com/doc/current/cookbook/form/data_transformers.html

I have an error when I am using $options['em'], the key does not exists

[stof]

There is no error. The form field defined in the doc puts em as a required option, so it exist in buildForm

[javiereguiluz]

@stof it's not an error in the code, but I think that @ajouve is right about being something that we should improve. Right now, this is the only information that readers can get from the code:

public function buildForm(FormBuilderInterface $builder, array $options)
{
    // ...

    // this assumes that the entity manager was passed in as an option
    $entityManager = $options['em'];

"This assumes that the EM was passed ..." I don't think it's clear enough who passed it, where and how.

[weaverryan]

What do you think about changing the comment to this:

// the "em" is an option that you pass when creating your form. Check out
// the 3rd argument to createForm in the next code block to see how this
// is passed to the form (also see setDefaultOptions).

The usage example (createForm with the em option being passed), is shown on this page. I think if you actually see it, it would clear things up.

[javiereguiluz]

@weaverryan I like your proposal. The new comment is definitely much better! Thank you.

[javiereguiluz]

@raulfraile I see your commit related to this minor change (raulfraile@b241206) but I don't know if you finally managed to create a pull request to the symfony-docs repo. If not, can we do something to help you? Thanks!

[javiereguiluz]

This issue seems to be fixed in raulfraile/symfony-docs@b241206 but it was never merged. Can we do anything about this?

[xabbuh]

ping @raulfraile

[raulfraile]

@javiereguiluz @xabbuh I just created a PR for this, I hope it's ok!