/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = [];
$fields['fid'] = BaseFieldDefinition::create('integer')
->setLabel(t('FillPDF Form ID'))
->setDescription(t('The ID of the FillPdfForm entity.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
$fields['uuid'] = BaseFieldDefinition::create('uuid')
->setLabel(t('UUID'))
->setDescription(t('The UUID of the FillPdfForm entity.'))
->setReadOnly(TRUE);
$fields['file'] = BaseFieldDefinition::create('file')
->setLabel(t('The associated managed file.'))
->setDescription(t('The associated managed file.'));
$overview_url = Url::fromUri('base://admin/structure/fillpdf')->toString();
$fields['admin_title'] = BaseFieldDefinition::create('string')
->setLabel(t('Administrative description'))
->setDescription(t('Enter the name of the form here, and it will be shown on the <a href="@overview_url">form overview page</a>. It has no effect on functionality, but it can help you identify which form configuration you want to edit.', ['@overview_url' => $overview_url]))
->setDisplayOptions('form', [
'type' => 'string',
'weight' => 0,
]);
$fields['title'] = BaseFieldDefinition::create('string')
->setLabel(t('Filename pattern'))
->setDescription(t('Enter a title for this mapping configuration. This will be used for deciding the filename of your PDF. <strong>This field supports tokens.</strong>'))
->setDisplayOptions('form', [
'type' => 'string',
'weight' => 10,
]);
$fields['default_entity_type'] = BaseFieldDefinition::create('string')
->setLabel(t('Default entity type'))
->setDescription(t('The type of the below entity ID.'));
$fields['default_entity_id'] = BaseFieldDefinition::create('integer')
->setLabel(t('Default entity ID'))
->setDescription(t('The default entity ID to be filled from this FillPDF Form.'))
->setDisplayOptions('form', [
'type' => 'string',
'weight' => 15,
]);
$fields['destination_path'] = BaseFieldDefinition::create('string')
->setLabel(t('Where to save generated PDFs'))
->setDescription(t("<p>By default, filled PDFs are not saved to disk; they are simply sent
directly to the browser for download. Enter a path here to change this behavior (tokens allowed).
<strong>Warning! Unless you include the &download=1 flag in the FillPDF URL, PDFs will only
be saved to disk <em>and won't</em> be sent to the browser as well.</strong></p><p>The path
you specify must be in the following format:<br />
<ul>
<li><code>path/to/directory</code> (path will be treated as relative to
your <em>fillpdf</em> files subdirectory)</li>
filesystem)</li>
</ul>
Note that you are responsible for ensuring that the user under which PHP is running can write to this path. Do not include a trailing slash.</p>"))
->setDisplayOptions('form', [
'type' => 'string',
'weight' => 20,
]);
// @todo: add post_save_redirect field for where to send the browser by default after they generate a PDF
$fields['scheme'] = BaseFieldDefinition::create('list_string')
->setLabel('Storage system for generated PDFs')
->setDescription(t('This setting is used as the storage/download method for generated PDFs. The use of public files is more efficient, but does not provide any access control. Changing this setting will require you to migrate associated files and data yourself and is not recommended after you have uploaded a template.'))
->setSettings([
'allowed_values' => FillPdfAdminFormHelper::schemeOptions(),
])
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'options_buttons',
'weight' => 25,
'settings' => [
'options' => FillPdfAdminFormHelper::schemeOptions(),
],
]);
$fields['destination_redirect'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Redirect browser directly to saved PDF'))
->setDescription(t("<strong>This setting is applicable only if <em>Where to save generated PDFs</em> is set.</strong> Instead of redirecting your visitors to the front page, it will redirect them directly to the PDF. However, if you pass Drupal's <em>destination</em> query string parameter, that will override this setting."))
->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'weight' => 30,
'settings' => [
'display_label' => TRUE,
],
]);
// Restore database and make this be string_long instead like FillPdfFormField
$fields['replacements'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Change text before sending to PDF (Transform values)'))
->setDescription(FillPdfAdminFormHelper::getReplacementsDescription())
->setDisplayOptions('form', [
'type' => 'string_long',
'weight' => 40,
]);
return $fields;
}
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this->config('fillpdf.settings');
$scheme_options = FillPdfAdminFormHelper::schemeOptions();
$form['scheme'] = [
'#type' => 'radios',
'#title' => $this->t('Template download method'),
'#default_value' => $config->get('scheme'),
'#options' => $scheme_options,
'#description' => $this->t('This setting is used as the download method for uploaded templates. The use of public files is more efficient, but does not provide any access control. Changing this setting will require you to migrate associated files and data yourself and is not recommended after you have uploaded a template.'),
];
$fillpdf_service = $config->get('backend');
// Assemble service options. Warning messages will be added next as needed.
$options = [
'pdftk' => $this->t('Use locally-installed pdftk: You will need a VPS or a dedicated server so you can install pdftk: (!see_documentation).', ['!see_documentation' => $this->l($this->t('see documentation'), Url::fromUri('http://drupal.org/documentation/modules/fillpdf'))]),
'local' => $this->t('Use locally-installed PHP/JavaBridge: You will need a VPS or dedicated server so you can deploy PHP/JavaBridge on Apache Tomcat: (!see_documentation).', ['!see_documentation' => $this->l($this->t('see documentation'), Url::fromUri('http://drupal.org/documentation/modules/fillpdf'))]),
'fillpdf_service' => $this->t('Use FillPDF Service: Sign up for <a href="https://fillpdf-service.com">FillPDF Service</a>.'),
];
// Check for JavaBridge.
if (!(file_exists(drupal_get_path('module', 'fillpdf') . '/lib/JavaBridge/java/Java.inc'))) {
$options['local'] .= '<div class="messages warning">' . $this->t('JavaBridge is not installed locally.') . '</div>';
}
// Check for pdftk.
$status = FillPdf::checkPdftkPath($this->adminFormHelper->getPdftkPath());
if ($status === FALSE) {
$options['pdftk'] .= '<div class="messages warning">' . $this->t('pdftk is not properly installed.') . '</div>';
}
$form['backend'] = [
'#type' => 'radios',
'#title' => $this->t('PDF-filling service'),
'#description' => $this->t('This module requires the use of one of several external PDF manipulation tools. Choose the service you would like to use.'),
'#default_value' => !empty($fillpdf_service) ? $fillpdf_service : 'fillpdf_service',
'#options' => $options,
];
$form['fillpdf_service'] = [
'#type' => 'fieldset',
'#title' => $this->t('Configure FillPDF Service'),
'#collapsible' => TRUE,
'#collapsed' => $fillpdf_service !== 'fillpdf_service',
];
$form['fillpdf_service']['fillpdf_service_api_key'] = [
'#type' => 'textfield',
'#title' => $this->t('API Key'),
'#default_value' => $config->get('fillpdf_service_api_key'),
'#description' => $this->t('You need to sign up for an API key at <a href="https://fillpdf-service.com">FillPDF Service</a>'),
];
$form['fillpdf_service']['remote_protocol'] = [
'#type' => 'radios',
'#title' => $this->t('Use HTTPS?'),
'#description' => $this->t('It is recommended to select <em>Use HTTPS</em> for this option. Doing so will help prevent
sensitive information in your PDFs from being intercepted in transit between your server and the remote service.'),
'#default_value' => $config->get('remote_protocol'),
'#options' => [
'https' => $this->t('Use HTTPS'),
'http' => $this->t('Do not use HTTPS'),
],
];
$form['pdftk_path'] = [
'#type' => 'textfield',
'#title' => $this->t('Configure path to pdftk'),
'#description' => $this->t("If FillPDF is not detecting your pdftk installation, you can specify the full path to the program here. Include the program name as well. For example, <em>/usr/bin/pdftk</em> is a valid value. You can almost always leave this field blank. If you should set it, you'll probably know."),
'#default_value' => $config->get('pdftk_path'),
];
$form['#attached'] = ['library' => ['fillpdf/fillpdf.admin.settings']];
return parent::buildForm($form, $form_state);
}
/**
* @inheritdoc
* @todo Fix field descriptions to match D7 version.
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = [];
$fields['ffid'] = BaseFieldDefinition::create('integer')
->setLabel(t('FillPDF Form Field ID'))
->setDescription(t('The ID of the FillPdfFormField entity.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
$fields['fillpdf_form'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('FillPDF Form ID'))
->setDescription(t('The ID of the FillPdfFormField entity.'))
->setSetting('target_type', 'fillpdf_form');
$fields['uuid'] = BaseFieldDefinition::create('uuid')
->setLabel(t('UUID'))
->setDescription(t('The UUID of the FillPdfFormField entity.'))
->setReadOnly(TRUE);
$fields['pdf_key'] = BaseFieldDefinition::create('string')
->setLabel(t('PDF Key'))
->setDescription(t('The name of the field in the PDF form.'));
$fields['label'] = BaseFieldDefinition::create('string')
->setLabel(t('PDF field label'))
->setDescription(t('An optional label to help you identify the field.'))
->setDisplayOptions('form', [
'type' => 'string',
]);
$fields['prefix'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Text before field value'))
->setDescription(t('Text to add to the front of the field value unless the field value is blank.'))
->setDisplayOptions('form', [
'type' => 'string_long',
]);
$fields['value'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Fill pattern'))
->setDescription(t('Text and tokens with which to fill in the PDF.'))
->setDisplayOptions('form', [
'type' => 'string_long',
]);
$fields['suffix'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Text after field value'))
->setDescription(t('Text to add to the end of the field value unless the field value is blank.'))
->setDisplayOptions('form', [
'type' => 'string_long',
]);
$fields['replacements'] = BaseFieldDefinition::create('string_long')
->setLabel(t('Change text before sending to PDF (Transform values)'))
->setDescription(FillPdfAdminFormHelper::getReplacementsDescription())
->setDisplayOptions('form', [
'type' => 'string_long',
]);
return $fields;
}
