Issue #1876942 by damiankloip, dawehner, tim.plunkett: Use direct methods...

Issue #1876942 by damiankloip, dawehner, tim.plunkett: Use direct methods instead of arrayAccess for display handlers.

core/lib/Drupal/Component/Plugin/PluginBag.php

@@ -13,7 +13,7 @@
  * The \ArrayAccess implementation is only for backwards compatibility, it is
  * deprecated and should not be used by new code.
  */
-abstract class PluginBag implements \ArrayAccess, \Iterator, \Countable {
+abstract class PluginBag implements \Iterator, \Countable {
 
   /**
    * Stores all instantiated plugins.
@@ -63,7 +63,7 @@ public function has($instance_id) {
    * @param string $instance_id
    *   The ID of the plugin instance being retrieved.
    */
-  public function get($instance_id) {
+  public function &get($instance_id) {
     if (!isset($this->pluginInstances[$instance_id])) {
       $this->initializePlugin($instance_id);
     }
@@ -124,50 +124,11 @@ public function setInstanceIDs(array $instance_ids) {
     $this->instanceIDs = $instance_ids;
   }
 
-  /**
-   * Implements \ArrayAccess::offsetExists().
-   *
-   * This is deprecated, use \Drupal\Component\Plugin\PluginBag::has().
-   */
-  public function offsetExists($offset) {
-    return isset($this->pluginInstances[$offset]) || isset($this->instanceIDs[$offset]);
-  }
-
-  /**
-   * Implements \ArrayAccess::offsetGet().
-   *
-   * This is deprecated, use \Drupal\Component\Plugin\PluginBag::get().
-   */
-  public function offsetGet($offset) {
-    if (!isset($this->pluginInstances[$offset])) {
-      $this->initializePlugin($offset);
-    }
-    return $this->pluginInstances[$offset];
-  }
-
-  /**
-   * Implements \ArrayAccess::offsetSet().
-   *
-   * This is deprecated, use \Drupal\Component\Plugin\PluginBag::set().
-   */
-  public function offsetSet($offset, $value) {
-    $this->pluginInstances[$offset] = $value;
-  }
-
-  /**
-   * Implements \ArrayAccess::offsetUnset().
-   *
-   * This is deprecated, use \Drupal\Component\Plugin\PluginBag::remove().
-   */
-  public function offsetUnset($offset) {
-    unset($this->pluginInstances[$offset]);
-  }
-
   /**
    * Implements \Iterator::current().
    */
   public function current() {
-    return $this->offsetGet($this->key());
+    return $this->get($this->key());
   }
 
   /**

core/modules/field/lib/Drupal/field/Tests/Views/HandlerFieldFieldTest.php

@@ -114,8 +114,8 @@ public function _testSimpleFieldRender() {
   public function _testFormatterSimpleFieldRender() {
     $view = views_get_view('test_view_fieldapi');
     $this->prepareView($view);
-    $view->displayHandlers['default']->options['fields'][$this->fields[0]['field_name']]['type'] = 'text_trimmed';
-    $view->displayHandlers['default']->options['fields'][$this->fields[0]['field_name']]['settings'] = array(
+    $view->displayHandlers->get('default')->options['fields'][$this->fields[0]['field_name']]['type'] = 'text_trimmed';
+    $view->displayHandlers->get('default')->options['fields'][$this->fields[0]['field_name']]['settings'] = array(
       'trim_length' => 3,
     );
     $this->executeView($view);
@@ -134,8 +134,8 @@ public function _testMultipleFieldRender() {
 
     // Test delta limit.
     $this->prepareView($view);
-    $view->displayHandlers['default']->options['fields'][$field_name]['group_rows'] = TRUE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_limit'] = 3;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
     $this->executeView($view);
 
     for ($i = 0; $i < 3; $i++) {
@@ -156,9 +156,9 @@ public function _testMultipleFieldRender() {
 
     // Test delta limit + offset
     $this->prepareView($view);
-    $view->displayHandlers['default']->options['fields'][$field_name]['group_rows'] = TRUE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_limit'] = 3;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_offset'] = 1;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_offset'] = 1;
     $this->executeView($view);
 
     for ($i = 0; $i < 3; $i++) {
@@ -175,10 +175,10 @@ public function _testMultipleFieldRender() {
 
     // Test delta limit + reverse.
     $this->prepareView($view);
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_offset'] = 0;
-    $view->displayHandlers['default']->options['fields'][$field_name]['group_rows'] = TRUE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_limit'] = 3;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_reversed'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_offset'] = 0;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_reversed'] = TRUE;
     $this->executeView($view);
 
     for ($i = 0; $i < 3; $i++) {
@@ -196,10 +196,10 @@ public function _testMultipleFieldRender() {
 
     // Test delta first last.
     $this->prepareView($view);
-    $view->displayHandlers['default']->options['fields'][$field_name]['group_rows'] = TRUE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_limit'] = 0;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_first_last'] = TRUE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_reversed'] = FALSE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 0;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_first_last'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_reversed'] = FALSE;
     $this->executeView($view);
 
     for ($i = 0; $i < 3; $i++) {
@@ -214,10 +214,10 @@ public function _testMultipleFieldRender() {
 
     // Test delta limit + custom seperator.
     $this->prepareView($view);
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_first_last'] = FALSE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['delta_limit'] = 3;
-    $view->displayHandlers['default']->options['fields'][$field_name]['group_rows'] = TRUE;
-    $view->displayHandlers['default']->options['fields'][$field_name]['separator'] = ':';
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_first_last'] = FALSE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
+    $view->displayHandlers->get('default')->options['fields'][$field_name]['separator'] = ':';
     $this->executeView($view);
 
     for ($i = 0; $i < 3; $i++) {

core/modules/language/lib/Drupal/language/Tests/Views/ArgumentLanguageTest.php

@@ -38,7 +38,7 @@ public function testArgument() {
     $view = views_get_view('test_view');
     foreach (array('en' => 'John', 'xx-lolspeak' => 'George') as $langcode => $name) {
       $view->setDisplay();
-      $view->displayHandlers['default']->overrideOption('arguments', array(
+      $view->displayHandlers->get('default')->overrideOption('arguments', array(
         'langcode' => array(
           'id' => 'langcode',
           'table' => 'views_test_data',

core/modules/language/lib/Drupal/language/Tests/Views/FieldLanguageTest.php

@@ -37,7 +37,7 @@ public static function getInfo() {
   public function testField() {
     $view = views_get_view('test_view');
     $view->setDisplay();
-    $view->displayHandlers['default']->overrideOption('fields', array(
+    $view->displayHandlers->get('default')->overrideOption('fields', array(
       'langcode' => array(
         'id' => 'langcode',
         'table' => 'views_test_data',

core/modules/language/lib/Drupal/language/Tests/Views/FilterLanguageTest.php

@@ -38,7 +38,7 @@ public function testFilter() {
     $view = views_get_view('test_view');
     foreach (array('en' => 'John', 'xx-lolspeak' => 'George') as $langcode => $name) {
       $view->setDisplay();
-      $view->displayHandlers['default']->overrideOption('filters', array(
+      $view->displayHandlers->get('default')->overrideOption('filters', array(
         'langcode' => array(
           'id' => 'langcode',
           'table' => 'views_test_data',

core/modules/system/lib/Drupal/system/Tests/Plugin/PluginBagTest.php

@@ -36,33 +36,21 @@ protected function testPluginBag() {
     $first_instance_id = key($definitions);
 
     foreach ($definitions as $instance_id => $definition) {
-      $this->assertTrue(isset($plugin_bag[$instance_id]), format_string('Plugin instance @instance_id exits on the bag', array('@instance_id' => $instance_id)));
       $this->assertTrue($plugin_bag->has($instance_id), format_string('Plugin instance @instance_id exits on the bag', array('@instance_id' => $instance_id)));
-      $this->assertTrue($plugin_bag[$instance_id] instanceof $definition['class'], 'Getting the plugin from the bag worked.');
       $this->assertTrue($plugin_bag->get($instance_id) instanceof $definition['class'], 'Getting the plugin from the bag worked.');
     }
 
     // A non existing instance_id shouldn't exist on the bag.
     $random_name = $this->randomName();
-    $random_name_2 = $this->randomName();
-    $this->assertFalse(isset($plugin_bag[$random_name]), 'A random instance_id should not exist on the plugin bag.');
-    $this->assertFalse($plugin_bag->has($random_name_2), 'A random instance_id should not exist on the plugin bag.');
+    $this->assertFalse($plugin_bag->has($random_name), 'A random instance_id should not exist on the plugin bag.');
 
     // Set a new plugin instance to the bag, to test offsetSet.
-    $plugin_bag[$random_name] = $this->mockBlockManager->createInstance($first_instance_id, array());
-    $plugin_bag->set($random_name_2, $this->mockBlockManager->createInstance($first_instance_id, array()));
-    $this->assertTrue(isset($plugin_bag[$random_name]), 'A random instance_id should exist after manual setting on the plugin bag.');
-    $this->assertTrue(isset($plugin_bag[$random_name_2]), 'A random instance_id should exist after manual setting on the plugin bag.');
+    $plugin_bag->set($random_name, $this->mockBlockManager->createInstance($first_instance_id, array()));
     $this->assertTrue($plugin_bag->has($random_name), 'A random instance_id should exist after manual setting on the plugin bag.');
-    $this->assertTrue($plugin_bag->has($random_name_2), 'A random instance_id should exist after manual setting on the plugin bag.');
 
     // Remove the previous added element and check whether it still exists.
-    unset($plugin_bag[$random_name]);
-    $plugin_bag->remove($random_name_2);
-    $this->assertFalse(isset($plugin_bag[$random_name]), 'A random instance_id should not exist on the plugin bag after removing.');
-    $this->assertFalse(isset($plugin_bag[$random_name_2]), 'A random instance_id should not exist on the plugin bag after removing.');
+    $plugin_bag->remove($random_name);
     $this->assertFalse($plugin_bag->has($random_name), 'A random instance_id should not exist on the plugin bag after removing.');
-    $this->assertFalse($plugin_bag->has($random_name_2), 'A random instance_id should not exist on the plugin bag after removing.');
 
     // Test that iterating over the plugins work.
     $expected_instance_ids = array_keys($definitions);

core/modules/user/lib/Drupal/user/Tests/Views/AccessRoleTest.php

@@ -38,7 +38,7 @@ function testAccessRole() {
     $view = views_get_view('test_access_role');
     $view->setDisplay();
 
-    $view->displayHandlers['default']->options['access']['options']['role'] = array(
+    $view->displayHandlers->get('default')->options['access']['options']['role'] = array(
       $this->normalRole => $this->normalRole,
     );
 

core/modules/user/lib/Drupal/user/Tests/Views/ArgumentValidateTest.php

@@ -85,7 +85,7 @@ function testArgumentValidateUserEither() {
   function view_argument_validate_user($argtype) {
     $view = views_get_view('test_view_argument_validate_user');
     $view->setDisplay();
-    $view->displayHandlers['default']->options['arguments']['null']['validate_options']['type'] = $argtype;
+    $view->displayHandlers->get('default')->options['arguments']['null']['validate_options']['type'] = $argtype;
     $view->preExecute();
     $view->initHandlers();
 

core/modules/views/includes/ajax.inc

@@ -69,7 +69,7 @@ function views_ajax() {
       // Override the display's pager_element with the one actually used.
       if (isset($pager_element)) {
         $commands[] = views_ajax_command_scroll_top('.view-dom-id-' . $dom_id);
-        $view->displayHandlers[$display_id]->setOption('pager_element', $pager_element);
+        $view->displayHandlers->get($display_id)->setOption('pager_element', $pager_element);
       }
       // Reuse the same DOM id so it matches that in Drupal.settings.
       $view->dom_id = $dom_id;

core/modules/views/lib/Drupal/views/Plugin/Core/Entity/View.php

@@ -324,7 +324,7 @@ public function newDisplay($plugin_id = 'page', $title = NULL, $id = NULL) {
       $executable = $this->get('executable');
       $executable->initDisplay();
       $executable->displayHandlers->addInstanceID($id);
-      return $executable->displayHandlers[$id];
+      return $executable->displayHandlers->get($id);
     }
 
     return $id;

core/modules/views/lib/Drupal/views/Plugin/views/display/Attachment.php

@@ -195,7 +195,7 @@ public function buildOptionsForm(&$form, &$form_state) {
         $form['#title'] .= t('Attach to');
         $displays = array();
         foreach ($this->view->storage->get('display') as $display_id => $display) {
-          if (!empty($this->view->displayHandlers[$display_id]) && $this->view->displayHandlers[$display_id]->acceptAttachments()) {
+          if ($this->view->displayHandlers->has($display_id) && $this->view->displayHandlers->get($display_id)->acceptAttachments()) {
             $displays[$display_id] = $display['display_title'];
           }
         }
@@ -246,8 +246,8 @@ public function attachTo(ViewExecutable $view, $display_id) {
     $view->setArguments($args);
     $view->setDisplay($this->display['id']);
     if ($this->getOption('inherit_pager')) {
-      $view->display_handler->usesPager = $this->view->displayHandlers[$display_id]->usesPager();
-      $view->display_handler->setOption('pager', $this->view->displayHandlers[$display_id]->getOption('pager'));
+      $view->display_handler->usesPager = $this->view->displayHandlers->get($display_id)->usesPager();
+      $view->display_handler->setOption('pager', $this->view->displayHandlers->get($display_id)->getOption('pager'));
     }
 
     $attachment = $view->executeDisplay($this->display['id'], $args);

core/modules/views/lib/Drupal/views/Plugin/views/display/DisplayPluginBase.php

@@ -708,7 +708,7 @@ public function getAttachedDisplays() {
   public function getLinkDisplay() {
     $display_id = $this->getOption('link_display');
     // If unknown, pick the first one.
-    if (empty($display_id) || empty($this->view->displayHandlers[$display_id])) {
+    if (empty($display_id) || !$this->view->displayHandlers->has($display_id)) {
       foreach ($this->view->displayHandlers as $display_id => $display) {
         if (!empty($display) && $display->hasPath()) {
           return $display_id;
@@ -733,8 +733,8 @@ public function getPath() {
     }
 
     $display_id = $this->getLinkDisplay();
-    if ($display_id && !empty($this->view->displayHandlers[$display_id]) && is_object($this->view->displayHandlers[$display_id])) {
-      return $this->view->displayHandlers[$display_id]->getPath();
+    if ($display_id && $this->view->displayHandlers->has($display_id) && is_object($this->view->displayHandlers->get($display_id))) {
+      return $this->view->displayHandlers->get($display_id)->getPath();
     }
   }
 
@@ -1655,7 +1655,7 @@ public function buildOptionsForm(&$form, &$form_state) {
       case 'link_display':
         $form['#title'] .= t('Which display to use for path');
         foreach ($this->view->storage->get('display') as $display_id => $display) {
-          if ($this->view->displayHandlers[$display_id]->hasPath()) {
+          if ($this->view->displayHandlers->get($display_id)->hasPath()) {
             $options[$display_id] = $display['display_title'];
           }
         }

core/modules/views/lib/Drupal/views/Plugin/views/display/Feed.php

@@ -213,7 +213,7 @@ public function buildOptionsForm(&$form, &$form_state) {
         $displays = array();
         foreach ($this->view->storage->get('display') as $display_id => $display) {
           // @todo The display plugin should have display_title and id as well.
-          if (!empty($this->view->displayHandlers[$display_id]) && $this->view->displayHandlers[$display_id]->acceptAttachments()) {
+          if ($this->view->displayHandlers->has($display_id) && $this->view->displayHandlers->get($display_id)->acceptAttachments()) {
             $displays[$display_id] = $display['display_title'];
           }
         }

core/modules/views/lib/Drupal/views/Plugin/views/style/Rss.php

@@ -33,7 +33,7 @@ class Rss extends StylePluginBase {
   protected $usesRowPlugin = TRUE;
 
   function attach_to($display_id, $path, $title) {
-    $display = $this->view->displayHandlers[$display_id];
+    $display = $this->view->displayHandlers->get($display_id);
     $url_options = array();
     $input = $this->view->getExposedInput();
     if ($input) {

core/modules/views/lib/Drupal/views/Tests/BasicTest.php

@@ -53,7 +53,7 @@ public function testSimpleFiltering() {
     $view->setDisplay();
 
     // Add a filter.
-    $view->displayHandlers['default']->overrideOption('filters', array(
+    $view->displayHandlers->get('default')->overrideOption('filters', array(
       'age' => array(
         'operator' => '<',
         'value' => array(

core/modules/views/lib/Drupal/views/Tests/Handler/AreaTest.php

@@ -161,7 +161,7 @@ public function testTitleArea() {
     $view->initDisplay('page_1');
 
     // Add the title area handler to the empty area.
-    $view->displayHandlers['page_1']->overrideOption('empty', array(
+    $view->displayHandlers->get('page_1')->overrideOption('empty', array(
       'title' => array(
         'id' => 'title',
         'table' => 'views',

core/modules/views/lib/Drupal/views/Tests/Handler/AreaTextTest.php

@@ -44,7 +44,7 @@ public function testAreaText() {
 
     // add a text header
     $string = $this->randomName();
-    $view->displayHandlers['default']->overrideOption('header', array(
+    $view->displayHandlers->get('default')->overrideOption('header', array(
       'area' => array(
         'id' => 'area',
         'table' => 'views',

core/modules/views/lib/Drupal/views/Tests/Handler/ArgumentNullTest.php

@@ -43,7 +43,7 @@ public function testAreaText() {
 
     // Add a null argument.
     $string = $this->randomString();
-    $view->displayHandlers['default']->overrideOption('arguments', array(
+    $view->displayHandlers->get('default')->overrideOption('arguments', array(
       'null' => array(
         'id' => 'null',
         'table' => 'views',
@@ -69,7 +69,7 @@ public function testAreaText() {
 
     // Add a argument, which has null as handler.
     $string = $this->randomString();
-    $view->displayHandlers['default']->overrideOption('arguments', array(
+    $view->displayHandlers->get('default')->overrideOption('arguments', array(
       'id' => array(
         'id' => 'id',
         'table' => 'views_test_data',

core/modules/views/lib/Drupal/views/Tests/Handler/FieldBooleanTest.php

@@ -47,7 +47,7 @@ public function testFieldBoolean() {
     $view = views_get_view('test_view');
     $view->setDisplay();
 
-    $view->displayHandlers['default']->overrideOption('fields', array(
+    $view->displayHandlers->get('default')->overrideOption('fields', array(
       'age' => array(
         'id' => 'age',
         'table' => 'views_test_data',

core/modules/views/lib/Drupal/views/Tests/Handler/FieldCounterTest.php

@@ -38,7 +38,7 @@ protected function setUp() {
   function testSimple() {
     $view = views_get_view('test_view');
     $view->setDisplay();
-    $view->displayHandlers['default']->overrideOption('fields', array(
+    $view->displayHandlers->get('default')->overrideOption('fields', array(
       'counter' => array(
         'id' => 'counter',
         'table' => 'views',
@@ -64,7 +64,7 @@ function testSimple() {
 
     $view->setDisplay();
     $rand_start = rand(5, 10);
-    $view->displayHandlers['default']->overrideOption('fields', array(
+    $view->displayHandlers->get('default')->overrideOption('fields', array(
       'counter' => array(
         'id' => 'counter',
         'table' => 'views',