class DocumentConfigForm in Forena Reports 8

Implements \Drupal\forena\Form\DocumentConfigForm

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\Form\DocumentConfigForm

Expanded class hierarchy of DocumentConfigForm

1 string reference to 'DocumentConfigForm'

forena.routing.yml in ./forena.routing.yml: forena.routing.yml

File

src/Form/DocumentConfigForm.php, line 18

Namespace

Drupal\forena\Form

View source

class DocumentConfigForm extends ConfigFormBase {
  protected $possible_docs = [];
  public function __construct() {

    // Load the possible documents based on the service.
    $pm = \Drupal::service('frxplugin.manager.document');
    $plugins = $pm
      ->getDefinitions();
    foreach ($plugins as $plugin) {
      $id = $plugin['id'];
      $name = $plugin['name'];
      $ext = $plugin['ext'];
      if ($id != 'drupal') {
        $this->possible_docs[$id] = "({$ext}){$name}";
      }
    }
    asort($this->possible_docs);
  }

  /**
   * {@inherit}
   */
  public function getFormId() {
    return 'forena_document_configuration_form';
  }
  public function getEditableConfigNames() {
    return [
      'forena.settings',
    ];
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    $possible_docs = DocManager::instance()
      ->getDocTypes();
    asort($possible_docs);
    $doc_options = array_combine($possible_docs, $possible_docs);
    $config = $this
      ->config('forena.settings');
    unset($doc_options['drupal']);
    $doc_formats = $config
      ->get('doc_formats');
    $key = array_search('drupal', $doc_formats);
    unset($doc_formats[$key]);

    // Load the possible document formats
    $form['doc_formats'] = [
      '#type' => 'checkboxes',
      '#title' => t('Allowed Document Types'),
      '#options' => $this->possible_docs,
      '#descriptions' => t('Document types allowed for reports. Only check one per document type'),
      '#default_value' => $doc_formats,
    ];

    // Determine the default document formats
    $form['doc_defaults'] = [
      '#type' => 'checkboxes',
      '#title' => t('Default Dcoument Types'),
      '#options' => $doc_options,
      '#description' => t('Document Types enabled if none are specified'),
      '#default_value' => $config
        ->get('doc_defaults'),
    ];
    $form['email_override'] = array(
      '#type' => 'checkbox',
      '#title' => 'Run email merges in test mode',
      '#default_value' => $config
        ->get('email_override'),
      '#description' => t('When this box is checked emails are sent to the currently logged in user.  Useful for testing environments.'),
    );

    // Determine possible input format options
    $formats = filter_formats();
    $options = [
      'none' => $this
        ->t('None'),
    ];
    foreach ($formats as $format) {
      $options[$format
        ->id()] = $format
        ->label();
    }

    // Email Input format
    $form['email_input_format'] = [
      '#type' => 'select',
      '#title' => t('Email Text Format'),
      '#options' => $options,
      '#description' => $this
        ->t('Process Mail merge reports reports using specified Text Formats. This can be overridden at the skin or report level.'),
      '#default_value' => $config
        ->get('email_input_format'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inherit}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $doc_formats = array_filter($values['doc_formats']);

    // You can't disable the drupal document format
    $doc_formats['drupal'] = 'drupal';
    $doc_defaults = array_filter($values['doc_defaults']);
    $this
      ->config('forena.settings')
      ->set('doc_formats', array_values($doc_formats))
      ->set('doc_defaults', array_values($doc_defaults))
      ->set('email_input_format', $values['email_input_format'])
      ->set('email_override', $values['email_override'])
      ->save();
    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
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
DocumentConfigForm::$possible_docs	protected	property
DocumentConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
DocumentConfigForm::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DocumentConfigForm::getFormId	public	function	{@inherit} Overrides FormInterface::getFormId
DocumentConfigForm::submitForm	public	function	{@inherit} Overrides ConfigFormBase::submitForm
DocumentConfigForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.
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 DocumentConfigForm in Forena Reports 8

Hierarchy

File

Namespace

Members

API Navigation