class FlaggingCollectionListBuilder in Flag Lists 8

Defines a class to build a listing of Flagging collection entities.

Hierarchy

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

File

src/FlaggingCollectionListBuilder.php, line 14

Namespace

Drupal\flag_lists

class FlaggingCollectionListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['name'] = $this
      ->t('Flagging Collection');
    $header['id'] = $this
      ->t('ID');
    $header['bundle']['data'] = $this
      ->t('Bundle');
    $header['templateflag']['data'] = $this
      ->t('Flag for List');
    $header['relatedflag']['data'] = $this
      ->t('The related flag');
    $header['base_flag']['data'] = $this
      ->t('Template Flag');
    $header['owner']['data'] = $this
      ->t('Owner');
    $header['scope']['data'] = $this
      ->t('Scope');
    $header['operations']['data'] = $this
      ->t('Operations');

    // Don't call parent as we add the Operations header ourselves
    // $header[] = parent::buildHeader();
    return $header;
  }

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

    /* @var $entity \Drupal\flag_lists\Entity\FlaggingCollection */
    $baseflag = $entity
      ->getBaseFlag();
    $relatedflag = $entity
      ->getRelatedFlag();
    $flagListService = \Drupal::service('flaglists');
    $flag = $flagListService
      ->getFlagForListById($baseflag
      ->id());
    $account = \Drupal::currentUser()
      ->getAccount();
    if ($entity
      ->access('view', $account)) {
      $row = [];
      $row['name'] = Link::createFromRoute($entity
        ->label(), 'entity.flagging_collection.edit_form', [
        'flagging_collection' => $entity
          ->id(),
      ]);
      $row['id'] = $entity
        ->id();
      $row['bundle'] = Link::createFromRoute($flagListService
        ->getFlaggingCollectionTypeById($entity
        ->bundle())
        ->label(), 'entity.flagging_collection_type.collection');
      $row['templateflag'] = Link::createFromRoute($flagListService
        ->getFlagForListById($baseflag
        ->id())
        ->label(), 'entity.flag_for_list.collection');
      $row['relatedflag'] = $relatedflag
        ->label();
      $row['base_flag'] = $baseflag
        ->label();
      $row['owner'] = $entity
        ->getOwner()
        ->label();
      $row['scope'] = $baseflag
        ->isGlobal() ? $this
        ->t('Global') : $this
        ->t('Personal');
      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::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::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
EntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
EntityListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render	16
EntityListBuilder::__construct	public	function	Constructs a new EntityListBuilder object.	16
FlaggingCollectionListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
FlaggingCollectionListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
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.
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.