You are here

Home » API reference » Entity Print 8.2 » ViewPrintController.php

class ViewPrintController in Entity Print 8.2

Controller class for printing Views.

Hierarchy

Expanded class hierarchy of ViewPrintController

1 file declares its use of ViewPrintController
ViewsAccessTest.php in modules/entity_print_views/tests/src/Kernel/ViewsAccessTest.php

File

modules/entity_print_views/src/Controller/ViewPrintController.php, line 24

Namespace

Drupal\entity_print_views\Controller
View source 
class ViewPrintController extends ControllerBase {

  /**
   * The plugin manager for our Print engines.
   *
   * @var \Drupal\entity_print\Plugin\EntityPrintPluginManagerInterface
   */
  protected $pluginManager;

  /**
   * The Print builder.
   *
   * @var \Drupal\entity_print\PrintBuilderInterface
   */
  protected $printBuilder;

  /**
   * The Entity Type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityPrintPluginManagerInterface $plugin_manager, PrintBuilderInterface $print_builder, EntityTypeManagerInterface $entity_type_manager, Request $current_request, AccountInterface $current_user) {
    $this->pluginManager = $plugin_manager;
    $this->printBuilder = $print_builder;
    $this->entityTypeManager = $entity_type_manager;
    $this->currentRequest = $current_request;
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.entity_print.print_engine'), $container
      ->get('entity_print.print_builder'), $container
      ->get('entity_type.manager'), $container
      ->get('request_stack')
      ->getCurrentRequest(), $container
      ->get('current_user'));
  }

  /**
   * Print an entity to the selected format.
   *
   * @param string $export_type
   *   The export type.
   * @param string $view_name
   *   The view name.
   * @param string $display_id
   *   The view display to render.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object on error otherwise the Print is sent.
   */
  public function viewPrint($export_type, $view_name, $display_id) {

    // Create the Print engine plugin.
    $config = $this
      ->config('entity_print.settings');

    /** @var \Drupal\views\Entity\View $view */
    $view = $this->entityTypeManager
      ->getStorage('view')
      ->load($view_name);
    $executable = $view
      ->getExecutable();
    $executable
      ->setDisplay($display_id);
    if ($args = $this->currentRequest->query
      ->get('view_args')) {
      $executable
        ->setArguments($args);
    }
    try {
      $print_engine = $this->pluginManager
        ->createSelectedInstance($export_type);
    } catch (PrintEngineException $e) {

      // Build a safe markup string using Xss::filter() so that the instructions
      // for installing dependencies can contain quotes.
      $this
        ->messenger()
        ->addError(new FormattableMarkup('Error generating Print: ' . Xss::filter($e
        ->getMessage()), []));
      $url = $executable
        ->hasUrl(NULL, $display_id) ? $executable
        ->getUrl(NULL, $display_id)
        ->toString() : Url::fromRoute('<front>');
      return new RedirectResponse($url);
    }
    return (new StreamedResponse(function () use ($view, $print_engine, $config) {

      // The printed document is sent straight to the browser.
      $this->printBuilder
        ->deliverPrintable([
        $view,
      ], $print_engine, $config
        ->get('force_download'), $config
        ->get('default_css'));
    }))
      ->send();
  }

  /**
   * Print the debug output.
   *
   * @param string $export_type
   *   The export type machine name.
   * @param string $view_name
   *   The machine name of the view.
   * @param string $display_id
   *   The machine name of the display.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function viewPrintDebug($export_type, $view_name, $display_id) {

    /** @var \Drupal\views\Entity\View $view */
    $view = $this->entityTypeManager
      ->getStorage('view')
      ->load($view_name);
    $executable = $view
      ->getExecutable();
    $executable
      ->setDisplay($display_id);
    if ($args = $this->currentRequest->query
      ->get('view_args')) {
      $executable
        ->setArguments($args);
    }
    $use_default_css = $this
      ->config('entity_print.settings')
      ->get('default_css');
    return new Response($this->printBuilder
      ->printHtml($view, $use_default_css, FALSE));
  }

  /**
   * Validate that the current user has access.
   *
   * We need to validate that the user is allowed to access this entity also the
   * print version.
   *
   * @param string $export_type
   *   The export type.
   * @param string $view_name
   *   The view name.
   * @param string $display_id
   *   The view display to render.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result object.
   *
   * @TODO, improve permissions in https://www.drupal.org/node/2759553
   */
  public function checkAccess($export_type, $view_name, $display_id) {
    $view = $this->entityTypeManager
      ->getStorage('view')
      ->load($view_name)
      ->getExecutable();
    $account = $this
      ->currentUser();

    // Check the Entity Print Views permission.
    $result = AccessResult::allowedIfHasPermission($account, 'entity print views access');

    // Also check the permissions defined by the view.
    return $result
      ->isAllowed() && $view
      ->access($display_id, $account) ? $result : AccessResult::forbidden();
  }

  /**
   * Provides a redirect BC layer for the old routes.
   *
   * @param string $export_type
   *   The export type.
   * @param string $view_name
   *   The view machine name.
   * @param string $display_id
   *   The machine name of the display.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The redirect response.
   */
  public function viewRedirect($export_type, $view_name, $display_id) {
    return $this
      ->redirect('entity_print_views.view', [
      'export_type' => $export_type,
      'view_name' => $view_name,
      'display_id' => $display_id,
    ]);
  }

  /**
   * Provides a redirect BC layer for the old routes.
   *
   * @param string $export_type
   *   The export type.
   * @param string $view_name
   *   The view machine name.
   * @param string $display_id
   *   The machine name of the display.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The redirect response.
   */
  public function viewRedirectDebug($export_type, $view_name, $display_id) {
    return $this
      ->redirect('entity_print_views.view.debug', [
      'export_type' => $export_type,
      'view_name' => $view_name,
      'display_id' => $display_id,
    ]);
  }

}

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::$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.
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.
ViewPrintController::$currentRequest protected property The current request.
ViewPrintController::$entityTypeManager protected property The Entity Type manager. Overrides ControllerBase::$entityTypeManager
ViewPrintController::$pluginManager protected property The plugin manager for our Print engines.
ViewPrintController::$printBuilder protected property The Print builder.
ViewPrintController::checkAccess public function Validate that the current user has access.
ViewPrintController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ViewPrintController::viewPrint public function Print an entity to the selected format.
ViewPrintController::viewPrintDebug public function Print the debug output.
ViewPrintController::viewRedirect public function Provides a redirect BC layer for the old routes.
ViewPrintController::viewRedirectDebug public function Provides a redirect BC layer for the old routes.
ViewPrintController::__construct public function