WishlistListBuilder.php in Commerce Wishlist 8.3

Namespace

Drupal\commerce_wishlist

File

src/WishlistListBuilder.php

<?php

namespace Drupal\commerce_wishlist;

use Drupal\Core\Datetime\DateFormatter;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityListBuilder;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines the list builder for wishlists.
 */
class WishlistListBuilder extends EntityListBuilder {

  /**
   * The date service.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new WishlistListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
   *   The date service.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, DateFormatter $date_formatter) {
    parent::__construct($entity_type, $entity_type_manager
      ->getStorage($entity_type
      ->id()));
    $this->entityTypeManager = $entity_type_manager;
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'), $container
      ->get('date.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'name' => [
        'data' => $this
          ->t('Name'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'type' => [
        'data' => $this
          ->t('Type'),
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ],
      'owner' => [
        'data' => $this
          ->t('Owner'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'created' => [
        'data' => $this
          ->t('Created'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
      'changed' => [
        'data' => $this
          ->t('Changed'),
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $wishlist_type_storage = $this->entityTypeManager
      ->getStorage('commerce_wishlist_type');
    $wishlist_type = $wishlist_type_storage
      ->load($entity
      ->bundle());

    /* @var \Drupal\commerce_wishlist\Entity\WishlistInterface $entity */
    $row = [
      'name' => $entity
        ->label(),
      'type' => $wishlist_type
        ->label(),
      'owner' => [
        'data' => [
          '#theme' => 'username',
          '#account' => $entity
            ->getOwner(),
        ],
      ],
      'created' => $this->dateFormatter
        ->format($entity
        ->getCreatedTime(), 'short'),
      'changed' => $this->dateFormatter
        ->format($entity
        ->getChangedTime(), 'short'),
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if ($entity
      ->access('update')) {
      $operations['items'] = [
        'title' => $this
          ->t('Items'),
        'url' => new Url('entity.commerce_wishlist_item.collection', [
          'commerce_wishlist' => $entity
            ->id(),
        ]),
      ];
    }
    return $operations;
  }

}

Classes

Name	Description
WishlistListBuilder	Defines the list builder for wishlists.