You are here

Home » API reference » Amazon Product Advertisement API 8.2 » AmazonFieldFormatter.php

class AmazonFieldFormatter in Amazon Product Advertisement API 8.2

Plugin implementation of the 'amazon_field_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "amazon_field_formatter",
  label = @Translation("Amazon field formatter"),
  field_types = {
    "amazon_asin_field"
  }
)

Hierarchy

Expanded class hierarchy of AmazonFieldFormatter

File

modules/amazon_field/src/Plugin/Field/FieldFormatter/AmazonFieldFormatter.php, line 24

Namespace

Drupal\amazon_field\Plugin\Field\FieldFormatter
View source 
class AmazonFieldFormatter extends FormatterBase {

  /**
   * Contians a list of display options for this formatter.
   *
   * @var array
   */
  protected $templateOptions = [];
  public function __construct($plugin_id, $plugin_definition, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->templateOptions = [
      'inline' => $this
        ->t('Item title'),
      'image_small' => $this
        ->t('Small image'),
      'image_medium' => $this
        ->t('Medium image'),
      'image_large' => $this
        ->t('Large image'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $defaultMaxAge = \Drupal::config('amazon.settings')
      ->get('default_max_age');
    if (is_null($defaultMaxAge)) {
      throw new \InvalidArgumentException('Missing Amazon settings: default max age.');
    }
    return array(
      'max_age' => $defaultMaxAge,
      'template' => 'image_large',
      'advanced' => [
        'extraResponseGroups' => '',
      ],
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $defaultMaxAge = \Drupal::config('amazon.settings')
      ->get('default_max_age');
    $form['max_age'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Max age for cached results'),
      '#description' => $this
        ->t('The number of seconds that the system should cache the results from Amazon\'s servers. Leave blank to use the default max age set on the <a href=":url">Amazon settings page</a>, currently set at @default_max_age seconds.', [
        ':url' => Url::fromRoute('amazon.settings_form')
          ->toString(),
        '@default_max_age' => $defaultMaxAge,
      ]),
      '#default_value' => $this
        ->getSetting('max_age') == $defaultMaxAge ? '' : $this
        ->getSetting('max_age'),
    ];
    $form['template'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Display item as'),
      '#description' => $this
        ->t('By default, all options will link to the item in the Amazon store tagged with your Associates ID.'),
      '#options' => $this->templateOptions,
      '#default_value' => $this
        ->getSetting('template'),
    ];
    $form['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $form['advanced']['extraResponseGroups'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Additional response groups'),
      '#description' => $this
        ->t('Use this field to add additional <a href="@amazon_link">response groups</a> to the information supplied to templates. This is only needed if you are overwriting the Twig templates and want addition product information. One response group per line, response groups <em>Small</em> and <em>Images</em> are included by default.', [
        '@amazon_link' => Url::fromUri('http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CHAP_ResponseGroupsList.html'),
      ]),
      '#default_value' => $this
        ->getSettings()['advanced']['extraResponseGroups'],
    ];
    return $form + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Display as: @template', [
      '@template' => $this->templateOptions[$settings['template']],
    ]);
    if (!empty($settings['max_age'])) {
      $summary[] = $this
        ->t('Cache max age: @max_age', [
        '@max_age' => $settings['max_age'],
      ]);
    }
    if (!empty($settings['advanced']['extraResponseGroups'])) {
      $summary[] = $this
        ->t('Includes extra response groups.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $asins = [];
    foreach ($items as $delta => $item) {
      if (!$item
        ->isEmpty()) {
        $asins[$item->value] = $item->value;
      }
    }

    // Nothing to render.
    if (empty($asins)) {
      return $elements;
    }
    $associatesId = \Drupal::config('amazon.settings')
      ->get('associates_id');
    $amazon = new Amazon($associatesId);

    // Include Small and Images response groups along with any specified.
    $responseGroups = [
      'Small',
      'Images',
    ];
    if (!empty($this
      ->getSettings()['advanced']['extraResponseGroups'])) {
      $responseGroups = array_merge($responseGroups, explode("\n", $this
        ->getSettings()['advanced']['extraResponseGroups']));
    }
    $results = $amazon
      ->lookup($asins, $responseGroups);

    // No results from Amazon.
    if (empty($results[0])) {
      return $elements;
    }
    $max_age = $this
      ->getSetting('max_age');
    $basicBuild = [
      '#max_age' => $max_age,
    ];

    // Use the correct Twig template based on the "template" specified.
    switch (strtolower($this
      ->getSetting('template'))) {
      case 'inline':
        $basicBuild['#theme'] = 'amazon_inline';
        break;
      case 'image_small':
        $basicBuild['#theme'] = 'amazon_image';
        $basicBuild['#size'] = 'small';
        break;
      case 'image_medium':
        $basicBuild['#theme'] = 'amazon_image';
        $basicBuild['#size'] = 'medium';
        break;
      case 'image_large':
        $basicBuild['#theme'] = 'amazon_image';
        $basicBuild['#size'] = 'large';
        break;
      default:

        // Unknown template specified.
        return $elements;
    }

    // Add some template suggestions. Note these won't show up in the template
    // debug code until https://www.drupal.org/node/2118743 is fixed.
    $basicBuild['#bundle'] = $this->fieldDefinition
      ->getTargetBundle();
    $basicBuild['#field'] = $this->fieldDefinition
      ->getName();
    foreach ($results as $delta => $result) {
      $elements[$delta] = $basicBuild + [
        '#results' => $result,
      ];
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AmazonFieldFormatter::$templateOptions protected property Contians a list of display options for this formatter.
AmazonFieldFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
AmazonFieldFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
AmazonFieldFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
AmazonFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
AmazonFieldFormatter::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct
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
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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::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. 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.