Commit 2a9dc18b authored by Gábor Hojtsy's avatar Gábor Hojtsy

Issue #2728869 by masipila, gaurav.kapoor, pk188, quietone, heddn,...

Issue #2728869 by masipila, gaurav.kapoor, pk188, quietone, heddn, phenaproxima, generalredneck, mikeryan, eojthebrave: Document public function MigrateSourceInterface::getIds return value better
parent 6dc062eb
......@@ -53,9 +53,12 @@ public function __toString();
* 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' => [
......@@ -70,6 +73,7 @@ public function __toString();
* ],
* ];
* @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:
......@@ -80,9 +84,13 @@ public function __toString();
* ],
* ];
* @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' => [
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment