class FlickityEntityView in Flickity Carousel 3.0.x

Plugin implementation of the 'flickity entity view' formatter.

Plugin annotation

@FieldFormatter(
  id = "flickity_entity_view",
  label = @Translation("Flickity"),
  description = @Translation("Display the referenced entities in a Flickity carousel."),
  field_types = {
    "entity_reference"
  }
)

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\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
          • class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceEntityFormatter
            • class \Drupal\flickity_fields\Plugin\Field\FieldFormatter\FlickityEntityView

File

modules/fields/src/Plugin/Field/FieldFormatter/FlickityEntityView.php, line 26

Contains \Drupal\flickity_fields\Plugin\Field\FieldFormatter\FlickityEntityView

Namespace

Drupal\flickity_fields\Plugin\Field\FieldFormatter

class FlickityEntityView extends EntityReferenceEntityFormatter {

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return array(
      'flickity_settings' => array(
        '#title' => $this
          ->t('Flickity settings'),
        '#type' => 'select',
        '#options' => flickity_settings_list(),
        '#default_value' => $this
          ->getSetting('flickity_settings'),
        '#required' => TRUE,
      ),
    ) + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'flickity_settings' => 'default_group',
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    return parent::settingsSummary();

    // TODO: Add selected settings group to summary
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = array(
      '#theme' => 'flickity_entity_view',
      '#children' => parent::viewElements($items, $langcode),
      '#settings' => $this
        ->getSetting('flickity_settings'),
      '#title' => $this->fieldDefinition
        ->getLabel(),
      '#label_display' => $this->label,
    );
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityReferenceEntityFormatter::$entityDisplayRepository	protected	property	The entity display repository.
EntityReferenceEntityFormatter::$entityTypeManager	protected	property	The entity type manager.
EntityReferenceEntityFormatter::$loggerFactory	protected	property	The logger factory.
EntityReferenceEntityFormatter::$recursiveRenderDepth	protected static	property	An array of counters for the recursive rendering protection.
EntityReferenceEntityFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
EntityReferenceEntityFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT		constant	The number of times this formatter allows rendering the same entity.
EntityReferenceEntityFormatter::__construct	public	function	Constructs an EntityReferenceEntityFormatter instance. Overrides FormatterBase::__construct
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::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
FlickityEntityView::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides EntityReferenceEntityFormatter::defaultSettings
FlickityEntityView::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides EntityReferenceEntityFormatter::settingsForm
FlickityEntityView::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides EntityReferenceEntityFormatter::settingsSummary
FlickityEntityView::viewElements	public	function	Builds a renderable array for a field value. Overrides EntityReferenceEntityFormatter::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::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.	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.