class AppCallbackUrlSettingsForm in Apigee Edge 8

Provides configuration form for app callback settings.

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

Expanded class hierarchy of AppCallbackUrlSettingsForm

1 string reference to 'AppCallbackUrlSettingsForm'

apigee_edge.routing.yml in ./apigee_edge.routing.yml: apigee_edge.routing.yml

File

src/Form/AppCallbackUrlSettingsForm.php, line 29

Namespace

Drupal\apigee_edge\Form

View source

class AppCallbackUrlSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $app_settings = $this
      ->config('apigee_edge.common_app_settings');
    $form['callback_url'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Callback URL validation settings'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    $form['callback_url']['pattern'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pattern'),
      '#default_value' => $app_settings
        ->get('callback_url_pattern'),
      '#description' => $this
        ->t('Regular expression that a Callback URL should match. Default is "^https?:\\/\\/.*$" that ensures callback url starts with either <em>http://</em> or <em>https://</em>.'),
      '#required' => TRUE,
    ];
    $form['callback_url']['pattern_error_message'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Validation error message'),
      '#default_value' => $app_settings
        ->get('callback_url_pattern_error_message'),
      '#description' => $this
        ->t('Client-side validation error message if a callback URL does not match.'),
      '#required' => TRUE,
    ];
    $form['callback_url']['description'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Description'),
      '#default_value' => $app_settings
        ->get('callback_url_description'),
      '#description' => $this
        ->t('Description of a Callback URL field.'),
    ];
    $form['callback_url']['placeholder'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder'),
      '#default_value' => $app_settings
        ->get('callback_url_placeholder'),
      '#description' => $this
        ->t('Placeholder for a Callback URL field.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (mb_strpos($form_state
      ->getValue([
      'callback_url',
      'pattern',
    ], ''), '^http') === FALSE) {
      $form_state
        ->setError($form['callback_url']['pattern'], $this
        ->t('The pattern should start with <em>^http</em> to limit the acceptable protocols.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('apigee_edge.common_app_settings')
      ->set('callback_url_pattern', $form_state
      ->getValue([
      'callback_url',
      'pattern',
    ]))
      ->set('callback_url_pattern_error_message', $form_state
      ->getValue([
      'callback_url',
      'pattern_error_message',
    ]))
      ->set('callback_url_description', $form_state
      ->getValue([
      'callback_url',
      'description',
    ]))
      ->set('callback_url_placeholder', $form_state
      ->getValue([
      'callback_url',
      'placeholder',
    ]))
      ->save();

    // Clear all caches - especially app callback url field's configuration.
    drupal_flush_all_caches();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AppCallbackUrlSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AppCallbackUrlSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AppCallbackUrlSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AppCallbackUrlSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AppCallbackUrlSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.
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 AppCallbackUrlSettingsForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation