Commit 8ff5e72f authored by xjm's avatar xjm

Issue #2845491 by Jo Fitzgerald, quietone, phenaproxima, ultimike: Add...

Issue #2845491 by Jo Fitzgerald, quietone, phenaproxima, ultimike: Add documentation to UrlEncode process plugin
parent 8c01266a
......@@ -9,10 +9,21 @@
use GuzzleHttp\Psr7\Uri;
/**
* Apply urlencoding to a URI.
* URL-encodes the input value.
*
* This is needed when the URI is to be opened by a later migration stage, and
* the source URI value is not already encoded.
* Example:
*
* @code
* process:
* new_url:
* plugin: urlencode
* source: 'http://example.com/a url with spaces.html'
* @endcode
*
* This will convert the source URL 'http://example.com/a url with spaces.html'
* into 'http://example.com/a%20url%20with%20spaces.html'.
*
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
*
* @MigrateProcessPlugin(
* id = "urlencode"
......
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