comparison core/modules/migrate/src/Plugin/MigrateSourceInterface.php @ 12:7a779792577d

Update Drupal core to v8.4.5 (via Composer)

    *
    * @return array[]
    *   An associative array of field definitions keyed by field ID. Values are
    *   associative arrays with a structure that contains the field type ('type'
    *   key). The other keys are the field storage settings as they are returned
-   *   by FieldStorageDefinitionInterface::getSettings(). As an example, for a
-   *   composite source primary key that is defined by an integer and a
-   *   string, the returned value might look like:
+   *   by FieldStorageDefinitionInterface::getSettings().
+   *
+   *   Examples:
+   *
+   *   A composite source primary key that is defined by an integer and a string
+   *   might look like this:
    *   @code
    *     return [
    *       'id' => [
    *         'type' => 'integer',
    *         'unsigned' => FALSE,

    *         'max_length' => 64,
    *         'is_ascii' => TRUE,
    *       ],
    *     ];
    *   @endcode
+   *
    *   If 'type' points to a field plugin with multiple columns and needs to
    *   refer to a column different than 'value', the key of that column will be
    *   appended as a suffix to the plugin name, separated by dot ('.'). Example:
    *   @code
    *     return [
    *       'format' => [
    *         'type' => 'text.format',
    *       ],
    *     ];
    *   @endcode
-   *   Additional custom keys/values, that are not part of field storage
-   *   definition, can be passed in definitions. The most common setting, passed
-   *   along the ID definition, is 'alias' used by SqlBase source plugin:
+   *
+   *   Additional custom keys/values that are not part of field storage
+   *   definition can be added as shown below. The most common setting
+   *   passed along to the ID definition is 'alias', used by the SqlBase source
+   *   plugin in order to distinguish between ambiguous column names - for
+   *   example, when a SQL source query joins two tables with the same column
+   *   names.
    *   @code
    *     return [
    *       'nid' => [
    *         'type' => 'integer',
    *         'alias' => 'n',