Newer
Older
<?php
/**
* @file
* Installation functionality for the recurring events registration module.
*/
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\recurring_events_registration\Plugin\Field\ComputedRegistrantTitleFieldItemList;
/**
* Install the schema updates for eventseries entities to add registration.
*
* @see hook_install()
*/
function recurring_events_registration_install() {
$storage_definition = BaseFieldDefinition::create('event_registration')
->setName('event_registration')
->setLabel(t('Event Registration'))
->setDescription('The event registration configuration.')
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE)
->setRevisionable(TRUE)
->setTranslatable(FALSE)
->setCardinality(1)
->setRequired(FALSE)
->setDisplayOptions('form', [
'type' => 'event_registration',

Paul Driver
committed
'weight' => 10,
]);
\Drupal::entityDefinitionUpdateManager()
->installFieldStorageDefinition('event_registration', 'eventseries', 'eventseries', $storage_definition);
// When enabling registrations make sure we create all the registrant types
// to match the existing series and instance types.
foreach (\Drupal::entityTypeManager()->getStorage('eventseries_type')->loadMultiple() as $type) {
$registrant_type = \Drupal::entityTypeManager()->getStorage('registrant_type')->load($type->id());
if (empty($registrant_type)) {
$registrant_type = \Drupal::entityTypeManager()->getStorage('registrant_type')->create([
'id' => $type->id(),
'label' => $type->label(),
'description' => $type->getDescription(),
]);
$registrant_type->save();
}
}
/**
* Add the computed title field to registrants.
*/
function recurring_events_registration_update_8001() {
$storage_definition = BaseFieldDefinition::create('string')
->setLabel(t('Title'))
->setReadOnly(TRUE)
->setComputed(TRUE)
->setClass(ComputedRegistrantTitleFieldItemList::class);
\Drupal::entityDefinitionUpdateManager()
->installFieldStorageDefinition('title', 'registrant', 'registrant', $storage_definition);
// Configure the registrants title field.
\Drupal::configFactory()->getEditable('recurring_events_registration.registrant.config')
->set('title', '[registrant:email]')
->save(TRUE);
}

Owen Bush
committed
/**
* Install the new type basefields for registrant.
*/
function recurring_events_registration_update_8002() {
$registrant_type = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Bundle'))
->setDescription(t('The registrant type.'))
->setSetting('target_type', 'registrant_type')
->setReadOnly(TRUE);
\Drupal::entityDefinitionUpdateManager()->installFieldStorageDefinition('bundle', 'registrant', 'registrant', $registrant_type);
}
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/**
* Update the event_registration field type to add new settings.
*/
function recurring_events_registration_update_8003() {
$entity_type_manager = \Drupal::entityTypeManager();
$storage = $entity_type_manager->getStorage('eventseries');
$bundle_definition = $entity_type_manager->getDefinition('eventseries');
$id_key = $bundle_definition->getKey('id');
$revision_key = $bundle_definition->getKey('revision');
$table_name = $storage->getDataTable() ?: $storage->getBaseTable();
$revision_table_name = $storage->getRevisionDataTable() ?: $storage->getRevisionTable();
$database = \Drupal::database();
$definition_manager = \Drupal::entityDefinitionUpdateManager();
$reg_fields = [
'event_registration__value',
'event_registration__end_value',
'event_registration__registration',
'event_registration__registration_type',
'event_registration__registration_dates',
'event_registration__capacity',
'event_registration__waitlist',
'event_registration__time_amount',
'event_registration__time_type',
];
$reg_field_mappings = [

Owen Bush
committed
'event_registration__time_amount' => 'event_registration__instance_schedule_open_amount',
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
'event_registration__time_type' => 'event_registration__instance_schedule_open_units',
];
$registration_values = $database->select($table_name)
->fields($table_name, [$id_key, $revision_key] + $reg_fields)
->execute()
->fetchAll();
$update_fields = array_fill_keys($reg_fields, NULL);
$database->update($table_name)
->fields($update_fields)
->execute();
$field_storage_definition = $definition_manager->getFieldStorageDefinition('event_registration', 'eventseries');
$definition_manager->uninstallFieldStorageDefinition($field_storage_definition);
$storage_definition = BaseFieldDefinition::create('event_registration')
->setName('event_registration')
->setLabel(t('Event Registration'))
->setDescription('The event registration configuration.')
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE)
->setRevisionable(TRUE)
->setTranslatable(FALSE)
->setCardinality(1)
->setRequired(FALSE)
->setDisplayOptions('form', [
'type' => 'event_registration',
'weight' => 10,
]);
\Drupal::entityDefinitionUpdateManager()
->installFieldStorageDefinition('event_registration', 'eventseries', 'eventseries', $storage_definition);
if (!empty($registration_values)) {
foreach ($registration_values as $value) {
$values_to_restore = [
$id_key => $value->{$id_key},
$revision_key => $value->{$revision_key},
];
foreach ($reg_fields as $field) {
$key = $field;
if (isset($reg_field_mappings[$field])) {
$key = $reg_field_mappings[$field];
}
$values_to_restore[$key] = rtrim($value->{$field}, 's');
$values_to_restore += [
'event_registration__instance_schedule_open' => 'custom',
'event_registration__instance_schedule_close' => 'start',
];
}
$database->update($table_name)
->fields($values_to_restore)
->condition($id_key, $value->{$id_key})
->execute();
$database->update($revision_table_name)
->fields($values_to_restore)
->condition($id_key, $value->{$id_key})
->execute();
}
}
}

