class ParagraphsBackgroundPlugin in Paragraphs Collection 8

Provides a background image feature plugin.

Plugin annotation


@ParagraphsBehavior(
  id = "background",
  label = @Translation("Background"),
  description = @Translation("Image to be used as background for the paragraph."),
  weight = 3
)

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_collection_demo\Plugin\paragraphs\Behavior\ParagraphsBackgroundPlugin implements ContainerFactoryPluginInterface

Expanded class hierarchy of ParagraphsBackgroundPlugin

File

modules/paragraphs_collection_demo/src/Plugin/paragraphs/Behavior/ParagraphsBackgroundPlugin.php, line 23

Namespace

Drupal\paragraphs_collection_demo\Plugin\paragraphs\Behavior

View source

class ParagraphsBackgroundPlugin extends ParagraphsBehaviorBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $paragraphs_type = $form_state
      ->getFormObject()
      ->getEntity();
    if ($paragraphs_type
      ->isNew()) {
      return [];
    }
    $image_field_options = $this
      ->getFieldNameOptions($paragraphs_type, 'image');

    // Show Image select form only if this entity has at least one image field.
    if (count($image_field_options) > 0) {
      $form['background_image_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Background field'),
        '#description' => $this
          ->t('Image field to be used as background.'),
        '#options' => $image_field_options,
        '#empty_value' => '',
        '#default_value' => count($image_field_options) == 1 ? key($image_field_options) : $this->configuration['background_image_field'],
      ];
    }
    else {
      $form['message'] = [
        '#type' => 'container',
        '#markup' => $this
          ->t('No image field type available. Please add at least one in the <a href=":link">Manage fields</a> page.', [
          ':link' => Url::fromRoute("entity.{$paragraphs_type->getEntityType()->getBundleOf()}.field_ui_fields", [
            $paragraphs_type
              ->getEntityTypeId() => $paragraphs_type
              ->id(),
          ])
            ->toString(),
        ]),
        '#attributes' => [
          'class' => [
            'messages messages--error',
          ],
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if (!$form_state
      ->getValue('background_image_field')) {
      $form_state
        ->setErrorByName('message', $this
        ->t('The Background plugin cannot be enabled without an image field.'));
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function view(array &$build, Paragraph $paragraphs_entity, EntityViewDisplayInterface $display, $view_mode) {
    $build['#attributes']['class'][] = 'paragraphs-behavior-background';
    $build['#attached']['library'][] = 'paragraphs_collection_demo/background';
    foreach (Element::children($build) as $field) {
      if ($field == $this->configuration['background_image_field']) {

        // Put the selected field into the background.
        $build[$field]['#attributes']['class'][] = 'paragraphs-behavior-background--image';
      }
      else {

        // Identify all other elements to put them on top of the background.
        $build[$field]['#attributes']['class'][] = 'paragraphs-behavior-background--element';
      }
    }
  }

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

}

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.
ParagraphsBackgroundPlugin::buildConfigurationForm	public	function	Form constructor. Overrides ParagraphsBehaviorBase::buildConfigurationForm
ParagraphsBackgroundPlugin::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ParagraphsBehaviorBase::defaultConfiguration
ParagraphsBackgroundPlugin::submitConfigurationForm	public	function	Form submission handler. Overrides ParagraphsBehaviorBase::submitConfigurationForm
ParagraphsBackgroundPlugin::validateConfigurationForm	public	function	Form validation handler. Overrides ParagraphsBehaviorBase::validateConfigurationForm
ParagraphsBackgroundPlugin::view	public	function	Extends the paragraph render array with behavior. Overrides ParagraphsBehaviorInterface::view
ParagraphsBehaviorBase::$entityFieldManager	protected	property	The entity field manager.
ParagraphsBehaviorBase::buildBehaviorForm	public	function	Builds a behavior perspective for each paragraph based on its type. Overrides ParagraphsBehaviorInterface::buildBehaviorForm	3
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::settingsSummary	public	function	Returns a short summary for the current behavior settings. Overrides ParagraphsBehaviorInterface::settingsSummary	2
ParagraphsBehaviorBase::submitBehaviorForm	public	function	Submit the values taken from the form to store the values. Overrides ParagraphsBehaviorInterface::submitBehaviorForm
ParagraphsBehaviorBase::validateBehaviorForm	public	function	Validates the behavior fields form. Overrides ParagraphsBehaviorInterface::validateBehaviorForm	1
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.

You are here

class ParagraphsBackgroundPlugin in Paragraphs Collection 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation