class FilterFormatPermission
Same name in other branches
- 9 core/modules/filter/src/Plugin/migrate/process/d6/FilterFormatPermission.php \Drupal\filter\Plugin\migrate\process\d6\FilterFormatPermission
- 10 core/modules/filter/src/Plugin/migrate/process/d6/FilterFormatPermission.php \Drupal\filter\Plugin\migrate\process\d6\FilterFormatPermission
- 11.x 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.
Plugin annotation
@MigrateProcessPlugin(
id = "filter_format_permission",
handle_multiples = TRUE
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\filter\Plugin\migrate\process\d6\FilterFormatPermission extends \Drupal\migrate\ProcessPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of FilterFormatPermission
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 22
Namespace
Drupal\filter\Plugin\migrate\process\d6View source
class FilterFormatPermission extends ProcessPluginBase implements ContainerFactoryPluginInterface {
/**
* The Migration process plugin.
*
* @var \Drupal\migrate\Plugin\MigrateProcessInterface
*
* @deprecated in drupal:8.8.x and is removed from drupal:9.0.0. Use
* the migrate.lookup service instead.
*
* @see https://www.drupal.org/node/3047268
*/
protected $migrationPlugin;
/**
* 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.
*/
// @codingStandardsIgnoreLine
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, $migrate_lookup) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
if ($migrate_lookup instanceof MigrateProcessInterface) {
@trigger_error('Passing a migration process plugin as the fourth argument to ' . __METHOD__ . ' is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268', E_USER_DEPRECATED);
$this->migrationPlugin = $migrate_lookup;
$migrate_lookup = \Drupal::service('migrate.lookup');
}
elseif (!$migrate_lookup instanceof MigrateLookupInterface) {
throw new \InvalidArgumentException("The fifth argument to " . __METHOD__ . " must be an instance of MigrateLookupInterface.");
}
$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 = isset($this->configuration['migration']) ? $this->configuration['migration'] : 'd6_filter_format';
if ($formats = $row->getSourceProperty("filter_permissions:{$rid}")) {
foreach ($formats as $format) {
// This BC layer is included because if the plugin constructor was
// called in the legacy way with a migration_lookup process plugin, it
// may have been preconfigured with a different migration to look up
// against. While this is unlikely, for maximum BC we will continue to
// use the plugin to do the lookup if it is provided, and support for
// this will be removed in Drupal 9.
if ($this->migrationPlugin) {
$new_id = $this->migrationPlugin
->transform($format, $migrate_executable, $row, $destination_property);
}
else {
$lookup_result = $this->migrateLookup
->lookup($migration, [
$format,
]);
if ($lookup_result) {
$new_id = $lookup_result[0]['format'];
}
}
if (!empty($new_id)) {
$value[] = 'use text format ' . $new_id;
}
}
}
return $value;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
FilterFormatPermission::$migrateLookup | protected | property | The migrate lookup service. | |||
FilterFormatPermission::$migrationPlugin | Deprecated | protected | property | The Migration process plugin. | ||
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 | ||||
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::multiple | public | function | Indicates whether the returned value requires multiple handling. | Overrides MigrateProcessInterface::multiple | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.