InstantArticleFormatterInterface.php in Facebook Instant Articles 3.x

Namespace

Drupal\fb_instant_articles\Plugin\Field

File

src/Plugin/Field/InstantArticleFormatterInterface.php

<?php

namespace Drupal\fb_instant_articles\Plugin\Field;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterInterface;
use Facebook\InstantArticles\Elements\InstantArticle;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Interface to define an operation to manipulate an InstantArticle object.
 */
interface InstantArticleFormatterInterface extends FormatterInterface {

  /**
   * Modifies the given instant article with the contents of this field.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field values to be rendered.
   * @param \Facebook\InstantArticles\Elements\InstantArticle $article
   *   Instant article object to modify, rendering the contents of this field
   *   into it.
   * @param string $region
   *   The Instant Article region name that the contents of this field should be
   *   rendered into.
   * @param \Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer
   *   Normalizer in case the formatter needs to recursively normalize, eg. in
   *   the case of a entity reference field.
   * @param string $langcode
   *   (optional) The language that should be used to render the field. Defaults
   *   to the current content language.
   */
  public function viewInstantArticle(FieldItemListInterface $items, InstantArticle $article, $region, NormalizerInterface $normalizer, $langcode = NULL);

}

Interfaces

Name	Description
InstantArticleFormatterInterface	Interface to define an operation to manipulate an InstantArticle object.