class BackgroundImageFormatter in Simple Background image formatter 8

Plugin implementation of the background_image_formatter.

Plugin annotation


@FieldFormatter(
 id = "background_image_formatter",
 label = @Translation("Background Image"),
 field_types = {"image"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
    class \Drupal\background_image_formatter\Plugin\Field\FieldFormatter\BackgroundImageFormatter

Expanded class hierarchy of BackgroundImageFormatter

File

src/Plugin/Field/FieldFormatter/BackgroundImageFormatter.php, line 20

Namespace

Drupal\background_image_formatter\Plugin\Field\FieldFormatter

View source

class BackgroundImageFormatter extends ImageFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'image_style' => '',
      'background_image_output_type' => 'inline',
      'background_image_selector' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $image_styles = image_style_options(FALSE);
    $element['image_style'] = [
      '#title' => $this
        ->t('Image style'),
      '#type' => 'select',
      '#options' => $image_styles,
      '#default_value' => $this
        ->getSetting('image_style'),
      '#empty_option' => $this
        ->t('None (original image)'),
      '#description' => $this
        ->t('Select the image style to use.'),
    ];
    $element['background_image_output_type'] = [
      '#title' => $this
        ->t('Output To'),
      '#type' => 'select',
      '#options' => [
        'inline' => $this
          ->t('Write background-image to inline style attribute'),
        'css' => $this
          ->t('Write background-image to CSS selector'),
      ],
      '#default_value' => $this
        ->getSetting('background_image_output_type'),
      '#required' => TRUE,
      '#description' => $this
        ->t('Define how background-image will be printed to the dom.'),
    ];
    $element['background_image_selector'] = [
      '#title' => $this
        ->t('CSS Selector'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('background_image_selector'),
      '#required' => FALSE,
      '#description' => $this
        ->t('CSS selector that image(s) are attached to.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $image_styles = image_style_options(FALSE);
    unset($image_styles['']);
    $select_style = $this
      ->getSetting('image_style');
    if (isset($image_styles[$select_style])) {
      $summary[] = $this
        ->t('URL for image style: @style', [
        '@style' => $image_styles[$select_style],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Original image');
    }
    $summary[] = $this
      ->t('Output type: @output_type', [
      '@output_type' => $this
        ->getSetting('background_image_output_type'),
    ]);
    $summary[] = $this
      ->t('The CSS selector <code>@background_image_selector</code> will be created with the image set to the background-image property.', [
      '@background_image_selector' => $this
        ->getSetting('background_image_selector') . '_id',
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $image_style = NULL;
    if (!$this
      ->isBackgroundImageDisplay()) {
      return $elements;
    }
    $image_style = $this
      ->getSetting('image_style');
    if (!empty($image_style)) {
      $image_style = ImageStyle::load($image_style);
    }
    $files = $this
      ->getEntitiesToView($items, $langcode);
    foreach ($files as $delta => $entity) {
      if ($files instanceof EntityInterface) {
        continue;
      }
      $image_url = file_url_transform_relative(file_create_url($entity
        ->getFileUri()));
      $id = $entity
        ->id();
      if ($image_style) {
        $image_uri = $entity
          ->getFileUri();
        $image_url = ImageStyle::load($image_style
          ->getName())
          ->buildUrl($image_uri);
      }
      $selector = strip_tags($this
        ->getSetting('background_image_selector'));

      // Only add an id when using inline styles.
      if ($this
        ->getSetting('background_image_output_type') === 'inline') {
        $selector .= '_' . $id;
      }
      $theme = [
        '#background_image_selector' => $selector,
        '#image_uri' => $image_url,
      ];
      array_push($elements, $this
        ->renderElements($delta, $theme, $id));
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  protected function isBackgroundImageDisplay() {
    return $this
      ->getPluginId() == 'background_image_formatter';
  }

  /**
   * {@inheritdoc}
   */
  protected function generateCssString($theme) {
    return $theme['#background_image_selector'] . ' {background-image: url("' . $theme['#image_uri'] . '");}';
  }

  /**
   * Render image elements.
   *
   * @param int $delta
   *   If multifield number of element.
   * @param array $theme
   *   Theme render array.
   * @param string $id
   *   Field id.
   *
   * @return array|null
   *   Rendered array of elements.
   */
  public function renderElements($delta, array $theme, $id) {
    $elements = NULL;
    switch ($this
      ->getSetting('background_image_output_type')) {
      case 'css':
        $data = [
          '#tag' => 'style',
          '#value' => $this
            ->generateCssString($theme),
        ];
        $elements['#attached']['html_head'][] = [
          $data,
          'background_image_formatter_' . $id,
        ];
        break;
      case 'inline':
        $theme['#theme'] = 'background_image_formatter_inline';
        $elements[$delta] = [
          '#markup' => \Drupal::service('renderer')
            ->render($theme),
        ];
        break;
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BackgroundImageFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
BackgroundImageFormatter::generateCssString	protected	function
BackgroundImageFormatter::isBackgroundImageDisplay	protected	function
BackgroundImageFormatter::renderElements	public	function	Render image elements.
BackgroundImageFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
BackgroundImageFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
BackgroundImageFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
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
EntityReferenceFormatterBase::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
FileFormatterBase::checkAccess	protected	function	Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
FileFormatterBase::needsEntityLoad	protected	function	Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad	1
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
ImageFormatter::$currentUser	protected	property	The current user.
ImageFormatter::$imageStyleStorage	protected	property	The image style entity storage.
ImageFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	1
ImageFormatter::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct	public	function	Constructs an ImageFormatter object. Overrides FormatterBase::__construct	1
ImageFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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 BackgroundImageFormatter in Simple Background image formatter 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation