Added uninstaller and made config files optional.

philltran · Jun 25, 2016 · 48c3ae3 · 48c3ae3
1 parent e109444
commit 48c3ae3
Show file tree

Hide file tree

Showing 22 changed files with 40 additions and 143 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ CONTENTS OF THIS FILE
  * Configuration
  * How to use
  * Security
- * Development and Test
+ * Development road-map
  * Maintainers
 
 
@@ -41,28 +41,16 @@ INSTALLATION
 
 CONFIGURATION
 -------------
-Enabling Permissions: 
- * "View a new message instance for Private Message" &
- "Create a new message instance for Private Message" for users needing to create
- and view private messages.
- * To hide private messages from this view, you must override view provided by 
- Message module: admin/structure/views/view/message/edit
-
-When enabled, the module will provide a new message type "Private Message" and a 
-Message Private View.
-
-Message Create Limits:
- * Message creation limits can be managed per role on the module settings form. 
- A message create limit can be set per interval per role. Users with more than 
- one role get the maximum limit by calculating the lowest time per message over 
- each role. Users with the 'bypass private message access control' permission 
- bypass these limitations.
+Show message form fields at: admin/structure/message/manage/private_message/form-display
+Show message display fields at: admin/structure/message/manage/private_message/display
+Show user form fields: /admin/config/people/accounts/form-display
+This will be addressed automatically later.
 
 
 HOW TO USE
 ----------
 To Create messages:
- * Visit /admin/content/message/create/private-message and Save the message to 
+ * Visit /message/add/private_message and Create the message to
  send, or
  * Visit the "Messages" tab detailed below and find the "Create a new message" 
 local action.
@@ -85,17 +73,14 @@ E.G:
  * CAPTCHA method: https://www.drupal.org/project/recaptcha
 
 
-DEVELOPMENT AND TEST
+DEVELOPMENT ROAD-MAP
 --------------------
  * Integrate with Message FOS (FOSMessage) bridge module.
  * Flag module on user entity to block/unblock users from messaging them
  * Flag module on message entity to show/hide (delete) messages from users own 
    display
  * Allow Operations links to display correctly on views, i.e. - show 'View' for
    users with view permissions. Not showing currently due to custom permissions.
- * Integrate with rolereference module or similar to provide sending to users
-   within a certain role.
- * Tests should be created in a "tests" folder.
 
 
 MAINTAINERS

diff --git a/config/install/core.entity_form_display.message.private_message.default.yml b/config/install/core.entity_form_display.message.private_message.default.yml
diff --git a/config/install/core.entity_view_display.message.private_message.default.yml b/config/install/core.entity_view_display.message.private_message.default.yml
diff --git a/config/install/core.entity_view_display.message.private_message.mail_body.yml b/config/install/core.entity_view_display.message.private_message.mail_body.yml
diff --git a/config/install/core.entity_view_display.message.private_message.mail_subject.yml b/config/install/core.entity_view_display.message.private_message.mail_subject.yml
diff --git a/...te_message.field_message_private_body.yml → ...te_message.field_message_private_body.yml b/...te_message.field_message_private_body.yml → ...te_message.field_message_private_body.yml
diff --git a/...message.field_message_private_subject.yml → ...message.field_message_private_subject.yml b/...message.field_message_private_subject.yml → ...message.field_message_private_subject.yml
diff --git a/...message.field_message_private_to_user.yml → ...message.field_message_private_to_user.yml b/...message.field_message_private_to_user.yml → ...message.field_message_private_to_user.yml
diff --git a/...user.field_message_private_usr_notify.yml → ...user.field_message_private_usr_notify.yml b/...user.field_message_private_usr_notify.yml → ...user.field_message_private_usr_notify.yml
diff --git a/...ge.message.field_message_private_body.yml → ...ge.message.field_message_private_body.yml b/...ge.message.field_message_private_body.yml → ...ge.message.field_message_private_body.yml
diff --git a/...message.field_message_private_subject.yml → ...message.field_message_private_subject.yml b/...message.field_message_private_subject.yml → ...message.field_message_private_subject.yml
diff --git a/...message.field_message_private_to_user.yml → ...message.field_message_private_to_user.yml b/...message.field_message_private_to_user.yml → ...message.field_message_private_to_user.yml
diff --git a/...user.field_message_private_usr_notify.yml → ...user.field_message_private_usr_notify.yml b/...user.field_message_private_usr_notify.yml → ...user.field_message_private_usr_notify.yml
diff --git a/...te_message.field_message_private_body.yml → ...te_message.field_message_private_body.yml b/...te_message.field_message_private_body.yml → ...te_message.field_message_private_body.yml
diff --git a/...message.field_message_private_subject.yml → ...message.field_message_private_subject.yml b/...message.field_message_private_subject.yml → ...message.field_message_private_subject.yml
diff --git a/...message.field_message_private_to_user.yml → ...message.field_message_private_to_user.yml b/...message.field_message_private_to_user.yml → ...message.field_message_private_to_user.yml
diff --git a/.../install/message.type.private_message.yml → ...optional/message.type.private_message.yml b/.../install/message.type.private_message.yml → ...optional/message.type.private_message.yml
diff --git a/config/install/message_private.settings.yml → config/optional/message_private.settings.yml b/config/install/message_private.settings.yml → config/optional/message_private.settings.yml
diff --git a/...user.field_message_private_usr_notify.yml → ...user.field_message_private_usr_notify.yml b/...user.field_message_private_usr_notify.yml → ...user.field_message_private_usr_notify.yml
diff --git a/...ig/install/views.view.message_private.yml → ...g/optional/views.view.message_private.yml b/...ig/install/views.view.message_private.yml → ...g/optional/views.view.message_private.yml
diff --git a/message_private.install b/message_private.install
@@ -0,0 +1,33 @@
+<?php
+/**
+ * @file
+ * Message Private un-installer.
+ */
+
+/**
+ * Implements hook_uninstall.
+ *
+ * Remove the field_message_private_usr_notify field.
+ */
+function message_private_uninstall() {
+  $properties = array(
+    'entity_type' => 'user',
+    'bundle' => 'user',
+    'include_deleted' => TRUE,
+  );
+
+  // Get the fields based on the above properties.
+  $fields = \Drupal::entityManager()->getStorage('field_config')->loadByProperties($properties);
+
+  // Cycle through user fields looking for our user notify field.
+  foreach ($fields as $field) {
+    /* @var \Drupal\Core\Field\FieldConfigBase $field */
+    // If we have the user notify field, purge the data and remove.
+    if(!empty($field->getName() == 'field_message_private_usr_notify')) {
+      $entity_type = $field->getTargetEntityTypeId();
+      Drupal::entityManager()->getStorage($entity_type)->purgeFieldData($field, 100);
+      field_purge_field($field);
+      $field->delete();
+    }
+  }
+}
diff --git a/src/Form/MessagePrivateSettingsForm.php b/src/Form/MessagePrivateSettingsForm.php
@@ -9,7 +9,6 @@
 namespace Drupal\message_private\Form;
 
 use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\Entity\ContentEntityTypeInterface;
 use Drupal\Core\Entity\EntityManagerInterface;
 use Drupal\Core\Form\ConfigFormBase;
 use Drupal\Core\Form\FormStateInterface;