Refactor membership module to better support plugins. Update namespac…

src/Entity/Membership.php

@@ -9,8 +9,8 @@
 use Drupal\entity\Revision\RevisionableContentEntityBase;
 use Drupal\membership\EventDispatcherTrait;
 use Drupal\membership\Exception\MembershipFeatureNotImplementedException;
-use Drupal\membership\MembershipEvent;
-use Drupal\membership\MembershipEvents;
+use Drupal\membership\Event\MembershipEvent;
+use Drupal\membership\Event\MembershipEvents;
 use Drupal\user\UserInterface;
 
 /**
@@ -148,9 +148,10 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDescription(t('The Membership type/bundle.'))
       ->setSetting('target_type', 'membership_type')
       ->setRequired(TRUE);
+
     $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
-      ->setLabel(t('Authored by'))
-      ->setDescription(t('The owner of the Membership entity.'))
+      ->setLabel(t('Primary user'))
+      ->setDescription(t('The owner of the Membership.'))
       ->setRevisionable(TRUE)
       ->setSetting('target_type', 'user')
       ->setSetting('handler', 'default')
@@ -173,6 +174,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ))
       ->setDisplayConfigurable('form', TRUE)
       ->setDisplayConfigurable('view', TRUE);
+
     $fields['data'] = BaseFieldDefinition::create('map')
       ->setLabel(t('Data'))
       ->setReadOnly(TRUE)
@@ -200,6 +202,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDisplayConfigurable('view', TRUE)
       ->setRevisionable(TRUE)
       ->setSetting('workflow_callback', ['\Drupal\membership\Entity\Membership', 'getWorkflowId']);
+
     $fields['provider'] = BaseFieldDefinition::create('membership_provider_id')
       ->setLabel('Provider plugin/remote ID')
       ->setDisplayConfigurable('form', false)
@@ -225,6 +228,7 @@ public function preSave(EntityStorageInterface $storage) {
       if ($this->isExpired()) {
         $this->getEventDispatcher()->dispatch(MembershipEvents::EXPIRE, $event);
       }
+      $this->setRevisionLogMessage($this->t('State changed: '.$this->state->getValue()));
     }
     parent::preSave($storage);
   }
@@ -248,6 +252,15 @@ public function postCreate(EntityStorageInterface $storage) {
     parent::postCreate($storage);
   }
 
+  /**
+   * @inheritDoc
+   */
+  function postSave(EntityStorageInterface $storage, $update = TRUE) {
+    $event = new MembershipEvent($this);
+    $this->getEventDispatcher()->dispatch(MembershipEvents::UPDATED, $event);
+    parent::postSave($storage, $update);
+
+  }
 
   /**
    * @inheritDoc

src/Entity/MembershipTermInterface.php

@@ -15,32 +15,39 @@ interface MembershipTermInterface extends  ContentEntityInterface, EntityChanged
 
   // Add get/set methods for your configuration properties here.
 
+
   /**
-   * Gets the Membership term type.
+   * Gets the membership for a term
    *
-   * @return string
-   *   The Membership term type.
+   * @return Membership
+   *   The membership entity
    */
-  public function getType();
+  public function getMembership();
 
   /**
-   * Gets the Membership term name.
+   * Set a membership on a term.
    *
-   * @return string
-   *   Name of the Membership term.
+   * @param \Drupal\membership\Entity\MembershipInterface $membership
+   *
+   * @return \Drupal\membership\Entity\MembershipTermInterface
+   *   The called Membership term.
    */
-  public function getName();
-
+  public function setMembership(MembershipInterface $membership);
   /**
-   * Sets the Membership term name.
+   * Gets the membership id for a term
    *
-   * @param string $name
-   *   The Membership term name.
+   * @return integer
+   *   The membership entity_id
+   */
+  public function getMembershipId();
+
+  /**
+   * Gets the Membership term type.
    *
-   * @return \Drupal\membership\Entity\MembershipTermInterface
-   *   The called Membership term entity.
+   * @return string
+   *   The Membership term type.
    */
-  public function setName($name);
+  public function getType();
 
   /**
    * Gets the Membership term creation timestamp.
@@ -61,26 +68,6 @@ public function getCreatedTime();
    */
   public function setCreatedTime($timestamp);
 
-  /**
-   * Returns the Membership term published status indicator.
-   *
-   * Unpublished Membership term are only visible to restricted users.
-   *
-   * @return bool
-   *   TRUE if the Membership term is published.
-   */
-  public function isPublished();
-
-  /**
-   * Sets the published status of a Membership term.
-   *
-   * @param bool $published
-   *   TRUE to set this Membership term to published, FALSE to set it to unpublished.
-   *
-   * @return \Drupal\membership\Entity\MembershipTermInterface
-   *   The called Membership term entity.
-   */
-  public function setPublished($published);
 
   /**
    * Returns the Membership Type (bundle) that this membership term is associated with.

src/Entity/MembershipTermTypeInterface.php

@@ -27,6 +27,15 @@ public function setWorkflowId($workflow_id);
    */
   public function getMembershipType();
 
