You are here

Home » API reference » Bynder 4.0.x » BynderFormatterBase.php

abstract class BynderFormatterBase in Bynder 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/BynderFormatterBase.php \Drupal\bynder\Plugin\Field\FieldFormatter\BynderFormatterBase

Base class for Bynder formatters.

Hierarchy

Expanded class hierarchy of BynderFormatterBase

File

src/Plugin/Field/FieldFormatter/BynderFormatterBase.php, line 21

Namespace

Drupal\bynder\Plugin\Field\FieldFormatter
View source 
abstract class BynderFormatterBase extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The Bynder API service.
   *
   * @var \Drupal\bynder\BynderApiInterface
   */
  protected $bynder;

  /**
   * Renderer object.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

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

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a BynderFormatter object.
   *
   * @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.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current user.
   * @param \Drupal\bynder\BynderApiInterface $bynder
   *   The Bynder API service.
   * @param \Drupal\Core\Render\RendererInterface $renderer_object
   *   Renderer object.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ConfigFactoryInterface $config_factory, AccountProxyInterface $current_user, BynderApiInterface $bynder, RendererInterface $renderer_object, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->configFactory = $config_factory;
    $this->currentUser = $current_user;
    $this->bynder = $bynder;
    $this->renderer = $renderer_object;
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@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('config.factory'), $container
      ->get('current_user'), $container
      ->get('bynder_api'), $container
      ->get('renderer'), $container
      ->get('entity_field.manager'), $container
      ->get('entity_type.manager'));
  }

  /**
   * Gets list of fields that are candidates for IMG attributes.
   *
   * @return array
   *   List of fields with machine names as keys and human-readable names as
   *   values.
   */
  protected function getAttributesFieldsCandidates() {
    $allowed_field_types = [
      'string',
      'string_long',
      'text',
      'text_long',
    ];
    $handler_settings = NULL;
    if (strpos($this->fieldDefinition
      ->getSetting('handler'), 'default:') === 0) {
      $handler_settings = $this->fieldDefinition
        ->getSetting('handler_settings');
    }
    $bundles = [];
    if ($handler_settings && is_array($handler_settings['target_bundles'])) {
      foreach ($handler_settings['target_bundles'] as $bundle) {

        /** @var \Drupal\media\MediaTypeInterface $type */
        $type = $this->entityTypeManager
          ->getStorage('media_type')
          ->load($bundle);
        if ($type && $type
          ->getSource() instanceof Bynder) {
          $bundles[] = $type;
        }
      }
    }
    else {

      /** @var \Drupal\media\MediaTypeInterface $type */
      foreach ($this->entityTypeManager
        ->getStorage('media_type')
        ->loadMultiple() as $type) {
        if ($type && $type
          ->getSource() instanceof Bynder) {
          $bundles[] = $type;
        }
      }
    }
    $options = [];
    foreach ($bundles as $type) {
      foreach ($this->entityFieldManager
        ->getFieldDefinitions('media', $type
        ->id()) as $field_name => $field) {
        if (in_array($field
          ->getType(), $allowed_field_types)) {
          $options[$field_name] = $field
            ->getLabel();
        }
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    if ($field_definition
      ->getType() == 'entity_reference') {
      if ($field_definition
        ->getFieldStorageDefinition()
        ->getSetting('target_type') == 'media') {
        if (strpos($field_definition
          ->getSetting('handler'), 'default:') === 0) {
          $handler_settings = $field_definition
            ->getSetting('handler_settings');
          if ($handler_settings['target_bundles'] === NULL) {
            return TRUE;
          }
          elseif (is_array($handler_settings['target_bundles'])) {
            foreach ($handler_settings['target_bundles'] as $bundle) {

              /** @var \Drupal\media\MediaTypeInterface $type */
              $type = \Drupal::entityTypeManager()
                ->getStorage('media_type')
                ->load($bundle);
              if ($type
                ->getSource() instanceof Bynder) {
                return TRUE;
              }
            }
          }
        }
        else {

          // If some other selection plugin than default is used we can't
          // reliably determine if we apply or not so we allow.
          return TRUE;
        }
      }
      return FALSE;
    }
    elseif (in_array($field_definition
      ->getType(), [
      'string',
      'string_long',
    ])) {
      if ($field_definition
        ->getTargetEntityTypeId() != 'media') {
        return FALSE;
      }

      /** @var \Drupal\media\MediaTypeInterface $type_entity */
      if (!($type_entity = $field_definition
        ->getTargetBundle()) || !($type_entity = MediaType::load($field_definition
        ->getTargetBundle()))) {
        return FALSE;
      }
      $source = $type_entity
        ->getSource();
      if (!$source instanceof Bynder) {
        return FALSE;
      }
      if ($source
        ->getConfiguration()['source_field'] != $field_definition
        ->getName()) {
        return FALSE;
      }
      return TRUE;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BynderFormatterBase::$bynder protected property The Bynder API service.
BynderFormatterBase::$configFactory protected property The config factory.
BynderFormatterBase::$currentUser protected property The current user.
BynderFormatterBase::$entityFieldManager protected property The entity field manager service.
BynderFormatterBase::$entityTypeManager protected property The entity type manager service.
BynderFormatterBase::$renderer protected property Renderer object.
BynderFormatterBase::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
BynderFormatterBase::getAttributesFieldsCandidates protected function Gets list of fields that are candidates for IMG attributes.
BynderFormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
BynderFormatterBase::__construct public function Constructs a BynderFormatter object. Overrides FormatterBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterInterface::viewElements public function Builds a renderable array for a field value. 47
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
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.