From bd518b71f2cb1195d67507cd2212e80c97c2bf00 Mon Sep 17 00:00:00 2001 From: Joe Shindelar Date: Mon, 9 Feb 2015 17:14:13 -0500 Subject: [PATCH] Initial pass at documentation for field storage definition events. --- .../Core/Field/FieldStorageDefinitionEvents.php | 36 ++++++++++++++++++++-- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/core/lib/Drupal/Core/Field/FieldStorageDefinitionEvents.php b/core/lib/Drupal/Core/Field/FieldStorageDefinitionEvents.php index ea17ec6..9707635 100644 --- a/core/lib/Drupal/Core/Field/FieldStorageDefinitionEvents.php +++ b/core/lib/Drupal/Core/Field/FieldStorageDefinitionEvents.php @@ -13,21 +13,51 @@ final class FieldStorageDefinitionEvents { /** - * Event name for field storage definition creation. + * Name of the event triggered for field storage definition creation. + * + * This event allows you to respond to the creation of a new field storage + * definition. The event listener method receives a + * \Drupal\Core\Field\FieldStorageDefinitionEvent instance. + * + * @Event + * + * @see \Drupal\Core\Field\FieldStorageDefinitionEvent + * @see \Drupal\Core\Entity\EntityManager::onFieldStorageDefinitionCreate() + * @see \Drupal\Core\Field\FieldStorageDefinitionEventSubscriberTrait * * @var string */ const CREATE = 'field_storage.definition.create'; /** - * Event name for field storage definition update. + * Name of the event triggered for field storage definition update. + * + * This event allows you to respond anytime a field storage definition is + * updated. The event listener method receives a + * \Drupal\Core\Field\FieldStorageDefinitionEvent instance. + * + * @Event + * + * @see \Drupal\Core\Field\FieldStorageDefinitionEvent + * @see \Drupal\Core\Entity\EntityManager::onFieldStorageDefinitionUpdate() + * @see \Drupal\Core\Field\FieldStorageDefinitionEventSubscriberTrait * * @var string */ const UPDATE = 'field_storage.definition.update'; /** - * Event name for field storage definition deletion. + * Name of the event triggered for field storage definition deletion. + * + * This event allows you to respond anytime a field storage definition is + * deleted. The event listener method receives a + * \Drupal\Core\Field\FieldStorageDefinitionEvent instance. + * + * @Event + * + * @see \Drupal\Core\Field\FieldStorageDefinitionEvent + * @see \Drupal\Core\Entity\EntityManager::onFieldStorageDefinitionDelete() + * @see \Drupal\Core\Field\FieldStorageDefinitionEventSubscriberTrait * * @var string */ -- 2.2.2