WidgetBaseInterface

Base interface definition for "Field widget" plugins.

This interface details base wrapping methods that most widget implementations will want to directly inherit from Drupal\Core\Field\WidgetBase. See Drupal\Core\Field\WidgetInterface for methods that will more likely be overridden in actual widget implementations.

Hierarchy

interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface
- interface \Drupal\Core\Field\PluginSettingsInterface
  - interface \Drupal\Core\Field\WidgetBaseInterface

File

core/lib/Drupal/Core/Field/WidgetBaseInterface.php, line 16

Namespace

Drupal\Core\Field

Members

Name	Modifiers	Type	Description
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.
PluginSettingsInterface::defaultSettings	public static	function	Defines the default settings for this plugin.
PluginSettingsInterface::getSetting	public	function	Returns the value of a setting, or its default value if absent.
PluginSettingsInterface::getSettings	public	function	Returns the array of settings, including defaults for missing settings.
PluginSettingsInterface::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted.
PluginSettingsInterface::setSetting	public	function	Sets the value of a setting for the plugin.
PluginSettingsInterface::setSettings	public	function	Sets the settings for the plugin.
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.
WidgetBaseInterface::extractFormValues	public	function	Extracts field values from submitted form values.
WidgetBaseInterface::flagErrors	public	function	Reports field-level validation errors against actual form elements.
WidgetBaseInterface::form	public	function	Creates a form element for a field.
WidgetBaseInterface::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state.
WidgetBaseInterface::setWidgetState	public static	function	Stores processing information about the widget in $form_state.

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Field%21WidgetBaseInterface.php/interface/WidgetBaseInterface/8.2.x

doc_Drupal

2016-10-29 09:56:43

Comments