+  /**
+   * @return string
+   */
+  public function getTermLength();
+
+  /**
+   * @return string
+   */
+  public function getGracePeriod();
   /**
    * @param string $membership_type
    * @return string

src/Entity/MembershipType.php

@@ -66,6 +66,13 @@ class MembershipType extends ConfigEntityBase implements MembershipTypeInterface
    */
   protected $workflow;
 
+  /**
+   * The processor plugin string ID.
+   *
+   * @var string
+   */
+  protected $processor_plugin_id;
+
   /**
    * {@inheritdoc}
    */
@@ -81,6 +88,20 @@ public function setWorkflowId($workflow_id) {
     return $this;
   }
 
+  /**
+   * @inheritdoc
+   */
+  public function getProcessorPlugin() {
+    // TODO: Implement getProcessorPlugin() method.
+  }
+
+  /**
+   * @inheritdoc
+   */
+  public function setProcessorPluginId($processor_plugin_id) {
+    // TODO: Implement setProcessorPluginId() method.
+  }
+
   /**
    * @inheritDoc
    * 

src/Entity/MembershipTypeInterface.php

@@ -3,6 +3,7 @@
 namespace Drupal\membership\Entity;
 
 use Drupal\entity\Entity\RevisionableEntityBundleInterface;
+use Drupal\membership\Plugin\MembershipProviderInterface;
 
 /**
  * Provides an interface for defining Membership type entities.
@@ -24,8 +25,23 @@ public function getWorkflowId();
 
   /**
    * @param string $workflow_id
-   * @return mixed
+   * @return MembershipTypeInterface This object
    */
   public function setWorkflowId($workflow_id);
 
+  /**
+   * Get the provider plugin for this membership type.
+   *
+   * @return MembershipProviderInterface
+   */
+  public function getProcessorPlugin();
+
+  /**
+   * Set the processor plugin type and instance id.
+   *
+   * @param $processor_plugin_id string
+   * @return MembershipTypeInterface This object
+   */
+  public function setProcessorPluginId($processor_plugin_id);
+
 }

src/MembershipEvent.php → src/Event/MembershipEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Drupal\membership;
+namespace Drupal\membership\Event;
 
 use Drupal\membership\Entity\MembershipInterface;
 use Symfony\Component\EventDispatcher\Event;

src/MembershipEvents.php → src/Event/MembershipEvents.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Drupal\membership;
+namespace Drupal\membership\Event;
 
 /**
  * Class MembershipEvents
@@ -21,6 +21,10 @@ final class MembershipEvents {
    */
   const CREATED = 'membership.create';
 
+  /**
+   * Membership is updated.
+   */
+  const UPDATED = 'membership.updated';
   /**
    * Membership state changes.
    */

src/Form/MembershipForm.php

@@ -19,6 +19,9 @@ public function buildForm(array $form, FormStateInterface $form_state) {
     /* @var $entity \Drupal\membership\Entity\Membership */
     $form = parent::buildForm($form, $form_state);
 
+    // Hide revision message and revision fields...
+    $form['revision_information']['#access'] = FALSE;
+    $form['revision_log_message']['#access'] = FALSE;
     return $form;
   }
 

src/Form/MembershipTypeForm.php

@@ -22,8 +22,7 @@ public function form(array $form, FormStateInterface $form_state) {
     $workflow_manager = \Drupal::service('plugin.manager.workflow');
     $workflows = $workflow_manager->getGroupedLabels('membership');
 
-    /** @var MembershipTypeInterface $entity */
-    $entity = $this->entity;
+    /** @var MembershipTypeInterface $membership_type */
     $membership_type = $this->entity;
     $form['label'] = array(
       '#type' => 'textfield',
@@ -46,7 +45,7 @@ public function form(array $form, FormStateInterface $form_state) {
       '#type' => 'select',
       '#title' => t('Workflow'),
       '#options' => $workflows,
-      '#default_value' => $entity->getWorkflowId(),
+      '#default_value' => $membership_type->getWorkflowId(),
       '#description' => $this->t('Used by all memberships of this type.'),
       '#required' => true,
     ];

src/Plugin/Field/FieldType/ProviderIdFieldItemList.php

@@ -5,8 +5,36 @@
 use Drupal\Core\Field\FieldItemList;
 
 /**
- * Defines the 'membership_provider_id' field item list class.
+ * Defines the 'membership_remote_id' field item list class.
  */
 class ProviderIdFieldItemList extends FieldItemList {
 
+  /**
+   * {@inheritdoc}
+   */
+  public function getByProvider($provider) {
+    foreach ($this->list as $delta => $item) {
+      if ($item->provider == $provider) {
+        return $item->remote_id;
+      }
+    }
+    return NULL;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setByProvider($provider, $remote_id) {
+    $target_item = NULL;
+    foreach ($this->list as $delta => $item) {
+      if ($item->provider == $provider) {
+        $target_item = $item;
+        break;
+      }
+    }
+    $target_item = $target_item ?: $this->appendItem();
+    $target_item->provider = $provider;
+    $target_item->remote_id = $remote_id;
+  }
+
 }