You are here

Home » API reference » Facebook Instant Articles 8 » FiaFields.php

class FiaFields in Facebook Instant Articles 8

Renders an RSS item based on fields.

Plugin annotation


@ViewsRow(
  id = "fiafields",
  title = @Translation("FIA Fields"),
  help = @Translation("Display fields as FIA (facebook instant articles) items."),
  theme = "views_view_row_fia",
  display_types = {"feed"}
)

Hierarchy

Expanded class hierarchy of FiaFields

File

src/Plugin/views/row/FiaFields.php, line 25
Contains Drupal\fb_instant_articles\Plugin\views\row\RssFields.

Namespace

Drupal\fb_instant_articles\Plugin\views\row
View source 
class FiaFields extends EntityRow {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $configuration['entity_type'] = 'node';
    $plugin = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $plugin->options['view_mode'] = 'fb_instant_articles_rss';
    return $plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function render($row) {

    /**
     * @var \Drupal\views\ResultRow $row
     */
    global $base_url;

    /**
     * @var \Drupal\Core\Entity\ContentEntityInterface $entity
     */
    $entity = $row->_entity;

    /**
     * @var []string $options
     */
    $options = $this->options;

    // Create the OPML item array.
    $item = parent::render($row);
    $options['langcode'] = \Drupal::languageManager()
      ->getCurrentLanguage()
      ->getId();
    switch (true) {
      default:
      case $entity instanceof \Drupal\node\Entity\Node:
        $options['row'] = $row;

        /**
         * @var \Drupal\node\Entity\Node $entity
         */
        $options['title'] = $entity
          ->getTitle();
        $options['author'] = $entity
          ->getOwner()
          ->getAccountName();
        $options['created'] = '@' . $entity
          ->getCreatedTime();
        $options['modified'] = '@' . $entity
          ->getChangedTime();
        $options['link'] = $entity
          ->toLink(NULL, 'canonical', [
          'absolute' => true,
        ]);
        $options['guid'] = $entity
          ->uuid();

        /**
         * @var \Drupal\user\UserInterface $author
         */
        $author = $entity
          ->getOwner();
        $options['author'] = $author
          ->toLink(NULL, 'canonical', [
          'absolute' => true,
        ]);
    }
    $build = [
      '#theme' => $this
        ->themeFunctions(),
      '#view' => $this->view,
      '#options' => $options,
      '#row' => $item,
      '#field_alias' => isset($this->field_alias) ? $this->field_alias : '',
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityRow::$base_field public property The actual field which is used for the entity id.
EntityRow::$base_table public property The table the entity is using for storage.
EntityRow::$deprecatedProperties protected property
EntityRow::$entityDisplayRepository protected property The entity display repository.
EntityRow::$entityRepository protected property The entity repository service.
EntityRow::$entityType protected property Contains the entity type of this row plugin instance.
EntityRow::$entityTypeId protected property Stores the entity type ID of the result entities.
EntityRow::$entityTypeManager protected property The entity type manager.
EntityRow::$languageManager protected property The language manager.
EntityRow::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
EntityRow::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
EntityRow::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions 2
EntityRow::getEntityManager protected function
EntityRow::getEntityRepository protected function Returns the entity repository. Overrides EntityTranslationRenderTrait::getEntityRepository
EntityRow::getEntityTypeId public function Returns the entity type identifier. Overrides EntityTranslationRenderTrait::getEntityTypeId
EntityRow::getEntityTypeManager protected function Returns the entity type manager. Overrides EntityTranslationRenderTrait::getEntityTypeManager
EntityRow::getLanguageManager protected function Returns the language manager. Overrides EntityTranslationRenderTrait::getLanguageManager
EntityRow::getView protected function Returns the top object of a view. Overrides EntityTranslationRenderTrait::getView
EntityRow::init public function Initialize the plugin. Overrides PluginBase::init
EntityRow::preRender public function Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::preRender
EntityRow::query public function Add anything to the query that we might need to. Overrides RowPluginBase::query
EntityRow::summaryTitle public function Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle
EntityRow::__construct public function Constructs a new EntityRow object. Overrides PluginBase::__construct
EntityTranslationRenderTrait::$entityTranslationRenderer protected property The renderer to be used to render the entity row.
EntityTranslationRenderTrait::getEntityTranslation public function Returns the entity translation matching the configured row language.
EntityTranslationRenderTrait::getEntityTranslationRenderer protected function Returns the current renderer.
FiaFields::create public static function Creates an instance of the plugin. Overrides EntityRow::create
FiaFields::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides EntityRow::render
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::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to its output. 4
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields public function Returns the usesFields property. 4
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1
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.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.