X-Git-Url: http://www.aleph1.co.uk/gitweb/?p=yaffs-website;a=blobdiff_plain;f=web%2Fcore%2Fmodules%2Fmigrate%2Fsrc%2FPlugin%2Fmigrate%2Fdestination%2FEntityFieldStorageConfig.php;h=80ea9f628b8b3cdb253b22d36f5decb5e333965e;hp=9b781a3f9ab87b300b4742b32b690520032387fe;hb=9917807b03b64faf00f6a1f29dcb6eafc454efa5;hpb=aea91e65e895364e460983b890e295aa5d5540a5

diff --git a/web/core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php b/web/core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php
index 9b781a3f9..80ea9f628 100644
--- a/web/core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php
+++ b/web/core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php
@@ -3,7 +3,48 @@
 namespace Drupal\migrate\Plugin\migrate\destination;
 
 /**
- * Provides entity field storage configuration plugin.
+ * Provides destination plugin for field_storage_config configuration entities.
+ *
+ * The Field API defines two primary data structures, FieldStorage and Field.
+ * A FieldStorage defines a particular type of data that can be attached to
+ * entities as a Field instance.
+ *
+ * The example below creates a storage for a simple text field. The example uses
+ * the EmptySource source plugin and constant source values for the sake of
+ * simplicity.
+ * @code
+ * id: field_storage_example
+ * label: Field storage example
+ * source:
+ * plugin: empty
+ * constants:
+ *   entity_type: node
+ *   id: node.field_text_example
+ *   field_name: field_text_example
+ *   type: string
+ *   cardinality: 1
+ *   settings:
+ *     max_length: 10
+ *   langcode: en
+ *   translatable: true
+ * process:
+ *   entity_type: constants/entity_type
+ *   id: constants/id
+ *   field_name: constants/field_name
+ *   type: constants/type
+ *   cardinality: constants/cardinality
+ *   settings: constants/settings
+ *   langcode: constants/langcode
+ *   translatable: constants/translatable
+ * destination:
+ *   plugin: entity:field_storage_config
+ * @endcode
+ *
+ * For a full list of the properties of a FieldStorage configuration entity,
+ * refer to \Drupal\field\Entity\FieldStorageConfig.
+ *
+ * For an example on how to migrate a Field instance of this FieldStorage,
+ * refer to \Drupal\migrate\Plugin\migrate\destination\EntityFieldInstance.
  *
  * @MigrateDestination(
  *   id = "entity:field_storage_config"