class PathProcessorImageStyles in Drupal 9

Defines a path processor to rewrite image styles URLs.

As the route system does not allow arbitrary amount of parameters convert the file path to a query parameter on the request.

This processor handles two different cases:

• public image styles: In order to allow the webserver to serve these files directly, the route is registered under the same path as the image style so it took over the first generation. Therefore the path processor converts the file path to a query parameter.
• private image styles: In contrast to public image styles, private derivatives are already using system/files/styles. Similar to public image styles, it also converts the file path to a query parameter.

Hierarchy

• class \Drupal\image\PathProcessor\PathProcessorImageStyles implements InboundPathProcessorInterface

1 string reference to 'PathProcessorImageStyles'

image.services.yml in core/modules/image/image.services.yml

core/modules/image/image.services.yml

1 service uses PathProcessorImageStyles

path_processor.image_styles in core/modules/image/image.services.yml

Drupal\image\PathProcessor\PathProcessorImageStyles

File

core/modules/image/src/PathProcessor/PathProcessorImageStyles.php, line 24

Namespace

Drupal\image\PathProcessor

class PathProcessorImageStyles implements InboundPathProcessorInterface {

  /**
   * The stream wrapper manager service.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
   */
  protected $streamWrapperManager;

  /**
   * Constructs a new PathProcessorImageStyles object.
   *
   * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
   *   The stream wrapper manager service.
   */
  public function __construct(StreamWrapperManagerInterface $stream_wrapper_manager) {
    $this->streamWrapperManager = $stream_wrapper_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function processInbound($path, Request $request) {
    $directory_path = $this->streamWrapperManager
      ->getViaScheme('public')
      ->getDirectoryPath();
    if (strpos($path, '/' . $directory_path . '/styles/') === 0) {
      $path_prefix = '/' . $directory_path . '/styles/';
    }
    elseif (strpos($path, '/system/files/styles/') !== FALSE) {
      $path_prefix = '/system/files/styles/';
      $path = substr($path, strpos($path, $path_prefix), strlen($path));
    }
    else {
      return $path;
    }

    // Strip out path prefix.
    $rest = preg_replace('|^' . preg_quote($path_prefix, '|') . '|', '', $path);

    // Get the image style, scheme and path.
    if (substr_count($rest, '/') >= 2) {
      list($image_style, $scheme, $file) = explode('/', $rest, 3);

      // Set the file as query parameter.
      $request->query
        ->set('file', $file);
      return $path_prefix . $image_style . '/' . $scheme;
    }
    else {
      return $path;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PathProcessorImageStyles::$streamWrapperManager	protected	property	The stream wrapper manager service.
PathProcessorImageStyles::processInbound	public	function	Processes the inbound path. Overrides InboundPathProcessorInterface::processInbound
PathProcessorImageStyles::__construct	public	function	Constructs a new PathProcessorImageStyles object.