interface TwitterWidgetInterface in Twitter Embed 8
Interface TwitterWidgetInterface.
Hierarchy
- interface \Drupal\twitter_embed\TwitterWidgetInterface
Expanded class hierarchy of TwitterWidgetInterface
All classes that implement TwitterWidgetInterface
3 files declare their use of TwitterWidgetInterface
- TwitterBlockBase.php in src/
Plugin/ Block/ TwitterBlockBase.php - TwitterEmbedItem.php in src/
Plugin/ Field/ FieldType/ TwitterEmbedItem.php - TwitterEmbedWidget.php in src/
Plugin/ Field/ FieldWidget/ TwitterEmbedWidget.php
File
- src/
TwitterWidgetInterface.php, line 8
Namespace
Drupal\twitter_embedView source
interface TwitterWidgetInterface {
const USERNAME_MAX_LENGTH = 50;
/**
* Get all available settings for a widget.
*
* @return array
* List of settings.
*/
public function getAvailableSettings();
/**
* Get default settings for a widget.
*
* @return array
* List of settings.
*/
public static function getDefaultSettings();
/**
* Get the settings form for a widget.
*
* It allows the sharing of the configuration among.
* Block configuration and FieldFormatter configuration.
*
* @param array $configuration
* List of selected configuration.
*
* @return array
* The settings form.
*/
public function getSettingsForm(array $configuration);
/**
* Get all available types.
*
* @return array
* Array of types.
*/
public function getAvailableTypes();
/**
* Get all available display styles.
*
* @return array
* Array of display styles.
*/
public function getAvailableDisplayStyles();
/**
* Get all available languages.
*
* @return array
* Array of languages.
*/
public function getAvailableLanguages();
/**
* Returns a Twitter widget depending on the configuration.
*
* @param array $configuration
* List of selected configuration.
*
* @return array
* The Twitter widget as a render array.
*/
public function getWidget(array $configuration);
/**
* Set the configuration state based on the chosen options.
*
* Some options are dependent to others, resets the options that
* does not need values or set the default configuration to
* avoid a configuration state that does not comply with the Twitter widgets.
*
* @param array $configuration
* List of selected configuration.
*/
public function setDependentConfiguration(array &$configuration);
/**
* Set the settings form #states based the context selector.
*
* The javascript selector changes, depending on the FieldFormatter
* or Block implementation.
*
* @param array $form
* The original Form array.
* @param string $selector
* The javascript selector.
*
* @return array
* The form array with states for form elements.
*/
public function setSettingsFormStates(array $form, $selector);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
TwitterWidgetInterface:: |
public | function | Get all available display styles. | 2 |
TwitterWidgetInterface:: |
public | function | Get all available languages. | 1 |
TwitterWidgetInterface:: |
public | function | Get all available settings for a widget. | 2 |
TwitterWidgetInterface:: |
public | function | Get all available types. | 2 |
TwitterWidgetInterface:: |
public static | function | Get default settings for a widget. | 2 |
TwitterWidgetInterface:: |
public | function | Get the settings form for a widget. | 2 |
TwitterWidgetInterface:: |
public | function | Returns a Twitter widget depending on the configuration. | 1 |
TwitterWidgetInterface:: |
public | function | Set the configuration state based on the chosen options. | 2 |
TwitterWidgetInterface:: |
public | function | Set the settings form #states based the context selector. | 2 |
TwitterWidgetInterface:: |
constant |