public function BackgroundImageInterface::getImageFile in Background Image 2.x

Same name and namespace in other branches

1. 8 src/BackgroundImageInterface.php \Drupal\background_image\BackgroundImageInterface::getImageFile()
2. 2.0.x src/BackgroundImageInterface.php \Drupal\background_image\BackgroundImageInterface::getImageFile()

Retrieves the image file.

Parameters

bool $parents: Flag indicating whether to use parent image if this image is not set.

Return value

\Drupal\file\FileInterface|null The image File object or NULL if it doesn't exist.

1 method overrides BackgroundImageInterface::getImageFile()

BackgroundImage::getImageFile in src/Entity/BackgroundImage.php

Retrieves the image file.

File

src/BackgroundImageInterface.php, line 156

Class

BackgroundImageInterface

Provides an interface defining a Background Image entity.

Namespace

Drupal\background_image

Code

public function getImageFile($parents = TRUE);