More updates to stop using dev or alpha or beta versions.

[yaffs-website] / web / modules / contrib / security_review / src / CheckSettingsInterface.php

diff --git a/web/modules/contrib/security_review/src/CheckSettingsInterface.php b/web/modules/contrib/security_review/src/CheckSettingsInterface.php
new file mode 100644 (file)
index 0000000..146e12c
--- /dev/null
+++ b/web/modules/contrib/security_review/src/CheckSettingsInterface.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace Drupal\security_review;
+
+/**
+ * Interface for check-specific settings and forms for altering them.
+ */
+interface CheckSettingsInterface {
+
+  /**
+   * Gets a check-specific setting value identified by $key.
+   *
+   * @param string $key
+   *   The key.
+   * @param mixed $default_value
+   *   Default value to return in case $key does not exist.
+   *
+   * @return mixed
+   *   The value of the stored setting.
+   */
+  public function get($key, $default_value);
+
+  /**
+   * Sets a check-specific setting value identified by $key.
+   *
+   * @param string $key
+   *   The key.
+   * @param mixed $value
+   *   The new value.
+   *
+   * @return CheckSettingsInterface
+   *   Returns itself.
+   */
+  public function set($key, $value);
+
+  /**
+   * Form constructor.
+   *
+   * @return array
+   *   The form structure.
+   */
+  public function buildForm();
+
+  /**
+   * Form validation handler.
+   *
+   * @param array $form
+   *   An associative array containing the structure of the form.
+   * @param array $values
+   *   The current values of the form.
+   */
+  public function validateForm(array &$form, array $values);
+
+  /**
+   * Form submission handler.
+   *
+   * @param array $form
+   *   An associative array containing the structure of the form.
+   * @param array $values
+   *   The current values of the form.
+   */
+  public function submitForm(array &$form, array $values);
+
+}