class IconSet in Icon API 8

Defines a IconSet annotation object.

Hierarchy

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

1 class is annotated with IconSet

CoreSet in src/Plugin/Icon/CoreSet.php

Drupal Core Icon Set.

File

src/Annotation/IconSet.php, line 12

Namespace

Drupal\icon\Annotation

class IconSet extends Plugin {

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

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

  /**
   * An array of icons grouped by unique name.
   *
   * @var array
   */
  public $icons = [];

  /**
   * The provider name corresponding to the icon set.
   *
   * @var string
   */
  public $provider;

  /**
   * The url for more information regarding the icon set.
   *
   * @var string
   */
  public $url;

  /**
   * Supplemental information for identifying the icon set.
   *
   * @var string
   */
  public $version;

  /**
   * Path where the icon set resource files are located.
   *
   * @var string
   */
  public $path;

  /**
   * The renderer the icon set should implement.
   *
   * @var string
   */
  public $renderer;

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

  /**
   * An array of resources to be loaded alongside the icon set.
   *
   * @var array
   */
  public $attached = [];

}

Members

Name	Modifiers	Type	Description	Overrides
IconSet::$attached	public	property	An array of resources to be loaded alongside the icon set.
IconSet::$icons	public	property	An array of icons grouped by unique name.
IconSet::$id	public	property	The plugin ID.
IconSet::$label	public	property	The human-readable name.
IconSet::$path	public	property	Path where the icon set resource files are located.
IconSet::$provider	public	property	The provider name corresponding to the icon set.
IconSet::$renderer	public	property	The renderer the icon set should implement.
IconSet::$settings	public	property	An array of settings passed to the renderer.
IconSet::$url	public	property	The url for more information regarding the icon set.
IconSet::$version	public	property	Supplemental information for identifying the icon set.
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