class BackgroundImageListBuilder in Background Image 2.0.x

Provides a list controller for background_image entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\background_image\BackgroundImageListBuilder

File

src/BackgroundImageListBuilder.php, line 14

Namespace

Drupal\background_image

class BackgroundImageListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['#attached']['library'][] = 'background_image/admin';
    $build['table']['#empty'] = $this
      ->t('There are no @label to display.', [
      '@label' => $this->entityType
        ->getPluralLabel(),
    ]);
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['image'] = [
      'data' => $this
        ->t('Background Image'),
      'class' => [
        'small',
      ],
    ];
    $header['type'] = $this
      ->t('Type');
    $header['settings'] = $this
      ->t('Settings');
    $header['operations'] = [
      'data' => $this
        ->t('Operations'),
      'class' => [
        'op',
        'small',
      ],
    ];
    return $header;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /* @var \Drupal\background_image\BackgroundImageInterface $entity */
    $background_image = $entity instanceof BackgroundImageInterface ? $entity : NULL;
    if (!$background_image) {
      return parent::buildRow($entity);
    }
    $manager = BackgroundImageManager::service();
    $build = [];
    if ($file = $background_image
      ->getImageFile()) {
      $build = [
        '#theme' => 'image_style',
        '#style_name' => $manager
          ->getPreloadImageStyle(),
        '#uri' => $file
          ->getFileUri(),
      ];

      // Add the file entity to the cache dependencies.
      // This will clear our cache when this entity updates.

      /** @var \Drupal\Core\Render\RendererInterface $renderer */
      $renderer = \Drupal::service('renderer');
      $renderer
        ->addCacheableDependency($build, $file);
    }
    if ($build) {
      $row['image'] = [
        'data' => [
          '#type' => 'link',
          '#title' => $build,
          '#url' => $background_image
            ->toUrl(),
        ],
      ];
    }
    else {
      $row['image'] = $this
        ->t('N/A');
    }
    $row['type'] = $background_image
      ->getTypeLabel(TRUE);
    $settings = [];
    foreach ($background_image
      ->getSettings()
      ->getOverridden() as $key => $value) {
      if ($key === 'preload') {
        continue;
      }
      if (is_bool($value)) {
        $value = $value ? $this
          ->t('Yes') : $this
          ->t('No');
      }
      $label = Unicode::ucfirst(str_replace([
        '_',
        '-',
        '.',
      ], ' ', $key));
      $settings[] = is_array($value) ? $label : $label . ': ' . $value;
    }
    $row['settings'] = $settings ? implode(', ', $settings) : $this
      ->t('None');
    return $row + parent::buildRow($background_image);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BackgroundImageListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
BackgroundImageListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
BackgroundImageListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityListBuilder::$entityType	protected	property	Information about the entity type.
EntityListBuilder::$entityTypeId	protected	property	The entity type ID.
EntityListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::$storage	protected	property	The entity storage class.	1
EntityListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity.	2
EntityListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
EntityListBuilder::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getDefaultOperations	protected	function	Gets this list's default operations.	2
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations	2
EntityListBuilder::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
EntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.