class FlagListBuilder in Flag 8.4

Provides a entity list page for Flags.

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\Core\Config\Entity\DraggableListBuilder implements FormInterface
    class \Drupal\flag\Controller\FlagListBuilder

Expanded class hierarchy of FlagListBuilder

File

src/Controller/FlagListBuilder.php, line 12

Namespace

Drupal\flag\Controller

View source

class FlagListBuilder extends DraggableListBuilder {

  /**
   * {@inheritdoc}
   */
  protected $entitiesKey = 'flags';

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'flag_list';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Flag');
    $header['flag_type'] = $this
      ->t('Flag Type');
    $header['roles'] = $this
      ->t('Roles');
    $header['bundles'] = $this
      ->t('Entity Bundles');
    $header['global'] = $this
      ->t('Scope');
    $header['status'] = $this
      ->t('Status');
    return $header + parent::buildHeader();
  }

  /**
   * Creates a render array of roles that may use the flag.
   *
   * @param \Drupal\flag\FlagInterface $flag
   *   The flag entity.
   *
   * @return array
   *   A render array of flag roles for the entity.
   */
  protected function getFlagRoles(FlagInterface $flag) {
    $all_roles = [];
    foreach (array_keys($flag
      ->actionPermissions()) as $perm) {
      $roles = user_roles(FALSE, $perm);
      foreach ($roles as $rid => $role) {
        $all_roles[$rid] = $role
          ->label();
      }
    }
    $out = implode(', ', $all_roles);
    if (empty($out)) {
      return [
        '#markup' => '<em>' . $this
          ->t('None') . '</em>',
        '#allowed_tags' => [
          'em',
        ],
      ];
    }
    return [
      '#markup' => rtrim($out, ', '),
    ];
  }

  /**
   * Gets the flag type label for the given flag.
   *
   * @param \Drupal\flag\FlagInterface $flag
   *   The flag entity.
   *
   * @return array
   *   A render array of the flag type label.
   */
  protected function getFlagType(FlagInterface $flag) {

    // Get the flaggable entity type definition.
    $flaggable_entity_type = \Drupal::entityTypeManager()
      ->getDefinition($flag
      ->getFlaggableEntityTypeId());
    return [
      '#markup' => $flaggable_entity_type
        ->getLabel(),
    ];
  }

  /**
   * Generates a render array of the applicable bundles for the flag..
   *
   * @param \Drupal\flag\FlagInterface $flag
   *   The flag entity.
   *
   * @return array
   *   A render array of the applicable bundles for the flag..
   */
  protected function getBundles(FlagInterface $flag) {
    $bundles = $flag
      ->getBundles();
    if (empty($bundles)) {
      return [
        '#markup' => '<em>' . $this
          ->t('All') . '</em>',
        '#allowed_tags' => [
          'em',
        ],
      ];
    }
    return [
      '#markup' => implode(', ', $bundles),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->label();
    $row['flag_type'] = $this
      ->getFlagType($entity);
    $row['roles'] = $this
      ->getFlagRoles($entity);
    $row['bundles'] = $this
      ->getBundles($entity);
    $row['global'] = [
      '#markup' => $entity
        ->isGlobal() ? $this
        ->t('Global') : $this
        ->t('Personal'),
    ];
    $row['status'] = [
      '#markup' => $entity
        ->status() ? $this
        ->t('Enabled') : $this
        ->t('Disabled'),
    ];
    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
DraggableListBuilder::$entities	protected	property	The entities being listed.	1
DraggableListBuilder::$formBuilder	protected	property	The form builder.
DraggableListBuilder::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey	protected	property	Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	4
DraggableListBuilder::formBuilder	protected	function	Returns the form builder.
DraggableListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render	1
DraggableListBuilder::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm	5
DraggableListBuilder::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	2
DraggableListBuilder::__construct	public	function	Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct	5
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::$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
FlagListBuilder::$entitiesKey	protected	property	The key to use for the form element containing the entities. Overrides DraggableListBuilder::$entitiesKey
FlagListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
FlagListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
FlagListBuilder::getBundles	protected	function	Generates a render array of the applicable bundles for the flag..
FlagListBuilder::getFlagRoles	protected	function	Creates a render array of roles that may use the flag.
FlagListBuilder::getFlagType	protected	function	Gets the flag type label for the given flag.
FlagListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
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.

You are here

class FlagListBuilder in Flag 8.4

Hierarchy

File

Namespace

Members

API Navigation