abstract class RabbitHoleEntityPluginBase in Rabbit Hole 2.x

Base class for Rabbit hole entity plugin plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\rabbit_hole\Plugin\RabbitHoleEntityPluginBase implements RabbitHoleEntityPluginInterface

7 files declare their use of RabbitHoleEntityPluginBase

File.php in modules/rh_file/src/Plugin/RabbitHoleEntityPlugin/File.php

Group.php in modules/rh_group/src/Plugin/RabbitHoleEntityPlugin/Group.php

Media.php in modules/rh_media/src/Plugin/RabbitHoleEntityPlugin/Media.php

Node.php in modules/rh_node/src/Plugin/RabbitHoleEntityPlugin/Node.php

Product.php in modules/rh_commerce/src/Plugin/RabbitHoleEntityPlugin/Product.php

... See full list

File

src/Plugin/RabbitHoleEntityPluginBase.php, line 11

Namespace

Drupal\rabbit_hole\Plugin

abstract class RabbitHoleEntityPluginBase extends PluginBase implements RabbitHoleEntityPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function getFormSubmitHandlerAttachLocations(array $form, FormStateInterface $form_state) {
    return [
      [
        'actions',
        'submit',
        '#submit',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getBundleFormSubmitHandlerAttachLocations(array $form, FormStateInterface $form_state) {
    return [
      [
        'actions',
        'submit',
        '#submit',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getGlobalConfigFormId() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getGlobalFormSubmitHandlerAttachLocations(array $form, FormStateInterface $form_state) {
    return [
      [
        'actions',
        'submit',
        '#submit',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityTokenMap() {
    $map = [];
    $map[$this->pluginDefinition['entityType']] = $this->pluginDefinition['entityType'];
    $bundle = \Drupal::entityTypeManager()
      ->getDefinition($this->pluginDefinition['entityType'])
      ->getBundleEntityType();
    if (!empty($bundle)) {
      $map[$bundle] = $bundle;
    }
    return $map;
  }

}

Members

Name	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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
RabbitHoleEntityPluginBase::getBundleFormSubmitHandlerAttachLocations	public	function	Return locations to attach submit handlers to entity bundle form. Overrides RabbitHoleEntityPluginInterface::getBundleFormSubmitHandlerAttachLocations	1
RabbitHoleEntityPluginBase::getEntityTokenMap	public	function	Return a map of entity IDs used by this plugin to token IDs. Overrides RabbitHoleEntityPluginInterface::getEntityTokenMap	1
RabbitHoleEntityPluginBase::getFormSubmitHandlerAttachLocations	public	function	Return locations to attach submit handlers to entities. Overrides RabbitHoleEntityPluginInterface::getFormSubmitHandlerAttachLocations
RabbitHoleEntityPluginBase::getGlobalConfigFormId	public	function	Return the form ID of the config form for this plugin's entity. Overrides RabbitHoleEntityPluginInterface::getGlobalConfigFormId	1
RabbitHoleEntityPluginBase::getGlobalFormSubmitHandlerAttachLocations	public	function	Return locations to attach submit handlers to the global config form. Overrides RabbitHoleEntityPluginInterface::getGlobalFormSubmitHandlerAttachLocations	1