Ryan Kavalsky
committed
/**
* Add the default registration message configurations.
*/
function recurring_events_registration_update_8004() {
// Configure the registrantion messages.
\Drupal::configFactory()->getEditable('recurring_events_registration.registrant.config')
->set('successfully_registered', 'Registrant successfully created.')
->set('successfully_registered_waitlist', 'Successfully registered to the waitlist.')
->set('successfully_updated', 'Registrant successfully updated.')
->set('successfully_updated_waitlist', 'Successfully updated waitlist registrant.')
->set('already_registered', 'ser already registered for this event.')
->set('registration_closed', 'Unfortunately, registration is not available at this time.')
->save(TRUE);

Owen Bush
committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
}
/**
* Install the new status field.
*/
function recurring_events_registration_update_8005() {
$definition_update_manager = \Drupal::entityDefinitionUpdateManager();
// Add the status field.
$status = BaseFieldDefinition::create('boolean')
->setLabel(t('Status'))
->setDescription(t('Is this registration complete?'))
->setDefaultValue(FALSE)
->setInitialValue(FALSE)
->setSetting('on_label', 'Complete')
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'settings' => [
'display_label' => FALSE,
],
'weight' => 100,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'type' => 'boolean',
'label' => 'above',
'weight' => 0,
'settings' => [
'format' => 'enabled-disabled',
],
])

Owen Bush
committed
->setDefaultValue(0)

Owen Bush
committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
->setDisplayConfigurable('view', FALSE);
$definition_update_manager->installFieldStorageDefinition('status', 'registrant', 'registrant', $status);
}
/**
* Update existing registrants to be marked as completed.
*/
function recurring_events_registration_update_8006(&$sandbox) {
// This is a multipass update.
// Grab all the registrants.
if (empty($sandbox['registrants'])) {
$registrants = \Drupal::entityTypeManager()
->getStorage('registrant')
->getQuery()
->execute();
$sandbox['registrants'] = $registrants;
$sandbox['max'] = count($registrants);
$sandbox['limit'] = 20;
$sandbox['progress'] = 0;
}
if (count($sandbox['registrants']) > 0) {
// Loop through chunks of 20 registrants at a time.
$registrant_ids = array_splice($sandbox['registrants'], 0, $sandbox['limit'], []);
if (!empty($registrant_ids)) {
$registrants = \Drupal::entityTypeManager()->getStorage('registrant')->loadMultiple($registrant_ids);
foreach ($registrants as $registrant) {
$registrant->status = 1;
$registrant->save();
$sandbox['progress']++;
}
$sandbox['#finished'] = ($sandbox['progress'] / $sandbox['max']);
}
}
else {
$sandbox['#finished'] = 1;
}
}

Owen Bush
committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/**
* Update the event_registration field type to add unique email field.
*/
function recurring_events_registration_update_8007() {
$entity_type_manager = \Drupal::entityTypeManager();
$storage = $entity_type_manager->getStorage('eventseries');
$bundle_definition = $entity_type_manager->getDefinition('eventseries');
$id_key = $bundle_definition->getKey('id');
$revision_key = $bundle_definition->getKey('revision');
$table_name = $storage->getDataTable() ?: $storage->getBaseTable();
$revision_table_name = $storage->getRevisionDataTable() ?: $storage->getRevisionTable();
$database = \Drupal::database();
$definition_manager = \Drupal::entityDefinitionUpdateManager();
// We need to grab all the current data for registration settings for an event
// before we remove the registration field, before re-adding it with our new
// unique email field.
$reg_fields = [
'event_registration__value',
'event_registration__end_value',
'event_registration__registration',
'event_registration__registration_type',
'event_registration__registration_dates',
'event_registration__capacity',
'event_registration__waitlist',
'event_registration__instance_schedule_open',
'event_registration__instance_schedule_open_amount',
'event_registration__instance_schedule_open_units',
'event_registration__instance_schedule_close',
'event_registration__instance_schedule_close_amount',
'event_registration__instance_schedule_close_units',
'event_registration__instance_schedule_close_type',
];
$registration_values = $database->select($table_name)
->fields($table_name, [$id_key, $revision_key] + $reg_fields)
->execute()
->fetchAll();
// We need to NULL out all the current values, so that we can remove the field
// without warning.
$update_fields = array_fill_keys($reg_fields, NULL);
$database->update($table_name)
->fields($update_fields)
->execute();
// Remove the existing registration field.
$field_storage_definition = $definition_manager->getFieldStorageDefinition('event_registration', 'eventseries');
$definition_manager->uninstallFieldStorageDefinition($field_storage_definition);
// Create a new instance of the registration field and install it.
$storage_definition = BaseFieldDefinition::create('event_registration')
->setName('event_registration')
->setLabel(t('Event Registration'))
->setDescription('The event registration configuration.')
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE)
->setRevisionable(TRUE)
->setTranslatable(FALSE)
->setCardinality(1)
->setRequired(FALSE)
->setDisplayOptions('form', [
'type' => 'event_registration',
'weight' => 10,
]);
\Drupal::entityDefinitionUpdateManager()
->installFieldStorageDefinition('event_registration', 'eventseries', 'eventseries', $storage_definition);
// Restore previously stored values.
if (!empty($registration_values)) {
foreach ($registration_values as $value) {
$values_to_restore = [
$id_key => $value->{$id_key},
$revision_key => $value->{$revision_key},
];
foreach ($reg_fields as $field) {
$values_to_restore[$field] = rtrim($value->{$field}, 's');
}
$values_to_restore['event_registration__unique_email_address'] = 0;
$database->update($table_name)
->fields($values_to_restore)
->condition($id_key, $value->{$id_key})
->execute();
$database->update($revision_table_name)
->fields($values_to_restore)
->condition($id_key, $value->{$id_key})
->execute();
}
}
}