class AgreementListBuilder in Agreement 3.0.x

Provides simple operations list.

Hierarchy

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

File

src/Entity/AgreementListBuilder.php, line 12

Namespace

Drupal\agreement\Entity

class AgreementListBuilder extends EntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    return [
      'label' => $this
        ->t('Name'),
      'path' => $this
        ->t('Agreement page'),
      'roles' => $this
        ->t('Roles'),
      'visibility' => $this
        ->t('Visibility Setting'),
    ] + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $settings = $entity
      ->getSettings();
    $roles = array_reduce($settings['roles'], function (&$result, $item) {
      $result[] = $item;
      return $result;
    }, []);
    $visibility_options = [
      $this
        ->t('Show on every page except the listed pages'),
      $this
        ->t('Show on only the listed pages'),
    ];
    return [
      'label' => $entity
        ->label(),
      'path' => [
        'data' => [
          '#type' => 'link',
          '#url' => Url::fromUserInput($entity
            ->get('path')),
          '#title' => $entity
            ->get('path'),
        ],
      ],
      'roles' => [
        'data' => [
          '#theme' => 'item_list',
          '#items' => $roles,
        ],
      ],
      'visibility' => $visibility_options[$settings['visibility']['settings']],
    ] + parent::buildRow($entity);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AgreementListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
AgreementListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
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.
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::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
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.