class LingotekProfileListBuilder in Lingotek Translation 3.4.x
Same name and namespace in other branches
- 8 src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 8.2 src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 4.0.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.0.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.1.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.2.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.3.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.5.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.6.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.7.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
- 3.8.x src/LingotekProfileListBuilder.php \Drupal\lingotek\LingotekProfileListBuilder
Defines a class to build a listing of Lingotek profile 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\Core\Config\Entity\DraggableListBuilder implements FormInterface
- class \Drupal\lingotek\LingotekProfileListBuilder
- class \Drupal\Core\Config\Entity\DraggableListBuilder implements FormInterface
- class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
Expanded class hierarchy of LingotekProfileListBuilder
See also
\Drupal\lingotek\Entity\LingotekProfile
File
- src/
LingotekProfileListBuilder.php, line 19
Namespace
Drupal\lingotekView source
class LingotekProfileListBuilder extends DraggableListBuilder {
/**
* {@inheritdoc}
*/
protected $entitiesKey = 'profile';
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* The configuration factory.
*
* @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('language_manager'), $container
->get('config.factory'));
}
/**
* Constructs a new LingotekProfileListBuilder object.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition.
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage controller class.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The factory for configuration objects.
*/
public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory) {
parent::__construct($entity_type, $storage);
$this->languageManager = $language_manager;
$this->configFactory = $config_factory;
}
/**
* {@inheritdoc}
*/
public function load() {
$entities = $this->storage
->loadMultiple();
// Sort the entities using the entity class's sort() method.
// See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
uasort($entities, [
$this->entityType
->getClass(),
'sort',
]);
return $entities;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'lingotek_profile_admin_overview_form';
}
/**
* {@inheritdoc}
*/
public function buildHeader() {
$header = [
'label' => t('Name'),
'auto_upload' => t('Automatic Upload'),
'auto_request' => t('Automatic Request'),
'auto_download' => t('Automatic Download'),
] + parent::buildHeader();
return $header;
}
/**
* {@inheritdoc}
*/
public function buildRow(EntityInterface $entity) {
/** @var \Drupal\lingotek\LingotekProfileInterface $entity */
$row['label'] = $entity
->label();
$row['auto_upload'] = [
'#type' => 'checkbox',
'#title' => t('Set @title for automatic upload', [
'@title' => $entity
->label(),
]),
'#title_display' => 'invisible',
'#disabled' => $entity
->isLocked(),
'#default_value' => $entity
->hasAutomaticUpload(),
];
$row['auto_request'] = [
'#type' => 'checkbox',
'#title' => t('Set @title for automatic request', [
'@title' => $entity
->label(),
]),
'#title_display' => 'invisible',
'#disabled' => $entity
->isLocked(),
'#default_value' => $entity
->hasAutomaticRequest(),
];
$row['auto_download'] = [
'#type' => 'checkbox',
'#title' => t('Set @title for automatic download', [
'@title' => $entity
->label(),
]),
'#title_display' => 'invisible',
'#disabled' => $entity
->isLocked(),
'#default_value' => $entity
->hasAutomaticDownload(),
];
return $row + parent::buildRow($entity);
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);
$form[$this->entitiesKey]['#profiles'] = $this->entities;
$form['actions']['submit']['#value'] = t('Save configuration');
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Parent submit handler takes care of the weights, but not the checkboxes.
parent::submitForm($form, $form_state);
/** @var \Drupal\lingotek\LingotekProfileInterface $entity */
foreach ($this->entities as $entity_id => $entity) {
if (!$entity
->isLocked() && ($entity
->hasAutomaticRequest() != $form_state
->getValue([
'profile',
$entity_id,
'auto_request',
]) || $entity
->hasAutomaticUpload() != $form_state
->getValue([
'profile',
$entity_id,
'auto_upload',
]) || $entity
->hasAutomaticDownload() != $form_state
->getValue([
'profile',
$entity_id,
'auto_download',
]))) {
$entity
->setAutomaticUpload($form_state
->getValue([
'profile',
$entity_id,
'auto_upload',
]));
$entity
->setAutomaticRequest($form_state
->getValue([
'profile',
$entity_id,
'auto_request',
]));
$entity
->setAutomaticDownload($form_state
->getValue([
'profile',
$entity_id,
'auto_download',
]));
$entity
->save();
}
}
$this
->messenger()
->addStatus(t('Configuration saved.'));
}
/**
* {@inheritdoc}
*/
public function getOperations(EntityInterface $entity) {
// We don't call parent, as we don't want config_translation operations.
$operations = [];
if (!$entity
->isLocked() && $entity
->hasLinkTemplate('edit-form')) {
$operations['edit'] = [
'title' => $this
->t('Edit'),
'weight' => 10,
'url' => $entity
->toUrl('edit-form'),
];
}
if (!$entity
->isLocked() && $entity
->hasLinkTemplate('delete-form')) {
$operations['delete'] = [
'title' => $this
->t('Delete'),
'weight' => 100,
'url' => $entity
->toUrl('delete-form'),
];
}
return $operations;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigEntityListBuilder:: |
public | function |
Gets this list's default operations. Overrides EntityListBuilder:: |
15 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DraggableListBuilder:: |
protected | property | The entities being listed. | 1 |
DraggableListBuilder:: |
protected | property | The form builder. | |
DraggableListBuilder:: |
protected | property | Name of the entity's weight field or FALSE if no field is provided. | |
DraggableListBuilder:: |
protected | function | Returns the form builder. | |
DraggableListBuilder:: |
public | function |
Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder:: |
1 |
DraggableListBuilder:: |
public | function |
Form validation handler. Overrides FormInterface:: |
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 |
Gets the entity storage. Overrides EntityListBuilderInterface:: |
|
EntityListBuilder:: |
protected | function | Gets the title of the page. | 1 |
LingotekProfileListBuilder:: |
protected | property | The configuration factory. | |
LingotekProfileListBuilder:: |
protected | property |
The key to use for the form element containing the entities. Overrides DraggableListBuilder:: |
|
LingotekProfileListBuilder:: |
protected | property | The language manager. | |
LingotekProfileListBuilder:: |
public | function |
Form constructor. Overrides DraggableListBuilder:: |
|
LingotekProfileListBuilder:: |
public | function |
Builds the header row for the entity listing. Overrides DraggableListBuilder:: |
|
LingotekProfileListBuilder:: |
public | function |
Builds a row for an entity in the entity listing. Overrides DraggableListBuilder:: |
|
LingotekProfileListBuilder:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityListBuilder:: |
|
LingotekProfileListBuilder:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
LingotekProfileListBuilder:: |
public | function |
Provides an array of information to build a list of operation links. Overrides EntityListBuilder:: |
|
LingotekProfileListBuilder:: |
public | function |
Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder:: |
|
LingotekProfileListBuilder:: |
public | function |
Form submission handler. Overrides DraggableListBuilder:: |
|
LingotekProfileListBuilder:: |
public | function |
Constructs a new LingotekProfileListBuilder object. Overrides DraggableListBuilder:: |
|
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. |