class PdfPreviewSettingsForm in PDFPreview 2.0.x

Configure PDF preview settings for this site.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\pdfpreview\PdfPreviewSettingsForm

1 string reference to 'PdfPreviewSettingsForm'

pdfpreview.routing.yml in ./pdfpreview.routing.yml

pdfpreview.routing.yml

File

src/PdfPreviewSettingsForm.php, line 12

Namespace

Drupal\pdfpreview

class PdfPreviewSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'pdfpreview_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'pdfpreview.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('pdfpreview.settings');
    $form['path'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Preview path'),
      '#description' => $this
        ->t('Path inside files directory where previews are stored. For example %default', [
        '%default' => 'pdfpreview',
      ]),
      '#default_value' => $config
        ->get('path'),
    ];
    $form['size'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Preview size'),
      '#description' => $this
        ->t('Size of the preview in pixels. For example %example. You must set this to a value big enough to apply your image styles.', [
        '%example' => '100x100',
      ]),
      '#default_value' => $config
        ->get('size'),
    ];
    $form['quality'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Image quality'),
      '#size' => 3,
      '#maxlength' => 3,
      '#field_suffix' => '%',
      '#description' => $this
        ->t('Image extraction quality'),
      '#default_value' => $config
        ->get('quality'),
    ];
    $form['filenames'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Generated filenames'),
      '#options' => [
        'machine' => $this
          ->t('Filename hash'),
        'human' => $this
          ->t('From PDF filename'),
      ],
      '#description' => $this
        ->t('This changes how filenames will be used on generated previews. If you change this after some files were generated, you must delete them manually.'),
      '#default_value' => $config
        ->get('filenames'),
    ];
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Preview image type'),
      '#options' => [
        'jpg' => $this
          ->t('JPEG'),
        'png' => $this
          ->t('PNG'),
      ],
      '#description' => $this
        ->t('The image file type that should be used when generating preview images.'),
      '#default_value' => $config
        ->get('type'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('pdfpreview.settings')
      ->set('path', $form_state
      ->getValue('path'))
      ->set('size', $form_state
      ->getValue('size'))
      ->set('quality', $form_state
      ->getValue('quality'))
      ->set('filenames', $form_state
      ->getValue('filenames'))
      ->set('type', $form_state
      ->getValue('type'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PdfPreviewSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
PdfPreviewSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
PdfPreviewSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PdfPreviewSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PdfPreviewSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.