Change record: Convert views_forms() to a classed form

Let's see how this works out.

1. +++ b/core/modules/views/lib/Drupal/views/Form/ViewsForm.php
   @@ -17,33 +17,76 @@
   +   *
   +   * @param ControllerResolverInterface $controller_resolver
   +   * @param UrlGeneratorInterface $url_generator
   +   * @param Request $request
   +   * @param string $view_id
   +   * @param string $view_display_id
   

   Some absolute documentation on there would be kind of cool

2. +++ b/core/modules/views/lib/Drupal/views/Form/ViewsForm.php
   @@ -118,18 +161,18 @@
   +    $form_step_class = isset($form_state['step_controller'][$form_state['step']]) ? $form_state['step_controller'][$form_state['step']] : 'Drupal\views\Form\ViewsFormMainForm';
   

   I like the new variable name.

Made some little changes given that I don't really want to RTBC my own patch.

+++ b/core/modules/views/views.theme.inc
@@ -134,7 +135,9 @@ function template_preprocess_views_view(&$variables) {
+    $form_object = ViewsForm::create(\Drupal::getContainer(), $view->storage->id(), $view->current_display);

Sorry, if we are creating an instance ourselves here, I think we should be creating a new object (new > __construct) instead of using the static create() method.

Needs work due to #10

.

1. +++ b/core/modules/views/lib/Drupal/views/Form/ViewsForm.php
   @@ -0,0 +1,183 @@
   +  public static function create(ContainerInterface $container, $view_id = NULL, $view_display_id = NULL) {
   

   This seems wrong to me.

2. +++ b/core/modules/views/lib/Drupal/views/Form/ViewsForm.php
   @@ -0,0 +1,183 @@
   +  public function getFormID() {
   +    $parts = array(
   +      'views_form',
   +      $this->viewId,
   +      $this->viewDisplayId,
   +    );
   +
   +    return implode('_', $parts);
   +  }
   

   But I guess we need it here...

3. +++ b/core/modules/views/lib/Drupal/views/Form/ViewsForm.php
   @@ -0,0 +1,183 @@
   +    if (class_exists($form_step_class)) {
   +      if (in_array('Drupal\Core\DependencyInjection\ContainerInjectionInterface', class_implements($form_step_class))) {
   +        return $form_step_class::create($container);
   +      }
   +
   +      return new $form_step_class();
   +    }
   +
   +    // Otherwise, it is a service.
   +    return $container->get($form_step_class);
   +  }
   

   Ouch, it hurts to have this duplicated again

4. +++ b/core/modules/views/views.theme.inc
   @@ -134,7 +135,10 @@ function template_preprocess_views_view(&$variables) {
   +    $container = \Drupal::getContainer();
   +    $form_object = new ViewsForm($container->get('controller_resolver'), $container->get('url_generator'), $container->get('request'), $view->storage->id(), $view->current_display);
   

   Why not the ::create here?

5. +++ b/core/modules/views/views.theme.inc
   @@ -134,7 +135,10 @@ function template_preprocess_views_view(&$variables) {
   +    $form = drupal_get_form($form_object, $view, $output);
   

   FormBuilder!

Why not the ::create here?

See https://drupal.org/node/2110953#comment-7984973

FormBuilder!

Fixed

+++ b/core/modules/views/lib/Drupal/views/Form/ViewsFormMainForm.php
@@ -0,0 +1,152 @@
+        $field->views_form_validate($form, $form_state);

ughs, we didn't convert that either. I will file a follow up. That got missed in the epic camalization patches.

Patch looks ready though.

Related, from #15 comment: #2123843: Camelize views form methods

I checked w/ Tim on whether or not we needed to retain legacy wrappers on these functions, but he said that these are all internal-facing Views things, so this looks like a nice clean-up (and one that other modules might be able to use for general wizards with a little tweaking). Tagging as an approved API change.

I'll confess I don't follow all of this code, but in comparing/contrasting the procedural vs. OO hunks, this seems to be basically doing the same thing.

Committed and pushed to 8.x, with some minor docs massaging on the ViewsForm class for the docs gate.

As the maintainer of Views Send, a Views Form implementation, I would very much like a change record for this issue because: 1) It took me quite some time to find this issue and 2) it isn't very clear how you should implement a Views Form now. Thx for any help in making my module work again.

Added some hours later: I was able to make my module work again, but I'm not sure if I did it the right way.

Looks like we missed moving this to Views for the change record. :)

For more information as to why this issue was moved to the Drupal core project, please see issue #3030347: Plan to clean process issue queue

Moving back to the contributed Views issue queue and closing as outdated per https://www.drupal.org/project/views/issues/3030347#comment-13023447