class GridStackMediaFormatter in GridStack 8.2

Plugin implementation of the 'GridStack Media' formatter.

Plugin annotation

@FieldFormatter(
  id = "gridstack_media",
  label = @Translation("GridStack Media"),
  description = @Translation("Display the core Media as a GridStack."),
  field_types = {"entity_reference"},
  quickedit = {"editor" = "disabled"}
)

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\blazy\Dejavu\BlazyEntityBase
            • class \Drupal\blazy\Dejavu\BlazyEntityMediaBase uses BlazyDependenciesTrait
              • class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyMediaFormatterBase uses BlazyFormatterTrait, BlazyFormatterViewTrait
                • class \Drupal\gridstack\Plugin\Field\FieldFormatter\GridStackMediaFormatter uses GridStackFormatterTrait, GridStackFormatterViewTrait

File

src/Plugin/Field/FieldFormatter/GridStackMediaFormatter.php, line 22

Namespace

Drupal\gridstack\Plugin\Field\FieldFormatter

class GridStackMediaFormatter extends BlazyMediaFormatterBase {
  use GridStackFormatterTrait;
  use GridStackFormatterViewTrait;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    return self::injectServices($instance, $container, 'entity');
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return GridStackDefault::extendedSettings() + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $entities = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($entities)) {
      return [];
    }
    return $this
      ->commonViewElements($items, $langcode, $entities);
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    return [
      'vanilla' => TRUE,
      'no_ratio' => TRUE,
      'responsive_image' => TRUE,
    ] + $this
      ->getCommonScopedFormElements() + parent::getScopedFormElements();
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyDependenciesTrait::calculateDependencies	public	function
BlazyDependenciesTrait::onDependencyRemoval	public	function
BlazyEntityMediaBase::blazyEntity	public	function	Returns the slick service.	1
BlazyEntityMediaBase::blazyOembed	public	function	Returns the slick service.
BlazyEntityMediaBase::buildElement	public	function	Returns item contents. Overrides BlazyEntityBase::buildElement
BlazyEntityMediaBase::buildElementExtra	public	function	Build extra elements.	1
BlazyEntityMediaBase::buildElements	public	function	Returns media contents. Overrides BlazyEntityBase::buildElements
BlazyEntityMediaBase::buildElementThumbnail	public	function	Build thumbnail navigation such as for Slick asnavfor.
BlazyEntityMediaBase::getCaption	public	function	Builds captions with possible multi-value fields.	1
BlazyEntityMediaBase::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides BlazyEntityBase::settingsForm	1
BlazyFormatterTrait::$blazyManager	protected	property	The blazy manager service.
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::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
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::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
GridStackFormatterTrait::$formatter	protected	property	The gridstack field formatter manager.
GridStackFormatterTrait::$loggerFactory	protected	property	The logger factory.
GridStackFormatterTrait::$manager	protected	property	The gridstack field formatter manager.
GridStackFormatterTrait::admin	public	function	Returns the gridstack admin service shortcut.
GridStackFormatterTrait::blazyManager	public	function	Overrides the blazy manager.
GridStackFormatterTrait::buildSettings	public	function	Builds the settings.
GridStackFormatterTrait::formatter	public	function	Returns the gridstack field formatter service.
GridStackFormatterTrait::getCommonFieldDefinition	public	function	Defines the common scope for both front and admin.
GridStackFormatterTrait::getCommonScopedFormElements	public	function	Defines the common scope for the form elements.
GridStackFormatterTrait::injectServices	protected static	function	Injects DI services.
GridStackFormatterTrait::manager	public	function	Returns the gridstack service.
GridStackFormatterTrait::settingsSummary	public	function
GridStackFormatterViewTrait::commonViewElements	public	function	Returns similar view elements.
GridStackMediaFormatter::create	public static	function	Creates an instance of the plugin. Overrides BlazyMediaFormatterBase::create
GridStackMediaFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides BlazyMediaFormatterBase::defaultSettings
GridStackMediaFormatter::getScopedFormElements	public	function	Defines the scope for the form elements. Overrides BlazyEntityMediaBase::getScopedFormElements
GridStackMediaFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides GridStackFormatterTrait::isApplicable
GridStackMediaFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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::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::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.