class IconProvider in Icon API 8

Defines a IconProvider annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\icon\Annotation\IconProvider

1 class is annotated with IconProvider

CoreProvider in src/Plugin/Icon/CoreProvider.php

Drupal Core.

File

src/Annotation/IconProvider.php, line 12

Namespace

Drupal\icon\Annotation

class IconProvider extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name.
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The url for more information regarding the provider
   *
   * @var string
   */
  public $url;

  /**
   * An array of settings passed to the renderer.
   *
   * @var array
   */
  public $settings = [];

}

Members

Name	Modifiers	Type	Description	Overrides
IconProvider::$id	public	property	The plugin ID.
IconProvider::$label	public	property	The human-readable name.
IconProvider::$settings	public	property	An array of settings passed to the renderer.
IconProvider::$url	public	property	The url for more information regarding the provider
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