class FontawesomeIconpicker in Font Awesome Iconpicker 8

Same name in this branch

8 src/Plugin/Field/FieldFormatter/FontawesomeIconpicker.php \Drupal\fontawesome_iconpicker\Plugin\Field\FieldFormatter\FontawesomeIconpicker
8 src/Plugin/Field/FieldWidget/FontawesomeIconpicker.php \Drupal\fontawesome_iconpicker\Plugin\Field\FieldWidget\FontawesomeIconpicker

Plugin implementation of the 'fontawesome_iconpicker' formatter.

Plugin annotation


@FieldFormatter(
  id = "fontawesome_iconpicker_formatter_type",
  label = @Translation("Font Awesome Icon Picker"),
  field_types = {
    "text",
    "string",
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\fontawesome_iconpicker\Plugin\Field\FieldFormatter\FontawesomeIconpicker

Expanded class hierarchy of FontawesomeIconpicker

File

src/Plugin/Field/FieldFormatter/FontawesomeIconpicker.php, line 23

Namespace

Drupal\fontawesome_iconpicker\Plugin\Field\FieldFormatter

View source

class FontawesomeIconpicker extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      // Implement default settings.
      'size' => 'fa-1x',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    $elements['size'] = [
      '#type' => 'select',
      '#title' => t('Icon Size'),
      '#description' => t('Select an icon size.'),
      '#default_value' => $this
        ->getSetting('size'),
      '#options' => $this
        ->getFaIconSizes(),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();

    // Implement settings summary.
    $summary[] = t('Size: @size', [
      '@size' => $this
        ->getFaIconSizeLabel($this
        ->getSetting('size')),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $size = $this
        ->getSetting('size');
      $safe_value = $this
        ->viewValue($item);
      $elements[$delta] = [
        '#theme' => 'fontawesome_iconpicker_formatter',
        '#icon' => $safe_value,
        '#size' => $size,
        '#attached' => [
          'library' => [
            'fontawesome_iconpicker/fontawesome',
          ],
        ],
      ];
    }
    return $elements;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {

    // The text value has no text format assigned to it, so the user input
    // should equal the output, including newlines.
    return nl2br(Html::escape($item->value));
  }

  /**
   * Helper function to get list of supported sizes in fontawesome.
   */
  private function getFaIconSizes() {
    return [
      'fa-1x' => '1x',
      'fa-2x' => '2x',
      'fa-3x' => '3x',
      'fa-4x' => '4x',
      'fa-5x' => '5x',
    ];
  }

  /**
   * Helper function to get default icon size.
   */
  private function getFaIconSizeLabel($key) {
    $available_sizes = $this
      ->getFaIconSizes();
    return isset($available_sizes[$key]) ? $available_sizes[$key] : NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FontawesomeIconpicker::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FontawesomeIconpicker::getFaIconSizeLabel	private	function	Helper function to get default icon size.
FontawesomeIconpicker::getFaIconSizes	private	function	Helper function to get list of supported sizes in fontawesome.
FontawesomeIconpicker::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FontawesomeIconpicker::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FontawesomeIconpicker::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FontawesomeIconpicker::viewValue	protected	function	Generate the output appropriate for one field item.
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class FontawesomeIconpicker in Font Awesome Iconpicker 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation