Allow to disable event reminders (#19)

Author: qzminski

dca/tl_calendar_events_subscription.php

@@ -46,7 +46,7 @@
             'disableGrouping'       => true,
             'fields'                => ['dateCreated'],
             'headerFields'          => ['title', 'startDate', 'startTime', 'endDate', 'endTime', 'published'],
-            'panelLayout'           => 'filter,limit',
+            'panelLayout'           => 'filter;limit',
             'child_record_callback' => [
                 'Codefog\EventsSubscriptions\DataContainer\SubscriptionContainer',
                 'generateLabel',
@@ -89,9 +89,9 @@
     // Palettes
     'palettes' => [
         '__selector__' => ['type'],
-        'default'      => '{type_legend},type,addedBy',
-        'guest'        => '{type_legend},type,addedBy;{guest_legend},firstname,lastname,email',
-        'member'       => '{type_legend},type,addedBy;{member_legend},member',
+        'default'      => '{type_legend},type,addedBy,disableReminders',
+        'guest'        => '{type_legend},type,addedBy,disableReminders;{guest_legend},firstname,lastname,email',
+        'member'       => '{type_legend},type,addedBy,disableReminders;{member_legend},member',
     ],
 
     // Fields
@@ -137,6 +137,14 @@
             'eval'       => ['includeBlankOption' => true, 'tl_class' => 'w50'],
             'sql'        => "int(10) unsigned NOT NULL default '0'",
         ],
+        'disableReminders' => [
+            'label'     => &$GLOBALS['TL_LANG']['tl_calendar_events_subscription']['disableReminders'],
+            'exclude'   => true,
+            'filter'    => true,
+            'inputType' => 'checkbox',
+            'eval'      => ['tl_class' => 'clr'],
+            'sql'       => "char(1) NOT NULL default ''",
+        ],
         'member'       => [
             'label'            => &$GLOBALS['TL_LANG']['tl_calendar_events_subscription']['member'],
             'exclude'          => true,

languages/en/default.php

@@ -19,6 +19,7 @@
 $GLOBALS['TL_LANG']['MSC']['events_subscriptions.subscribeNotAllowed']     = 'It is no longer possible to subscribe to this event.';
 $GLOBALS['TL_LANG']['MSC']['events_subscriptions.unsubscribeNotAllowed']   = 'It is no longer possible to unsubscribe from this event.';
 $GLOBALS['TL_LANG']['MSC']['events_subscriptions.onWaitingList']           = 'waiting list';
+$GLOBALS['TL_LANG']['MSC']['events_subscriptions.enableReminders']         = 'Enable reminders';
 $GLOBALS['TL_LANG']['MSC']['events_subscriptions.guestForm.firstname']     = 'First name';
 $GLOBALS['TL_LANG']['MSC']['events_subscriptions.guestForm.lastname']      = 'Last name';
 $GLOBALS['TL_LANG']['MSC']['events_subscriptions.guestForm.email']         = 'E-mail address';

languages/en/tl_calendar_events_subscription.php

@@ -20,6 +20,10 @@
     'Added by',
     'Here you can choose who subscribed this member.',
 ];
+$GLOBALS['TL_LANG']['tl_calendar_events_subscription']['disableReminders'] = [
+    'Disable reminders',
+    'Disable the event reminders for this subscriber.',
+];
 $GLOBALS['TL_LANG']['tl_calendar_events_subscription']['member']       = [
     'Member',
     'Please choose the member you want to subscribe to the event.',

src/Codefog/EventsSubscriptions/Automator.php

@@ -145,7 +145,7 @@ private function getEvents(CalendarModel $calendar)
         $where = (count($where) ? " AND (".implode(" OR ", $where).")" : "");
 
         return Database::getInstance()->prepare(
-            "SELECT e.*, es.id AS subscriptionId FROM tl_calendar_events_subscription es JOIN tl_calendar_events e ON e.id=es.pid WHERE e.pid=?".$where
+            "SELECT e.*, es.id AS subscriptionId FROM tl_calendar_events_subscription es JOIN tl_calendar_events e ON e.id=es.pid WHERE e.pid=? AND es.disableReminders=''".$where
         )
             ->execute($calendar->id)
             ->fetchAllAssoc();

src/Codefog/EventsSubscriptions/EventConfig.php

@@ -82,6 +82,16 @@ public function canSubscribe()
         return $this->calendar->subscription_enable ? true : false;
     }
 
+    /**
+     * Return true if calendar has reminders
+     *
+     * @return bool
+     */
+    public function hasReminders()
+    {
+        return $this->calendar->subscription_reminders ? true : false;
+    }
+
     /**
      * Get the allowed subscription types
      *

src/Codefog/EventsSubscriptions/Subscription/AbstractSubscription.php

@@ -108,6 +108,21 @@ public function setUnsubscribeCriteria(EventConfig $event, array &$columns, arra
         // Backwards compatibility
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function writeToModel(EventConfig $event, SubscriptionModel $model)
+    {
+        if (($form = $this->getForm($event)) === null) {
+            return;
+        }
+
+        // Disable reminder if they are turned on and the user explicitly does not request them
+        if ($event->hasReminders() && !$this->form->fetch('enableReminders')) {
+            $model->disableReminders = 1;
+        }
+    }
+
     /**
      * Create the basic form
      *
@@ -131,6 +146,14 @@ function ($haste) {
 
         $form->addContaoHiddenFields();
 
+        if ($event->hasReminders()) {
+            $form->addFormField('enableReminders', [
+                'inputType' => 'checkbox',
+                'default' => 1,
+                'options' => [1 => &$GLOBALS['TL_LANG']['MSC']['events_subscriptions.enableReminders']],
+            ]);
+        }
+
         return $form;
     }
 

src/Codefog/EventsSubscriptions/Subscription/GuestSubscription.php

@@ -5,6 +5,7 @@
 use Codefog\EventsSubscriptions\EventConfig;
 use Codefog\EventsSubscriptions\Model\SubscriptionModel;
 use Haste\Form\Form;
+use Haste\Util\ArrayPosition;
 
 class GuestSubscription extends AbstractSubscription implements ExportAwareInterface, NotificationAwareInterface
 {
@@ -41,6 +42,8 @@ public function writeToModel(EventConfig $event, SubscriptionModel $model)
             return;
         }
 
+        parent::writeToModel($event, $model);
+
         $model->firstname = $form->fetch('firstname');
         $model->lastname  = $form->fetch('lastname');
         $model->email     = $form->fetch('email');
@@ -62,21 +65,24 @@ public function createForm(EventConfig $event)
                     'label'     => &$GLOBALS['TL_LANG']['MSC']['events_subscriptions.guestForm.firstname'],
                     'inputType' => 'text',
                     'eval'      => ['mandatory' => true],
-                ]
+                ],
+                ArrayPosition::before('enableReminders')
             )->addFormField(
                 'lastname',
                 [
                     'label'     => &$GLOBALS['TL_LANG']['MSC']['events_subscriptions.guestForm.lastname'],
                     'inputType' => 'text',
                     'eval'      => ['mandatory' => true],
-                ]
+                ],
+                ArrayPosition::before('enableReminders')
             )->addFormField(
                 'email',
                 [
                     'label'     => &$GLOBALS['TL_LANG']['MSC']['events_subscriptions.guestForm.email'],
                     'inputType' => 'text',
                     'eval'      => ['mandatory' => true, 'rgxp' => 'email'],
-                ]
+                ],
+                ArrayPosition::before('enableReminders')
             );
 
         return $form;

src/Codefog/EventsSubscriptions/Subscription/MemberSubscription.php

@@ -120,6 +120,8 @@ public function writeToModel(EventConfig $event, SubscriptionModel $model)
             throw new \RuntimeException('The member model cannot be null');
         }
 
+        parent::writeToModel($event, $model);
+
         $model->member = $memberModel->id;
     }