class FlagForListListBuilder in Flag Lists 8

Provides a listing of Flag for list entities.

Hierarchy

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

File

src/FlagForListListBuilder.php, line 13

Namespace

Drupal\flag_lists

class FlagForListListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Template name');
    $header['id'] = $this
      ->t('Machine name');
    $header['owner'] = [
      'data' => $this
        ->t('Owner'),
    ];
    $header['base_flag'] = [
      'data' => $this
        ->t('Template flag'),
    ];
    $header['entity_type'] = [
      'data' => $this
        ->t('Entity'),
    ];
    $header['bundles'] = [
      'data' => $this
        ->t('Bundles'),
    ];
    $header['scope'] = [
      'data' => $this
        ->t('Scope'),
    ];

    // $header['weight'] = ['data' => $this->t('Weight')];
    $header['operations'] = [
      'data' => $this
        ->t('Operations'),
    ];
    $header[] = parent::buildHeader();
    return $header;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row = [];
    $row['label'] = $entity
      ->label();
    $row['id'] = $entity
      ->id();
    $row['owner'] = $entity
      ->get('owner');
    if ($entity
      ->hasBaseFlag()) {
      $flag = \Drupal::service('flag')
        ->getFlagById($entity
        ->getBaseFlag());
      $flag_url = new Url('');
      $row['base_flag'] = Link::fromTextAndUrl($flag
        ->label(), $flag_url
        ->fromRoute('entity.flag.edit_form', [
        'flag' => $flag
          ->id(),
      ]))
        ->toString();
      $bundles = '';
      foreach ($flag
        ->getBundles() as $bundle) {
        if (empty($bundles)) {
          $bundles = $bundle;
        }
        else {
          $bundles = $bundles . ', ' . $bundle;
        }
      }
      if (empty($bundles)) {
        $bundles = '-';
      }
      $row['entity_type'] = $flag
        ->getFlaggableEntityTypeId();
      $row['bundles'] = $bundles;
      $row['scope'] = $flag
        ->isGlobal() ? $this
        ->t('Global') : $this
        ->t('Personal');
    }
    else {
      $row['base_flag'] = $this
        ->t("<em>Template flag doesn't exist</em>");
      $row['entity_type'] = 'unknown';
      $row['bundles'] = '-';
      $row['scope'] = '-';
    }
    return $row + parent::buildRow($entity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
ConfigEntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilder::load	7
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::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::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
FlagForListListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
FlagForListListBuilder::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.