You are here

Home » API reference » Retina Images 8 » PreviewController.php

class PreviewController in Retina Images 8

Class PreviewController @package Drupal\retina_images\Controller

Hierarchy

Expanded class hierarchy of PreviewController

File

src/Controller/PreviewController.php, line 23
Controller for alternate preview image.

Namespace

Drupal\retina_images\Controller
View source 
class PreviewController extends ControllerBase {

  /**
   * Image settings config.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * The image factory.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * A logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a ImageStyleDownloadController object.
   *
   * @param \Drupal\Core\Image\ImageFactory $image_factory
   *   The image factory.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   */
  public function __construct(ImageFactory $image_factory, LoggerInterface $logger, ImmutableConfig $immutableConfig) {
    $this->imageFactory = $image_factory;
    $this->logger = $logger;
    $this->config = $immutableConfig;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('image.factory'), $container
      ->get('logger.factory')
      ->get('image'), $container
      ->get('config.factory')
      ->get('image.settings'));
  }

  /**
   * Deliver a retina version of the preview image.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   * @param \Drupal\image\ImageStyleInterface $image_style
   */
  public function preview(Request $request, ImageStyleInterface $image_style) {
    $original_path = $this->config
      ->get('preview_image');

    // Set up derivative file information.
    $preview_file = $image_style
      ->buildUri($original_path);

    // Create derivative if necessary.
    if (!file_exists($preview_file)) {
      $image_style
        ->createDerivative($original_path, $preview_file);
    }
    $preview_image = $this->imageFactory
      ->get($preview_file);
    $path_info = pathinfo($preview_file);
    $filename = $path_info['basename'];
    $variables['derivative'] = [
      'url' => file_url_transform_relative(file_create_url($preview_file)),
      'width' => $preview_image
        ->getWidth(),
      'height' => $preview_image
        ->getHeight(),
    ];
    $image_style
      ->transformDimensions($variables['derivative'], $preview_file);
    $image = [
      '#theme' => 'image',
      '#uri' => $variables['derivative']['url'] . '?cache_bypass=' . REQUEST_TIME,
      '#attributes' => [
        'width' => $variables['derivative']['width'],
        'height' => $variables['derivative']['height'],
      ],
    ];
    $image_tag = drupal_render($image);
    $output = <<<EOT
<html>
  <head>
  <title>{<span class="php-variable">$filename</span>} {<span class="php-variable">$variables</span>[<span class="php-string">'derivative'</span>][<span class="php-string">'width'</span>]}&times;{<span class="php-variable">$variables</span>[<span class="php-string">'derivative'</span>][<span class="php-string">'height'</span>]} pixels</title>
  </head>
  <body>
    {<span class="php-variable">$image_tag</span>}
  </body>
</html>

EOT;
    return Response::create($output);
  }

}

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::$entityManager protected property The entity manager.
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::entityManager Deprecated protected function Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PreviewController::$config protected property Image settings config.
PreviewController::$imageFactory protected property The image factory.
PreviewController::$logger protected property A logger instance.
PreviewController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
PreviewController::preview public function Deliver a retina version of the preview image.
PreviewController::__construct public function Constructs a ImageStyleDownloadController object.
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. 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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.