class FilterFormatPermission

Same name and namespace in other branches
  1. 9 core/modules/filter/src/Plugin/migrate/process/d6/FilterFormatPermission.php \Drupal\filter\Plugin\migrate\process\d6\FilterFormatPermission
  2. 8.9.x core/modules/filter/src/Plugin/migrate/process/d6/FilterFormatPermission.php \Drupal\filter\Plugin\migrate\process\d6\FilterFormatPermission
  3. 10 core/modules/filter/src/Plugin/migrate/process/d6/FilterFormatPermission.php \Drupal\filter\Plugin\migrate\process\d6\FilterFormatPermission

Migrate filter format serial to string id in permission name.

The filter_format_permission plugin is used to get the filter formats for a role and convert it to a permission name.

Available configuration keys:

  • migration: (optional) The filter migration. Defaults to

'd6_filter_format'.

Examples:


 process:
   result:
     plugin: filter_format_permission
     migration: d6_filter_format

This will use the 'd6_filter_format' migration to lookup the destination filter formats for a role.

Hierarchy

Expanded class hierarchy of FilterFormatPermission

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

1 file declares its use of FilterFormatPermission
FilterFormatPermissionTest.php in core/modules/filter/tests/src/Kernel/Migrate/d6/FilterFormatPermissionTest.php

File

core/modules/filter/src/Plugin/migrate/process/d6/FilterFormatPermission.php, line 38

Namespace

Drupal\filter\Plugin\migrate\process\d6
View source 
class FilterFormatPermission extends ProcessPluginBase implements ContainerFactoryPluginInterface {
    
    /**
     * The current migration.
     */
    protected MigrationInterface $migration;
    
    /**
     * The migrate lookup service.
     *
     * @var \Drupal\migrate\MigrateLookupInterface
     */
    protected $migrateLookup;
    
    /**
     * Constructs a FilterFormatPermission plugin instance.
     *
     * @param array $configuration
     *   The plugin configuration.
     * @param string $plugin_id
     *   The plugin ID.
     * @param mixed $plugin_definition
     *   The plugin definition.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The current migration.
     * @param \Drupal\migrate\MigrateLookupInterface $migrate_lookup
     *   The migrate lookup service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, MigrateLookupInterface $migrate_lookup) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->migration = $migration;
        $this->migrateLookup = $migrate_lookup;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('migrate.lookup'));
    }
    
    /**
     * {@inheritdoc}
     *
     * Migrate filter format serial to string id in permission name.
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        $rid = $row->getSourceProperty('rid');
        $migration = $this->configuration['migration'] ?? 'd6_filter_format';
        if ($formats = $row->getSourceProperty("filter_permissions:{$rid}")) {
            foreach ($formats as $format) {
                $lookup_result = $this->migrateLookup
                    ->lookup($migration, [
                    $format,
                ]);
                if ($lookup_result) {
                    $value[] = 'use text format ' . $lookup_result[0]['format'];
                }
            }
        }
        return $value;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FilterFormatPermission::$migrateLookup protected property The migrate lookup service.
FilterFormatPermission::$migration protected property The current migration.
FilterFormatPermission::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FilterFormatPermission::transform public function Migrate filter format serial to string id in permission name. Overrides ProcessPluginBase::transform
FilterFormatPermission::__construct public function Constructs a FilterFormatPermission plugin instance.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.