class ParagraphsClassBehavior in Paragraphs Class 8

Custom paragraph wrapper class.

Plugin annotation

@ParagraphsBehavior(
  id = "paragraphs_class_paragraph_class",
  label = @Translation("Paragraphs wrapper class"),
  description = @Translation("Allows to set wrapper class for paragraphs."),
  weight = 0,
)

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_class\Plugin\paragraphs\Behavior\ParagraphsClassBehavior

File

src/Plugin/paragraphs/Behavior/ParagraphsClassBehavior.php, line 22

Namespace

Drupal\paragraphs_class\Plugin\paragraphs\Behavior

class ParagraphsClassBehavior extends ParagraphsBehaviorBase {

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(ParagraphsType $paragraphs_type) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function view(array &$build, Paragraph $paragraph, EntityViewDisplayInterface $display, $view_mode) {
    $class = $paragraph
      ->getBehaviorSetting($this
      ->getPluginId(), 'wrapper_class');
    $build['#attributes']['class'][] = $class;
  }

  /**
   * {@inheritdoc}
   */
  public function buildBehaviorForm(ParagraphInterface $paragraph, array &$form, FormStateInterface $form_state) {
    $form['wrapper_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Wrapper class'),
      '#description' => $this
        ->t('Wrapper HTML class'),
      '#default_value' => $paragraph
        ->getBehaviorSetting($this
        ->getPluginId(), 'wrapper_class'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary(Paragraph $paragraph) {
    return [
      $this
        ->t('Wrapper class element'),
    ];
  }

}

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::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
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::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
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::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::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	1
ParagraphsBehaviorBase::validateBehaviorForm	public	function	Validates the behavior fields form. Overrides ParagraphsBehaviorInterface::validateBehaviorForm	1
ParagraphsBehaviorBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
ParagraphsBehaviorBase::__construct	public	function	Constructs a ParagraphsBehaviorBase object. Overrides PluginBase::__construct
ParagraphsClassBehavior::buildBehaviorForm	public	function	Builds a behavior perspective for each paragraph based on its type. Overrides ParagraphsBehaviorBase::buildBehaviorForm
ParagraphsClassBehavior::isApplicable	public static	function	Returns if the plugin can be used for the provided Paragraphs type. Overrides ParagraphsBehaviorBase::isApplicable
ParagraphsClassBehavior::settingsSummary	public	function	Returns a short summary for the current behavior settings. Overrides ParagraphsBehaviorBase::settingsSummary
ParagraphsClassBehavior::view	public	function	Extends the paragraph render array with behavior. Overrides ParagraphsBehaviorInterface::view
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.