class RegistrationListBuilder in RNG - Events and Registrations 8

Builds a list of registrations.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\rng\Lists\RegistrationListBuilder

File

src/Lists/RegistrationListBuilder.php, line 15

Namespace

Drupal\rng\Lists

class RegistrationListBuilder extends EntityListBuilder {

  /**
   * The RNG event manager.
   *
   * @var \Drupal\rng\EventManagerInterface
   */
  protected $eventManager;

  /**
   * Row Counter.
   *
   * @var integer
   */
  protected $row_counter;

  /**
   * The event entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $event;

  /**
   * Constructs a new RegistrationListBuilder object.
   *
   * {@inheritdoc}
   *
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EventManagerInterface $event_manager) {
    parent::__construct($entity_type, $storage);
    $this->eventManager = $event_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('rng.event_manager'));
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\Core\Entity\EntityInterface $rng_event
   *   The event entity to display registrations.
   */
  public function render(EntityInterface $rng_event = NULL) {
    if (isset($rng_event)) {
      $this->event = $rng_event;
    }
    $render = parent::render();
    $render['table']['#empty'] = t('No registrations found for this event.');
    return $render;
  }

  /**
   * {@inheritdoc}
   */
  public function load() {
    if (isset($this->event)) {
      return $this->eventManager
        ->getMeta($this->event)
        ->getRegistrations();
    }
    return parent::load();
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if ($entity
      ->access('view') && $entity
      ->hasLinkTemplate('canonical')) {
      $operations['view'] = array(
        'title' => $this
          ->t('View'),
        'weight' => 0,
        'url' => $entity
          ->urlInfo('canonical'),
      );
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['counter'] = '';
    $header['type'] = $this
      ->t('Type');
    $header['groups'] = $this
      ->t('Groups');
    $header['created'] = $this
      ->t('Created');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\rng\RegistrationInterface $entity
   *   A registration entity.
   */
  public function buildRow(EntityInterface $entity) {
    $row['counter'] = ++$this->row_counter;
    $bundle = entity_load($this->entityType
      ->getBundleEntityType(), $entity
      ->bundle());
    $row['type'] = $bundle ? $bundle
      ->label() : '';
    $row['groups']['data'] = array(
      '#theme' => 'item_list',
      '#items' => [],
      '#attributes' => [
        'class' => [
          'inline',
        ],
      ],
    );
    foreach ($entity
      ->getGroups() as $group) {
      $text = '@group_label';
      $t_args = [
        '@group_id' => $group
          ->id(),
        '@group_label' => $group
          ->label(),
      ];
      $options['context'] = $group
        ->isUserGenerated() ? 'system' : 'user';
      $row['groups']['data']['#items'][] = $this
        ->t($group
        ->isUserGenerated() ? $text : "<em>{$text}</em>", $t_args, $options);
    }
    $row['created'] = format_date($entity->created->value);
    return $row + parent::buildRow($entity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
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.	3
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::ensureDestination	protected	function	Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id.	4
EntityListBuilder::getLabel Deprecated	protected	function	Gets the label of an entity.
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.
RegistrationListBuilder::$event	protected	property	The event entity.
RegistrationListBuilder::$eventManager	protected	property	The RNG event manager.
RegistrationListBuilder::$row_counter	protected	property	Row Counter.
RegistrationListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
RegistrationListBuilder::buildRow	public	function	Overrides EntityListBuilder::buildRow
RegistrationListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
RegistrationListBuilder::getDefaultOperations	protected	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
RegistrationListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load
RegistrationListBuilder::render	public	function	Overrides EntityListBuilder::render
RegistrationListBuilder::__construct	public	function	Constructs a new RegistrationListBuilder object. Overrides EntityListBuilder::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.