public function FormatConfigurationFormPdf::buildForm in Printer and PDF versions for Drupal 8+ 2.x

Same name and namespace in other branches

1. 8 src/Form/FormatConfigurationFormPdf.php \Drupal\printable\Form\FormatConfigurationFormPdf::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

src/Form/FormatConfigurationFormPdf.php, line 80

Class

FormatConfigurationFormPdf

Provides shared configuration form for all printable formats.

Namespace

Drupal\printable\Form

Code

public function buildForm(array $form, FormStateInterface $form_state, $printable_format = NULL) {
  $wkhtmltopdf_present = class_exists('mikehaertl\\wkhtmlto\\Pdf');
  $mpdf_present = class_exists('Mpdf\\Mpdf');
  $tcpdf_present = class_exists('TCPDF');
  $dompdf_present = class_exists('Dompdf\\Dompdf');
  if ($wkhtmltopdf_present || $mpdf_present || $tcpdf_present || $dompdf_present) {
    $form['settings']['print_pdf_pdf_tool'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('PDF generation tool'),
      '#options' => [],
      '#default_value' => $this
        ->config('printable.settings')
        ->get('pdf_tool'),
      '#description' => $this
        ->t('This option selects the PDF generation tool being used by this module to create the PDF version.'),
    ];
  }
  else {
    $this
      ->messenger()
      ->addStatus($this
      ->t('You are seeing no PDF generating tool because you have not installed any third party library using composer.'));
  }
  if ($mpdf_present) {
    $form['settings']['print_pdf_pdf_tool']['#options'] += [
      'mPDF' => 'mPDF',
    ];
  }
  if ($tcpdf_present) {
    $form['settings']['print_pdf_pdf_tool']['#options'] += [
      'TCPDF' => 'TCPDF',
    ];
  }
  if ($wkhtmltopdf_present) {
    $form['settings']['print_pdf_pdf_tool']['#options'] += [
      'wkhtmltopdf' => 'wkhtmltopdf',
    ];
  }
  if ($dompdf_present) {
    $form['settings']['print_pdf_pdf_tool']['#options'] += [
      'dompdf' => 'dompdf',
    ];
  }
  $form['settings']['print_pdf_content_disposition'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Save the pdf'),
    '#description' => $this
      ->t('Save the pdf instead of showing inline'),
    '#default_value' => $this
      ->config('printable.settings')
      ->get('save_pdf'),
  ];
  $form['settings']['print_pdf_ignore_warnings'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Ignore warnings'),
    '#description' => $this
      ->t('Use the generated PDF even if warnings are indicated'),
    '#default_value' => $this
      ->config('printable.settings')
      ->get('ignore_warnings'),
  ];
  $form['settings']['print_pdf_paper_size'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Paper size'),
    '#options' => [],
    '#default_value' => (string) $this
      ->config('printable.settings')
      ->get('paper_size'),
    '#description' => $this
      ->t('Choose the paper size of the generated PDF.'),
  ];
  $paper_sizes = [
    'A0',
    'A1',
    'A2',
    'A3',
    'A4',
    'A5',
    'A6',
    'A7',
    'A8',
    'A9',
    'B0',
    'B1',
    'B10',
    'B2',
    'B3',
    'B4',
    'B5',
    'B6',
    'B7',
    'B8',
    'B9',
    'C5E',
    'Comm10E',
    'DLE',
    'Executive',
    'Folio',
    'Ledger',
    'Legal',
    'Letter',
    'Tabloid',
  ];
  foreach ($paper_sizes as $sizes) {
    $form['settings']['print_pdf_paper_size']['#options'][$sizes] = $sizes;
  }
  $form['settings']['print_pdf_page_orientation'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Page orientation'),
    '#options' => [
      'portrait' => $this
        ->t('Portrait'),
      'landscape' => $this
        ->t('Landscape'),
    ],
    '#default_value' => $this
      ->config('printable.settings')
      ->get('page_orientation'),
    '#description' => $this
      ->t('Choose the page orientation of the generated PDF.'),
  ];
  $token_help = '';
  $token_args = [];
  if ($this->moduleHandler
    ->moduleExists('token')) {
    $build = [
      '#type' => 'container',
      'token_tree_link' => [
        '#theme' => 'token_tree_link',
        '#token_types' => [
          'all',
        ],
        '#click_insert' => TRUE,
        '#dialog' => TRUE,
      ],
    ];
    $token_args = [
      '@browse_tokens_link' => \Drupal::service('renderer')
        ->render($build),
    ];
    $token_help = ' This field supports tokens: @browse_tokens_link';
  }
  $form['settings']['print_pdf_filename'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('PDF filename'),
    '#default_value' => $this
      ->config('printable.settings')
      ->get('pdf_location'),
    '#description' => t("Filename with its location can be entered. If left empty and Save the pdf option has been selected the generated filename defaults to the node's path.The .pdf extension will be appended automatically." . $token_help, $token_args),
  ];
  $form['settings']['print_pdf_filename']['#element_validate'][] = 'token_element_validate';
  $form['settings']['print_pdf_filename'] += [
    '#token_types' => [
      'all',
    ],
  ];
  if ($wkhtmltopdf_present) {
    $form['settings']['path_to_binary'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path to binary file'),
      '#default_value' => $this
        ->config('printable.settings')
        ->get('path_to_binary'),
      '#description' => $this
        ->t("Enter the path to binary file for wkhtmltopdf over here."),
      '#states' => [
        'visible' => [
          'input[name="print_pdf_pdf_tool"]' => [
            'value' => 'wkhtmltopdf',
          ],
        ],
      ],
    ];
    $form['settings']['print_pdf_use_xvfb_run'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use Xvfb-run'),
      '#description' => $this
        ->t('Enable this option if you get an error "QXcbConnection: Could not connect to display Aborted (core dumped)" when seeking to generate PDFs.'),
      '#default_value' => $this
        ->config('printable.settings')
        ->get('print_pdf_use_xvfb_run'),
      '#states' => [
        'visible' => [
          'input[name="print_pdf_pdf_tool"]' => [
            'value' => 'wkhtmltopdf',
          ],
        ],
      ],
    ];
    $form['settings']['path_to_xfb_run'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Path to Xvfb-run binary file'),
      '#default_value' => $this
        ->config('printable.settings')
        ->get('path_to_xfb_run'),
      '#description' => $this
        ->t("Enter the path to binary file for Xvfb-run over here."),
      '#states' => [
        'visible' => [
          'input[name="print_pdf_pdf_tool"]' => [
            'value' => 'wkhtmltopdf',
          ],
          'input[name="print_pdf_use_xvfb_run"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
  }
  $form['settings']['submit'] = [
    '#type' => 'submit',
    '#value' => 'Submit',
  ];
  return $form;
}