class PirateFilter in Config Filter 8

Provides a pirate filter that adds "Arrr" to the site name.

Plugin annotation

@ConfigFilter(
  id = "pirate_filter",
  label = "More pirates! Arrr",
  weight = 10
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\config_filter\Plugin\ConfigFilterBase implements ConfigFilterInterface uses TransparentStorageFilterTrait
      • class \Drupal\config_filter_test\Plugin\ConfigFilter\PirateFilter

File

tests/modules/config_filter_test/src/Plugin/ConfigFilter/PirateFilter.php, line 16

Namespace

Drupal\config_filter_test\Plugin\ConfigFilter

class PirateFilter extends ConfigFilterBase {

  /**
   * {@inheritdoc}
   */
  public function filterRead($name, $data) {
    if ($name == 'system.site') {
      $data['name'] = $data['name'] . ' Arrr';
    }
    if ($name === 'system.pirates' && \Drupal::state()
      ->get('config_filter_test_bluff', FALSE)) {
      $data['captain'] = 'n/a';
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function filterReadMultiple(array $names, array $data) {
    if (in_array('system.site', $names)) {
      $data['system.site'] = $this
        ->filterRead('system.site', $data['system.site']);
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function filterListAll($prefix, array $data) {
    return array_merge($data, [
      'system.pirates',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function filterExists($name, $exists) {
    if ($name === 'system.pirates' && \Drupal::state()
      ->get('config_filter_test_bluff', FALSE)) {
      return TRUE;
    }
    return $exists;
  }

  /**
   * {@inheritdoc}
   */
  public function filterWrite($name, array $data) {
    if ($name == 'system.site') {
      $data['slogan'] = $data['slogan'] . ' Arrr';
    }
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PirateFilter::filterExists	public	function	Overrides TransparentStorageFilterTrait::filterExists
PirateFilter::filterListAll	public	function	Overrides TransparentStorageFilterTrait::filterListAll
PirateFilter::filterRead	public	function	Overrides TransparentStorageFilterTrait::filterRead
PirateFilter::filterReadMultiple	public	function	Overrides TransparentStorageFilterTrait::filterReadMultiple
PirateFilter::filterWrite	public	function	Overrides TransparentStorageFilterTrait::filterWrite
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TransparentStorageFilterTrait::$filtered	protected	property	The wrapped storage which calls the filter.
TransparentStorageFilterTrait::$source	protected	property	The read-only source storage on which the filter operations are performed.
TransparentStorageFilterTrait::filterCreateCollection	public	function		1
TransparentStorageFilterTrait::filterDelete	public	function		1
TransparentStorageFilterTrait::filterDeleteAll	public	function		1
TransparentStorageFilterTrait::filterGetAllCollectionNames	public	function
TransparentStorageFilterTrait::filterGetCollectionName	public	function
TransparentStorageFilterTrait::filterRename	public	function
TransparentStorageFilterTrait::filterWriteEmptyIsDelete	public	function		1
TransparentStorageFilterTrait::getFilteredStorage	protected	function	Get the decorator storage which applies the filters.
TransparentStorageFilterTrait::getSourceStorage	protected	function	Get the read-only source Storage.
TransparentStorageFilterTrait::setFilteredStorage	public	function
TransparentStorageFilterTrait::setSourceStorage	public	function