You are here

Home » API reference » ImageAPI Optimize WebP 2.x » ImageStyleDownloadController.php

class ImageStyleDownloadController in ImageAPI Optimize WebP 2.x

Same name and namespace in other branches
  1. 8 src/Controller/ImageStyleDownloadController.php \Drupal\imageapi_optimize_webp\Controller\ImageStyleDownloadController

Defines a controller to serve image styles.

Hierarchy

Expanded class hierarchy of ImageStyleDownloadController

File

src/Controller/ImageStyleDownloadController.php, line 15

Namespace

Drupal\imageapi_optimize_webp\Controller
View source 
class ImageStyleDownloadController extends CoreImageStyleDownloadController {

  /**
   * Lookup potential source files based on webp uri.
   *
   * @param string $image_uri
   *   The webp image uri.
   *
   * @return mixed|null
   *   The source image uri.
   */
  public function lookupSourceImage($image_uri) {
    $source_image = substr($image_uri, 0, strrpos($image_uri, "."));
    if ($source_image . '.webp' === $image_uri) {
      return $source_image;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function deliver(Request $request, $scheme, ImageStyleInterface $image_style) {
    $target = $request->query
      ->get('file');
    $path_info = pathinfo($target);

    // If .webp file, look for image to derive from.
    if ($path_info['extension'] == 'webp') {
      $image_uri = $scheme . '://' . $target;

      // Continue processing if source found, else throw NotFoundHttpException.
      if ($source_uri = $this
        ->lookupSourceImage($image_uri)) {

        // Replace webp image with source image and call parent:deliver().
        $request->query
          ->set('file', str_replace($scheme . '://', '', $source_uri));
        $source_response = parent::deliver($request, $scheme, $image_style);
        $derivative_uri = $image_style
          ->buildUri($image_uri);

        // If parent:deliver() returns BinaryFileResponse, we'll replace
        // the BinaryFileResponse with one containing the .webp image
        // so long as it exists.
        if ($source_response instanceof BinaryFileResponse) {
          if (file_exists($derivative_uri)) {
            $image = $this->imageFactory
              ->get($derivative_uri);
            $uri = $image
              ->getSource();
            $headers = [
              'Content-Type' => 'image/webp',
              'Content-Length' => $image
                ->getFileSize(),
            ];
            return new BinaryFileResponse($uri, 200, $headers, $scheme !== 'private');
          }

          // If the derivative does not exist, return a failed reponse.
          return new Response($this
            ->t('Error generating image.'), 500);
        }

        // If we get any response other than BinaryFileResponse,
        // then return the response unchanged.
        return $source_response;
      }
      throw new NotFoundHttpException();
    }
    else {
      return parent::deliver($request, $scheme, $image_style);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
FileDownloadController::$streamWrapperManager protected property The stream wrapper manager.
FileDownloadController::download public function Handles private file transfers.
ImageStyleDownloadController::$fileSystem protected property File system service.
ImageStyleDownloadController::$imageFactory protected property The image factory.
ImageStyleDownloadController::$lock protected property The lock backend.
ImageStyleDownloadController::$logger protected property A logger instance.
ImageStyleDownloadController::create public static function Instantiates a new instance of this class. Overrides FileDownloadController::create
ImageStyleDownloadController::deliver public function Generates a derivative, given a style and image path. Overrides ImageStyleDownloadController::deliver
ImageStyleDownloadController::lookupSourceImage public function Lookup potential source files based on webp uri.
ImageStyleDownloadController::__construct public function Constructs an ImageStyleDownloadController object. Overrides FileDownloadController::__construct
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.