interface SettingInterface in Express 8

Defines the interface for an object oriented theme setting plugin.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\bootstrap\Plugin\Form\FormInterface
  • interface \Drupal\bootstrap\Plugin\Setting\SettingInterface

File

themes/contrib/bootstrap/src/Plugin/Setting/SettingInterface.php, line 19

Contains \Drupal\bootstrap\Plugin\Setting\SettingInterface.

Namespace

Drupal\bootstrap\Plugin\Setting

interface SettingInterface extends PluginInspectionInterface, FormInterface {

  /**
   * 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 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();

}

Members

Name	Modifiers	Type	Description	Overrides
FormInterface::alterForm	public	function	The alter method to store the code.	2
FormInterface::alterFormElement	public	function	The alter method to store the code.	2
FormInterface::submitForm	public static	function	Form submission handler.	2
FormInterface::submitFormElement	public static	function	Form submission handler.	2
FormInterface::validateForm	public static	function	Form validation handler.	2
FormInterface::validateFormElement	public static	function	Form validation handler.	2
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
SettingInterface::drupalSettings	public	function	Determines whether a theme setting should added to drupalSettings.	1
SettingInterface::getCacheTags	public	function	The cache tags associated with this object.	1
SettingInterface::getDefaultValue	public	function	Retrieves the setting's default value.	1
SettingInterface::getElement Deprecated	public	function	Retrieves the form element for the setting.	1
SettingInterface::getGroup Deprecated	public	function	Retrieves the group form element the setting belongs to.	1
SettingInterface::getGroupElement	public	function	Retrieves the group form element the setting belongs to.	1
SettingInterface::getGroups	public	function	Retrieves the setting's groups.	1
SettingInterface::getOptions	public	function	Retrieves the settings options, if set.	1
SettingInterface::getSettingElement	public	function	Retrieves the form element for the setting.	1
SettingInterface::getTitle	public	function	Retrieves the setting's human-readable title.	1