Review main Abandoned

69811[FEATURE] Introduce selectMultipleBox

Sybille Peters CR 0 V 0 Normal +117 −2 updated 10/13/21, 08:36

Commit message

todo:
- TCA migration
- Extension scanner file

In TCA, the renderType selectSingleBox was used to select multiple
values in a select list. To make usage more intuitive, a new renderType
selectMultipleBox is introduced which provides the exact
same functionality as selectSingleBox.

The new renderType selectMultipleBox should be used in the future,
selectSingleBox is deprecated.

Review

  • Code review CR 0
  • Verified V 0

Issues 1

Files 8

Review log 1214

  1. Sybille Peters uploaded patch set 1 07/12/21, 07:22

  2. Andreas Kienast commented on patch set 1 CR -1 07/12/21, 07:24

    If something has the "exact same functionality" how can it be more intuitive, besides the naming change?
  3. core-ci voted on patch set 1 V +1 07/12/21, 07:37 Core CI is happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/13201

  4. Sybille Peters commented on patch set 1 07/12/21, 07:39

    Reply Unresolved

    The "more intuitive" is done by changing the name. That is all. The name was non-intuitive because it uses "single", but the functionality is "multiple". To be non-breaking the "old" one is not removed yet, but deprecated first. I thought the changelogs made that clear. I am not sure, what is unclear. What do you suggest?
  5. Benni Mack commented on patch set 1 07/12/21, 07:47

    Hey, from what I understand the "selectSingleBox" is renamed to "selectMultipleBox" and that's it. So we _could_ rename the PHP class, use a ClassAlias and keep both entries in the NodeFactory for the time being, add a ExtensionScanner file and a TCA migration and that should be it?
  6. Sybille Peters commented on patch set 1 07/12/21, 08:16

    Reply

    Yes, that sounds better. It is in fact a rename. I am not sure if I can figure out all of the steps, will try ...
  7. Benni Mack wrote 07/12/21, 08:24

    Removed reviewer Benni Mack.
  8. Christian Kuhn commented on patch set 1 07/12/21, 08:31

    Why bother? This is a developer thing with zero editor impact: When we rename the renderType, maybe even with a TCA migration, we force every dev out there to do this renaming without *any* benefit at all. I'd even argue that the name isn't wrong: This is a *single box* that allows selection of items. It is not a box that allows selection of a *single item*. So, maybe this patch comes from a misunderstanding. Maybe simply sort this out as a class comment? I admit the name isn't a true piece of art, but I'm unsure if it's worth renaming since it isn't broken or wrong as such and would just force anyone to adapt extension TCA without benefit. What do you think?
  9. Sybille Peters uploaded patch set 2 07/12/21, 08:32

  10. Sybille Peters marked it work in progress 07/12/21, 08:33

  11. core-ci voted on patch set 2 V -1 07/12/21, 08:33 Core CI is not happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/13207

  12. Sybille Peters commented on patch set 2 07/12/21, 08:49

    This change is ready for review.

    Reply Unresolved

    Ah, saw this comment after I started changing. Probably best to discuss first IF the name is misleading and IF a change is helpful or too much of a burden. I would argue that the name is misleading. I admit that I did not know that the single refers to the box, not the selection mode. (it seemed to refer to selection mode in selectSingle and selectMultipleSideBySide) If I understand you correctly @Christian you say in the name "selectSingleBox", the single does not refer to the number of possible selected items but to the "single box" so the name is not wrong. I still think it is at least misleading because in "selectSingle" and in "selectMultipleSideBySide" it seems the single / multiple is used to differentiate between selecting a single item or multiple items. If selectMultipleSideBySide were to refer to the number of boxes it should probably be named selectDoubleBoxSideBySide. Here, I think first of all clarity and consistency is key. In that case, the rename should probably rather be to selectMultiple instead of selectMultipleBox (as selectMultipleSideBySide is a box too but the word box is not in the name). I must admit, not sure what the exact difference is between box or not. A single can be changed to look like a box with size > 1. (?) Is current naming scheme clear enough and helpful? Can you intuitively guess which renderType does what without looking at the documentation? Is it consistent? Renaming always comes with an impact. I tried (or would try with additional changes to the patch) keep the impact small. The benefit is long-term.
  13. Sybille Peters marked it work in progress 07/12/21, 08:49

  14. Sybille Peters abandoned the change 10/13/21, 08:36

    Too much controversy, not worth the effort.