class WebformEntityPrintAttachment in Webform 8.5

Provides a 'webform_entity_print_attachment' element.

Plugin annotation

@FormElement("webform_entity_print_attachment");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\webform_attachment\Element\WebformAttachmentBase implements WebformAttachmentInterface
        • class \Drupal\webform_entity_print_attachment\Element\WebformEntityPrintAttachment

File

modules/webform_entity_print_attachment/src/Element/WebformEntityPrintAttachment.php, line 13

Namespace

Drupal\webform_entity_print_attachment\Element

class WebformEntityPrintAttachment extends WebformAttachmentBase {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return parent::getInfo() + [
      '#view_mode' => 'html',
      '#export_type' => 'pdf',
      '#template' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function getFileContent(array $element, WebformSubmissionInterface $webform_submission) {

    /** @var \Drupal\entity_print\Plugin\EntityPrintPluginManagerInterface $print_engine_manager */
    $print_engine_manager = \Drupal::service('plugin.manager.entity_print.print_engine');

    /** @var \Drupal\entity_print\PrintBuilderInterface $print_builder */
    $print_builder = \Drupal::service('entity_print.print_builder');

    // Make sure Webform Entity Print template is used.
    // @see webform_entity_print_entity_view_alter()
    \Drupal::request()->request
      ->set('_webform_entity_print', TRUE);

    // Set view mode or render custom twig.
    // @see \Drupal\webform\WebformSubmissionViewBuilder::view
    // @see webform_entity_print_attachment_webform_submission_view_alter()
    $view_mode = isset($element['#view_mode']) ? $element['#view_mode'] : 'html';
    if ($view_mode === 'twig') {
      $webform_submission->_webform_view_mode_twig = $element['#template'];
    }
    \Drupal::request()->request
      ->set('_webform_submissions_view_mode', $view_mode);

    // Get scheme.
    $scheme = 'temporary';

    // Get filename.
    $file_name = 'webform-entity-print-attachment--' . $webform_submission
      ->getWebform()
      ->id() . '-' . $webform_submission
      ->id() . '.pdf';

    // Save printable document.
    $export_type_id = static::getExportTypeId($element);
    $print_engine = $print_engine_manager
      ->createSelectedInstance($export_type_id);
    $temporary_file_path = $print_builder
      ->savePrintable([
      $webform_submission,
    ], $print_engine, $scheme, $file_name);
    if ($temporary_file_path) {
      $contents = file_get_contents($temporary_file_path);
      \Drupal::service('file_system')
        ->delete($temporary_file_path);
    }
    else {

      // Log error.
      $context = [
        '@filename' => $file_name,
      ];
      \Drupal::logger('webform_entity_print')
        ->error("Unable to generate '@filename'.", $context);
      $contents = '';
    }
    return $contents;
  }

  /**
   * {@inheritdoc}
   */
  public static function getFileName(array $element, WebformSubmissionInterface $webform_submission) {
    if (empty($element['#filename'])) {
      return $element['#webform_key'] . '.' . static::getExportTypeFileExtension($element);
    }
    else {
      return parent::getFileName($element, $webform_submission);
    }
  }

  /**
   * Get export type id.
   *
   * @param array $element
   *   An element.
   *
   * @return string
   *   An export type id.
   */
  protected static function getExportTypeId(array $element) {
    if (isset($element['#export_type'])) {
      return $element['#export_type'];
    }
    else {
      list(, $export_type_id) = explode(':', $element['#type']);
      return $export_type_id;
    }
  }

  /**
   * Get export type file extension.
   *
   * @param array $element
   *   An element.
   *
   * @return string
   *   An export type file extension.
   */
  protected static function getExportTypeFileExtension(array $element) {

    /** @var \Drupal\entity_print\Plugin\ExportTypeManagerInterface $export_type_manager */
    $export_type_manager = \Drupal::service('plugin.manager.entity_print.export_type');
    $export_type_id = static::getExportTypeId($element);
    $definition = $export_type_manager
      ->getDefinition($export_type_id);
    return $definition['file_extension'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
WebformAttachmentBase::getFileLink	public static	function	Get a webform attachment's file link. Overrides WebformAttachmentInterface::getFileLink
WebformAttachmentBase::getFileMimeType	public static	function	Get a webform attachment's file type. Overrides WebformAttachmentInterface::getFileMimeType
WebformAttachmentBase::getFileUrl	public static	function	Get a webform attachment's download URL. Overrides WebformAttachmentInterface::getFileUrl
WebformAttachmentBase::processWebformAttachment	public static	function	Processes a 'webform_attachment' element.
WebformEntityPrintAttachment::getExportTypeFileExtension	protected static	function	Get export type file extension.
WebformEntityPrintAttachment::getExportTypeId	protected static	function	Get export type id.
WebformEntityPrintAttachment::getFileContent	public static	function	Get a webform attachment's file content. Overrides WebformAttachmentInterface::getFileContent
WebformEntityPrintAttachment::getFileName	public static	function	Get a webform attachment's file name. Overrides WebformAttachmentBase::getFileName
WebformEntityPrintAttachment::getInfo	public	function	Returns the element properties for this element. Overrides WebformAttachmentBase::getInfo