You are here

Home » API reference » Extra Field Settings Provider 8.2 » ExtraFieldPlusFormManager.php

class ExtraFieldPlusFormManager in Extra Field Settings Provider 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/ExtraFieldPlusFormManager.php \Drupal\extra_field_plus\Plugin\ExtraFieldPlusFormManager

Manages Extra Field Plus plugins settings forms.

Hierarchy

Expanded class hierarchy of ExtraFieldPlusFormManager

1 file declares its use of ExtraFieldPlusFormManager
ExtraFieldPluginListController.php in src/Controller/ExtraFieldPluginListController.php
1 string reference to 'ExtraFieldPlusFormManager'
extra_field_plus.services.yml in ./extra_field_plus.services.yml
extra_field_plus.services.yml
1 service uses ExtraFieldPlusFormManager
plugin.manager.extra_field_plus.form in ./extra_field_plus.services.yml
Drupal\extra_field_plus\Plugin\ExtraFieldPlusFormManager

File

src/Plugin/ExtraFieldPlusFormManager.php, line 13

Namespace

Drupal\extra_field_plus\Plugin
View source 
class ExtraFieldPlusFormManager extends DefaultPluginManager {

  /**
   * Constructor for ExtraFieldPlusFormManager objects.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/ExtraField/Display', $namespaces, $module_handler, 'Drupal\\extra_field_plus\\Plugin\\ExtraFieldPlusDisplayInterface', 'Drupal\\extra_field\\Annotation\\ExtraFieldDisplay');
    $this
      ->alterInfo('extra_field_display_info');
    $this
      ->setCacheBackend($cache_backend, 'extra_field_display_plugins');
  }

  /**
   * Gets extra field settings form.
   *
   * @param string $field_name
   *   The extra field machine name.
   *
   * @return array
   *   Array with form fields or empty array.
   */
  public function getSettingsForm($field_name) {
    if (substr($field_name, 0, 12) === 'extra_field_') {
      $plugin_id = substr($field_name, 12);
    }
    else {
      return [];
    }
    try {
      $plugin = $this
        ->getFactory()
        ->createInstance($plugin_id);
    } catch (Exception $e) {

      // Return empty array for wrong plugins.
      return [];
    }
    return $plugin
      ->getSettingsForm();
  }

  /**
   * Checks if extra field has settings form.
   *
   * @param string $plugin_id
   *   The extra field plugin id.
   *
   * @return bool
   *   True if plugin has form, false otherwise.
   */
  public function hasSettingsForm($plugin_id) {
    try {
      $plugin = $this
        ->getFactory()
        ->createInstance($plugin_id);
    } catch (Exception $e) {

      // Return false for wrong plugins.
      return FALSE;
    }
    return !empty($plugin
      ->getSettingsForm()) ? TRUE : FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults protected property A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery 12
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 13
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
ExtraFieldPlusFormManager::getSettingsForm public function Gets extra field settings form.
ExtraFieldPlusFormManager::hasSettingsForm public function Checks if extra field has settings form.
ExtraFieldPlusFormManager::__construct public function Constructor for ExtraFieldPlusFormManager objects. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance public function Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance 12
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 7
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.