class ToggleEditableFormatter in Toggle Editable fields 8

Plugin implementation of the 'ranking' formatter.

Plugin annotation


@FieldFormatter(
  id = "toggle_editable_formatter",
  label = @Translation("Toggle Editable Formatter"),
  field_types = {
    "boolean"
  }
)

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\toggle_editable_fields\Plugin\Field\FieldFormatter\ToggleEditableFormatter implements ContainerFactoryPluginInterface

Expanded class hierarchy of ToggleEditableFormatter

1 file declares its use of ToggleEditableFormatter

ToggleEditableFieldsUiTest.php in tests/src/Functional/ToggleEditableFieldsUiTest.php

File

src/Plugin/Field/FieldFormatter/ToggleEditableFormatter.php, line 27

Namespace

Drupal\toggle_editable_fields\Plugin\Field\FieldFormatter

View source

class ToggleEditableFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The class resolver.
   *
   * @var \Drupal\Core\DependencyInjection\ClassResolverInterface
   */
  protected $classResolver;

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * Constructs a StringFormatter instance.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
   *   The class resolver.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ClassResolverInterface $class_resolver, FormBuilderInterface $form_builder) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->classResolver = $class_resolver;
    $this->formBuilder = $form_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('class_resolver'), $container
      ->get('form_builder'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'on' => 'On',
      'off' => 'Off',
      'size' => 'small',
      'onstyle' => 'success',
      'offstyle' => 'default',
      'height' => NULL,
      'width' => NULL,
    ] + parent::defaultSettings();
  }

  /**
   * Return all sizes options for boostrapToggle plugin.
   *
   * @return array
   *   A list of options to be use with boostrapToggle plugin.
   */
  public function bootstrapToggleSizesOptions() {
    return [
      'large' => $this
        ->t('Large'),
      'normal' => $this
        ->t('Normal'),
      'small' => $this
        ->t('Small'),
      'mini' => $this
        ->t('Mini'),
    ];
  }

  /**
   * Return all styles options for boostrapToggle plugin.
   *
   * @return array
   *   A list of options to be use with boostrapToggle plugin.
   */
  public function bootstrapToggleStylesOptions() {
    return [
      'default' => $this
        ->t('Default'),
      'primary' => $this
        ->t('Primary'),
      'success' => $this
        ->t('Success'),
      'info' => $this
        ->t('Info'),
      'warning' => $this
        ->t('Warning'),
      'danger' => $this
        ->t('Danger'),
    ];
  }

  /**
   * Retrieve setting values for given option name.
   *
   * @param string $name
   *   The name of a setting needed.
   *
   * @return string|null
   *   Thrown when the entity can't found the clicked field name.
   */
  public function getBoostrapToogleParameters($name) {
    $parameters = array_merge($this
      ->bootstrapToggleSizesOptions(), $this
      ->bootstrapToggleStylesOptions());
    if (!isset($parameters[$name])) {
      return NULL;
    }
    return $parameters[$name];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    parent::settingsForm($form, $form_state);
    $elements['on'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Use custom label for "On state"'),
      '#default_value' => $this
        ->getSetting('on'),
    ];
    $elements['off'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Use custom label for "Off state"'),
      '#default_value' => $this
        ->getSetting('off'),
    ];
    $elements['size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Size of toggle button'),
      '#default_value' => $this
        ->getSetting('size'),
      '#options' => $this
        ->bootstrapToggleSizesOptions(),
    ];
    $elements['onstyle'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('On state style of toggle button'),
      '#default_value' => $this
        ->getSetting('onstyle'),
      '#options' => $this
        ->bootstrapToggleStylesOptions(),
    ];
    $elements['offstyle'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Off state style of toggle button'),
      '#default_value' => $this
        ->getSetting('offstyle'),
      '#options' => $this
        ->bootstrapToggleStylesOptions(),
    ];
    $elements['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Override height of toggle button'),
      '#default_value' => $this
        ->getSetting('height'),
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#min' => 1,
    ];
    $elements['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Override width of toggle button'),
      '#default_value' => $this
        ->getSetting('width'),
      '#field_suffix' => ' ' . $this
        ->t('pixels'),
      '#min' => 1,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('On label: @on', [
      '@on' => $this
        ->getSetting('on'),
    ]);
    $summary[] = $this
      ->t('Off label: @off', [
      '@off' => $this
        ->getSetting('off'),
    ]);
    $summary[] = $this
      ->t('Box size: @size', [
      '@size' => $this
        ->getBoostrapToogleParameters($this
        ->getSetting('size')),
    ]);
    $summary[] = $this
      ->t('On state style: @onstyle', [
      '@onstyle' => $this
        ->getBoostrapToogleParameters($this
        ->getSetting('onstyle')),
    ]);
    $summary[] = $this
      ->t('Off state style: @offstyle', [
      '@offstyle' => $this
        ->getBoostrapToogleParameters($this
        ->getSetting('offstyle')),
    ]);
    $summary[] = $this
      ->t('Box height: @height', [
      '@height' => $this
        ->getSetting('height') ?: $this
        ->t('Default'),
    ]);
    $summary[] = $this
      ->t('Box width: @width', [
      '@width' => $this
        ->getSetting('width') ?: $this
        ->t('Default'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {

      // We create an instance of element form to edit field first and,
      // initialize Form object with item definition to make a form id dynamic.
      $form_object = $this->classResolver
        ->getInstanceFromDefinition(AjaxToggleForm::class);
      $form_object
        ->setFieldItem($item, $this
        ->getSettings());
      $form_state = new FormState();
      $elements[$delta] = $this->formBuilder
        ->buildForm($form_object, $form_state);
    }
    return $elements;
  }

}

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
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::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
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.
ToggleEditableFormatter::$classResolver	protected	property	The class resolver.
ToggleEditableFormatter::$formBuilder	protected	property	The form builder service.
ToggleEditableFormatter::bootstrapToggleSizesOptions	public	function	Return all sizes options for boostrapToggle plugin.
ToggleEditableFormatter::bootstrapToggleStylesOptions	public	function	Return all styles options for boostrapToggle plugin.
ToggleEditableFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
ToggleEditableFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ToggleEditableFormatter::getBoostrapToogleParameters	public	function	Retrieve setting values for given option name.
ToggleEditableFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ToggleEditableFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ToggleEditableFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ToggleEditableFormatter::__construct	public	function	Constructs a StringFormatter instance. Overrides FormatterBase::__construct

You are here

class ToggleEditableFormatter in Toggle Editable fields 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation