class ConfigForm in Apigee Edge 8

Provides a form for changing configuration of the debug module.

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\apigee_edge_debug\Form\ConfigForm

Expanded class hierarchy of ConfigForm

1 string reference to 'ConfigForm'

apigee_edge_debug.routing.yml in modules/apigee_edge_debug/apigee_edge_debug.routing.yml: modules/apigee_edge_debug/apigee_edge_debug.routing.yml

File

modules/apigee_edge_debug/src/Form/ConfigForm.php, line 32

Namespace

Drupal\apigee_edge_debug\Form

View source

class ConfigForm extends ConfigFormBase {

  /**
   * Debug message formatter plugin manager.
   *
   * @var \Drupal\apigee_edge_debug\DebugMessageFormatterPluginManager
   */
  private $pluginManager;

  /**
   * ConfigForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\apigee_edge_debug\DebugMessageFormatterPluginManager $plugin_manager
   *   The debug message formatter plugin manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, DebugMessageFormatterPluginManager $plugin_manager) {
    parent::__construct($config_factory);
    $this->pluginManager = $plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('plugin.manager.apigee_edge_debug.debug_message_formatter'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('apigee_edge_debug.settings');
    $options = [];
    foreach ($this->pluginManager
      ->getDefinitions() as $id => $definition) {
      $options[$id] = $definition['label'];
    }
    $form['log_message_format'] = [
      '#type' => 'container',
      '#tree' => TRUE,
    ];
    $form['log_message_format']['format'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Log message format'),
      '#description' => $this
        ->t('Note: Adding API responses to log messages by using <em>{response_formatted}</em> token may contain sensitive data (ex.: app credentials, etc.).'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('log_message_format'),
    ];
    $form['log_message_format']['help'] = [
      '#type' => 'container',
      'tokens' => [
        '#type' => 'details',
        '#title' => $this
          ->t('Available tokens'),
        '#open' => FALSE,
        'token_list' => [
          '#theme' => 'item_list',
          '#items' => [
            '{request_formatted} - Formatted HTTP request by the selected formatter.',
            '{response_formatted} - Formatted HTTP response by the selected formatter.',
            '{stats} - Transfer statistics of the request.',
          ],
        ],
      ],
    ];
    $form['formatter'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Formatter'),
      '#description' => $this
        ->t('The formatter plugin for the HTTP requests, responses and transfer statistics in log messages.'),
      '#options' => $options,
      '#required' => TRUE,
      '#default_value' => $config
        ->get('formatter'),
    ];
    $form['sanitization'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Sanitization'),
      '#open' => TRUE,
    ];
    $form['sanitization']['mask_organization'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Mask organization'),
      '#description' => $this
        ->t('Mask organization name in log entries.'),
      '#default_value' => $config
        ->get('mask_organization'),
    ];
    $form['sanitization']['remove_credentials'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Remove credentials'),
      '#description' => $this
        ->t('Remove Apigee Edge authentication data from log entries, ex.: authentication header, OAuth client id and secret, access token, refresh token, etc.'),
      '#default_value' => $config
        ->get('remove_credentials'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('apigee_edge_debug.settings')
      ->set('formatter', $form_state
      ->getValue('formatter'))
      ->set('log_message_format', $form_state
      ->getValue([
      'log_message_format',
      'format',
    ]))
      ->set('mask_organization', $form_state
      ->getValue('mask_organization'))
      ->set('remove_credentials', $form_state
      ->getValue('remove_credentials'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigForm::$pluginManager	private	property	Debug message formatter plugin manager.
ConfigForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
ConfigForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
ConfigForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ConfigForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConfigForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigForm::__construct	public	function	ConfigForm constructor. Overrides ConfigFormBase::__construct
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.
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 ConfigForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation