abstract class ConfigurableProviderUsingHandlerBase in Geocoder 8.3

Provides a base class for configurable providers using handlers.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geocoder\ProviderBase implements ContainerFactoryPluginInterface, ProviderInterface
      • class \Drupal\geocoder\ProviderUsingHandlerBase
        • class \Drupal\geocoder\ConfigurableProviderUsingHandlerBase implements ConfigurableInterface, PluginFormInterface uses \Drupal\geocoder\Traits\ConfigurableProviderTrait

File

src/ConfigurableProviderUsingHandlerBase.php, line 20

Namespace

Drupal\geocoder

abstract class ConfigurableProviderUsingHandlerBase extends ProviderUsingHandlerBase implements ConfigurableInterface, PluginFormInterface {
  use ConfigurableProviderTrait;

  /**
   * The typed config manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

  /**
   * Constructs a geocoder provider plugin object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend used to cache geocoding data.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The Drupal language manager service.
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config_manager
   *   The typed config manager service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, TypedConfigManagerInterface $typed_config_manager) {
    try {

      // The typedConfigManager property needs to be set before the constructor,
      // to prevent its possible exception, and allow the
      // getConfigSchemaDefinition().
      $this->typedConfigManager = $typed_config_manager;
      parent::__construct($configuration, $plugin_id, $plugin_definition, $config_factory, $cache_backend, $language_manager);
    } catch (InvalidPluginDefinitionException $e) {
      watchdog_exception('geocoder', $e);
    }
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('cache.geocoder'), $container
      ->get('language_manager'), $container
      ->get('config.typed'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
ConfigurableProviderUsingHandlerBase::$typedConfigManager	protected	property	The typed config manager.
ConfigurableProviderUsingHandlerBase::create	public static	function	Overrides ProviderBase::create
ConfigurableProviderUsingHandlerBase::__construct	public	function	Constructs a geocoder provider plugin object. Overrides ProviderUsingHandlerBase::__construct
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.
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.
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
ProviderBase::$cacheBackend	protected	property	The cache backend used to cache geocoding data.
ProviderBase::$configFactory	protected	property	The config factory service.
ProviderBase::$languageManager	protected	property	The configurable language manager.
ProviderBase::geocode	public	function	Geocode a source string. Overrides ProviderInterface::geocode
ProviderBase::getCacheId	protected	function	Builds a cached id.
ProviderBase::process	protected	function	Provides a helper callback for geocode() and reverse().
ProviderBase::reverse	public	function	Reverse geocode latitude and longitude. Overrides ProviderInterface::reverse
ProviderUsingHandlerBase::$handler	protected	property	The provider handler.
ProviderUsingHandlerBase::$handlerWrapper	protected	property	The V4 Stateful handler wrapper.
ProviderUsingHandlerBase::doGeocode	protected	function	Overrides ProviderBase::doGeocode	1
ProviderUsingHandlerBase::doReverse	protected	function	Overrides ProviderBase::doReverse	1
ProviderUsingHandlerBase::getArguments	protected	function	Builds a list of arguments to be used by the handler.	1
ProviderUsingHandlerBase::getHandler	protected	function	Returns the provider handler.	1
ProviderUsingHandlerBase::getHandlerWrapper	protected	function	Returns the V4 Stateful wrapper.
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.