class MaestroEngineSettingsForm in Maestro 8.2

Same name and namespace in other branches

3.x src/Form/MaestroEngineSettingsForm.php \Drupal\maestro\Form\MaestroEngineSettingsForm

Configure settings for this site.

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\maestro\Form\MaestroEngineSettingsForm

Expanded class hierarchy of MaestroEngineSettingsForm

1 string reference to 'MaestroEngineSettingsForm'

maestro.routing.yml in ./maestro.routing.yml: maestro.routing.yml

File

src/Form/MaestroEngineSettingsForm.php, line 11

Namespace

Drupal\maestro\Form

View source

class MaestroEngineSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('maestro.settings');
    $default = $config
      ->get('maestro_redirect_location');
    $form['maestro_redirect_location'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('URI used in notifications to redirect the recipient to.'),
      '#default_value' => isset($default) ? $default : '/taskconsole',
      '#description' => $this
        ->t('Defaults to /taskconsole'),
      '#required' => TRUE,
    ];
    $form['maestro_send_notifications'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Send out notifications"),
      '#default_value' => $config
        ->get('maestro_send_notifications'),
      '#description' => $this
        ->t('When checked, this config value will enable outgoing notifications.'),
    ];
    $form['maestro_orchestrator_task_console'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Run the Orchestrator on Task Console Refreshes"),
      '#default_value' => $config
        ->get('maestro_orchestrator_task_console'),
      '#description' => $this
        ->t('When checked, a refresh of the Task Console (provided by Maestro) will run the orchestrator.'),
    ];
    $default = $config
      ->get('maestro_orchestrator_token');
    $form['maestro_orchestrator_token'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('The token that MUST be appended to the /orchestrator URL in order to run the orchestrator.'),
      '#default_value' => isset($default) ? $default : '',
      '#description' => $this
        ->t('Defaults to nothing.  YOU MUST SET THIS!  Resulting URL to run the orchestrator is http://[site]/orchestrator/{token}'),
      '#required' => TRUE,
    ];
    $default = $config
      ->get('maestro_orchestrator_lock_execution_time');
    $form['maestro_orchestrator_lock_execution_time'] = [
      '#type' => 'number',
      '#size' => 5,
      '#title' => $this
        ->t('The number of seconds you wish to let the orchestrator lock for.'),
      '#default_value' => isset($default) ? $default : '30',
      '#description' => $this
        ->t('Default 30 seconds. You must tune this value to however long you believe the orchestrator can potentially run for.'),
      '#required' => TRUE,
    ];
    $form['maestro_orchestrator_development_mode'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Turn on Maestro Development Mode during orchestrator execution."),
      '#default_value' => $config
        ->get('maestro_orchestrator_development_mode'),
      '#description' => $this
        ->t('LEAVE THIS OFF EXCEPT WHEN TROUBLESHOOTING. When checked, Maestro Development mode is activated.') . $this
        ->t('This forces the orchestrator to reset the cache on entity queries.') . $this
        ->t('This will add processing time to the orchestrator. Please see the Maestro Installation Documentation on Drupal.org (https://www.drupal.org/docs/8/modules/maestro/installation).'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('maestro.settings')
      ->set('maestro_send_notifications', $form_state
      ->getValue('maestro_send_notifications'))
      ->save();
    $this
      ->config('maestro.settings')
      ->set('maestro_orchestrator_task_console', $form_state
      ->getValue('maestro_orchestrator_task_console'))
      ->save();
    $this
      ->config('maestro.settings')
      ->set('maestro_redirect_location', $form_state
      ->getValue('maestro_redirect_location'))
      ->save();
    $this
      ->config('maestro.settings')
      ->set('maestro_orchestrator_token', $form_state
      ->getValue('maestro_orchestrator_token'))
      ->save();
    $this
      ->config('maestro.settings')
      ->set('maestro_orchestrator_lock_execution_time', $form_state
      ->getValue('maestro_orchestrator_lock_execution_time'))
      ->save();
    $this
      ->config('maestro.settings')
      ->set('maestro_orchestrator_development_mode', $form_state
      ->getValue('maestro_orchestrator_development_mode'))
      ->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
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.
MaestroEngineSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
MaestroEngineSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MaestroEngineSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MaestroEngineSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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 MaestroEngineSettingsForm in Maestro 8.2

Hierarchy

File

Namespace

Members

API Navigation