class FormatConfigurationFormPrint in Printer and PDF versions for Drupal 8+ 2.x

Provides shared configuration form for all printable formats.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\printable\Form\FormatConfigurationFormPrint

1 string reference to 'FormatConfigurationFormPrint'

printable.routing.yml in ./printable.routing.yml

printable.routing.yml

File

src/Form/FormatConfigurationFormPrint.php, line 15

Namespace

Drupal\printable\Form

class FormatConfigurationFormPrint extends FormBase {

  /**
   * The printable entity manager.
   *
   * @var \Drupal\printable\PrintableEntityManagerInterface
   */
  protected $printableEntityManager;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a new form object.
   *
   * @param \Drupal\printable\PrintableEntityManagerInterface $printable_entity_manager
   *   The printable entity manager.
   * @param \Drupal\Core\Config\ConfigFactory $configFactory
   *   Defines the configuration object factory.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(PrintableEntityManagerInterface $printable_entity_manager, ConfigFactory $configFactory, MessengerInterface $messenger) {
    $this->printableEntityManager = $printable_entity_manager;
    $this->configFactory = $configFactory;
    $this->messenger = $messenger;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $printable_format = NULL) {
    $form['settings']['print_html_sendtoprinter'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Send to printer'),
      '#default_value' => $this
        ->config('printable.settings')
        ->get('send_to_printer'),
      '#description' => $this
        ->t("Automatically calls the browser's print function when the printer-friendly version is displayed."),
    ];
    $form['settings']['print_html_windowclose'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Close window after sending to printer'),
      '#default_value' => $this
        ->config('printable.settings')
        ->get('close_window'),
      '#description' => $this
        ->t("When the above options are enabled, this option will close the window after its contents are printed."),
    ];
    $form['settings']['print_html_display_sys_urllist'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Printer-friendly URLs list in system pages'),
      '#default_value' => $this
        ->config('printable.settings')
        ->get('list_attribute'),
      '#description' => $this
        ->t('Enabling this option will display a list of printer-friendly destination URLs at the bottom of the page.'),
    ];
    $form['settings']['submit'] = [
      '#type' => 'submit',
      '#value' => 'Submit',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('printable.settings')
      ->set('send_to_printer', $form_state
      ->getValue('print_html_sendtoprinter'))
      ->set('close_window', $form_state
      ->getValue('print_html_windowclose'))
      ->set('list_attribute', $form_state
      ->getValue('print_html_display_sys_urllist'))
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('The configuration option has been saved'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormatConfigurationFormPrint::$configFactory	protected	property	The config factory service. Overrides FormBase::$configFactory
FormatConfigurationFormPrint::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
FormatConfigurationFormPrint::$printableEntityManager	protected	property	The printable entity manager.
FormatConfigurationFormPrint::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
FormatConfigurationFormPrint::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
FormatConfigurationFormPrint::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormatConfigurationFormPrint::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
FormatConfigurationFormPrint::__construct	public	function	Constructs a new form object.
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
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	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.