public function FastlySettingsForm::buildForm in Fastly 8.3

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/FastlySettingsForm.php, line 116

Class

FastlySettingsForm

Class FastlySettingsForm Defines a form to configure module settings.

Namespace

Drupal\fastly\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $config = $this
    ->config('fastly.settings');
  if ($config
    ->get('image_optimization') == 1) {
    if (!$this->api
      ->ioEnabled($config
      ->get('service_id'))) {
      $this
        ->messenger()
        ->addError($this
        ->t('You have Fastly image optimization enabled in configuration but you don\'t have it available on service!'));
    }
  }

  // Validate API credentials set directly in settings files.
  $purge_credentials_are_valid = $this->api
    ->validatePurgeCredentials();
  if (getenv('FASTLY_API_TOKEN')) {
    $api_key = getenv('FASTLY_API_TOKEN');
  }
  else {
    $api_key = count($form_state
      ->getValues()) ? $form_state
      ->getValue('api_key') : $config
      ->get('api_key');
  }
  $form['account_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Account settings'),
    '#open' => TRUE,
  ];
  $form['account_settings']['site_id'] = [
    '#type' => 'machine_name',
    '#title' => $this
      ->t('Site ID'),
    '#default_value' => $config
      ->get('site_id'),
    '#required' => FALSE,
    '#description' => $this
      ->t("Site identifier which is being prepended to cache tags. Use this if you have multiple sites in the same service in Fastly. Note: You can use the environment variable <code>FASTLY_SITE_ID</code> to set this also. If nothing is set in either config or environment variable then one will be randomly generated for you."),
  ];
  $purge_credentials_status_message = $purge_credentials_are_valid ? $this
    ->t("An <em>API key</em> and <em>Service Id</em> pair are set that can perform purge operations. These credentials may not be adequate to performs all operations on this form. Can be overridden by <code>FASTLY_API_TOKEN</code> environment variable.") : $this
    ->t("You can find your personal API tokens on your Fastly Account Settings page. See <a href=':using_api_tokens'>using API tokens</a> for more information. If you don't have an account yet, please visit <a href=':signup'>https://www.fastly.com/signup</a> on Fastly. Can be overridden by <code>FASTLY_API_TOKEN</code> environment variable.", [
    ':using_api_tokens' => 'https://docs.fastly.com/guides/account-management-and-security/using-api-tokens',
    ':signup' => 'https://www.fastly.com/signup',
  ]);
  $form['service_settings'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Service settings'),
    '#open' => TRUE,
  ];
  $form['account_settings']['api_key'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('API key'),
    '#default_value' => $api_key,
    '#required' => !$purge_credentials_are_valid,
    '#description' => $purge_credentials_status_message,
    // Update the listed services whenever the API key is modified.
    '#ajax' => [
      'callback' => '::updateServices',
      'wrapper' => 'edit-service-wrapper',
      'event' => 'change',
    ],
  ];
  $service_options = $this
    ->getServiceOptions();
  $form['service_settings']['service_id'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Service'),
    '#options' => $service_options,
    '#empty_option' => $this
      ->t('- Select -'),
    '#default_value' => getenv('FASTLY_API_SERVICE') ?: $config
      ->get('service_id'),
    '#required' => !$purge_credentials_are_valid,
    '#description' => $this
      ->t('A Service represents the configuration for your website to be served through Fastly. You can override this with FASTLY_API_SERVICE environment variable'),
    // Hide while no API key is set.
    '#states' => [
      'invisible' => [
        'input[name="api_key"]' => [
          'empty' => TRUE,
        ],
      ],
    ],
    '#prefix' => '<div id="edit-service-wrapper">',
    '#suffix' => '</div>',
  ];
  $form['vcl'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('VCL update options'),
    '#open' => TRUE,
    '#description' => $this
      ->t('Upload Fastly VCL snippets that improve cacheability of the site. Note: VCL assumes Drupal is the only app running. Please test in staging before applying in production.'),
  ];
  $form['vcl']['vcl_snippets'] = [
    '#type' => 'button',
    '#title' => 'Upload latest Fastly VCL snippets',
    '#value' => $this
      ->t('Upload latest Fastly VCL'),
    '#ajax' => [
      'callback' => [
        $this,
        'uploadVcls',
      ],
      'event' => 'click-custom',
    ],
    '#attached' => [
      'library' => [
        'fastly/fastly',
      ],
    ],
    '#suffix' => '<span class="email-valid-message"></span>',
  ];
  $form['vcl']['activate'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Activate version on VCL upload'),
    '#default_value' => 1,
    '#attributes' => [
      'checked' => 'checked',
    ],
  ];
  $form['vcl']['error_maintenance'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Error/Maintenance Page'),
    '#default_value' => $config
      ->get('error_maintenance'),
    '#required' => FALSE,
    '#description' => $this
      ->t('Custom error / maintenance HTML page content. "Pretty" page presented to the end user on HTTP 500+ errors. Max size 128kB'),
    '#prefix' => '<div id="edit-maintenance-wrapper">',
    '#suffix' => '</div>',
  ];
  $form['vcl']['upload_error_maintenance'] = [
    '#type' => 'button',
    '#value' => $this
      ->t('Upload error maintenance page'),
    '#required' => FALSE,
    '#description' => $this
      ->t('Upload error maintenance page'),
    '#ajax' => [
      'callback' => [
        $this,
        'uploadMaintenance',
      ],
      'event' => 'click-custom-upload-error-maintenance',
    ],
    '#attached' => [
      'library' => [
        'fastly/fastly',
      ],
    ],
    '#suffix' => '<span class="error-maintenance-message"></span>',
  ];
  $form['purge_actions'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Purge actions'),
    '#description' => $this
      ->t('Purge / invalidate all site content: affects this site only. <br><b>WARNING: PURGE WHOLE SERVICE ACTION WILL DESTROY THE ENTIRE CACHE FOR ALL SITES IN THE CURRENT FASTLY SERVICE.</b>'),
    '#open' => TRUE,
  ];
  $form['purge_actions']['purge_all_keys'] = [
    '#type' => 'button',
    '#value' => $this
      ->t('Purge / invalidate all site content'),
    '#required' => FALSE,
    '#description' => $this
      ->t('Purge all'),
    '#ajax' => [
      'callback' => [
        $this,
        'purgeAllByKeys',
      ],
      'event' => 'click-custom-purge-all-keys',
    ],
    '#attached' => [
      'library' => [
        'fastly/fastly',
      ],
    ],
    '#suffix' => '<span class="purge-all-message-keys"></span>',
  ];
  $form['purge_actions']['purge_all'] = [
    '#type' => 'button',
    '#value' => $this
      ->t('Purge whole service'),
    '#required' => FALSE,
    '#description' => $this
      ->t('Purge whole service'),
    '#ajax' => [
      'callback' => [
        $this,
        'purgeAll',
      ],
      'event' => 'click-custom-purge-all',
    ],
    '#attached' => [
      'library' => [
        'fastly/fastly',
      ],
    ],
    '#suffix' => '<span class="purge-all-message"></span>',
  ];
  return parent::buildForm($form, $form_state);
}