You are here

Home » API reference » Name Field 8 » NameListFormatListBuilder.php

class NameListFormatListBuilder in Name Field 8

The name list builder.

Hierarchy

Expanded class hierarchy of NameListFormatListBuilder

File

src/NameListFormatListBuilder.php, line 16

Namespace

Drupal\name
View source 
class NameListFormatListBuilder extends ConfigEntityListBuilder {

  /**
   * The name formatter.
   *
   * @var \Drupal\name\NameFormatterInterface
   */
  protected $formatter;

  /**
   * The name format parser.
   *
   * @var \Drupal\name\NameFormatParser
   */
  protected $parser;

  /**
   * The name generator.
   *
   * @var \Drupal\name\NameGeneratorInterface
   */
  protected $generator;

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

  /**
   * Constructs a new EntityListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\name\NameFormatterInterface $formatter
   *   The name formatter.
   * @param \Drupal\name\NameFormatParser $parser
   *   The name format parser.
   * @param \Drupal\name\NameGeneratorInterface $generator
   *   The name generator service.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, NameFormatterInterface $formatter, NameFormatParser $parser, NameGeneratorInterface $generator) {
    parent::__construct($entity_type, $storage);
    $this->parser = $parser;
    $this->formatter = $formatter;
    $this->generator = $generator;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $row = [];
    $row['label'] = $this
      ->t('Label');
    $row['id'] = $this
      ->t('Machine name');
    $row['settings'] = $this
      ->t('Settings');
    $row['examples'] = $this
      ->t('Examples');
    $row['operations'] = $this
      ->t('Operations');
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row = [];
    $row['label'] = $entity
      ->label();
    $row['id'] = $entity
      ->id();
    $settings = $entity
      ->listSettings();
    $and_options = $this->formatter
      ->getLastDelimitorTypes();
    $and_delimiter = isset($and_options[$settings['and']]) ? $and_options[$settings['and']] : $this
      ->t('-- invalid option --');
    $and_behavior_options = $this->formatter
      ->getLastDelimitorBehaviors(FALSE);
    $and_behavior = isset($and_behavior_options[$settings['delimiter_precedes_last']]) ? $and_behavior_options[$settings['delimiter_precedes_last']] : $this
      ->t('-- invalid option --');
    if ($settings['el_al_min']) {
      $behavior = $this
        ->t('Reduce after @max items and show @min items followed by <em>el al</em>.', [
        '@max' => $settings['el_al_min'],
        '@min' => $settings['el_al_first'],
      ]);
    }
    else {
      $behavior = $this
        ->t('Show all names.');
    }
    $summary = [
      $behavior,
      $this
        ->t('Delimiters: "@delimiter" and @last', [
        '@delimiter' => $settings['delimiter'],
        '@last' => $and_delimiter,
      ]),
      $this
        ->t('Last delimiter: @delimiter', [
        '@delimiter' => $and_behavior,
      ]),
    ];
    if ($entity
      ->isLocked()) {
      $summary[] = t('Default format (locked)');
    }
    $row['settings'] = new FormattableMarkup(implode('<br>', $summary), []);

    // Add a few examples.
    $row['examples'] = $this
      ->examples($entity);
    $operations = $this
      ->buildOperations($entity);
    $row['operations']['data'] = $operations;
    return $row;
  }

  /**
   * Provides some example based on names with various components set.
   *
   * @param \Drupal\name\Entity\NameListFormat $entity
   *   The name format entity.
   *
   * @return \Drupal\Component\Render\FormattableMarkup
   *   The example names with formatting applied.
   */
  protected function examples(NameListFormat $entity) {
    $examples = [];
    foreach ([
      1,
      2,
      3,
      4,
    ] as $num) {
      $names = $this->generator
        ->generateSampleNames($num);
      $examples[] = $this
        ->t('(@num) %list', [
        '@num' => $num,
        '%list' => $this->formatter
          ->formatList($names, 'family', $entity
          ->id()),
      ]);
    }
    return new FormattableMarkup(implode('<br>', $examples), []);
  }

}

Members

Namesort descending 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::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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
NameListFormatListBuilder::$formatter protected property The name formatter.
NameListFormatListBuilder::$generator protected property The name generator.
NameListFormatListBuilder::$parser protected property The name format parser.
NameListFormatListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
NameListFormatListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
NameListFormatListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
NameListFormatListBuilder::examples protected function Provides some example based on names with various components set.
NameListFormatListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct
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.