class AvatarKitService in Avatar Kit 8.2

Defines the annotation for AvatarKitService plugins.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\avatars\Annotation\AvatarKitService

1 file declares its use of AvatarKitService

AvatarKitServicePluginManager.php in src/AvatarKitServicePluginManager.php

2 classes are annotated with AvatarKitService

AvatarKitCommonService in src/Plugin/Avatars/Service/AvatarKitCommonService.php

Automatically creates services based on plugins from Avatar Kit library.

AvatarKitEntityField in src/Plugin/Avatars/Service/AvatarKitEntityField.php

Gets avatar from a field in the same entity.

File

src/Annotation/AvatarKitService.php, line 12

Namespace

Drupal\avatars\Annotation

class AvatarKitService extends Plugin {

  /**
   * Unique identifier of the service.
   *
   * @var string
   * @Required
   */
  public $id;

  /**
   * Description of the service.
   *
   * @var string
   * @Required
   */
  public $description;

  /**
   * Whether the service uses File entities as a source.
   *
   * @var bool
   */
  public $files = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
AvatarKitService::$description	public	property	Description of the service.
AvatarKitService::$files	public	property	Whether the service uses File entities as a source.
AvatarKitService::$id	public	property	Unique identifier of the service.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2