class BlazyFileFormatter in Blazy 8.2

Plugin implementation of the 'Blazy File' to get VEF/VEM within images/files.

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\file\Plugin\Field\FieldFormatter\FileFormatterBase
            • class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatterBase uses BlazyDependenciesTrait, BlazyFormatterTrait, BlazyFormatterViewTrait
              • class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFormatterBlazy
                • class \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatter

Deprecated

in blazy:8.x-2.0 and is removed from blazy:8.x-3.0. Use \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyMediaFormatter instead.

See also

https://www.drupal.org/node/3103018

File

src/Plugin/Field/FieldFormatter/BlazyFileFormatter.php, line 17

Namespace

Drupal\blazy\Plugin\Field\FieldFormatter

class BlazyFileFormatter extends BlazyFormatterBlazy {

  /**
   * {@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 function buildElement(array &$build, $entity) {
    $settings = $build['settings'];

    /** @var Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item */

    // EntityReferenceItem provides $item->entity Drupal\file\Entity\File.
    if ($item = $this->blazyOembed
      ->getImageItem($entity)) {
      $build['item'] = $item['item'];
      $build['settings'] = array_merge($settings, $item['settings']);
    }
    $this->blazyOembed
      ->getMediaItem($build, $entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    return [
      'fieldable_form' => TRUE,
      'multimedia' => TRUE,
      'view_mode' => $this->viewMode,
    ] + parent::getScopedFormElements();
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyDependenciesTrait::calculateDependencies	public	function
BlazyDependenciesTrait::onDependencyRemoval	public	function
BlazyFileFormatter::buildElement	public	function	Build individual item if so configured such as for file ER goodness. Overrides BlazyFileFormatterBase::buildElement
BlazyFileFormatter::create	public static	function	Creates an instance of the plugin. Overrides BlazyFileFormatterBase::create
BlazyFileFormatter::getScopedFormElements	public	function	Defines the scope for the form elements. Overrides BlazyFileFormatterBase::getScopedFormElements
BlazyFileFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
BlazyFileFormatterBase::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BlazyFileFormatterBase::getEntitiesToView	protected	function	A clone of Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase so to have one base class to extend for both image and file ER formatters. Overrides EntityReferenceFormatterBase::getEntitiesToView
BlazyFileFormatterBase::needsEntityLoad	protected	function	Overrides parent::needsEntityLoad(). Overrides FileFormatterBase::needsEntityLoad
BlazyFileFormatterBase::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BlazyFormatterBlazy::buildElements	public	function	Build the Blazy elements.
BlazyFormatterBlazy::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
BlazyFormatterTrait::$blazyManager	protected	property	The blazy manager service.
BlazyFormatterTrait::$formatter	protected	property	The blazy manager service.
BlazyFormatterTrait::admin	public	function	Returns the blazy admin service.	1
BlazyFormatterTrait::blazyManager	public	function	Returns the blazy manager.
BlazyFormatterTrait::buildSettings	public	function	Builds the settings.	1
BlazyFormatterTrait::formatter	public	function	Returns the blazy formatter manager.
BlazyFormatterTrait::getCommonFieldDefinition	public	function	Defines the common scope for both front and admin.
BlazyFormatterTrait::getCommonScopedFormElements	public	function	Defines the common scope for the form elements.
BlazyFormatterTrait::injectServices	protected static	function	Injects DI services.
BlazyFormatterTrait::settingsSummary	public	function
BlazyFormatterViewTrait::commonViewElements	public	function	Returns similar view elements.
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::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
FileFormatterBase::checkAccess	protected	function	Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
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
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.