Extend TipPluginInterface with ConfigurablePluginInterface

configuration protected attribute in TipPluginBase is now available in tip plugin interface.

I can see how having this method available would be better DX. However, shouldn't it instead extend ConfigurablePluginInterface?

Checked documentation for ConfigurablePluginInterface , other modules such as search are also using this method.Similar should be the case with Tour.

Now it looks better.

Now it looks better.

+++ b/core/modules/tour/src/TipPluginBase.php
@@ -79,4 +79,32 @@ public function set($key, $value) {
+  /**
+   * {@inheritdoc}
+   */
+  public function setConfiguration(array $configuration) {
+    $this->configuration = $configuration + $this->defaultConfiguration();
+  }

I think this should be:

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep(
      $this->defaultConfiguration(),
      $configuration
    );
  }

It's just a bit more future proof. And would cope with merging the attributes array if the defaults contained values.

Also the issue summary needs an update since making TipPluginInterface implement \Drupal\Component\Plugin\ConfigurablePluginInterface is a big change - and one that probably needs a CR and some thought about BC layers extra. Maybe Tour UI should extend TipPluginBase and do this itself?

@GoZ okay - we need to update the issue summary and create change record for this. And it probably will not make it into 8.3.x since it is an API change.

1. +++ b/core/modules/tour/src/TipPluginBase.php
   @@ -79,4 +80,35 @@ public function set($key, $value) {
   +  public function setConfiguration(array $configuration) {
   

   This should be called from the constructor instead of just doing $this->configuration = $configuration;

   See https://www.drupal.org/node/2851635

2. +++ b/core/modules/tour/src/TipPluginBase.php
   @@ -79,4 +80,35 @@ public function set($key, $value) {
   +    $this->configuration = NestedArray::mergeDeep(
   +      $this->defaultConfiguration(),
   +      $configuration
   +    );
   

   This should be one line

3. +++ b/core/modules/tour/src/TipPluginBase.php
   @@ -79,4 +80,35 @@ public function set($key, $value) {
   +    return ['id' => '', 'label' => '', 'weight' => 0, 'attributes' => []];
   

   This should be multiple lines :)

We can use the new trait in #2852463: Create a trait and base class to implement \Drupal\Component\Plugin\ConfigurableInterface for this actually! Postponing briefly on that.

This extension is being deprecated, see #3336033: [Meta] Tasks to deprecate Tour module. It will be removed from core and moved to a contrib project, #3376099: [11.x] [Meta] Tasks to remove Tour.

This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project and the Extensions approved for removal policies.

Moving over but blocking ticket #21 is still not complete after 7 years wonder if we can do something else in contrib.

Since we are moving Tour UI over in contrib version 2.0.x think it would be good to get something in for this. The trait ticket is all but stalled (happens). So think we can go forward with another.

Going to include in #3458337: Integrate Tour UI into 2.0.x

Amending attribution.