class TestTextColorBehavior in Paragraphs 8

Provides a test feature plugin.

Plugin annotation


@ParagraphsBehavior(
  id = "test_text_color",
  label = @Translation("Test text color behavior plugin"),
  description = @Translation("Test text color behavior plugin"),
  weight = 1
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\paragraphs\ParagraphsBehaviorBase implements ContainerFactoryPluginInterface, ParagraphsBehaviorInterface
    class \Drupal\paragraphs_test\Plugin\paragraphs\Behavior\TestTextColorBehavior

Expanded class hierarchy of TestTextColorBehavior

File

tests/modules/paragraphs_test/src/Plugin/paragraphs/Behavior/TestTextColorBehavior.php, line 21

Namespace

Drupal\paragraphs_test\Plugin\paragraphs\Behavior

View source

class TestTextColorBehavior extends ParagraphsBehaviorBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['default_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default Color'),
      '#maxlength' => 255,
      '#default_value' => $this->configuration['default_color'],
      '#description' => $this
        ->t("Text color for the paragraph."),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('default_color') == 'red') {
      $form_state
        ->setErrorByName('default_color', $this
        ->t('Red can not be used as the default color.'));
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'default_color' => 'blue',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildBehaviorForm(ParagraphInterface $paragraph, array &$form, FormStateInterface $form_state) {
    $form['text_color'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Color'),
      '#maxlength' => 255,
      '#default_value' => $paragraph
        ->getBehaviorSetting($this
        ->getPluginId(), 'text_color', $this->configuration['default_color']),
      '#description' => $this
        ->t("Text color for the paragraph."),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateBehaviorForm(ParagraphInterface $paragraph, array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('text_color') != 'blue' && $form_state
      ->getValue('text_color') != 'red') {
      $form_state
        ->setError($form, 'The only allowed values are blue and red.');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function view(array &$build, Paragraph $paragraphs_entity, EntityViewDisplayInterface $display, $view_mode) {
    if ($color = $paragraphs_entity
      ->getBehaviorSetting($this
      ->getPluginId(), 'text_color')) {
      $build['#attributes']['class'][] = $color . '_plugin_text';
      $build['#attached']['library'][] = 'paragraphs_test/drupal.paragraphs_test.color_text';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary(Paragraph $paragraph) {
    $text_color = $paragraph
      ->getBehaviorSetting($this->pluginId, 'text_color');
    return [
      [
        'label' => $this
          ->t('Text color'),
        'value' => $text_color,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
ParagraphsBehaviorBase::$entityFieldManager	protected	property	The entity field manager.
ParagraphsBehaviorBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ParagraphsBehaviorBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ParagraphsBehaviorBase::filterBehaviorFormSubmitValues	protected	function	Removes default behavior form values before storing the user-set ones.
ParagraphsBehaviorBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ParagraphsBehaviorBase::getFieldNameOptions	public	function	Returns list of field names for the given paragraph type and field type. Overrides ParagraphsBehaviorInterface::getFieldNameOptions
ParagraphsBehaviorBase::isApplicable	public static	function	Returns if the plugin can be used for the provided Paragraphs type. Overrides ParagraphsBehaviorInterface::isApplicable	1
ParagraphsBehaviorBase::preprocess	public	function	Adds a default set of helper variables for preprocessors and templates. Overrides ParagraphsBehaviorInterface::preprocess
ParagraphsBehaviorBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ParagraphsBehaviorBase::settingsIcon	public	function	Returns a short info icon for the current behavior settings. Overrides ParagraphsBehaviorInterface::settingsIcon	1
ParagraphsBehaviorBase::submitBehaviorForm	public	function	Submit the values taken from the form to store the values. Overrides ParagraphsBehaviorInterface::submitBehaviorForm
ParagraphsBehaviorBase::__construct	public	function	Constructs a ParagraphsBehaviorBase object. Overrides PluginBase::__construct
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.
TestTextColorBehavior::buildBehaviorForm	public	function	Builds a behavior perspective for each paragraph based on its type. Overrides ParagraphsBehaviorBase::buildBehaviorForm
TestTextColorBehavior::buildConfigurationForm	public	function	Form constructor. Overrides ParagraphsBehaviorBase::buildConfigurationForm
TestTextColorBehavior::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ParagraphsBehaviorBase::defaultConfiguration
TestTextColorBehavior::settingsSummary	public	function	Returns a short summary for the current behavior settings. Overrides ParagraphsBehaviorBase::settingsSummary
TestTextColorBehavior::submitConfigurationForm	public	function	Form submission handler. Overrides ParagraphsBehaviorBase::submitConfigurationForm
TestTextColorBehavior::validateBehaviorForm	public	function	Validates the behavior fields form. Overrides ParagraphsBehaviorBase::validateBehaviorForm
TestTextColorBehavior::validateConfigurationForm	public	function	Form validation handler. Overrides ParagraphsBehaviorBase::validateConfigurationForm
TestTextColorBehavior::view	public	function	Extends the paragraph render array with behavior. Overrides ParagraphsBehaviorInterface::view

You are here

class TestTextColorBehavior in Paragraphs 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation