class PDFGenerationConfigForm in Forena Reports 8

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\forena_pdf\Form\PDFGenerationConfigForm

Expanded class hierarchy of PDFGenerationConfigForm

1 string reference to 'PDFGenerationConfigForm'

forena_pdf.routing.yml in forena_pdf/forena_pdf.routing.yml: forena_pdf/forena_pdf.routing.yml

File

forena_pdf/src/Form/PDFGenerationConfigForm.php, line 15

Namespace

Drupal\forena_pdf\Form

View source

class PDFGenerationConfigForm extends ConfigFormBase {

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

  /**
   * {@inheritdoc}
   */
  public function getEditableConfigNames() {
    return array(
      'forena_pdf.settings',
    );
  }

  /**
   * [@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('forena_pdf.settings');
    $path = $config
      ->get('prince_path');
    $disable_links = $config
      ->get('disable_links');
    $prince_path = t('Prince XML library not found.  Please install so sites/all/libraries/prince/prince.php exists.');
    if (forena_library_file('prince')) {
      $prince_path = 'libraries/prince';
    }
    $form['disable_links'] = array(
      '#type' => 'checkbox',
      '#title' => 'Disable links in PDF Documents',
      '#description' => t('When checked links in reports will not appear as links in PDF documents.'),
      '#default_value' => $disable_links,
    );

    /*
    $mpdf_path = t('MDPF Libarary not found. Please install so sites/all/libraries/mpdf/mpdf.php exists.');

    if (forena_library_file('mpdf')) {
      $mpdf_path = 'libraries/mpdf';
    }

    $form['mpdf'] = array('#type' => 'fieldset', '#title' => t('MPDF library'));

    $form['mpdf']['library'] = array(
      '#type' => 'item',
      '#title' => 'Installation path',
      '#markup' => $mpdf_path,
    );
    */
    $form['prince'] = array(
      '#type' => 'fieldset',
      '#title' => t('Prince XML'),
    );
    $form['prince']['library'] = array(
      '#type' => 'item',
      '#title' => 'PHP Library path',
      '#markup' => $prince_path,
    );
    $form['prince']['prince_path'] = array(
      '#type' => 'textfield',
      '#title' => 'Path to binary',
      '#description' => t('Specify the location of the prince executable (e.g. /usr/local/bin/prince'),
      '#required' => TRUE,
      '#default_value' => $path,
    );
    $docraptor_url = $config
      ->get('docraptor_url');
    $docraptor_key = $config
      ->get('docraptor_key');
    $docraptor_test = $config
      ->get('docraptor_test');
    $form['config']['docraptor'] = array(
      '#type' => 'fieldset',
      '#title' => t("DocRaptor PDF Generation Service"),
    );
    $form['config']['docraptor']['docraptor_url'] = array(
      '#type' => 'textfield',
      '#title' => t('URL to Docraptor Service'),
      '#description' => t('Specify the URL to the PDF Document Generation Service'),
      '#default_value' => $docraptor_url,
    );
    $form['config']['docraptor']['docraptor_key'] = array(
      '#type' => 'textfield',
      '#title' => t('DocRaptor API Key'),
      '#description' => t('Enter the API key for your DocRaptor account here.'),
      '#default_value' => $docraptor_key,
    );
    $form['config']['docraptor']['docraptor_test'] = array(
      '#type' => 'checkbox',
      '#title' => t('Test Mode Document Generation'),
      '#desciption' => t('Generating Documents in Test mode generally does not count towards document counts, but places
      a TEST DOCUMENT header at the top of every page of the document'),
      '#default_value' => $docraptor_test,
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => 'Save',
    );
    return parent::buildForm($form, $form_state);
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $this
      ->config('forena_pdf.settings')
      ->set('prince_path', $values['prince_path'])
      ->set('disable_links', $values['disable_links'])
      ->set('docraptor_url', $values['docraptor_url'])
      ->set('docraptor_test', $values['docraptor_test'])
      ->set('docraptor_key', $values['docraptor_key'])
      ->save();

    // Call Configuration form to save changes.
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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. Overrides UrlGeneratorTrait::redirect
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	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PDFGenerationConfigForm::buildForm	public	function	[@inheritdoc} Overrides ConfigFormBase::buildForm
PDFGenerationConfigForm::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PDFGenerationConfigForm::getFormId	public	function	[@inheritdoc} Overrides FormInterface::getFormId
PDFGenerationConfigForm::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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class PDFGenerationConfigForm in Forena Reports 8

Hierarchy

File

Namespace

Members

API Navigation