Feature: [Form] Toggle Displaying Percent Type Symbol #28797

d42ohpaz · 2018-10-09T20:04:26Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#28796
License	MIT
Doc PR	symfony/symfony-docs#10464

PercentType `symbol` option

As of this writing, Symfony will forcibly append a percentage sign (%) to all input fields that are of the PercentType form type. This PR will introduce a boolean flag called symbol that, when false, will not display the percentage sign. Each of the default layouts that define percent_widget will respect this option.

By default, this new option will be set to true so that it maintains backward compatibility. The unit tests have been updated where appropriate, and a new unit test has been added (as appropriate).

Also update the bootstrap layout unit tests.

Also includes unit test

xabbuh

This looks quite good so far. I have just left a few comments.

Can we think of use cases where you would want to display another symbol than the percent character (then it could make sense to allow arbitrary strings for this option)?

xabbuh · 2018-10-10T08:04:11Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -19,6 +19,7 @@ CHANGELOG
 * Deprecated the `--no-debug` console option, set the "APP_DEBUG" 
   environment variable to "0" instead.
 * Deprecated the `Templating\Helper\TranslatorHelper::transChoice()` method, use the `trans()` one instead with a `%count%` parameter
+ * Only display `PercentType` percent symbol if the `symbol` option is `true`


I don't think we need a changelog entry for this in the FrameworkBundle.

xabbuh · 2018-10-10T08:05:10Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_4_layout.html.twig

@@ -106,12 +106,16 @@
 {%- endblock dateinterval_widget %}

 {% block percent_widget -%}
+    {% if symbol == true %}


let's shorten this: {% if symbol %} (and everywhere else below too)

It also seems like we need to take whitespace control (i.e. the - character) into account here too.

xabbuh · 2018-10-10T08:06:03Z

src/Symfony/Bridge/Twig/CHANGELOG.md

@@ -7,6 +7,7 @@ CHANGELOG
 * add bundle name suggestion on wrongly overridden templates paths
 * added `name` argument in `debug:twig` command and changed `filter` argument as `--filter` option
 * deprecated the `transchoice` tag and filter, use the `trans` ones instead with a `%count%` parameter
+ * Update `percent_widget` to consider `symbol` option for `PercentType` when displaying the percent symbol


I don't think we need such an entry in the changelog file of the Twig bridge

xabbuh · 2018-10-10T08:07:25Z

src/Symfony/Component/Form/CHANGELOG.md

@@ -9,6 +9,7 @@ CHANGELOG
 * deprecated calling `FormRenderer::searchAndRenderBlock` for fields which were already rendered
 * added a cause when a CSRF error has occurred
 * deprecated the `scale` option of the `IntegerType`
+ * add `symbol` to `PercentType` options and make available as `FormView` vars


I would reword this a bit:

added a symbol option to the PercentType that allows to disable the output of the percent character

src/Symfony/Component/Form/Extension/Core/Type/PercentType.php

xabbuh · 2018-10-10T08:13:44Z

src/Symfony/Component/Form/Extension/Core/Type/PercentType.php

