Commit67ec88c

committed

Documenting the block_prefix option

1 parent3f20558 commit67ec88cCopy full SHA for 67ec88c

File tree

+51

-0

lines changed

+51

-0

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,12 @@ The goal of this field was to extend the choice type to enable selection of the`
`87`	`87`	shipping type. This is achieved by fixing the ``choices`` to a list of available
`88`	`88`	`shipping options.`
`89`	`89`
	`90`	`+..tip::`
	`91`	`+`
	`92`	`+ If the purpose of this new form type were to customize the rendering of some`
	`93`	+ fields only, skip this step and use ``block_name`` or ``block_prefix`` option
	`94`	+ instead. For more information, see:ref:`form-customization-form-themes`.
	`95`	`+`
`90`	`96`	`Creating a Template for the Field`
`91`	`97`	`---------------------------------`
`92`	`98`

Lines changed: 29 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -735,6 +735,35 @@ class to the ``div`` element around each row:
`735`	`735`	`</div>`
`736`	`736`	`{% endblock form_row %}`
`737`	`737`
	`738`	`+..tip::`
	`739`	`+`
	`740`	`+ If you want to customize some instances of the same form only (without`
	`741`	+ the need to create a new form type) you can set the ``block_prefix``
	`742`	`+ option in your form type::`
	`743`	`+`
	`744`	`+ use Symfony\Component\Form\Extension\Core\Type\TextType;`
	`745`	`+ use Symfony\Component\Form\FormBuilderInterface;`
	`746`	`+`
	`747`	`+ public function buildForm(FormBuilderInterface $builder, array $options)`
	`748`	`+ {`
	`749`	`+ $builder->add('name', TextType::class, array(`
	`750`	`+ 'block_prefix' => 'wrapped_text',`
	`751`	`+ ));`
	`752`	`+ }`
	`753`	`+`
	`754`	`+ ..versionadded::4.3`
	`755`	+ The ``block_prefix`` option was introduced in Symfony 4.3.
	`756`	`+`
	`757`	+ Then the block name will be ``wrapped_text_row``.
	`758`	`+`
	`759`	`+ ..code-block::html+twig`
	`760`	`+`
	`761`	`+ {% block wrapped_text_row %}`
	`762`	`+ <div class="wrapped">`
	`763`	`+ {{ form_row(form) }}`
	`764`	`+ </div>`
	`765`	`+ {% endblock wrapped_text_row %}`
	`766`	`+`
`738`	`767`	`..tip::`
`739`	`768`
`740`	`769`	See:ref:`form-theming-methods` for how to apply this customization.

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -37,6 +37,7 @@ on all types for which ``FormType`` is the parent.
`37`	`37`	\| Inherited\| - `attr`_\|
`38`	`38`	\| options\| - `auto_initialize`_\|
`39`	`39`	\|\| - `block_name`_\|
	`40`	+\|\| - `block_prefix`_\|
`40`	`41`	\|\| - `disabled`_\|
`41`	`42`	\|\| - `label`_\|
`42`	`43`	\|\| - `translation_domain`_\|
`@@ -154,6 +155,8 @@ of the form type tree (i.e. it cannot be used as a form type on its own).`
`154`	`155`
`155`	`156`	`..include::/reference/forms/types/options/block_name.rst.inc`
`156`	`157`
	`158`	`+..include::/reference/forms/types/options/block_prefix.rst.inc`
	`159`	`+`
`157`	`160`	`..include::/reference/forms/types/options/disabled.rst.inc`
`158`	`161`
`159`	`162`	`..include::/reference/forms/types/options/label.rst.inc`

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,13 @@`
	`1`	`+block_prefix`
	`2`	`+~~~~~~~~~~~~`
	`3`	`+`
	`4`	+type: ``string``or ``null`` default: ``null`` (see :ref:`Knowing which
	`5`	+block to customize <form-customization-sidebar>`)
	`6`	`+`
	`7`	`+.. versionadded::4.3`
	`8`	+ The ``block_prefix`` option was introduced in Symfony4.3.
	`9`	`+`
	`10`	`+Allows you to add a custom block prefixandoverride the block name`
	`11`	`+used to render the form type. Usefulfor exampleif you have multiple`
	`12`	`+instances of the same formand you need to personalize the rendering`
	`13`	`+of all of them without the need to create anew form type.`

Comments

(0)