class UrlEncode

URL-encodes the input value.

Example:


process:
  new_url:
    plugin: urlencode
    source: 'http://example.com/a url with spaces.html'

This will convert the source URL 'http://example.com/a url with spaces.html' into 'http://example.com/a%20url%20with%20spaces.html'.

Hierarchy

Expanded class hierarchy of UrlEncode

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

6 string references to 'UrlEncode'
CoreExtension::getFilters in vendor/twig/twig/src/Extension/CoreExtension.php
Returns a list of filters to add to the existing list.
d6_file.yml in core/modules/file/migrations/d6_file.yml
core/modules/file/migrations/d6_file.yml
d6_user_picture_file.yml in core/modules/user/migrations/d6_user_picture_file.yml
core/modules/user/migrations/d6_user_picture_file.yml
d7_file.yml in core/modules/file/migrations/d7_file.yml
core/modules/file/migrations/d7_file.yml
EnvVarProcessor::getEnv in vendor/symfony/dependency-injection/EnvVarProcessor.php
Returns the value of the given variable as managed by the current instance.

... See full list

File

core/modules/migrate/src/Plugin/migrate/process/UrlEncode.php, line 29

Namespace

Drupal\migrate\Plugin\migrate\process
View source 
class UrlEncode extends ProcessPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        // Only apply to a full URL.
        if (is_string($value) && strpos($value, '://') > 0) {
            // URL encode everything after the hostname.
            $parsed_url = parse_url($value);
            // Fail on seriously malformed URLs.
            if ($parsed_url === FALSE) {
                throw new MigrateException("Value '{$value}' is not a valid URL");
            }
            // Iterate over specific pieces of the URL raw URL encoding each one.
            $url_parts_to_encode = [
                'path',
                'query',
                'fragment',
            ];
            foreach ($parsed_url as $parsed_url_key => $parsed_url_value) {
                if (in_array($parsed_url_key, $url_parts_to_encode)) {
                    // urlencode() would convert spaces to + signs.
                    $urlencoded_parsed_url_value = rawurlencode($parsed_url_value);
                    // Restore special characters depending on which part of the URL this is.
                    switch ($parsed_url_key) {
                        case 'query':
                            $urlencoded_parsed_url_value = str_replace('%26', '&', $urlencoded_parsed_url_value);
                            break;
                        case 'path':
                            $urlencoded_parsed_url_value = str_replace('%2F', '/', $urlencoded_parsed_url_value);
                            break;
                    }
                    $parsed_url[$parsed_url_key] = $urlencoded_parsed_url_value;
                }
            }
            $value = (string) Uri::fromParts($parsed_url);
        }
        return $value;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.
UrlEncode::transform public function Performs the associated process. Overrides ProcessPluginBase::transform