You are here

Home » API reference » Blazy 8.2 » BlazyFormatterBlazy.php

class BlazyFormatterBlazy in Blazy 8.2

Same name and namespace in other branches
  1. 7 src/Plugin/Field/FieldFormatter/BlazyFormatterBlazy.php \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFormatterBlazy

Plugin implementation of the `Blazy File` or `Blazy Image` for Blazy only.

Hierarchy

Expanded class hierarchy of BlazyFormatterBlazy

See also

\Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatter

\Drupal\blazy\Plugin\Field\FieldFormatter\BlazyImageFormatter

File

src/Plugin/Field/FieldFormatter/BlazyFormatterBlazy.php, line 14

Namespace

Drupal\blazy\Plugin\Field\FieldFormatter
View source 
class BlazyFormatterBlazy extends BlazyFileFormatterBase {

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

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

  /**
   * Build the Blazy elements.
   */
  public function buildElements(array &$build, $files) {
    $settings = $build['settings'];
    foreach ($files as $delta => $file) {

      /** @var Drupal\image\Plugin\Field\FieldType\ImageItem $item */
      $item = $file->_referringItem;
      $box = [];
      $settings['delta'] = $delta;
      $settings['file_tags'] = $file
        ->getCacheTags();
      $settings['type'] = 'image';
      $settings['uri'] = $file
        ->getFileUri();
      $box['item'] = $item;
      $box['settings'] = $settings;

      // Build individual element.
      $this
        ->buildElement($box, $file);

      // Build caption if so configured.
      if (!empty($settings['caption'])) {
        foreach ($settings['caption'] as $caption) {
          if ($caption_content = $box['item']->{$caption}) {
            $box['captions'][$caption] = [
              '#markup' => Xss::filterAdmin($caption_content),
            ];
          }
        }
      }

      // Image with grid, responsive image, lazyLoad, and lightbox supports.
      $build[$delta] = $this->formatter
        ->getBlazy($box);
      unset($box);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlazyDependenciesTrait::calculateDependencies public function
BlazyDependenciesTrait::onDependencyRemoval public function
BlazyFileFormatterBase::buildElement public function Build individual item if so configured such as for file ER goodness. 1
BlazyFileFormatterBase::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
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::getScopedFormElements public function Defines the scope for the form elements. 1
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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
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.