(outdated) Replace func_get_args with variable-length argument in FormBuilder

Seems to have some open points in the threads.

Also was tagged for a followup in #15 have those points been documented?

Could someone explain what the thing of commenting out single function parameters is meant to do and how it works:

  public function getForm($form_arg/* , ...$args */) {

I don't think the deprecation notice in the MR can ever be triggered successfully but 📌 Replace func_get_args with variable-length argument in FormBuilder Needs review solves this problem and I think it's ready to go.

@catch I think you meant 📌 Remove the debug classloader deprecation silencing for Drupal interfaces Closed: duplicate . I am attaching here the patch from there and close the other as dupe of this.

#24 from https://drupal.slack.com/archives/C1BMUQ9U6/p1681721410656849 (my additions in square brackets):

[...] Symfony lets you add commented out arguments to interfaces that trigger a deprecation error [via Symfony's debug classloader] when they aren't implemented [...]

+++ b/core/lib/Drupal/Core/Form/FormBuilderInterface.php
@@ -46,20 +46,22 @@ public function getFormId($form_arg, FormStateInterface &$form_state);
    *   - An instance of a class that implements \Drupal\Core\Form\FormInterface.
-   * @param ...
+   * phpcs:disable Drupal.Commenting
+   * @param mixed ...$args
    *   Any additional arguments are passed on to the functions called by
    *   \Drupal::formBuilder()->getForm(), including the unique form constructor
    *   function. For example, the node_edit form requires that a node object is
    *   passed in here when it is called. These are available to implementations
    *   of hook_form_alter() and hook_form_FORM_ID_alter() as the array
    *   $form_state->getBuildInfo()['args'].
+   * phpcs:enable
    *

One more thing - do we need a note saying that defining this will be required in Drupal 11. There is otherwise no way to add a custom message anywhere afaict.

How about opening an issue for the D11 queue listing all the interfaces to be changed, and refer such cases in code to that issue. Would also solve issues like https://git.drupalcode.org/project/drupal/-/blob/10.1.x/core/lib/Drupal/... where an addition was made in D9 but then everyone forgot about fixing it for D10 and so now it's too late.

Done #29.

Typo in "method" picked up by cspell.

Strange, attached files got lost in the x-post with @longwave

1. +++ b/core/lib/Drupal/Core/Database/StatementInterface.php
   @@ -120,7 +120,8 @@ public function fetchField($index = 0);
   +   * @see https://www.drupal.org/project/drupal/issues/3354672.
   
   +++ b/core/lib/Drupal/Core/Form/FormBuilderInterface.php
   @@ -46,20 +46,25 @@ public function getFormId($form_arg, FormStateInterface &$form_state);
   +   * @see https://www.drupal.org/project/drupal/issues/3354672.
   
   @@ -158,7 +163,11 @@ public function rebuildForm($form_id, FormStateInterface &$form_state, $old_form
   +   * @see https://www.drupal.org/project/drupal/issues/3354672.
   

   @see shouldn't use dot at the end

2. +++ b/core/lib/Drupal/Core/Form/FormBuilder.php
   @@ -211,13 +211,12 @@ public function getFormId($form_arg, FormStateInterface &$form_state) {
   -  public function getForm($form_arg) {
   +  public function getForm($form_arg, mixed ...$args) {
   ...
   +    if (!empty($args)) {
   +      $form_state->addBuildInfo('args', array_values($args));
   

   Maybe check for emptiness is not needed as it's ok to use empty array or even NULL if passed

For the pints in #34

Also was tagged for followups in #15.

On this.

Addressed #34.

Follow-up re. #15, 📌 [meta] Replace usage of func_get_args with variadic functions Active .

We still have a BC break as noted in #15 - we can't add the args to the concrete method until Drupal 11, in case someone has already extended FormBuilder::getForm(): https://3v4l.org/nblth

Symfony EventDispatcher did not add them either: https://github.com/symfony/event-dispatcher/blob/4.4/EventDispatcher.php...

#39 if I add the new parameter commented out in the concrete class too, though, we get the deprecation error:

#3257824-101: Ignore, testing issue →

https://dispatcher.drupalci.org/job/drupal_patches/179671/

We have to add that exact deprecation to the ignore file until 11.x opens. This means the deprecation will be skipped for core, but if anyone else is extending the class then they will still get the deprecation notice now - if we keep the regex deprecation instead then downstream users will not be notified.

Right.

#41 changes the scope significantly, so I will postpone this one (the actual change) to D11, and file 📌 Prepare FormBuilder for variadic functions Fixed for the D10 deprecation.

Updating title, tags and version number based on recent announcement at https://www.drupal.org/about/core/blog/new-drupal-core-branching-scheme-... →

Fixing attribution.

Opened 📌 Replace func_get_args with variable-length argument in FormBuilder Active since the issue fork was too old here to be able to place a MR against 11.x.