You are here

protected function AudioPlayerBase::getEntitiesToView in Media entity audio 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/AudioPlayerBase.php \Drupal\media_entity_audio\Plugin\Field\FieldFormatter\AudioPlayerBase::getEntitiesToView()

Returns the referenced entities for display.

The method takes care of:

  • checking entity access,
  • placing the entities in the language expected for display.

It is thus strongly recommended that formatters use it in their implementation of viewElements($items) rather than dealing with $items directly.

For each entity, the EntityReferenceItem by which the entity is referenced is available in $entity->_referringItem. This is useful for field types that store additional values next to the reference itself.

Parameters

\Drupal\Core\Field\EntityReferenceFieldItemListInterface $items: The item list.

string $langcode: The language code of the referenced entities to display.

Return value

\Drupal\Core\Entity\EntityInterface[] The array of referenced entities to display, keyed by delta.

Overrides EntityReferenceFormatterBase::getEntitiesToView

See also

::prepareView()

1 call to AudioPlayerBase::getEntitiesToView()
AudioPlayerHTML5::viewElements in src/Plugin/Field/FieldFormatter/AudioPlayerHTML5.php
Builds a renderable array for a field value.

File

src/Plugin/Field/FieldFormatter/AudioPlayerBase.php, line 16

Class

AudioPlayerBase
Base class for Audio Player file formatters.

Namespace

Drupal\media_entity_audio\Plugin\Field\FieldFormatter

Code

protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {
  return parent::getEntitiesToView($items, $langcode);
}