interface FontAwesomeManagerInterface in Font Awesome Icons 8.2

Icon Manager Service Inteface for Font Awesome.

Hierarchy

• interface \Drupal\fontawesome\FontAwesomeManagerInterface

5 files declare their use of FontAwesomeManagerInterface

AutocompleteController.php in src/Controller/AutocompleteController.php

EditorIconDialog.php in src/Form/EditorIconDialog.php

FontAwesomeIconpickerWidget.php in modules/fontawesome_iconpicker_widget/src/Plugin/Field/FieldWidget/FontAwesomeIconpickerWidget.php

FontAwesomeIconWidget.php in src/Plugin/Field/FieldWidget/FontAwesomeIconWidget.php

IconManagerService.php in modules/fontawesome_iconpicker_widget/src/IconManagerService.php

File

src/FontAwesomeManagerInterface.php, line 8

Namespace

Drupal\fontawesome

interface FontAwesomeManagerInterface {

  /**
   * Get icons.
   *
   * @return array
   *   List of all icons.
   */
  public function getIcons();

  /**
   * Extract metadata for a specific icon.
   *
   * @param string $findIcon
   *   The icon for which we want metadata.
   *
   * @return array|bool
   *   Array containing icons.
   */
  public function getIconMetadata($findIcon);

  /**
   * Returns the FontAwesome metadata file path.
   *
   * @return string
   *   The filepath of the metadata file.
   */
  public function getMetadataFilepath();

  /**
   * Loads the Font Awesome metadata.
   *
   * @return array
   *   The available FontAwesome icon metadata.
   */
  public function getMetadata();

  /**
   * Helper function returns the prefix for an icon based on icon type.
   *
   * @param array $styles
   *   An array of valid styles for the icon.
   * @param string $default
   *   The value to assign here if it's not a brand icon.
   *
   * @return string
   *   A valid prefix for this icon.
   */
  public function determinePrefix(array $styles, $default = 'fas');

}

Members

Name	Modifiers	Type	Description	Overrides
FontAwesomeManagerInterface::determinePrefix	public	function	Helper function returns the prefix for an icon based on icon type.	1
FontAwesomeManagerInterface::getIconMetadata	public	function	Extract metadata for a specific icon.	1
FontAwesomeManagerInterface::getIcons	public	function	Get icons.	1
FontAwesomeManagerInterface::getMetadata	public	function	Loads the Font Awesome metadata.	1
FontAwesomeManagerInterface::getMetadataFilepath	public	function	Returns the FontAwesome metadata file path.	1