class InlineResponsiveImage in Inline responsive images 8

Plugin annotation

@Filter(
  id = "inline_responsive_image",
  title = @Translation("Inline responsive images"),
  description = @Translation("Filter for inline responsive images"),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\filter\Plugin\FilterBase implements FilterInterface
      • class \Drupal\inline_responsive_image\Plugin\Filter\InlineResponsiveImage

File

src/Plugin/Filter/InlineResponsiveImage.php, line 18

Namespace

Drupal\inline_responsive_image\Plugin\Filter

class InlineResponsiveImage extends FilterBase {
  public function process($text, $langcode) {
    $result = new FilterProcessResult($text);
    if (stristr($text, 'data-style') !== FALSE) {
      $dom = Html::load($text);
      $xpath = new \DOMXPath($dom);
      foreach ($xpath
        ->query('//*[@data-style]') as $node) {
        $style = $node
          ->getAttribute('data-style');
        $caption = $node
          ->getAttribute('data-caption');
        $align = $node
          ->getAttribute('data-align');
        $entityUuid = $node
          ->getAttribute('data-entity-uuid');
        list($type, $style_name) = explode(':', $style);
        $file = \Drupal::entityManager()
          ->loadEntityByUuid('file', $entityUuid);
        if ($file) {
          $responsiveImage = [];
          if ($type === 'responsive') {
            $responsiveImage = [
              '#theme' => 'inline_responsive_image',
              '#image' => [
                '#type' => 'responsive_image',
                '#responsive_image_style_id' => $style_name,
                '#uri' => $file
                  ->getFileUri(),
              ],
              '#attributes' => [
                'class' => [],
              ],
              '#caption' => !empty($caption) ? $caption : '',
            ];
          }
          elseif ($type === 'imagestyle') {
            $responsiveImage = [
              '#theme' => 'inline_responsive_image',
              '#image' => [
                '#theme' => 'image_style',
                '#style_name' => $style_name,
                '#uri' => $file
                  ->getFileUri(),
              ],
              '#attributes' => [
                'class' => [],
              ],
              '#caption' => !empty($caption) ? $caption : '',
            ];
          }
          if (count($responsiveImage) > 0) {
            $responsiveImage['#attributes']['class'][] = $style;
            if (!empty($align)) {
              $responsiveImage['#attributes']['class'][] = $align;
            }
            $responsiveImageHtml = \Drupal::service('renderer')
              ->render($responsiveImage);
            $fragment = $dom
              ->createDocumentFragment();
            if ($fragment
              ->appendXML($responsiveImageHtml)) {
              $node->parentNode
                ->replaceChild($fragment, $node);
            }
          }
        }
      }
      $result
        ->setProcessedText(Html::serialize($dom));
    }
    return $result;
  }

}

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
FilterBase::$provider	public	property	The name of the provider that owns this filter.
FilterBase::$settings	public	property	An associative array containing the configured settings of this filter.
FilterBase::$status	public	property	A Boolean indicating whether this filter is enabled.
FilterBase::$weight	public	property	The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
FilterBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription	public	function	Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions	public	function	Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions	4
FilterBase::getLabel	public	function	Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType	public	function	Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare	public	function	Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
FilterBase::settingsForm	public	function	Generates a filter's settings form. Overrides FilterInterface::settingsForm	3
FilterBase::tips	public	function	Generates a filter's tip. Overrides FilterInterface::tips	9
FilterBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	4
FilterInterface::TYPE_HTML_RESTRICTOR		constant	HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE		constant	Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE		constant	Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE		constant	Reversible transformation filters.
InlineResponsiveImage::process	public	function	Performs the filter processing. Overrides FilterInterface::process
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.
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.