class PrintBuilder in Entity Print 8.2

The print builder service.

Hierarchy

• class \Drupal\entity_print\PrintBuilder implements PrintBuilderInterface uses StringTranslationTrait

1 string reference to 'PrintBuilder'

entity_print.services.yml in ./entity_print.services.yml

entity_print.services.yml

1 service uses PrintBuilder

entity_print.print_builder in ./entity_print.services.yml

Drupal\entity_print\PrintBuilder

File

src/PrintBuilder.php, line 18

Namespace

Drupal\entity_print

class PrintBuilder implements PrintBuilderInterface {
  use StringTranslationTrait;

  /**
   * The Print Renderer factory.
   *
   * @var \Drupal\entity_print\Renderer\RendererFactoryInterface
   */
  protected $rendererFactory;

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $dispatcher;

  /**
   * Constructs a new EntityPrintPrintBuilder.
   *
   * @param \Drupal\entity_print\Renderer\RendererFactoryInterface $renderer_factory
   *   The Renderer factory.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
   */
  public function __construct(RendererFactoryInterface $renderer_factory, EventDispatcherInterface $event_dispatcher, TranslationInterface $string_translation) {
    $this->rendererFactory = $renderer_factory;
    $this->dispatcher = $event_dispatcher;
    $this->stringTranslation = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public function deliverPrintable(array $entities, PrintEngineInterface $print_engine, $force_download = FALSE, $use_default_css = TRUE) {
    $renderer = $this
      ->prepareRenderer($entities, $print_engine, $use_default_css);

    // Allow other modules to alter the generated Print object.
    $this->dispatcher
      ->dispatch(PrintEvents::PRE_SEND, new PreSendPrintEvent($print_engine, $entities));

    // Calculate the filename.
    $filename = $renderer
      ->getFilename($entities) . '.' . $print_engine
      ->getExportType()
      ->getFileExtension();
    return $print_engine
      ->send($filename, $force_download);
  }

  /**
   * {@inheritdoc}
   */
  public function printHtml(EntityInterface $entity, $use_default_css = TRUE, $optimize_css = TRUE) {
    $renderer = $this->rendererFactory
      ->create([
      $entity,
    ]);
    $content[] = $renderer
      ->render([
      $entity,
    ]);
    $render = [
      '#theme' => 'entity_print__' . $entity
        ->getEntityTypeId() . '__' . $entity
        ->bundle(),
      '#title' => $this
        ->t('View'),
      '#content' => $content,
      '#attached' => [],
    ];
    return $renderer
      ->generateHtml([
      $entity,
    ], $render, $use_default_css, $optimize_css);
  }

  /**
   * {@inheritdoc}
   */
  public function savePrintable(array $entities, PrintEngineInterface $print_engine, $scheme = 'public', $filename = FALSE, $use_default_css = TRUE) {
    $renderer = $this
      ->prepareRenderer($entities, $print_engine, $use_default_css);

    // Allow other modules to alter the generated Print object.
    $this->dispatcher
      ->dispatch(PrintEvents::PRE_SEND, new PreSendPrintEvent($print_engine, $entities));

    // If we didn't have a URI passed in the generate one.
    if (!$filename) {
      $filename = $renderer
        ->getFilename($entities) . '.' . $print_engine
        ->getExportType()
        ->getFileExtension();
    }
    $uri = "{$scheme}://{$filename}";

    // Save the file.
    return \Drupal::service('file_system')
      ->saveData($print_engine
      ->getBlob(), $uri, FileSystemInterface::EXISTS_REPLACE);
  }

  /**
   * Configure the print engine with the passed entities.
   *
   * @param array $entities
   *   An array of entities.
   * @param \Drupal\entity_print\Plugin\PrintEngineInterface $print_engine
   *   The print engine.
   * @param bool $use_default_css
   *   TRUE if we want the default CSS included.
   *
   * @return \Drupal\entity_print\Renderer\RendererInterface
   *   A print renderer.
   */
  protected function prepareRenderer(array $entities, PrintEngineInterface $print_engine, $use_default_css) {
    if (empty($entities)) {
      throw new \InvalidArgumentException('You must pass at least 1 entity');
    }
    $renderer = $this->rendererFactory
      ->create($entities);
    $content = $renderer
      ->render($entities);
    $first_entity = reset($entities);
    $render = [
      '#theme' => 'entity_print__' . $first_entity
        ->getEntityTypeId() . '__' . $first_entity
        ->bundle(),
      '#title' => $this
        ->t('View @type', [
        '@type' => $print_engine
          ->getExportType()
          ->label(),
      ]),
      '#content' => $content,
      '#attached' => [],
    ];
    $print_engine
      ->addPage($renderer
      ->generateHtml($entities, $render, $use_default_css, TRUE));
    return $renderer;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PrintBuilder::$dispatcher	protected	property	The event dispatcher.
PrintBuilder::$rendererFactory	protected	property	The Print Renderer factory.
PrintBuilder::deliverPrintable	public	function	Render any content entity as a Print. Overrides PrintBuilderInterface::deliverPrintable
PrintBuilder::prepareRenderer	protected	function	Configure the print engine with the passed entities.
PrintBuilder::printHtml	public	function	Get a HTML version of the entity as used for the Print rendering. Overrides PrintBuilderInterface::printHtml
PrintBuilder::savePrintable	public	function	Render any content entity as a printed document and save to disk. Overrides PrintBuilderInterface::savePrintable
PrintBuilder::__construct	public	function	Constructs a new EntityPrintPrintBuilder.
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.