Skip to content

Add note about the property attribute (Property Accessor) #3124

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

Closed
wants to merge 5 commits into from
Closed

Add note about the property attribute (Property Accessor) #3124

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6af779d
Add note about the property attribute (Property Accessor)
raziel057 Oct 29, 2013
7d65fed
Update entity.rst
raziel057 Mar 5, 2014
c097f9b
Update entity.rst
raziel057 Mar 5, 2014
7496e68
Update entity.rst
raziel057 Mar 5, 2014
46f1b8b
Update entity.rst
raziel057 Mar 18, 2014
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
18 changes: 18 additions & 0 deletions reference/forms/types/entity.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,24 @@ This is the property that should be used for displaying the entities
as text in the HTML element. If left blank, the entity object will be
cast into a string and so must have a ``__toString()`` method.

.. note::

The ``property`` option is the property path used to display the option. So you
can use anything supported by the :doc:`PropertyAccessor component</components/property_access/introduction>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should move the doc directive to a new line and add a space between component and the opening angle bracket


Usage sample::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok then, how about we just tell them what translations looks like here:

For example, if the translations property is actually an associative array of objects, each with a name property, then you could do this::

Then I'm not sure if we need the query_builder option - it may just be distracting.

Thanks for the work on this @raziel057!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ping @raziel057 - what do you think about removing the query_builder option and adding the note above?

Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, I made the change as requested.


$builder->add('gender', 'entity', array(
'class' => 'MyBundle:Gender',
'property' => 'translations[en].name',
'query_builder' => function(EntityRepository $er) {
return $er->createQueryBuilder('g')
->join('g.translations', 't', 'WITH', 't.locale = :locale')
->orderBy('t.name', 'ASC')
->setParameter('locale', 'en');
},
));

group_by
~~~~~~~~

Expand Down