interface IconsetInterface in Social Media Links Block and Field 8.2

Defines an interface for social media links iconset plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\social_media_links\IconsetInterface

3 files declare their use of IconsetInterface

ElegantThemes.php in src/Plugin/SocialMediaLinks/Iconset/ElegantThemes.php

FontAwesome.php in src/Plugin/SocialMediaLinks/Iconset/FontAwesome.php

Nouveller.php in src/Plugin/SocialMediaLinks/Iconset/Nouveller.php

File

src/IconsetInterface.php, line 10

Namespace

Drupal\social_media_links

interface IconsetInterface extends PluginInspectionInterface {

  /**
   * Return the name of the iconset.
   *
   * @return string
   *   The name of the iconset.
   */
  public function getName();

  /**
   * Return the name of the publisher.
   *
   * @return string
   *   Publisher name.
   */
  public function getPublisher();

  /**
   * Return the url of the publisher.
   *
   * @return string
   *   URL to the publisher website.
   */
  public function getPublisherUrl();

  /**
   * Return the url to download the iconset.
   *
   * @return string
   *   URL to download the iconset.
   */
  public function getDownloadUrl();

  /**
   * Return the available styles.
   *
   * @return array
   *   The available styles/sizes of the iconset.
   */
  public function getStyle();

  /**
   * Return the path of an icon for the given platform (iconName) and style.
   *
   * @param string $icon_name
   *   The name of the icon/platform.
   * @param string $style
   *   The style/size.
   *
   * @return string
   *   The path to the icon of a platform.
   */
  public function getIconPath($icon_name, $style);

}

Members

Name	Modifiers	Type	Description	Overrides
IconsetInterface::getDownloadUrl	public	function	Return the url to download the iconset.	1
IconsetInterface::getIconPath	public	function	Return the path of an icon for the given platform (iconName) and style.	3
IconsetInterface::getName	public	function	Return the name of the iconset.	1
IconsetInterface::getPublisher	public	function	Return the name of the publisher.	1
IconsetInterface::getPublisherUrl	public	function	Return the url of the publisher.	1
IconsetInterface::getStyle	public	function	Return the available styles.	3
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