class AdminSettingsForm in PDF using mPDF 8
Same name and namespace in other branches
- 8.2 src/Form/AdminSettingsForm.php \Drupal\pdf_using_mpdf\Form\AdminSettingsForm
Admin settings form.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\pdf_using_mpdf\Form\AdminSettingsForm
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of AdminSettingsForm
1 string reference to 'AdminSettingsForm'
File
- src/
Form/ AdminSettingsForm.php, line 14
Namespace
Drupal\pdf_using_mpdf\FormView source
class AdminSettingsForm extends ConfigFormBase {
/**
* The entity type manager service.
*
* @var \Drupal\Core\Entity\EntityTypeManager
*/
protected $entityTypeManager;
/**
* Constructs a NodeController object.
*
* @param \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
* The entity type manager.
*/
public function __construct(EntityTypeManager $entityTypeManager) {
$this->entityTypeManager = $entityTypeManager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'pdf_using_mpdf_config';
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
'pdf_using_mpdf.settings',
];
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
// Get settings for this form.
$settings = $this
->configFactory()
->getEditable('pdf_using_mpdf.settings')
->get('pdf_using_mpdf');
$form['pdf'] = [
'#type' => 'details',
'#open' => TRUE,
'#title' => $this
->t('Config'),
];
$filename = $settings['pdf_filename'];
$form['pdf']['pdf_filename'] = [
'#type' => 'textfield',
'#title' => $this
->t('PDF Filename'),
'#required' => TRUE,
'#default_value' => isset($filename) && $filename != NULL ? $filename : '[site:name] - PDF',
];
$form['pdf']['pdf_save_option'] = [
'#type' => 'radios',
'#title' => t('Open PDF File in'),
'#options' => [
$this
->t('Web Browser'),
$this
->t('Save Dialog Box'),
$this
->t('Save to Server'),
],
'#default_value' => $settings['pdf_save_option'],
];
// Document properties.
$form['pdf']['property'] = [
'#type' => 'details',
'#open' => FALSE,
'#title' => $this
->t('Document Properties'),
'#description' => $this
->t('These optional properties can be seen when inspecting the document properties like in Adobe Reader.'),
];
$form['pdf']['property']['pdf_set_title'] = [
'#type' => 'textfield',
'#size' => 35,
'#title' => $this
->t('Title'),
'#default_value' => $settings['pdf_set_title'],
'#description' => $this
->t('Set the title for the document.'),
];
$form['pdf']['property']['pdf_set_author'] = [
'#type' => 'textfield',
'#size' => 35,
'#title' => $this
->t('Author'),
'#default_value' => $settings['pdf_set_author'],
'#description' => $this
->t('Set the Author for the document.'),
];
$form['pdf']['property']['pdf_set_subject'] = [
'#type' => 'textfield',
'#size' => 35,
'#title' => $this
->t('Subject'),
'#default_value' => $settings['pdf_set_subject'],
'#description' => $this
->t('Set Subject of PDF.'),
];
$form['pdf']['property']['pdf_set_creator'] = [
'#type' => 'textfield',
'#size' => 35,
'#title' => $this
->t('Creator'),
'#default_value' => $settings['pdf_set_creator'],
'#description' => $this
->t('Set the document Creator.'),
];
// Page settings.
$form['pdf']['page_setting'] = [
'#type' => 'details',
'#open' => FALSE,
'#title' => $this
->t('PDF Page Setting'),
'#description' => $this
->t('All margin values should be specified as LENGTH in millimetres.'),
];
$form['pdf']['page_setting']['margin_top'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Top Margin'),
'#default_value' => $settings['margin_top'],
];
$form['pdf']['page_setting']['margin_right'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Right Margin'),
'#default_value' => $settings['margin_right'],
];
$form['pdf']['page_setting']['margin_bottom'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Bottom Margin'),
'#default_value' => $settings['margin_bottom'],
];
$form['pdf']['page_setting']['margin_left'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Left Margin'),
'#default_value' => $settings['margin_left'],
];
$form['pdf']['page_setting']['margin_header'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Header Margin'),
'#default_value' => $settings['margin_header'],
];
$form['pdf']['page_setting']['margin_footer'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Footer Margin'),
'#default_value' => $settings['margin_footer'],
];
$form['pdf']['page_setting']['pdf_font_size'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Font Size'),
'#default_value' => $settings['pdf_font_size'],
];
$form['pdf']['page_setting']['pdf_default_font'] = [
'#type' => 'select',
'#title' => $this
->t('Default Font Style'),
'#description' => $this
->t('These are the default fonts provided by mPDF. This may not work for HTML content if your styles already have a <em>font-family</em> property.'),
'#options' => $this
->getDefaultFonts(),
'#default_value' => $settings['pdf_default_font'],
];
$form['pdf']['page_setting']['pdf_page_size'] = [
'#type' => 'select',
'#title' => $this
->t('Page Size'),
'#options' => $this
->getPageSizeOptions(),
'#default_value' => $settings['pdf_page_size'],
];
$form['pdf']['page_setting']['dpi'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Document DPI'),
'#default_value' => $settings['dpi'],
];
$form['pdf']['page_setting']['img_dpi'] = [
'#type' => 'textfield',
'#size' => 5,
'#title' => $this
->t('Image DPI'),
'#default_value' => $settings['img_dpi'],
];
$form['pdf']['page_setting']['orientation'] = [
'#type' => 'select',
'#title' => $this
->t('Orientation'),
'#default_value' => $settings['orientation'],
'#options' => [
'P' => $this
->t('Portrait'),
'L' => $this
->t('Landscape'),
],
];
// Watermark.
$form['pdf']['watermark'] = [
'#type' => 'details',
'#open' => TRUE,
'#description' => $this
->t('Display watermark on every page.'),
'#title' => $this
->t('PDF Watermark Option'),
];
$form['pdf']['watermark']['watermark_opacity'] = [
'#type' => 'select',
'#title' => $this
->t('Watermark Transparency'),
'#options' => [
'0.1' => '0.1',
'0.2' => '0.2',
'0.3' => '0.3',
'0.4' => '0.4',
'0.5' => '0.5',
'0.6' => '0.6',
'0.7' => '0.7',
'0.8' => '0.8',
'0.9' => '0.9',
'1.0' => '1.0',
],
'#default_value' => $settings['watermark_opacity'],
];
$form['pdf']['watermark']['watermark_option'] = [
'#type' => 'radios',
'#title' => $this
->t('Watermark Option'),
'#options' => [
$this
->t('Text'),
$this
->t('Image'),
],
'#default_value' => $settings['watermark_option'],
];
$form['pdf']['watermark']['pdf_watermark_text'] = [
'#type' => 'textfield',
'#default_value' => $settings['pdf_watermark_text'],
'#placeholder' => $this
->t('Watermark text'),
];
$form['pdf']['watermark']['watermark_image'] = [
'#type' => 'managed_file',
'#default_value' => $settings['watermark_image'],
'#upload_location' => 'public://pdf_using_mpdf',
'#description' => $this
->t('Display watermark image'),
'#upload_validators' => [
'file_validate_extensions' => [
'gif png jpg jpeg',
],
'file_validate_size' => [
1024 * 1024,
],
],
];
// Header.
$form['pdf']['head_foot'] = [
'#type' => 'details',
'#open' => TRUE,
'#title' => $this
->t('PDF Header & Footer Option'),
'#description' => $this
->t('use {PAGENO} for page numbering or {DATE j-m-Y} for current date.'),
];
$form['pdf']['head_foot']['pdf_header'] = [
'#type' => 'textarea',
'#title' => $this
->t('Header content'),
'#description' => $this
->t('Use a valid HTML code to write a custom header content. Example: @example', [
'@example' => '<div><img src="http://www.example.com/sites/default/files/company_logo.png" width="300px" height="50px" ></div> <hr />',
]),
'#default_value' => $settings['pdf_header'],
];
// Footer.
$form['pdf']['head_foot']['pdf_footer'] = [
'#type' => 'textarea',
'#title' => $this
->t('Footer content'),
'#description' => $this
->t('Use a valid HTML code to write a custom footer content. Example: @example', [
'example' => '<hr /> <div style="color:#f00; text-align:center;" > <strong>Your Company</strong>, web: <a href="http://example.com">www.example.com</a>, email : contact@example.com</div>',
]),
'#default_value' => $settings['pdf_footer'],
];
// Password.
$form['pdf']['permission'] = [
'#type' => 'details',
'#open' => FALSE,
'#title' => $this
->t('PDF Password Protection'),
];
$pwd = $settings['pdf_password'];
if (isset($pwd) && $pwd != NULL) {
$form['pdf']['permission']['msg'] = [
'#type' => 'markup',
'#markup' => $this
->t('<p>***** Password is already set *****</p>'),
];
$form['pdf']['permission']['remove_pwd'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Remove Password'),
];
}
else {
$form['pdf']['permission']['pdf_password'] = [
'#type' => 'password_confirm',
'#description' => $this
->t('If password is not required, leave blank. Do not use space in starting and ending of password.'),
];
}
// Custom style Sheet.
$form['pdf']['style'] = [
'#type' => 'details',
'#title' => $this
->t('Custom Style Sheet for PDF'),
'#open' => FALSE,
];
$form['pdf']['style']['pdf_css_file'] = [
'#type' => 'textfield',
'#description' => $this
->t('Enter path for CSS file. This path should be strictly related to Drupal root. For example: <em>styles/custom.css</em> will have its path validated as <em>DRUPAL_ROOT/styles/custom.css</em>'),
'#default_value' => $settings['pdf_css_file'],
];
$types = $this->entityTypeManager
->getStorage('node_type')
->loadMultiple();
$options = [];
foreach ($types as $type) {
$options[$type
->id()] = $type
->label();
}
// Enabled content types.
$form['pdf']['content_types'] = [
'#type' => 'details',
'#title' => $this
->t('Content types'),
'#open' => FALSE,
];
$form['pdf']['content_types']['enabled_content_types'] = [
'#title' => $this
->t('Enable PDF generation for the following node types.'),
'#type' => 'select',
'#multiple' => TRUE,
'#options' => $options,
'#default_value' => $settings['enabled_content_types'],
];
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValues();
if (!is_numeric($values['pdf_font_size']) || $values['pdf_font_size'] < 1) {
$form_state
->setErrorByName('pdf_font_size', $this
->t('Font size should be numeric and greater than 1.'));
}
if (!is_numeric($values['margin_top']) || $values['margin_top'] <= 0) {
$form_state
->setErrorByName('margin_top', $this
->t('PDF top margin should be numeric and greater than -1.'));
}
if (!is_numeric($values['margin_right']) || $values['margin_right'] <= 0) {
$form_state
->setErrorByName('margin_right', $this
->t('PDF right margin should be numeric and greater than -1.'));
}
if (!is_numeric($values['margin_bottom']) || $values['margin_bottom'] <= 0) {
$form_state
->setErrorByName('margin_bottom', $this
->t('PDF bottom margin should be numeric and greater than -1.'));
}
if (!is_numeric($values['margin_left']) || $values['margin_left'] <= 0) {
$form_state
->setErrorByName('margin_left', $this
->t('PDF left margin should be numeric and greater than -1.'));
}
if (!is_numeric($values['margin_header']) || $values['margin_header'] <= 0) {
$form_state
->setErrorByName('margin_header', $this
->t('PDF header margin should be numeric and greater than -1.'));
}
if (!is_numeric($values['margin_footer']) || $values['margin_footer'] <= 0) {
$form_state
->setErrorByName('margin_footer', $this
->t('PDF footer margin should be numeric and greater than -1.'));
}
if (!is_numeric($values['dpi']) || $values['dpi'] < 0) {
$form_state
->setErrorByName('dpi', $this
->t('Document DPI should be numeric and greater than 0.'));
}
if (!is_numeric($values['img_dpi']) || $values['img_dpi'] < 0) {
$form_state
->setErrorByName('img_dpi', $this
->t('Image DPI should be numeric and greater than 0.'));
}
// Change watermark image status to permanent.
if (!empty($values['watermark_image'])) {
$file = File::load($values['watermark_image'][0]);
if (!$file
->isPermanent()) {
$file
->setPermanent();
$file
->save();
$file_usage = \Drupal::service('file.usage');
$file_usage
->add($file, 'pdf_using_mpdf', 'user', \Drupal::currentUser()
->id());
}
}
// Validate custom stylesheet.
if (!empty($values['pdf_css_file'])) {
$path = DRUPAL_ROOT . '/' . $values['pdf_css_file'];
if (!file_exists($path)) {
$form_state
->setErrorByName('pdf_css_file', $this
->t('Stylesheet not found in path: @path', [
'@path' => $path,
]));
}
if ($target_path = pathinfo($path)) {
if ($target_path['extension'] != 'css') {
$form_state
->setErrorByName('pdf_css_file', $this
->t('*.css file extension is needed.'));
}
}
}
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValues();
$settings = [
'pdf_filename' => $values['pdf_filename'],
'pdf_save_option' => $values['pdf_save_option'],
'pdf_set_title' => $values['pdf_set_title'],
'pdf_set_author' => $values['pdf_set_author'],
'pdf_set_subject' => $values['pdf_set_subject'],
'pdf_set_creator' => $values['pdf_set_creator'],
'margin_top' => $values['margin_top'],
'margin_right' => $values['margin_right'],
'margin_bottom' => $values['margin_bottom'],
'margin_left' => $values['margin_left'],
'margin_header' => $values['margin_header'],
'margin_footer' => $values['margin_footer'],
'pdf_font_size' => $values['pdf_font_size'],
'pdf_default_font' => $values['pdf_default_font'],
'pdf_page_size' => $values['pdf_page_size'],
'dpi' => $values['dpi'],
'img_dpi' => $values['img_dpi'],
'orientation' => $values['orientation'],
'watermark_option' => $values['watermark_option'],
'watermark_opacity' => $values['watermark_opacity'],
'pdf_watermark_text' => $values['pdf_watermark_text'],
'watermark_image' => $values['watermark_image'],
'pdf_header' => $values['pdf_header'],
'pdf_footer' => $values['pdf_footer'],
'pdf_css_file' => $values['pdf_css_file'],
'enabled_content_types' => $values['enabled_content_types'] ? $values['enabled_content_types'] : [],
];
if (isset($values['remove_pwd'])) {
if ($values['remove_pwd'] == '1') {
$settings['pdf_password'] = NULL;
}
}
else {
$settings['pdf_password'] = $values['pdf_password'];
}
// Save the configuration into database.
$this
->configFactory()
->getEditable('pdf_using_mpdf.settings')
->set('pdf_using_mpdf', $settings)
->save();
parent::submitForm($form, $form_state);
}
/**
* Get default font styles provided by mPDF library.
*
* @return array
* Default font list.
*/
public function getDefaultFonts() {
return [
'dejavusanscondensed' => 'DejaVuSansCondensed',
'dejavusans' => 'DejaVuSans',
'dejavuserif' => 'DejaVuSerif',
'dejavuserifcondensed' => 'DejaVuSerifCondensed',
'dejavusansmono' => 'DejaVuSansMono',
'freesans' => 'FreeSans',
'freeserif' => 'FreeSerif',
'freemono' => 'FreeMono',
'ocrb' => 'ocrb10',
'estrangeloedessa' => 'SyrCOMEdessa',
'kaputaunicode' => 'kaputaunicode',
'abyssinicasil' => 'Abyssinica_SIL',
'aboriginalsans' => 'AboriginalSansREGULAR',
'jomolhari' => 'Jomolhari',
'sundaneseunicode' => 'SundaneseUnicode-1.0.5',
'taiheritagepro' => 'TaiHeritagePro',
'aegean' => 'Aegean',
'aegyptus' => 'Aegyptus',
'akkadian' => 'Akkadian',
'quivira' => 'Quivira',
'eeyekunicode' => 'Eeyek',
'lannaalif' => 'lannaalif-v1-03',
'daibannasilbook' => 'DBSILBR',
'garuda' => 'Garuda',
'khmeros' => 'KhmerOS',
'dhyana' => 'Dhyana',
'tharlon' => 'Tharlon',
'padaukbook' => 'Padauk-book',
'zawgyi-one' => 'ZawgyiOne',
'ayar' => 'ayar',
'taameydavidclm' => 'TaameyDavidCLM',
'mph2bdamase' => 'damase_v.2',
'lohitkannada' => 'Lohit-Kannada',
'pothana2000' => 'Pothana2000',
'xbriyaz' => 'XB Riyaz',
'lateef' => 'LateefRegOT',
'kfgqpcuthmantahanaskh' => 'Uthman',
'sun-exta' => 'Sun-ExtA',
'sun-extb' => 'Sun-ExtB',
'unbatang' => 'UnBatang_0613',
];
}
/**
* International Paper Sizes.
*
* @return array
* Page size option list.
*/
public function getPageSizeOptions() {
return [
'A0' => 'A0',
'A1' => 'A1',
'A2' => 'A2',
'A3' => 'A3',
'A4' => 'A4',
'A5' => 'A5',
'A6' => 'A6',
'A7' => 'A7',
'A8' => 'A8',
'A9' => 'A9',
'A10' => 'A10',
'B0' => 'B0',
'B1' => 'B1',
'B2' => 'B2',
'B3' => 'B3',
'B4' => 'B4',
'B5' => 'B5',
'B6' => 'B6',
'B7' => 'B7',
'B8' => 'B8',
'B9' => 'B9',
'B10' => 'B10',
'C0' => 'C0',
'C1' => 'C1',
'C2' => 'C2',
'C3' => 'C3',
'C4' => 'C4',
'C5' => 'C5',
'C6' => 'C6',
'C7' => 'C7',
'C8' => 'C8',
'C9' => 'C9',
'C10' => 'C10',
'2A0' => '2A0',
'4A0' => '4A0',
'RA0' => 'RA0',
'RA1' => 'RA1',
'RA2' => 'RA2',
'RA3' => 'RA3',
'SRA0' => 'SRA0',
'SRA1' => 'SRA1',
'SRA2' => 'SRA2',
'SRA3' => 'SRA3',
'SRA4' => 'SRA4',
'Letter' => 'Letter',
'Legal' => 'Legal',
];
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
AdminSettingsForm:: |
protected | property | The entity type manager service. | |
|
AdminSettingsForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
|
AdminSettingsForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
|
AdminSettingsForm:: |
public | function | Get default font styles provided by mPDF library. | |
|
AdminSettingsForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
|
AdminSettingsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
|
AdminSettingsForm:: |
public | function | International Paper Sizes. | |
|
AdminSettingsForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
|
AdminSettingsForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
|
AdminSettingsForm:: |
public | function |
Constructs a NodeController object. Overrides ConfigFormBase:: |
|
|
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
|
DependencySerializationTrait:: |
public | function | 1 | |
|
DependencySerializationTrait:: |
public | function | 2 | |
|
FormBase:: |
protected | property | The config factory. | 1 |
|
FormBase:: |
protected | property | The request stack. | 1 |
|
FormBase:: |
protected | property | The route match. | |
|
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
|
FormBase:: |
private | function | Returns the service container. | |
|
FormBase:: |
protected | function | Gets the current user. | |
|
FormBase:: |
protected | function | Gets the request object. | |
|
FormBase:: |
protected | function | Gets the route match. | |
|
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
|
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
|
FormBase:: |
public | function | Resets the configuration factory. | |
|
FormBase:: |
public | function | Sets the config factory for this form. | |
|
FormBase:: |
public | function | Sets the request stack object to use. | |
|
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
|
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
|
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
|
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
|
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
|
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
|
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
|
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
|
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
|
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
|
UrlGeneratorTrait:: |
protected | property | The url generator. | |
|
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
|
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
|
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |