Remove usages of drupal_form_submit() and update documentation

#16 looks good. RTBC

Evaluating per https://www.drupal.org/contribute/core/beta-changes

--

while looking at the patch, I saw a few things to change.
Patch coming.

1. +++ b/core/includes/batch.inc
   @@ -218,8 +218,9 @@ function _batch_process() {
      // If this batch was marked for progressive execution (e.g. forms submitted by
   -  // drupal_form_submit()), initialize a timer to determine whether we need to
   -  // proceed with the same batch phase when a processing time of 1 second has
   +  // \Drupal::formBuilder()->submitForm(), initialize a timer to determine
   +  // whether we need to proceed with the same batch phase when a processing time
   +  // of 1 second has
      // been exceeded.
   

   the overflow should be merged with the partial line/comment.

2. +++ b/core/modules/system/src/Tests/Batch/ProcessingTest.php
   @@ -129,14 +129,15 @@ function testBatchFormProgrammatic() {
   -   * Tests that drupal_form_submit() can run within a batch operation.
   +   * Tests that \Drupal::formBuilder()->submitForm() can run within a batch
   +   * operation.
   
   +++ b/core/modules/system/tests/modules/batch_test/batch_test.module
   @@ -8,7 +8,8 @@
   - * Batch operation: Submits form_test_mock_form() using drupal_form_submit().
   + * Batch operation: Submits form_test_mock_form() using
   + * \Drupal::formBuilder()->submitForm().
   

   one line summaries should stay one line (80 chars or less).

   "All summaries (first lines of docblocks) must be under 80 characters, start with a capital letter, and end with a period (.). They must provide a brief description of what a function does, what a class does, what a file contains, etc."

   https://www.drupal.org/node/1354#drupal

Note, in this last one, form_test_mock_form() is an error, there is no such function anymore. It was removed in #2132477: Convert batch_test forms to controllers

I just reworded it this comment.

1. +++ b/core/modules/system/src/Tests/Batch/ProcessingTest.php
   @@ -129,14 +129,14 @@ function testBatchFormProgrammatic() {
   +   * Tests that \Drupal::formBuilder()->submitForm() within a batch operation.
   

   oops. now the grammar is off. Fix coming.

2. +++ b/core/modules/system/tests/modules/batch_test/batch_test.module
   @@ -8,7 +8,7 @@
   - * Batch operation: Submits form_test_mock_form() using drupal_form_submit().
   

   I left this and did not change it to Third person verb since the other summaries in this test module use this form.

I reviewed the patch with git diff --color-words (which I just found out works awesome when re-wrapping!) and it looks good from there.

I verified the grep from the issue summary and there are no remaining usages/docs updates needed.

Some of the docs are slightly reworded to fit in 80 characters but they make more sense and fix references to things that are gone now.

RTBC!

The existing change record should be updated to link to this issue.

Update the CR.

+++ b/core/lib/Drupal/Core/Render/Element/Checkboxes.php
@@ -95,12 +95,12 @@ public static function valueCallback(&$element, $input, FormStateInterface $form
+      // should be unchecked; see \Drupal::formBuilder()->submitForm(). We

I think this should be a link to \Drupal\Core\Form\FormBuilderInterface::submitForm() since I think the point here is to point the reader to the documentation there. In fact the correct thing might be to remove this and add an @see to the end of the doc block.

Please review.

the @see shouldn't be added in the comment but to the docblock for the function per @alexpott comment

The "@see" has been removed correctly from the code and now is part of the docblock from before the function.

I dont know if @alexpott really meant the end of the doc block /** ... */ on the method, or just at the end of the group of the in line comments.
... because I dont think our api parser, can parse @inheritdoc *AND* also additional documentation.

See #1994890-10: Allow {@inheritdoc} and additional documentation

hi

wasn't aware of that we had an inherit doc so that's my fault but I also thought it was solved so we could use both inherit and a new tag, simply since I see it here and there. But apparently not.

anyway, the @see was on the end of the group of inline comments, and I'm not really sure what the point of using a @see on a inline comment is.

1. +++ b/core/lib/Drupal/Core/Render/Element/Checkboxes.php
   @@ -83,6 +83,8 @@ public static function processCheckboxes(&$element, FormStateInterface $form_sta
   +   * @see \Drupal::formBuilder()->submitForm()
   

   This should point to the interface.

2. +++ b/core/modules/system/src/Tests/Batch/ProcessingTest.php
   @@ -129,14 +129,15 @@ function testBatchFormProgrammatic() {
   -   * Tests that drupal_form_submit() can run within a batch operation.
   +   * Tests that \Drupal::formBuilder()->submitForm() can run within a batch
   +   * operation.
   

   SHould be on one line... "Test form submission during a batch operation"

3. +++ b/core/modules/system/tests/modules/batch_test/batch_test.module
   @@ -8,7 +8,8 @@
   + * Batch operation: Submits form_test_mock_form() using
   + * \Drupal::formBuilder()->submitForm().
   

   Should be on one line. "Batch operation: Submits form_test_mock_form()."

Hi

see comment #36 about the @see tag. my fault but it won't work with current parser as @YesCT mentioned.

Moved the @see back to an inline comment but now pointing to the interface. Restored a line of the comment that had gone missing.

There's also a single mention of drupal_prepare_form() in a comment which we may as well fix here (the other form functions have already been removed).

Patch given in #42 applying succesfully and removing all the instances of drupal_form_submit() from

/core/includes/batch.inc:
./core/includes/install.core.inc:
./core/includes/install.core.inc:
./core/modules/system/tests/modules/batch_test/src/Controller/BatchTestController.php:
./core/modules/system/tests/modules/batch_test/batch_test.module:
./core/modules/system/src/Tests/Batch/ProcessingTest.php:
./core/modules/system/src/Tests/Batch/ProcessingTest.php:

and also removing instances of drupal_prepare_form().

Looks fine for me.

This issue is a prioritized change (deprecated code removal) as per https://www.drupal.org/core/beta-changes and it's benefits outweigh any disruption. Committed ff41283 and pushed to 8.0.x. Thanks!

diff --git a/core/includes/batch.inc b/core/includes/batch.inc
index 8358816..362854d 100644
--- a/core/includes/batch.inc
+++ b/core/includes/batch.inc
@@ -214,8 +214,7 @@ function _batch_process() {
   // If this batch was marked for progressive execution (e.g. forms submitted by
   // \Drupal::formBuilder()->submitForm(), initialize a timer to determine
   // whether we need to proceed with the same batch phase when a processing time
-  // of 1 second has
-  // been exceeded.
+  // of 1 second has been exceeded.
   if ($batch['progressive']) {
     Timer::start('batch_processing');
   }

Fixed on commit.