+     */
+    public function buildView(FormView $view, FormInterface $form, array $options)
+    {
+        $view->vars['symbol'] = isset($options['symbol']) ? $options['symbol'] : true;


Can be shortened as the option will always be set:

$view->vars['symbol'] = $options['symbol'];

# Conflicts: # src/Symfony/Component/Form/CHANGELOG.md

d42ohpaz · 2018-10-10T12:05:37Z

Can we think of use cases where you would want to display another symbol than the percent character (then it could make sense to allow arbitrary strings for this option)?

I missed finding this yesterday, but apparently there are a few different versions of a percent symbol:

U+0025 % Percent sign (HTML %) (% in HTML5[24]),
U+2030 ‰ per mille sign (HTML ‰ · ‰),
U+2031 ‱ per ten thousand sign (HTML ‱) a.k.a. basis point, and
U+FF05 ％ fullwidth percent sign (HTML ％ · see fullwidth forms)
U+FE6A ﹪ small percent sign (HTML ﹪ · see Small Form Variants)
There is also U+066A ٪ ARABIC PERCENT SIGN (HTML ٪), which has the circles replaced by square dots set on edge, the shape of the digit 0 in Arabic numerals.

And there are icons. Unless others object, I'll update the PR later today to allow arbitrary text or boolean false.

OskarStark · 2018-10-10T19:32:44Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_4_layout.html.twig

    <div class="input-group">
        {{- block('form_widget_simple') -}}
        <div class="input-group-append">
            <span class="input-group-text">%</span>
        </div>
    </div>
+    {%- else -%}
+    {{- block('form_widget_simple') -}}


could you please add more indention?

Same for the other twig parts

OskarStark · 2018-10-10T19:33:01Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_4_layout.html.twig

@@ -106,12 +106,16 @@
 {%- endblock dateinterval_widget %}

 {% block percent_widget -%}
+    {%- if symbol == true -%}
    <div class="input-group">


could you please add more indention?

d42ohpaz · 2018-10-12T12:56:06Z

As for the failed unit tests, I could use some guidance on how to set up an environment and/or execute the tests so that I can reproduce their failures.

xabbuh · 2018-11-01T17:09:48Z

@dohpaz42 Sorry, I missed your question. I think https://symfony.com/doc/current/contributing/code/tests.html should provide some useful insights.

xabbuh · 2019-02-15T18:53:21Z

@9ae8sdf76 Do you think you will be able to finish this pull request?

fabpot · 2019-03-04T07:11:23Z

@xabbuh Can you take over this one?

OskarStark · 2019-03-04T07:47:31Z

I could overtake this too, I just need to know what’s featurewise missing here?

fabpot · 2019-03-04T08:28:48Z

@OskarStark Thank you. I think it's ok feature-wise. It's more about rebasing/squashing and fixing tests if needed after that.

OskarStark · 2019-03-04T09:22:43Z

Done in #30433

This one can be closed

Ken Stanley and others added 5 commits October 9, 2018 15:39

Add ‘symbol’ option to PercentType

b90c49a

Make ‘symbol’ of PercentType available in the FormView vars

16a17f6

Update Twig to consider symbol option of PercentType

4461d04

Also update the bootstrap layout unit tests.

Update PHP template for symbol option of PercentType

bdbfb42

Also includes unit test

Update corresponding CHANGELOG.md files

d2ef7ca

carsonbot added Status: Needs Review Form Feature labels Oct 9, 2018

d42ohpaz added 2 commits October 9, 2018 16:07

Add license headers to percent_widget.html.php #28797

2a05c45

Fix inheritdoc doc block in PercentType.php #28797

94a587a

xabbuh requested changes Oct 10, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 10, 2018

xabbuh added this to the next milestone Oct 10, 2018

d42ohpaz added 6 commits October 10, 2018 07:23

Revert the CHANGELOG.md for Twig and FrameworkBundle

58feed7

Updated CHANGELOG.md entry

ade92b7

Add whitespace control to Twig templates

6f3dda9

Set the allowed type for the symbol option

8b9c785

Removed unnecessary isset() and ternary operator

d5bebf7

Merge branch 'master' into feature/percent-type-symbol

446002f

# Conflicts: # src/Symfony/Component/Form/CHANGELOG.md

OskarStark requested changes Oct 10, 2018

View reviewed changes

d42ohpaz added 6 commits October 12, 2018 08:01

Indentation as requested #28797

5e69600

Shortened if conditions as requested #28797

53e7431

Merge branch 'master' into feature/percent-type-symbol

7a6be67

Missed one if condition

7a7d97a

Add support for custom symbols for PercentType #28797

22f09c5

Fix typo with spacing in array

46f91fd

fabpot closed this Mar 4, 2019

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: [Form] Toggle Displaying Percent Type Symbol #28797

Feature: [Form] Toggle Displaying Percent Type Symbol #28797

d42ohpaz commented Oct 9, 2018

xabbuh left a comment

xabbuh Oct 10, 2018

xabbuh Oct 10, 2018

xabbuh Oct 10, 2018

xabbuh Oct 10, 2018

xabbuh Oct 10, 2018

xabbuh Oct 10, 2018

d42ohpaz commented Oct 10, 2018

OskarStark Oct 10, 2018

OskarStark Oct 10, 2018

OskarStark Oct 10, 2018

d42ohpaz commented Oct 12, 2018

xabbuh commented Nov 1, 2018

xabbuh commented Feb 15, 2019

fabpot commented Mar 4, 2019

OskarStark commented Mar 4, 2019

fabpot commented Mar 4, 2019

OskarStark commented Mar 4, 2019

Feature: [Form] Toggle Displaying Percent Type Symbol #28797

Feature: [Form] Toggle Displaying Percent Type Symbol #28797

Conversation

d42ohpaz commented Oct 9, 2018

PercentType symbol option

xabbuh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d42ohpaz commented Oct 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d42ohpaz commented Oct 12, 2018

xabbuh commented Nov 1, 2018

xabbuh commented Feb 15, 2019

fabpot commented Mar 4, 2019

OskarStark commented Mar 4, 2019

fabpot commented Mar 4, 2019

OskarStark commented Mar 4, 2019

PercentType `symbol` option