You are here

class PageTemplateSuggestions in Context 8

Same name and namespace in other branches
  1. 8.4 src/Plugin/ContextReaction/PageTemplateSuggestions.php \Drupal\context\Plugin\ContextReaction\PageTemplateSuggestions

Provides a content reaction that will let you change theme.

Plugin annotation


@ContextReaction(
  id = "page_template_suggestions",
  label = @Translation("Page template suggestions")
)

Hierarchy

Expanded class hierarchy of PageTemplateSuggestions

File

src/Plugin/ContextReaction/PageTemplateSuggestions.php, line 15

Namespace

Drupal\context\Plugin\ContextReaction
View source
class PageTemplateSuggestions extends ContextReactionPluginBase {

  /**
   * {@inheritdoc}
   */
  public function summary() {
    return $this
      ->t('Gives you ability to add template suggestions.');
  }

  /**
   * Executes the plugin.
   */
  public function execute() {
    $config = $this
      ->getConfiguration();
    return $config['suggestions'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->getConfiguration();
    $form['suggestions'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Page template suggestions'),
      '#default_value' => isset($config['suggestions']) ? $config['suggestions'] : '',
      '#description' => $this
        ->t('Enter page template suggestions such as "page__front", one per line, in order of preference (using underscores instead of hyphens). Entered template suggestions will override page.html.twig template.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $config['suggestions'] = str_replace("\r\n", "\n", $form_state
      ->getValue('suggestions'));
    $this
      ->setConfiguration($config);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContextReactionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ContextReactionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration 2
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.
PageTemplateSuggestions::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
PageTemplateSuggestions::execute public function Executes the plugin. Overrides ExecutableInterface::execute
PageTemplateSuggestions::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
PageTemplateSuggestions::summary public function Provides a human readable summary of the condition's configuration. Overrides ContextReactionInterface::summary
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.