interface IconSetInterface in Icon API 8

Interface IconSetInterface

Hierarchy

• interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\icon\Plugin\Icon\IconSetInterface extends \Symfony\Component\DependencyInjection\ContainerAwareInterface

File

src/Plugin/Icon/IconSetInterface.php, line 13

Namespace

Drupal\icon\Plugin\Icon

interface IconSetInterface extends ContainerAwareInterface, ContainerFactoryPluginInterface, DerivativeInspectionInterface, PluginInspectionInterface {

  /**
   * Retrieves the human readable label for the plugin.
   *
   * @return string
   *   The human readable label.
   */
  public function getLabel();

  /**
   * Retrieves an array of icons grouped by unique name.
   *
   * @return array
   *   Array of icons.
   */
  public function getIcons();

  /**
   * Retrieves the provider name corresponding to the icon set.
   *
   * @return string
   *   The provider.
   */
  public function getProvider();

  /**
   * Retrieves the url for more information regarding the icon set.
   *
   * @return string
   *   The url.
   */
  public function getUrl();

  /**
   * Retrieves the supplemental information for identifying the icon set.
   *
   * @return string
   *   The version.
   */
  public function getVersion();

  /**
   * Retrieves the path where the icon set resource files are located.
   *
   * @return string
   *   The path to the file.
   */
  public function getPath();

  /**
   * Retrieves the renderer the icon set should implement.
   *
   * @return string
   *   The renderer.
   */
  public function getRenderer();

  /**
   * Retrieves an array of settings passed to the renderer.
   *
   * @return array
   *   Array of settings.
   */
  public function getSettings();

  /**
   * Retrieves an array of resources to be loaded alongside the icon set.
   *
   * @return array
   *   The plugin settings.
   */
  public function getAttached();

  /**
   * Processes a IconSet.
   *
   * @return array
   *   An associative array representing an IconSet
   */
  public function process();

  /**
   * Get icon.
   *
   * @return mixed
   *   Icon or FALSE;
   */
  public function getIcon();

  /**
   * Set icon.
   *
   * @param string $value
   *   Custom Icon value.
   * @param string $key
   *   Custom Icon key.
   */
  public function setIcon($value, $key);

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
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
IconSetInterface::getAttached	public	function	Retrieves an array of resources to be loaded alongside the icon set.	1
IconSetInterface::getIcon	public	function	Get icon.	1
IconSetInterface::getIcons	public	function	Retrieves an array of icons grouped by unique name.	1
IconSetInterface::getLabel	public	function	Retrieves the human readable label for the plugin.	1
IconSetInterface::getPath	public	function	Retrieves the path where the icon set resource files are located.	1
IconSetInterface::getProvider	public	function	Retrieves the provider name corresponding to the icon set.	1
IconSetInterface::getRenderer	public	function	Retrieves the renderer the icon set should implement.	1
IconSetInterface::getSettings	public	function	Retrieves an array of settings passed to the renderer.	1
IconSetInterface::getUrl	public	function	Retrieves the url for more information regarding the icon set.	1
IconSetInterface::getVersion	public	function	Retrieves the supplemental information for identifying the icon set.	1
IconSetInterface::process	public	function	Processes a IconSet.	1
IconSetInterface::setIcon	public	function	Set icon.	1
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