class GeneratePdf in PDF using mPDF 8

Class GeneratePdf.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\pdf_using_mpdf\Controller\GeneratePdf implements ContainerInjectionInterface

File

src/Controller/GeneratePdf.php, line 21

Namespace

Drupal\pdf_using_mpdf\Controller

class GeneratePdf extends ControllerBase implements ContainerInjectionInterface {

  /**
   * Convert to PDF service.
   *
   * @var \Drupal\pdf_using_mpdf\Conversion\ConvertToPdf
   */
  protected $convert;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\Renderer
   */
  protected $renderer;

  /**
   * The configuration factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('pdf_using_mpdf.conversion'), $container
      ->get('entity_type.manager'), $container
      ->get('renderer'), $container
      ->get('config.factory'));
  }

  /**
   * GeneratePdf constructor.
   *
   * @param \Drupal\pdf_using_mpdf\Conversion\ConvertToPdf $convert
   *   Convert to PDF service.
   * @param \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\Core\Render\Renderer $renderer
   *   The renderer service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The configuration factory service.
   */
  public function __construct(ConvertToPdf $convert, EntityTypeManager $entityTypeManager, Renderer $renderer, ConfigFactoryInterface $configFactory) {
    $this->convert = $convert;
    $this->entityTypeManager = $entityTypeManager;
    $this->renderer = $renderer;
    $this->configFactory = $configFactory;
  }

  /**
   * Checks if current user has access to view PDF.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Current user account.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   True if user has access, false otherwise.
   */
  public function checkAccess(AccountInterface $account) {
    return AccessResult::allowedIf($account
      ->hasPermission('generate pdf using mpdf') && $this
      ->checkContentTypeEnabled());
  }

  /**
   * Checks if current node is enabled for viewing in PDF.
   *
   * @return bool
   *   True if content type enabled, false otherwise.
   */
  protected function checkContentTypeEnabled() {
    $node = \Drupal::routeMatch()
      ->getParameter('node');
    if ($node instanceof NodeInterface) {
      $config = $this->configFactory
        ->getEditable('pdf_using_mpdf.settings')
        ->get('pdf_using_mpdf');
      if (in_array($node
        ->getType(), $config['enabled_content_types'])) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Generate a PDF file of a node.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node object.
   *
   * @return array
   *   Response headers.
   *
   * @throws \Exception
   */
  public function generate(NodeInterface $node) {
    $build = $this->entityTypeManager
      ->getViewBuilder('node')
      ->view($node, 'pdf_using_mpdf');
    $fileContent = $this->convert
      ->convertToString($this->renderer
      ->render($build));
    $response = new Response($fileContent);
    $disposition = $response->headers
      ->makeDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, $this->convert
      ->getFilename());
    $response->headers
      ->set('Content-Disposition', $disposition);
    $response->headers
      ->set('Content-type', 'application/pdf');
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
GeneratePdf::$configFactory	protected	property	The configuration factory service. Overrides ControllerBase::$configFactory
GeneratePdf::$convert	protected	property	Convert to PDF service.
GeneratePdf::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
GeneratePdf::$renderer	protected	property	The renderer service.
GeneratePdf::checkAccess	public	function	Checks if current user has access to view PDF.
GeneratePdf::checkContentTypeEnabled	protected	function	Checks if current node is enabled for viewing in PDF.
GeneratePdf::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
GeneratePdf::generate	public	function	Generate a PDF file of a node.
GeneratePdf::__construct	public	function	GeneratePdf constructor.
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.