interface AvatarGeneratorPluginInterface in Avatar Kit 8

Interface for AvatarGenerator plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface
  • interface \Drupal\avatars\Plugin\AvatarGenerator\AvatarGeneratorPluginInterface

File

src/Plugin/AvatarGenerator/AvatarGeneratorPluginInterface.php, line 15

Namespace

Drupal\avatars\Plugin\AvatarGenerator

interface AvatarGeneratorPluginInterface extends PluginInspectionInterface, DerivativeInspectionInterface, PluginFormInterface, ConfigurableInterface, DependentPluginInterface {

  /**
   * Generate a summary about the current configuration of the widget.
   *
   * @return array
   *   A render array.
   */
  public function settingsSummary();

  /**
   * Gets File object for an avatar.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   A user account.
   *
   * @return \Drupal\file\FileInterface
   *   A file object.
   */
  public function getFile(AccountInterface $account);

  /**
   * Creates a URI to an avatar.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   A user account.
   *
   * @return string
   *   URI to an image file.
   */
  public function generateUri(AccountInterface $account);

}

Members

Name	Modifiers	Type	Description	Overrides
AvatarGeneratorPluginInterface::generateUri	public	function	Creates a URI to an avatar.	1
AvatarGeneratorPluginInterface::getFile	public	function	Gets File object for an avatar.	1
AvatarGeneratorPluginInterface::settingsSummary	public	function	Generate a summary about the current configuration of the widget.	1
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
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