class AppAnalyticsSettingsForm in Apigee Edge 8

Provides a form for app analytics related configuration.

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\AppAnalyticsSettingsForm

Expanded class hierarchy of AppAnalyticsSettingsForm

1 string reference to 'AppAnalyticsSettingsForm'

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

File

src/Form/AppAnalyticsSettingsForm.php, line 32

Namespace

Drupal\apigee_edge\Form

View source

class AppAnalyticsSettingsForm extends ConfigFormBase {

  /**
   * Environment controller object.
   *
   * @var \Apigee\Edge\Api\Management\Controller\EnvironmentController
   */
  protected $environmentController;

  /**
   * Constructs a new DeveloperAppAnalyticsSettingsForm.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\apigee_edge\SDKConnectorInterface $sdk_connector
   *   The SDK connector service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, SDKConnectorInterface $sdk_connector) {
    parent::__construct($config_factory);
    $this->environmentController = new EnvironmentController($sdk_connector
      ->getOrganization(), $sdk_connector
      ->getClient());
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Portal environment is for internal use with integrated portals and
    // is not an actual environment for customers use.
    // To reduce confusion portal environment is hidden from configuration.
    $environments = $this->environmentController
      ->getEntityIds();
    $environments = array_combine($environments, $environments);
    unset($environments['portal']);
    $form['label'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Environment to query for analytics data'),
      '#collapsible' => FALSE,
    ];
    $form['label']['available_environments'] = [
      '#type' => 'checkboxes',
      '#required' => TRUE,
      '#title' => $this
        ->t('Which environments should be displayed on the form to query analytics data?'),
      '#default_value' => $this
        ->config('apigee_edge.common_app_settings')
        ->get('analytics_available_environments') ?: [],
      '#options' => $environments,
    ];
    $form['label']['environment'] = [
      '#type' => 'select',
      '#required' => TRUE,
      '#title' => $this
        ->t('Which environment should be selected by default?'),
      '#default_value' => $this
        ->config('apigee_edge.common_app_settings')
        ->get('analytics_environment'),
      '#options' => $environments,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (!in_array($form_state
      ->getValue('environment'), array_values(array_filter($form_state
      ->getValue('available_environments'))))) {
      $form_state
        ->setError($form['label']['environment'], $this
        ->t('The selected default environment is not available on the form.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('apigee_edge.common_app_settings')
      ->set('analytics_environment', $form_state
      ->getValue('environment'))
      ->set('analytics_available_environments', array_values(array_filter($form_state
      ->getValue('available_environments'))))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AppAnalyticsSettingsForm::$environmentController	protected	property	Environment controller object.
AppAnalyticsSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AppAnalyticsSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
AppAnalyticsSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AppAnalyticsSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AppAnalyticsSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AppAnalyticsSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
AppAnalyticsSettingsForm::__construct	public	function	Constructs a new DeveloperAppAnalyticsSettingsForm. 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.
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 AppAnalyticsSettingsForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation