class ParagraphsJQueryUIAccordionFormatter in Paragraphs jQuery UI Accordion 8

Plugin implementation of the 'paragraphs_jquery_ui_accordion_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "paragraphs_jquery_ui_accordion_formatter",
  label = @Translation("Paragraphs jQuery UI Accordion"),
  field_types = {
    "entity_reference_revisions"
  }
)

View source

class ParagraphsJQueryUIAccordionFormatter extends EntityReferenceRevisionsFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfo;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The entity type id.
   *
   * @var string
   */
  protected $entityTypeId = '';

  /**
   * The logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Transliteration service.
   *
   * @var \Drupal\Component\Transliteration\TransliterationInterface
   */
  protected $transliteration;

  /**
   * ParagraphsJQueryUIAccordionFormatter constructor.
   *
   * @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\Entity\EntityTypeBundleInfoInterface $bundle_info
   *   Entity type manager service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param LoggerChannelFactoryInterface $logger_factory
   *   The logger factory.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   * @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
   *   The transliteration service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeBundleInfoInterface $bundle_info, EntityFieldManagerInterface $entity_field_manager, LoggerChannelFactoryInterface $logger_factory, EntityDisplayRepositoryInterface $entity_display_repository, TransliterationInterface $transliteration) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->bundleInfo = $bundle_info;
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeId = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getSetting('target_type');
    $this->loggerFactory = $logger_factory;
    $this->entityDisplayRepository = $entity_display_repository;
    $this->transliteration = $transliteration;
  }

  /**
   * {@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('entity_type.bundle.info'), $container
      ->get('entity_field.manager'), $container
      ->get('logger.factory'), $container
      ->get('entity_display.repository'), $container
      ->get('transliteration'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'bundle' => '',
      'title' => '',
      'content' => '',
      'active' => 1,
      'autoscroll' => FALSE,
      'autoscroll_offset' => '',
      'autoscroll_offset_toolbar' => FALSE,
      'view_mode' => 'default',
      'simple_id' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $bundles = $this
      ->getBundles();
    $bundle_fields = $this
      ->getBundleFields();
    $form['bundle'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Paragraph bundle'),
      '#default_value' => $this
        ->getSetting('bundle'),
      '#options' => $bundles,
    ];
    $form['title'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Paragraph title'),
      '#default_value' => $this
        ->getSetting('title'),
      '#options' => $bundle_fields,
    ];
    $form['content'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Paragraph content'),
      '#default_value' => $this
        ->getSetting('content'),
      '#options' => $bundle_fields,
    ];
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => $this->entityDisplayRepository
        ->getViewModeOptions($this
        ->getFieldSetting('target_type')),
      '#title' => $this
        ->t('View mode'),
      '#description' => $this
        ->t('This view mode will be applied for content field selected above.'),
      '#default_value' => $this
        ->getSetting('view_mode'),
      '#required' => TRUE,
    );
    $form['active'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Active'),
      '#description' => $this
        ->t('Makes first panel is open.'),
      '#default_value' => $this
        ->getSetting('active'),
    ];
    $form['simple_id'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Simple Ids'),
      '#description' => $this
        ->t('This makes each accordion id in numerical order (#1, #2, #3 etc).<br />Note this may break functionality if you are using multiple accordions on the same page.'),
      '#default_value' => $this
        ->getSetting('simple_id'),
    ];
    $form['autoscroll'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('AutoScroll'),
      '#description' => $this
        ->t('Scrolls to active accordion item.'),
      '#default_value' => $this
        ->getSetting('autoscroll'),
      '#attributes' => [
        'setting-name' => 'autoscroll',
      ],
    ];
    $form['autoscroll_offset'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('AutoScroll offset'),
      '#description' => $this
        ->t('Adds extra margin if such exist in your page layout (for example if enabled admin_toolbar module, then you need set 80px).<br />Leave empty if not needed.'),
      '#default_value' => $this
        ->getSetting('autoscroll_offset'),
      '#states' => [
        'visible' => [
          [
            ':input[setting-name="autoscroll"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
      '#size' => 20,
      '#field_suffix' => 'px',
    ];
    $form['autoscroll_offset_toolbar'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Apply offset only for admin toolbar.'),
      '#default_value' => $this
        ->getSetting('autoscroll_offset_toolbar'),
      '#states' => [
        'visible' => [
          [
            ':input[setting-name="autoscroll"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $settings = $this
      ->getSettings();
    $view_modes = $this->entityDisplayRepository
      ->getViewModeOptions($this
      ->getFieldSetting('target_type'));
    $summary[] = t('Paragraph bundle: %bundle', [
      '%bundle' => $settings['bundle'],
    ]);
    $summary[] = t('Paragraph title: %title', [
      '%title' => $settings['title'],
    ]);
    $summary[] = t('Paragraph content: %content', [
      '%content' => $settings['content'],
    ]);
    $summary[] = t('Paragraph content view mode: %view_mode', [
      '%view_mode' => isset($view_modes[$settings['view_mode']]) ? $view_modes[$settings['view_mode']] : $settings['view_mode'],
    ]);
    $summary[] = t('AutoScroll: %autoscroll', [
      '%autoscroll' => $settings['autoscroll'] ? t('enabled') : t('disabled'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = $this
      ->getSettings();
    $elements = [];
    $moduleHandler = \Drupal::service('module_handler');
    $quickedit = FALSE;
    if ($moduleHandler
      ->moduleExists('quickedit')) {
      $quickedit = TRUE;
    }
    $accordion_id = $this
      ->getAccordionId($items
      ->getEntity()
      ->id());
    $js_options = [
      'ids' => [
        $items
          ->getEntity()
          ->id() => $accordion_id,
      ],
      'active' => $this
        ->getSetting('active') ? 1 : 0,
      'autoscroll' => $this
        ->getSetting('autoscroll'),
      'autoscroll_offset' => $this
        ->getSetting('autoscroll_offset'),
    ];
    if ($settings['autoscroll_offset_toolbar'] && $moduleHandler
      ->moduleExists('toolbar')) {
      if (!\Drupal::currentUser()
        ->hasPermission('access toolbar')) {
        unset($js_options['autoscroll_offset']);
      }
    }
    $elements[0]['accordion'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => $accordion_id,
      ],
      '#attached' => [
        'library' => 'paragraphs_jquery_ui_accordion/accordion',
        'drupalSettings' => [
          'paragraphs_jquery_ui_accordion' => $js_options,
        ],
      ],
    ];
    $title_attributes = [
      'class' => [
        'accordion-title',
      ],
    ];
    $content_attributes = [
      'class' => [
        'accordion-description',
      ],
    ];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {

      // Protect ourselves from recursive rendering.
      static $depth = 0;
      $depth++;
      if ($depth > 20) {
        $this->loggerFactory
          ->get('entity')
          ->error('Recursive rendering detected when rendering entity @entity_type @entity_id. Aborting rendering.', array(
          '@entity_type' => $entity
            ->getEntityTypeId(),
          '@entity_id' => $entity
            ->id(),
        ));
        return $elements;
      }
      $title = $entity
        ->get($this
        ->getSetting('title'))->value;
      $content = $entity
        ->get($this
        ->getSetting('content'))
        ->view($settings['view_mode']);
      if (!$settings['simple_id']) {
        $id = Html::getUniqueId($this->transliteration
          ->transliterate($title));
      }
      else {
        $id = $delta + 1;
      }

      // This variable is needed to avoid js errors during render of paragraph's fields.
      if ($quickedit) {
        $content_attributes['data-quickedit-entity-id'] = $entity
          ->getEntityTypeId() . '/' . $entity
          ->id();
      }
      $elements[0]['accordion'][$delta] = [
        '#theme' => 'paragraphs_jquery_ui_accordion_formatter',
        '#title' => $title,
        '#content' => $content,
        '#id' => $id,
        '#title_attributes' => $title_attributes,
        '#content_attributes' => $content_attributes,
      ];

      // Add a resource attribute to set the mapping property's value to the
      // entity's url. Since we don't know what the markup of the entity will
      // be, we shouldn't rely on it for structured data such as RDFa.
      if (!empty($items[$delta]->_attributes) && !$entity
        ->isNew() && $entity
        ->hasLinkTemplate('canonical')) {
        $items[$delta]->_attributes += [
          'resource' => $entity
            ->toUrl()
            ->toString(),
        ];
      }
      $depth = 0;
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $storage = $field_definition
      ->getFieldStorageDefinition();
    return $storage
      ->isMultiple() && $storage
      ->getSetting('target_type') === 'paragraph';
  }

  /**
   * Gets a bundles array suitable for form options.
   *
   * @return array
   *   The bundles array that can be passed to form element of type select.
   */
  protected function getBundles() {
    foreach ($this->bundleInfo
      ->getBundleInfo($this->entityTypeId) as $key => $bundle) {
      $bundles[$key] = $bundle['label'];
    }
    return isset($bundles) ? $bundles : [];
  }

  /**
   * Gets a bundle fields array suitable for form options.
   *
   * @return array
   *   The fields array that can be passed to form element of type select.
   */
  protected function getBundleFields() {
    foreach ($this
      ->getBundles() as $bundle_name => $bundle) {
      $field_definitions = $this->entityFieldManager
        ->getFieldDefinitions($this->entityTypeId, $bundle_name);
      foreach ($field_definitions as $field_name => $field_definition) {
        if (!$field_definition
          ->getFieldStorageDefinition()
          ->isBaseField()) {
          $bundle_fields[$field_name] = $field_definition
            ->getLabel();
        }
      }
    }
    return isset($bundle_fields) ? $bundle_fields : [];
  }

  /**
   * Generates unique accordion identifier for html attribute.
   *
   * @param int $id
   *   Unique identifier.
   *
   * @return string
   *   Returns unique accordion id.
   */
  protected function getAccordionId($id) {
    return 'accordion-' . $id;
  }

}

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
EntityReferenceFormatterBase::checkAccess	protected	function	Checks access to the given entity.	3
EntityReferenceFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display.	1
EntityReferenceFormatterBase::needsEntityLoad	protected	function	Returns whether the entity referenced by an item needs to be loaded.	1
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
EntityReferenceRevisionsFormatterBase::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides EntityReferenceFormatterBase::prepareView
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.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
ParagraphsJQueryUIAccordionFormatter::$bundleInfo	protected	property	The entity type bundle info service.
ParagraphsJQueryUIAccordionFormatter::$entityDisplayRepository	protected	property	The entity display repository.
ParagraphsJQueryUIAccordionFormatter::$entityFieldManager	protected	property	The entity field manager.
ParagraphsJQueryUIAccordionFormatter::$entityTypeId	protected	property	The entity type id.
ParagraphsJQueryUIAccordionFormatter::$loggerFactory	protected	property	The logger factory.
ParagraphsJQueryUIAccordionFormatter::$transliteration	protected	property	Transliteration service.
ParagraphsJQueryUIAccordionFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
ParagraphsJQueryUIAccordionFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ParagraphsJQueryUIAccordionFormatter::getAccordionId	protected	function	Generates unique accordion identifier for html attribute.
ParagraphsJQueryUIAccordionFormatter::getBundleFields	protected	function	Gets a bundle fields array suitable for form options.
ParagraphsJQueryUIAccordionFormatter::getBundles	protected	function	Gets a bundles array suitable for form options.
ParagraphsJQueryUIAccordionFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
ParagraphsJQueryUIAccordionFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ParagraphsJQueryUIAccordionFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ParagraphsJQueryUIAccordionFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ParagraphsJQueryUIAccordionFormatter::__construct	public	function	ParagraphsJQueryUIAccordionFormatter constructor. Overrides FormatterBase::__construct
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 ParagraphsJQueryUIAccordionFormatter in Paragraphs jQuery UI Accordion 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation