interface SettingInterface

gen-theme-setting-docs.php in scripts/gen-theme-setting-docs.php

Generates the markdown documentation for all available theme settings.

ThemeSettings.php in src/ThemeSettings.php

interface SettingInterface extends PluginInspectionInterface, FormInterface {

  /**
   * Indicates whether a setting is accessible.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The value to supply to the setting's #access property.
   */
  public function access();

  /**
   * Indicates whether a form element should be created automatically.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function autoCreateFormElement();

  /**
   * Determines whether a theme setting should added to drupalSettings.
   *
   * By default, this value will be FALSE unless the method is overridden. This
   * is to ensure that no sensitive information can be potientially leaked.
   *
   * @see \Drupal\bootstrap\Plugin\Setting\SettingBase::drupalSettings()
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function drupalSettings();

  /**
   * The cache tags associated with this object.
   *
   * When this object is modified, these cache tags will be invalidated.
   *
   * @return string[]
   *   A set of cache tags.
   */
  public function getCacheTags();

  /**
   * Retrieves the setting's default value.
   *
   * @return string
   *   The setting's default value.
   */
  public function getDefaultValue();

  /**
   * Retrieves the setting's description, if any.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The setting description.
   */
  public function getDescription();

  /**
   * Retrieves the group form element the setting belongs to.
   *
   * @param array $form
   *   Nested array of form elements that comprise the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\bootstrap\Utility\Element
   *   The group element object.
   *
   * @deprecated Will be removed in a future release. Use \Drupal\bootstrap\Plugin\Setting\SettingInterface::getGroupElement
   */
  public function getGroup(array &$form, FormStateInterface $form_state);

  /**
   * Retrieves the group form element the setting belongs to.
   *
   * @param \Drupal\bootstrap\Utility\Element $form
   *   The Element object that comprises the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\bootstrap\Utility\Element
   *   The group element object.
   */
  public function getGroupElement(Element $form, FormStateInterface $form_state);

  /**
   * Retrieves the setting's groups.
   *
   * @return array
   *   The setting's group.
   */
  public function getGroups();

  /**
   * Retrieves the form element for the setting.
   *
   * @param array $form
   *   Nested array of form elements that comprise the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\bootstrap\Utility\Element
   *   The setting element object.
   *
   * @deprecated Will be removed in a future release. Use \Drupal\bootstrap\Plugin\Setting\SettingInterface::getSettingElement
   */
  public function getElement(array &$form, FormStateInterface $form_state);

  /**
   * Retrieves the settings options, if set.
   *
   * @return array
   *   An array of options.
   */
  public function getOptions();

  /**
   * Retrieves the form element for the setting.
   *
   * @param \Drupal\bootstrap\Utility\Element $form
   *   The Element object that comprises the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\bootstrap\Utility\Element
   *   The setting element object.
   */
  public function getSettingElement(Element $form, FormStateInterface $form_state);

  /**
   * Retrieves the setting's human-readable title.
   *
   * @return string
   *   The setting's type.
   */
  public function getTitle();

  /**
   * Retrieves the value from other deprecated settings.
   *
   * @param array $values
   *   An array of values, keyed by deprecated setting name.
   * @param \Drupal\bootstrap\Plugin\Setting\DeprecatedSettingInterface[] $deprecated
   *   An array of deprecated Setting objects indicating this setting replaced
   *   theirs, keyed by deprecated setting name.
   *
   * @return string
   *   The setting's deprecated value.
   */
  public function processDeprecatedValues(array $values, array $deprecated);

}