class BodyClass in Context 8

Provides a content reaction that adds a new css class.

Plugin annotation

@ContextReaction(
  id = "body_class",
  label = @Translation("Body class")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\context\ContextReactionPluginBase implements ContextReactionInterface
      • class \Drupal\context\Plugin\ContextReaction\BodyClass

File

src/Plugin/ContextReaction/BodyClass.php, line 16

Namespace

Drupal\context\Plugin\ContextReaction

class BodyClass extends ContextReactionPluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'body_class' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function summary() {
    return $this
      ->getConfiguration()['body_class'];
  }

  /**
   * {@inheritdoc}
   */
  public function execute(array &$vars = []) {
    return [
      'class' => explode(' ', $this
        ->getConfiguration()['body_class']),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['body_class'] = [
      '#title' => $this
        ->t('Section class'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('Provides this text as additional body class in the html.html.twig.'),
      '#default_value' => $this
        ->getConfiguration()['body_class'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->setConfiguration([
      'body_class' => $form_state
        ->getValue('body_class'),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BodyClass::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
BodyClass::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ContextReactionPluginBase::defaultConfiguration
BodyClass::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
BodyClass::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
BodyClass::summary	public	function	Provides a human readable summary of the condition's configuration. Overrides ContextReactionInterface::summary
ContextReactionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ContextReactionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration	1
ContextReactionPluginBase::getId	public	function	Get the unique ID of this context reaction. Overrides ContextReactionInterface::getId
ContextReactionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration	1
ContextReactionPluginBase::validateConfigurationForm	public	function	Form validation handler is optional. Overrides PluginFormInterface::validateConfigurationForm
ContextReactionPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	4
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.
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.