You are here

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

class EntityPrintController in Entity Print 8.2

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

Print controller.

Hierarchy

Expanded class hierarchy of EntityPrintController

2 files declare their use of EntityPrintController
EntityPrintAccessTest.php in tests/src/Kernel/EntityPrintAccessTest.php
TranslationTest.php in tests/src/Kernel/TranslationTest.php

File

src/Controller/EntityPrintController.php, line 18

Namespace

Drupal\entity_print\Controller
View source 
class EntityPrintController extends ControllerBase {

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

  /**
   * The export type manager.
   *
   * @var \Drupal\entity_print\Plugin\ExportTypeManagerInterface
   */
  protected $exportTypeManager;

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

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

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityPrintPluginManagerInterface $plugin_manager, ExportTypeManagerInterface $export_type_manager, PrintBuilderInterface $print_builder, EntityTypeManagerInterface $entity_type_manager) {
    $this->pluginManager = $plugin_manager;
    $this->exportTypeManager = $export_type_manager;
    $this->printBuilder = $print_builder;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * Print an entity to the selected format.
   *
   * @param string $export_type
   *   The export type.
   * @param string $entity_type
   *   The entity type.
   * @param int $entity_id
   *   The entity id.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object on error otherwise the Print is sent.
   */
  public function viewPrint($export_type, $entity_type, $entity_id) {

    // Create the Print engine plugin.
    $config = $this
      ->config('entity_print.settings');
    $entity = $this->entityTypeManager
      ->getStorage($entity_type)
      ->load($entity_id);
    $print_engine = $this->pluginManager
      ->createSelectedInstance($export_type);
    return (new StreamedResponse(function () use ($entity, $print_engine, $config) {

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

  /**
   * A debug callback for styling up the Print.
   *
   * @param string $export_type
   *   The export type.
   * @param string $entity_type
   *   The entity type.
   * @param int $entity_id
   *   The entity id.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   *
   * @TODO, improve permissions in https://www.drupal.org/node/2759553
   */
  public function viewPrintDebug($export_type, $entity_type, $entity_id) {
    $entity = $this->entityTypeManager
      ->getStorage($entity_type)
      ->load($entity_id);
    $use_default_css = $this
      ->config('entity_print.settings')
      ->get('default_css');
    return new Response($this->printBuilder
      ->printHtml($entity, $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 $entity_type
   *   The entity type.
   * @param int $entity_id
   *   The entity id.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result object.
   */
  public function checkAccess($export_type, $entity_type, $entity_id) {
    if (empty($entity_id)) {
      return AccessResult::forbidden();
    }
    $account = $this
      ->currentUser();

    // Invalid storage type.
    if (!$this->entityTypeManager
      ->hasHandler($entity_type, 'storage')) {
      return AccessResult::forbidden();
    }

    // Unable to find the entity requested.
    if (!($entity = $this->entityTypeManager
      ->getStorage($entity_type)
      ->load($entity_id))) {
      return AccessResult::forbidden();
    }

    // Ensure it's a valid export type.
    if (!in_array($export_type, array_keys($this->exportTypeManager
      ->getDefinitions()))) {
      return AccessResult::forbidden();
    }

    // Check if the user has the permission "bypass entity print access".
    $access_result = AccessResult::allowedIfHasPermission($account, 'bypass entity print access');
    if ($access_result
      ->isAllowed()) {
      return $access_result
        ->andIf($entity
        ->access('view', $account, TRUE));
    }

    // Check if the user is allowed to view all bundles of the entity type.
    $access_result = AccessResult::allowedIfHasPermission($account, 'entity print access type ' . $entity_type);
    if ($access_result
      ->isAllowed()) {
      return $access_result
        ->andIf($entity
        ->access('view', $account, TRUE));
    }

    // Check if the user is allowed to view that bundle type.
    $access_result = AccessResult::allowedIfHasPermission($account, 'entity print access bundle ' . $entity
      ->bundle());
    if ($access_result
      ->isAllowed()) {
      return $access_result
        ->andIf($entity
        ->access('view', $account, TRUE));
    }
    return AccessResult::forbidden();
  }

  /**
   * Provides a redirect BC layer for the old routes.
   *
   * @param string $export_type
   *   The export type.
   * @param string $entity_type
   *   The entity type.
   * @param string|int $entity_id
   *   The entity type id.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The redirect response.
   */
  public function viewRedirect($export_type, $entity_type, $entity_id) {
    return $this
      ->redirect('entity_print.view', [
      'export_type' => $export_type,
      'entity_type' => $entity_type,
      'entity_id' => $entity_id,
    ]);
  }

  /**
   * Provides a redirect BC layer for the old routes.
   *
   * @param string $export_type
   *   The export type.
   * @param string $entity_type
   *   The entity type.
   * @param string|int $entity_id
   *   The entity type id.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The redirect response.
   */
  public function viewRedirectDebug($export_type, $entity_type, $entity_id) {
    return $this
      ->redirect('entity_print.view.debug', [
      'export_type' => $export_type,
      'entity_type' => $entity_type,
      'entity_id' => $entity_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.
EntityPrintController::$entityTypeManager protected property The Entity Type manager. Overrides ControllerBase::$entityTypeManager
EntityPrintController::$exportTypeManager protected property The export type manager.
EntityPrintController::$pluginManager protected property The plugin manager for our Print engines.
EntityPrintController::$printBuilder protected property The Print builder.
EntityPrintController::checkAccess public function Validate that the current user has access.
EntityPrintController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
EntityPrintController::viewPrint public function Print an entity to the selected format.
EntityPrintController::viewPrintDebug public function A debug callback for styling up the Print.
EntityPrintController::viewRedirect public function Provides a redirect BC layer for the old routes.
EntityPrintController::viewRedirectDebug public function Provides a redirect BC layer for the old routes.
EntityPrintController::__construct public function
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.