Skip to content
Snippets Groups Projects
Commit fdccb84b authored by catch's avatar catch
Browse files

Issue #2954908 by idebr, mr.baileys, maxocub, fenstrat, quietone,...

Issue #2954908 by idebr, mr.baileys, maxocub, fenstrat, quietone, phenaproxima: Add documentation to the LinkUri process plugin
parent 1a2babd2
No related branches found
No related tags found
No related merge requests found
......@@ -12,9 +12,32 @@
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Processes a link path into an 'internal:' or 'entity:' URI.
* Generates an internal URI from the source value.
*
* @todo: Add documentation in https://www.drupal.org/node/2954908
* Converts the source path value to an 'entity:', 'internal:' or 'base:' URI.
*
* Available configuration keys:
* - source: A source path to be converted into an URI.
* - validate_route: (optional) Whether the plugin should validate that the URI
* derived from the source link path has a valid Drupal route.
* - TRUE: Throw a MigrateException if the resulting URI is not routed. This
* value is the default.
* - FALSE: Return the URI for the unrouted path.
*
* Examples:
*
* @code
* process:
* link/uri:
* plugin: link_uri
* validate_route: false
* source: link_path
* @endcode
*
* This will set the uri property of link to the internal notation of link_path
* without validating if the resulting URI is valid. For example, if the
* 'link_path' property is 'node/12', the uri property value of link will be
* 'entity:node/12'.
*
* @MigrateProcessPlugin(
* id = "link_uri"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment