public function BackgroundImageManager::view in Background Image 2.0.x

Same name and namespace in other branches

1. 8 src/BackgroundImageManager.php \Drupal\background_image\BackgroundImageManager::view()
2. 2.x src/BackgroundImageManager.php \Drupal\background_image\BackgroundImageManager::view()

Builds the render array for the provided entity.

Parameters

\Drupal\background_image\BackgroundImageInterface $background_image: The background image entity to render.

string $view_mode: (optional) The view mode that should be used to render the entity.

string $langcode: (optional) For which language the entity should be rendered, defaults to the current content language.

Return value

array A render array for the entity.

Throws

\InvalidArgumentException Can be thrown when the set of parameters is inconsistent, like when trying to view a Comment and passing a Node which is not the one the comment belongs to, or not passing one, and having the comment node not be available for loading.

Overrides BackgroundImageManagerInterface::view

File

src/BackgroundImageManager.php, line 747

Class

BackgroundImageManager

Namespace

Drupal\background_image

Code

public function view($background_image, $view_mode = 'full', $langcode = NULL) {
  return $this->viewBuilder
    ->view($background_image, $view_mode, $langcode);
}