class RavenConfigForm in Raven: Sentry Integration 8

Implements a Raven Config form.

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\raven\Form\RavenConfigForm

1 string reference to 'RavenConfigForm'

raven.routing.yml in ./raven.routing.yml

raven.routing.yml

File

src/Form/RavenConfigForm.php, line 17

Contains \Drupal\raven\Form\RavenConfigForm.

Namespace

Drupal\raven\Form

class RavenConfigForm extends ConfigFormBase {

  /**
   * {@inheritdoc}.
   */
  public function getFormID() {
    return 'raven_config_form';
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['client_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Sentry DSN'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('client_key'),
      '#description' => $this
        ->t('Sentry client key for current site.'),
    ];
    $form['public_dsn'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Sentry public DSN'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('public_dsn'),
      '#description' => $this
        ->t('Sentry public client key for current site.'),
    ];
    $form['timeout'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Timeout'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('timeout'),
      '#description' => $this
        ->t('Connection timeout in seconds.'),
    ];

    // "0" is not a valid checkbox option.
    $levels = RfcLogLevel::getLevels();
    foreach ($levels as $key => $value) {
      $log_levels[$key + 1] = $value;
    }
    $form['log_levels'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Log levels'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('log_levels'),
      '#description' => $this
        ->t('Check the log levels that should be captured by Sentry.'),
      '#options' => $log_levels,
    ];
    $form['fatal_error_handler'] = [
      '#type' => 'checkbox',
      '#title' => t('Enable fatal error handler'),
      '#description' => t('Check to capture fatal PHP errors.'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('fatal_error_handler'),
    ];
    $form['fatal_error_handler_memory'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Reserved memory'),
      '#description' => $this
        ->t('Reserved memory for fatal error handler (KB).'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('fatal_error_handler_memory'),
      '#size' => 10,
    ];
    $form['javascript_error_handler'] = [
      '#type' => 'checkbox',
      '#title' => t('Enable JavaScript error handler'),
      '#description' => t('Check to capture JavaScript errors (if user has the <a target="_blank" href=":url">send JavaScript errors to Sentry</a> permission).', [
        ':url' => \Drupal::url('user.admin_permissions', [], [
          'fragment' => 'module-raven',
        ]),
      ]),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('javascript_error_handler'),
    ];
    $form['stack'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable stacktraces'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('stack'),
      '#description' => $this
        ->t('Check to add stacktraces to reports.'),
    ];
    $form['trace'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Reflection tracing in stacktraces'),
      '#default_value' => $this
        ->config('raven.settings')
        ->get('trace'),
      '#description' => $this
        ->t('Check to enable reflection tracing (function calling arguments) in stacktraces. Warning: This setting allows sensitive data to be logged by Sentry!'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('raven.settings')
      ->set('client_key', $form_state
      ->getValue('client_key'))
      ->set('fatal_error_handler', $form_state
      ->getValue('fatal_error_handler'))
      ->set('fatal_error_handler_memory', $form_state
      ->getValue('fatal_error_handler_memory'))
      ->set('log_levels', $form_state
      ->getValue('log_levels'))
      ->set('stack', $form_state
      ->getValue('stack'))
      ->set('timeout', $form_state
      ->getValue('timeout'))
      ->set('trace', $form_state
      ->getValue('trace'))
      ->set('javascript_error_handler', $form_state
      ->getValue('javascript_error_handler'))
      ->set('public_dsn', $form_state
      ->getValue('public_dsn'))
      ->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
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
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.
RavenConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
RavenConfigForm::getEditableConfigNames	protected	function	. Overrides ConfigFormBaseTrait::getEditableConfigNames
RavenConfigForm::getFormID	public	function	.
RavenConfigForm::submitForm	public	function	. 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.