class FilterFormatListBuilder
Same name in other branches
- 8.9.x core/modules/filter/src/FilterFormatListBuilder.php \Drupal\filter\FilterFormatListBuilder
- 10 core/modules/filter/src/FilterFormatListBuilder.php \Drupal\filter\FilterFormatListBuilder
- 11.x core/modules/filter/src/FilterFormatListBuilder.php \Drupal\filter\FilterFormatListBuilder
Defines a class to build a listing of filter format entities.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityListBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityListBuilderInterface, \Drupal\Core\Entity\EntityHandlerInterface uses \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder extends \Drupal\Core\Entity\EntityListBuilder
- class \Drupal\Core\Config\Entity\DraggableListBuilder extends \Drupal\Core\Config\Entity\ConfigEntityListBuilder implements \Drupal\Core\Form\FormInterface
- class \Drupal\filter\FilterFormatListBuilder extends \Drupal\Core\Config\Entity\DraggableListBuilder
- class \Drupal\Core\Config\Entity\DraggableListBuilder extends \Drupal\Core\Config\Entity\ConfigEntityListBuilder implements \Drupal\Core\Form\FormInterface
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder extends \Drupal\Core\Entity\EntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityListBuilderInterface, \Drupal\Core\Entity\EntityHandlerInterface uses \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait
Expanded class hierarchy of FilterFormatListBuilder
See also
\Drupal\filter\Entity\FilterFormat
File
-
core/
modules/ filter/ src/ FilterFormatListBuilder.php, line 19
Namespace
Drupal\filterView source
class FilterFormatListBuilder extends DraggableListBuilder {
/**
* {@inheritdoc}
*/
protected $entitiesKey = 'formats';
/**
* The config factory service.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* The messenger.
*
* @var \Drupal\Core\Messenger\MessengerInterface
*/
protected $messenger;
/**
* Constructs a new FilterFormatListBuilder.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage class.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ConfigFactoryInterface $config_factory, MessengerInterface $messenger) {
parent::__construct($entity_type, $storage);
$this->configFactory = $config_factory;
$this->messenger = $messenger;
}
/**
* {@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('config.factory'), $container->get('messenger'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'filter_admin_overview';
}
/**
* {@inheritdoc}
*/
public function load() {
// Only list enabled filters.
return array_filter(parent::load(), function ($entity) {
return $entity->status();
});
}
/**
* {@inheritdoc}
*/
public function buildHeader() {
$header['label'] = $this->t('Name');
$header['roles'] = $this->t('Roles');
return $header + parent::buildHeader();
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
// Check whether this is the fallback text format. This format is available
// to all roles and cannot be disabled via the admin interface.
$row['label'] = $entity->label();
$row['roles'] = [];
if ($entity->isFallbackFormat()) {
$fallback_choice = $this->configFactory
->get('filter.settings')
->get('always_show_fallback_choice');
if ($fallback_choice) {
$row['roles']['#markup'] = $this->t('All roles may use this format');
}
else {
$row['roles']['#markup'] = $this->t('This format is shown when no other formats are available');
}
// Emphasize the fallback role text since it is important to understand
// how it works which configuring filter formats. Additionally, it is not
// a list of roles unlike the other values in this column.
$row['roles']['#prefix'] = '<em>';
$row['roles']['#suffix'] = '</em>';
}
else {
$row['roles'] = [
'#theme' => 'item_list',
'#items' => filter_get_roles_by_format($entity),
'#empty' => $this->t('No roles may use this format'),
'#context' => [
'list_style' => 'comma-list',
],
];
}
return $row + parent::buildRow($entity);
}
/**
* {@inheritdoc}
*/
public function getDefaultOperations(EntityInterface $entity) {
$operations = parent::getDefaultOperations($entity);
if (isset($operations['edit'])) {
$operations['edit']['title'] = $this->t('Configure');
}
// The fallback format may not be disabled.
if ($entity->isFallbackFormat()) {
unset($operations['disable']);
}
return $operations;
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);
$form['actions']['submit']['#value'] = $this->t('Save');
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
parent::submitForm($form, $form_state);
filter_formats_reset();
$this->messenger
->addStatus($this->t('The text format ordering has been saved.'));
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
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::$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::render | public | function | Builds the entity listing as renderable array for table.html.twig. | Overrides EntityListBuilder::render | 1 |
DraggableListBuilder::validateForm | public | function | Form validation handler. | Overrides FormInterface::validateForm | 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::ensureDestination | protected | function | Ensures that a destination is present on the given URL. | 1 | |
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 | |
FilterFormatListBuilder::$configFactory | protected | property | The config factory service. | ||
FilterFormatListBuilder::$entitiesKey | protected | property | The key to use for the form element containing the entities. | Overrides DraggableListBuilder::$entitiesKey | |
FilterFormatListBuilder::$messenger | protected | property | The messenger. | Overrides MessengerTrait::$messenger | |
FilterFormatListBuilder::buildForm | public | function | Form constructor. | Overrides DraggableListBuilder::buildForm | |
FilterFormatListBuilder::buildHeader | public | function | Builds the header row for the entity listing. | Overrides DraggableListBuilder::buildHeader | |
FilterFormatListBuilder::buildRow | public | function | Builds a row for an entity in the entity listing. | Overrides DraggableListBuilder::buildRow | |
FilterFormatListBuilder::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides EntityListBuilder::createInstance | |
FilterFormatListBuilder::getDefaultOperations | public | function | Gets this list's default operations. | Overrides ConfigEntityListBuilder::getDefaultOperations | |
FilterFormatListBuilder::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
FilterFormatListBuilder::load | public | function | Loads entities of this type from storage for listing. | Overrides ConfigEntityListBuilder::load | |
FilterFormatListBuilder::submitForm | public | function | Form submission handler. | Overrides DraggableListBuilder::submitForm | |
FilterFormatListBuilder::__construct | public | function | Constructs a new FilterFormatListBuilder. | Overrides DraggableListBuilder::__construct | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
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. | 3 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.