You are here

Home » API reference » FAQ Field 2.0.x » FaqFieldAccordionFormatter.php

class FaqFieldAccordionFormatter in FAQ Field 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/FaqFieldAccordionFormatter.php \Drupal\faqfield\Plugin\Field\FieldFormatter\FaqFieldAccordionFormatter

Plugin implementation of the 'faqfield_accordion' formatter.

Plugin annotation


@FieldFormatter(
  id = "faqfield_accordion",
  label = @Translation("jQuery Accordion"),
  field_types = {
    "faqfield"
  }
)

Hierarchy

Expanded class hierarchy of FaqFieldAccordionFormatter

File

src/Plugin/Field/FieldFormatter/FaqFieldAccordionFormatter.php, line 20

Namespace

Drupal\faqfield\Plugin\Field\FieldFormatter
View source 
class FaqFieldAccordionFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'active' => 0,
      'heightStyle' => 'auto',
      'collapsible' => FALSE,
      'event' => 'click',
      'animate' => [
        'easing' => 'linear',
        'duration' => 200,
      ],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);

    // Number of first active element.
    $elements['active'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Default active'),
      '#placeholder' => $this
        ->t('None'),
      '#default_value' => $this
        ->getSetting('active'),
      '#description' => $this
        ->t('Index of the active question starting from 0. If left empty and <em>Fully collapsible</em> is on, no question will be opened by default.'),
      '#maxlength' => 3,
      '#size' => 5,
    ];

    // Whether auto heigth is enabled.
    $elements['heightStyle'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Height style'),
      '#default_value' => $this
        ->getSetting('heightStyle'),
      '#options' => [
        'auto' => $this
          ->t('Auto : All panels will be set to the height of the tallest question.'),
        'fill' => $this
          ->t('Fill : Expand to the available height based on the accordions question height.'),
        'content' => $this
          ->t('Content : Each panel will be only as tall as its question.'),
      ],
      '#description' => $this
        ->t('Controls the height of the accordion and each panel.'),
    ];

    // Whether elements are collabsible.
    $elements['collapsible'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Fully collapsible'),
      '#default_value' => $this
        ->getSetting('collapsible'),
      '#description' => $this
        ->t('Whether all the questions can be closed at once. Allows collapsing the active section.'),
    ];

    // Name of triggering event.
    $elements['event'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Event'),
      '#placeholder' => 'click',
      '#default_value' => $this
        ->getSetting('event'),
      '#description' => $this
        ->t('The event on which to open a question. Multiple events can be specified, separated by a space.'),
    ];

    // Animation options for the accordion formatter.
    $elements['animate'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Animation settings'),
      '#collapsed' => TRUE,
    ];

    // Animation duration in milliseconds with the selected easing.
    $elements['animate']['duration'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Duration'),
      '#default_value' => $this
        ->getSetting('animate')['duration'],
      '#description' => $this
        ->t('Animation duration in milliseconds with the selected easing.'),
      '#min' => 0,
    ];

    // Name of easing to use when the event is triggered.
    $elements['animate']['easing'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Easing'),
      '#placeholder' => 'linear',
      '#default_value' => $this
        ->getSetting('animate')['easing'],
      '#description' => $this
        ->t('Name of <a href="@link">easing</a> to use when the event is triggered.', [
        '@link' => 'http://api.jqueryui.com/easings/',
      ]),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if (is_numeric($this
      ->getSetting('active'))) {
      $active = $this
        ->getSetting('active');
    }
    else {
      $active = $this
        ->t('None');
    }
    $summary[] = $this
      ->t('Default active: @element', [
      '@element' => $active,
    ]);
    $height_style = '';
    switch ($this
      ->getSetting('heightStyle')) {
      case 'auto':
        $height_style = $this
          ->t('Auto');
        break;
      case 'fill':
        $height_style = $this
          ->t('Fill');
        break;
      case 'content':
        $height_style = $this
          ->t('Content');
        break;
    }
    $summary[] = $this
      ->t('Height style : @style', [
      '@style' => $height_style,
    ]);
    if ($this
      ->getSetting('collapsible')) {
      $summary[] = $this
        ->t('Fully collapsible');
    }
    $summary[] = $this
      ->t('Event: @event', [
      '@event' => $this
        ->getSetting('event'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   *
   * This will not be themeable, because changes would break jQuery UI
   * accordion functionality!
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $default_format = $this
      ->getFieldSetting('default_format');
    $settings = $this
      ->getSettings();

    // Generate faqfield id by fieldname and entity id.
    $faqfield_id = 'faqfield_' . $this->fieldDefinition
      ->getName() . '_' . $items
      ->getEntity()
      ->getEntityTypeId() . '_' . $items
      ->getEntity()
      ->id();

    // If active setting was blank, set FALSE so no element will be active.
    if (!is_numeric($settings['active'])) {
      $settings['active'] = FALSE;
    }
    $element_items = [];
    foreach ($items as $item) {

      // Decide whether to use the default format or the custom one.
      $format = !empty($item->answer_format) ? $item->answer_format : $default_format;
      $element_items[] = [
        'question' => $item->question,
        'answer' => $item->answer,
        'answer_format' => $format,
      ];
    }
    if ($element_items) {
      $elements[0] = [
        '#theme' => 'faqfield_jquery_accordion_formatter',
        '#items' => $element_items,
        '#id' => $faqfield_id,
        '#attached' => [
          // Add FAQ Field accordion library.
          'library' => [
            'faqfield/faqfield.accordion',
          ],
          'drupalSettings' => [
            'faqfield' => [
              '#' . $faqfield_id => $settings,
            ],
          ],
        ],
      ];
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FaqFieldAccordionFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FaqFieldAccordionFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FaqFieldAccordionFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FaqFieldAccordionFormatter::viewElements public function This will not be themeable, because changes would break jQuery UI accordion functionality! Overrides FormatterInterface::viewElements
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 12
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 12
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 4
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.