class StaleContentOptionsForm in Fastly 8.3

Class StaleContentOptionsForm.

@package Drupal\fastly\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\fastly\Form\StaleContentOptionsForm

Expanded class hierarchy of StaleContentOptionsForm

1 string reference to 'StaleContentOptionsForm'

fastly.routing.yml in ./fastly.routing.yml: fastly.routing.yml

File

src/Form/StaleContentOptionsForm.php, line 17

Namespace

Drupal\fastly\Form

View source

class StaleContentOptionsForm extends ConfigFormBase {

  /**
   * The Fastly webhook service.
   *
   * @var \Drupal\fastly\Services\Webhook
   */
  protected $webhook;

  /**
   * Host of current request.
   *
   * @var string
   */
  protected $baseUrl;

  /**
   * Constructs a StaleContentOptionsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\fastly\Services\Webhook $webhook
   *   The Fastly webhook service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack object.
   */
  public function __construct(ConfigFactoryInterface $config_factory, Webhook $webhook, RequestStack $requestStack) {
    parent::__construct($config_factory);
    $this->webhook = $webhook;
    $this->baseUrl = $requestStack
      ->getCurrentRequest()
      ->getHost();
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('fastly.settings');
    $form['stale_while_revalidate'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Stale while revalidate'),
      '#description' => $this
        ->t("Activate the stale-while-revalidate tag to improve experience for users attempting to access expired content."),
      '#default_value' => $config
        ->get('stale_while_revalidate'),
    ];
    $form['stale_while_revalidate_value'] = [
      '#type' => 'number',
      '#description' => $this
        ->t('Number of seconds to show stale content while revalidating cache. More details <a href=":serving_stale_content">here</a>.', [
        ':serving_stale_content' => 'https://docs.fastly.com/guides/performance-tuning/serving-stale-content',
      ]),
      '#default_value' => $config
        ->get('stale_while_revalidate_value') ?: 604800,
      '#states' => [
        'visible' => [
          ':input[name="stale_while_revalidate"]' => [
            'checked' => TRUE,
          ],
        ],
        'required' => [
          ':input[name="stale_while_revalidate"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['stale_if_error'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Stale if error'),
      '#description' => $this
        ->t('Number of seconds to show stale content if the origin server becomes unavailable.'),
      '#default_value' => $config
        ->get('stale_if_error'),
    ];
    $form['stale_if_error_value'] = [
      '#type' => 'number',
      '#description' => $this
        ->t('Number of seconds to show stale content if the origin server becomes unavailable/returns errors. More details <a
href=":serving_stale_content">here</a>.', [
        ':serving_stale_content' => 'https://docs.fastly.com/guides/performance-tuning/serving-stale-content',
      ]),
      '#default_value' => $config
        ->get('stale_if_error_value') ?: 604800,
      '#states' => [
        'visible' => [
          ':input[name="stale_if_error"]' => [
            'checked' => TRUE,
          ],
        ],
        'required' => [
          ':input[name="stale_if_error"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('fastly.settings')
      ->set('stale_while_revalidate', $form_state
      ->getValue('stale_while_revalidate'))
      ->set('stale_while_revalidate_value', $form_state
      ->getValue('stale_while_revalidate_value'))
      ->set('stale_if_error', $form_state
      ->getValue('stale_if_error'))
      ->set('stale_if_error_value', $form_state
      ->getValue('stale_if_error_value'))
      ->save();
    $this->webhook
      ->sendWebHook($this
      ->t("Fastly module configuration changed on %base_url", [
      '%base_url' => $this->baseUrl,
    ]), "config_save");
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
StaleContentOptionsForm::$baseUrl	protected	property	Host of current request.
StaleContentOptionsForm::$webhook	protected	property	The Fastly webhook service.
StaleContentOptionsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
StaleContentOptionsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
StaleContentOptionsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
StaleContentOptionsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
StaleContentOptionsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
StaleContentOptionsForm::__construct	public	function	Constructs a StaleContentOptionsForm object. Overrides ConfigFormBase::__construct
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 StaleContentOptionsForm in Fastly 8.3

Hierarchy

File

Namespace

Members

API Navigation