class AccessFilterListBuilder in Access Filter 8

Provides filter config entity list builder.

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\access_filter\AccessFilterListBuilder

File

src/AccessFilterListBuilder.php, line 13

Namespace

Drupal\access_filter

class AccessFilterListBuilder extends DraggableListBuilder {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('ID');
    $header['name'] = $this
      ->t('Name');
    $header['conditions'] = $this
      ->t('Conditions');
    $header['rules'] = $this
      ->t('Rules');
    $header['response'] = $this
      ->t('Response');
    if (!empty($this->weightKey)) {
      $header['weight'] = $this
        ->t('Weight');
    }
    $header['operations'] = $this
      ->t('Operations');
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\access_filter\Entity\Filter $entity */
    $entity
      ->parse();
    if (!$entity
      ->status()) {
      $row['#attributes']['class'] = [
        'disabled',
        'draggable',
      ];
    }
    $row['id']['data'] = [
      '#plain_text' => $entity
        ->id(),
    ];
    $row['name']['data'] = [
      '#plain_text' => $entity
        ->label(),
    ];
    $conditions = [];
    foreach ($entity
      ->get('parsedConditions') as $condition) {
      $negated_marker = $condition
        ->isNegated() ? '<span class="negated">!</span>' : '';
      $conditions[] = [
        '#markup' => $negated_marker . Html::escape($condition
          ->getPluginId()) . ': ' . $condition
          ->summary(),
      ];
    }
    $row['conditions']['data'] = [
      '#theme' => 'item_list',
      '#items' => $conditions,
    ];
    $rules = [];
    foreach ($entity
      ->get('parsedRules') as $rule) {
      $rules[] = [
        '#markup' => Html::escape($rule
          ->getPluginId()) . ': ' . $rule
          ->summary(),
      ];
    }
    $row['rules']['data'] = [
      '#theme' => 'item_list',
      '#items' => $rules,
    ];
    $row['response']['data'] = [
      '#plain_text' => $entity
        ->get('parsedResponse')['code'],
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $entities = $this
      ->load();
    if (count($entities) <= 1) {
      unset($this->weightKey);
    }
    $build = parent::render();
    $build['table']['#empty'] = $this
      ->t('No filters available.');
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['#attached']['library'][] = 'access_filter/common';
    $form['filters']['#attributes'] = [
      'id' => 'filters',
    ];
    $form['actions']['submit']['#value'] = $this
      ->t('Save');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->messenger()
      ->addStatus($this
      ->t('The configuration options have been saved.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccessFilterListBuilder::$entitiesKey	protected	property	The key to use for the form element containing the entities. Overrides DraggableListBuilder::$entitiesKey
AccessFilterListBuilder::buildForm	public	function	Form constructor. Overrides DraggableListBuilder::buildForm
AccessFilterListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
AccessFilterListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
AccessFilterListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AccessFilterListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides DraggableListBuilder::render
AccessFilterListBuilder::submitForm	public	function	Form submission handler. Overrides DraggableListBuilder::submitForm
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::formBuilder	protected	function	Returns the form builder.
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
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.