class MailListController in Mail Editor 2.0.x
Same name and namespace in other branches
- 8 src/Controller/MailListController.php \Drupal\mail_edit\Controller\MailListController
List all the emails that may be edited by the module.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\mail_edit\Controller\MailListController
Expanded class hierarchy of MailListController
File
- src/
Controller/ MailListController.php, line 12
Namespace
Drupal\mail_edit\ControllerView source
class MailListController extends ControllerBase {
/**
* List the emails.
*
* @return array
* A render array.
*/
public function listAll() {
$render = [
'#theme' => 'table',
'#attributes' => [],
'#header' => [
$this
->t('Module'),
$this
->t('Description'),
$this
->t('Length (characters)'),
$this
->t('Actions'),
],
'#rows' => [],
];
// Build rows out of the templates.
foreach ($this
->getAllTemplates() as $config_name => $templates) {
$config_label = $config_name;
if ($config_name == 'user.mail') {
$config_label = $this
->t('Drupal core');
}
foreach ($templates as $name => $data) {
$body_length = mb_strlen($data['body']);
if ($body_length === 0) {
$body_length = $this
->t('empty');
}
$args = [
'id' => $config_name . '.' . $name,
];
$render['#rows'][] = [
$config_label,
Xss::filter($data['description']),
$body_length,
Link::createFromRoute($this
->t('Edit'), 'mail_edit.edit', $args),
];
}
}
return $render;
}
/**
* Get a list of all templates provided by the site.
*
* @return array
* A list of all templates provided by module hooks.
*/
private function getAllTemplates() {
$all_templates = [];
$module_handler = $this
->moduleHandler();
// Trigger hook_mail_edit_templates().
// Get a list of the email templates as defined by other modules.
foreach ($module_handler
->invokeAll('mail_edit_templates') as $config_name => $templates) {
$config_data = $this
->config($config_name)
->getRawData();
// Make sure data was actually found.
if (empty($config_data)) {
$config_data = [];
}
// Process each of the defined templates.
foreach ($templates as $key => $label) {
// Keys will not be numeric if they are in $key => $label format, so if
// the key is numeric then it was provided as just a list of keys.
if (is_numeric($key)) {
$key = $label;
}
// Make sure the config structure exists.
if (!isset($config_data[$key])) {
$config_data[$key] = [
'subject' => '',
'body' => '',
];
}
$data = $config_data[$key];
// If an email's description is provided then use it, otherwise just
// use the email's subject line.
if ($key != $label) {
$data['description'] = $label;
}
else {
$data['description'] = $data['subject'];
}
$all_templates[$config_name][$key] = $data;
}
}
// Trigger hook_mail_edit_templates_list_alter().
// Allow modules to adjust the list of available templates, e.g. to remove
// items from the list for security purposes.
$module_handler
->alter('mail_edit_templates_list', $all_templates);
return $all_templates;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
46 |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MailListController:: |
private | function | Get a list of all templates provided by the site. | |
MailListController:: |
public | function | List the emails. | |
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. |