You are here

Home » API reference » Backup and Migrate 5.0.x » SourcePluginBase.php

abstract class SourcePluginBase in Backup and Migrate 5.0.x

@package Drupal\backup_migrate\Drupal\EntityPlugins

Hierarchy

Expanded class hierarchy of SourcePluginBase

5 files declare their use of SourcePluginBase
DefaultDBSourcePlugin.php in src/Plugin/BackupMigrateSource/DefaultDBSourcePlugin.php
DrupalFilesSourcePlugin.php in src/Plugin/BackupMigrateSource/DrupalFilesSourcePlugin.php
EntireSiteSourcePlugin.php in src/Plugin/BackupMigrateSource/EntireSiteSourcePlugin.php
FileDirectorySourcePlugin.php in src/Plugin/BackupMigrateSource/FileDirectorySourcePlugin.php
MySQLSourcePlugin.php in src/Plugin/BackupMigrateSource/MySQLSourcePlugin.php

File

src/Drupal/EntityPlugins/SourcePluginBase.php, line 12

Namespace

Drupal\backup_migrate\Drupal\EntityPlugins
View source 
abstract class SourcePluginBase extends WrapperPluginBase implements SourcePluginInterface {

  /**
   * {@inheritdoc}
   */
  public function alterBackupMigrate(BackupMigrateInterface $bam, $key, array $options = []) {
    $bam
      ->sources()
      ->add($key, $this
      ->getObject());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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 2
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.
SourcePluginBase::alterBackupMigrate public function Alter the backup_migrate object to add the source and required services. Overrides WrapperPluginBase::alterBackupMigrate 3
WrapperPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
WrapperPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
WrapperPluginBase::getConfig public function Return a Backup and Migrate Config object with the plugin configuration.
WrapperPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WrapperPluginBase::getObject public function Get the Backup and Migrate plugin object. 2
WrapperPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WrapperPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct