class ConfigSplitEntityListBuilder in Configuration Split 2.0.x
Same name and namespace in other branches
- 8 src/ConfigSplitEntityListBuilder.php \Drupal\config_split\ConfigSplitEntityListBuilder
Provides a listing of Configuration Split setting entities.
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\config_split\ConfigSplitEntityListBuilder
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of ConfigSplitEntityListBuilder
File
- src/
ConfigSplitEntityListBuilder.php, line 16
Namespace
Drupal\config_splitView source
class ConfigSplitEntityListBuilder extends ConfigEntityListBuilder {
/**
* The status override service.
*
* @var \Drupal\config_split\Config\StatusOverride
*/
protected $statusOverride;
/**
* The config factory that knows what is overwritten.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* {@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_split.status_override'), $container
->get('config.factory'));
}
/**
* 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\config_split\Config\StatusOverride $statusOverride
* The status override service.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The config factory.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, StatusOverride $statusOverride, ConfigFactoryInterface $config_factory) {
parent::__construct($entity_type, $storage);
$this->configFactory = $config_factory;
$this->statusOverride = $statusOverride;
}
/**
* {@inheritdoc}
*/
public function buildHeader() {
$header['label'] = $this
->t('Configuration Split setting');
$header['id'] = $this
->t('Machine name');
$header['description'] = $this
->t('Description');
$header['current_status'] = $this
->t('Current status');
$header['default_status'] = $this
->t('Default status');
return $header + parent::buildHeader();
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
$row['label'] = $entity
->toLink();
$row['id'] = $entity
->id();
$config = $this->configFactory
->get('config_split.config_split.' . $entity
->id());
$row['description'] = $config
->get('description');
$row['current_status'] = $config
->get('status') ? 'active' : 'inactive';
$row['default_status'] = $entity
->status() ? 'active' : 'inactive';
if ($this->statusOverride
->getSettingsOverride($entity
->id()) !== NULL) {
$row['current_status'] .= ' (settings.php)';
}
elseif ($this->statusOverride
->getSplitOverride($entity
->id()) !== NULL) {
$row['current_status'] .= ' (state)';
}
return $row + parent::buildRow($entity);
}
/**
* {@inheritdoc}
*/
public function getDefaultOperations(EntityInterface $entity) {
/** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
$operations = parent::getDefaultOperations($entity);
// Operations changing the entity.
if (!$entity
->get('status') && $entity
->hasLinkTemplate('enable')) {
$operations['enable'] = [
'title' => $this
->t('Enable'),
'weight' => 40,
'url' => $entity
->toUrl('enable'),
];
}
elseif ($entity
->hasLinkTemplate('disable')) {
$operations['disable'] = [
'title' => $this
->t('Disable'),
'weight' => 50,
'url' => $entity
->toUrl('disable'),
];
}
// Operations changing the site config.
$config = $this->configFactory
->get('config_split.config_split.' . $entity
->id());
$enforced = $this->statusOverride
->getSettingsOverride($entity
->id()) !== NULL;
if ($config
->get('status')) {
if ($entity
->hasLinkTemplate('import')) {
$operations['import'] = [
'title' => $this
->t('Import'),
'weight' => 40,
'url' => $entity
->toUrl('import'),
];
}
if ($entity
->hasLinkTemplate('export')) {
$operations['export'] = [
'title' => $this
->t('Export'),
'weight' => 40,
'url' => $entity
->toUrl('export'),
];
}
if ($entity
->hasLinkTemplate('deactivate') && !$enforced) {
$operations['deactivate'] = [
'title' => $this
->t('Deactivate'),
'weight' => 40,
'url' => $entity
->toUrl('deactivate'),
];
}
}
else {
if ($entity
->get('storage') === 'collection') {
if ($entity
->hasLinkTemplate('activate') && !$enforced) {
$operations['activate'] = [
'title' => $this
->t('Activate'),
'weight' => 40,
'url' => $entity
->toUrl('activate'),
];
}
if ($entity
->hasLinkTemplate('import') && !$enforced) {
$operations['import'] = [
'title' => $this
->t('Import'),
'weight' => 40,
'url' => $entity
->toUrl('import'),
];
}
}
else {
if ($entity
->hasLinkTemplate('import') && !$enforced) {
$operations['import'] = [
'title' => $this
->t('Activate/Import'),
'weight' => 40,
'url' => $entity
->toUrl('import'),
];
}
}
}
return $operations;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides EntityListBuilder:: |
7 |
ConfigSplitEntityListBuilder:: |
protected | property | The config factory that knows what is overwritten. | |
ConfigSplitEntityListBuilder:: |
protected | property | The status override service. | |
ConfigSplitEntityListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides EntityListBuilder:: |
|
ConfigSplitEntityListBuilder:: |
public | function |
Builds a row for an entity in the entity listing. Overrides EntityListBuilder:: |
|
ConfigSplitEntityListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
ConfigSplitEntityListBuilder:: |
public | function |
Gets this list's default operations. Overrides ConfigEntityListBuilder:: |
|
ConfigSplitEntityListBuilder:: |
public | function |
Constructs a new EntityListBuilder object. Overrides EntityListBuilder:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityHandlerBase:: |
protected | property | The module handler to invoke hooks on. | 5 |
EntityHandlerBase:: |
protected | function | Gets the module handler. | 5 |
EntityHandlerBase:: |
public | function | Sets the module handler for this handler. | |
EntityListBuilder:: |
protected | property | Information about the entity type. | |
EntityListBuilder:: |
protected | property | The entity type ID. | |
EntityListBuilder:: |
protected | property | The number of entities to list per page, or FALSE to list all entities. | |
EntityListBuilder:: |
protected | property | The entity storage class. | 1 |
EntityListBuilder:: |
public | function | Builds a renderable list of operation links for the entity. | 2 |
EntityListBuilder:: |
protected | function | Ensures that a destination is present on the given URL. | |
EntityListBuilder:: |
protected | function | Loads entity IDs using a pager sorted by the entity id. | 4 |
EntityListBuilder:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface:: |
2 |
EntityListBuilder:: |
public | function |
Gets the entity storage. Overrides EntityListBuilderInterface:: |
|
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
EntityListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface:: |
16 |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |