abstract class DumperBase in Geocoder 8.3

Provides a base class for geocoder dumper plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geocoder\DumperBase implements ContainerFactoryPluginInterface, DumperInterface

7 files declare their use of DumperBase

AddressText.php in src/Plugin/Geocoder/Dumper/AddressText.php

Geohash.php in modules/geocoder_geofield/src/Plugin/Geocoder/Dumper/Geohash.php

GeoJson.php in src/Plugin/Geocoder/Dumper/GeoJson.php

Gpx.php in src/Plugin/Geocoder/Dumper/Gpx.php

Kml.php in src/Plugin/Geocoder/Dumper/Kml.php

... See full list

File

src/DumperBase.php, line 13

Namespace

Drupal\geocoder

abstract class DumperBase extends PluginBase implements DumperInterface, ContainerFactoryPluginInterface {

  /**
   * The geocoder dumper handler.
   *
   * @var \Geocoder\Dumper\Dumper
   */
  protected $handler;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function dump(Location $location) {
    return $this
      ->getHandler()
      ->dump($location);
  }

  /**
   * Returns the dumper handler.
   *
   * @return \Geocoder\Dumper\Dumper
   *   Returns dumper handler.
   */
  protected function getHandler() {
    if ($this->handler === NULL) {
      $definition = $this
        ->getPluginDefinition();
      $class = $definition['handler'];
      $this->handler = new $class();
    }
    return $this->handler;
  }

}

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
DumperBase::$handler	protected	property	The geocoder dumper handler.
DumperBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
DumperBase::dump	public	function	Dumps the argument into a specific format. Overrides DumperInterface::dump	3
DumperBase::getHandler	protected	function	Returns the dumper handler.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.