class WebformAddonsController in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Controller/WebformAddonsController.php \Drupal\webform\Controller\WebformAddonsController
Provides route responses for Webform add-ons.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\webform\Controller\WebformAddonsController implements ContainerInjectionInterface
Expanded class hierarchy of WebformAddonsController
File
- src/
Controller/ WebformAddonsController.php, line 14
Namespace
Drupal\webform\ControllerView source
class WebformAddonsController extends ControllerBase implements ContainerInjectionInterface {
/**
* The current request.
*
* @var \Symfony\Component\HttpFoundation\Request
*/
protected $request;
/**
* The webform theme manager.
*
* @var \Drupal\webform\WebformThemeManagerInterface
*/
protected $themeManager;
/**
* The webform add-ons manager.
*
* @var \Drupal\webform\WebformAddonsManagerInterface
*/
protected $addons;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->request = $container
->get('request_stack')
->getCurrentRequest();
$instance->themeManager = $container
->get('webform.theme_manager');
$instance->addons = $container
->get('webform.addons_manager');
return $instance;
}
/**
* Returns the Webform add-ons page.
*
* @return array
* The webform submission webform.
*/
public function index() {
$build = [
'#type' => 'container',
'#attributes' => [
'class' => [
'webform-addons',
],
],
];
// Support.
if (!$this
->config('webform.settings')
->get('ui.support_disabled')) {
$build['support'] = [
'#theme' => 'webform_help_support',
];
}
// Filter.
$is_claro_theme = $this->themeManager
->isActiveTheme('claro');
$data_source = $is_claro_theme ? '.admin-item' : 'li';
$data_parent = $is_claro_theme ? '.admin-item' : 'li';
$build['filter'] = [
'#type' => 'search',
'#title' => $this
->t('Filter'),
'#title_display' => 'invisible',
'#size' => 30,
'#placeholder' => $this
->t('Filter by keyword'),
'#attributes' => [
'name' => 'text',
'class' => [
'webform-form-filter-text',
],
'data-summary' => '.webform-addons-summary',
'data-item-singlular' => $this
->t('add-on'),
'data-item-plural' => $this
->t('add-ons'),
'data-no-results' => '.webform-addons-no-results',
'data-element' => '.admin-list',
'data-source' => $data_source,
'data-parent' => $data_parent,
'title' => $this
->t('Enter a keyword to filter by.'),
'autofocus' => 'autofocus',
],
];
// Display info.
$build['info'] = [
'#markup' => $this
->t('@total add-ons', [
'@total' => count($this->addons
->getProjects()),
]),
'#prefix' => '<p class="webform-addons-summary">',
'#suffix' => '</p>',
];
// Projects.
$build['projects'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'webform-addons-projects',
'js-webform-details-toggle',
'webform-details-toggle',
],
],
];
// Store and disable compact mode.
// @see system_admin_compact_mode
$system_admin_compact_mode = system_admin_compact_mode();
$this->request->cookies
->set('Drupal_visitor_admin_compact_mode', FALSE);
$categories = $this->addons
->getCategories();
foreach ($categories as $category_name => $category) {
$build['projects'][$category_name] = [
'#type' => 'details',
'#title' => $category['title'],
'#attributes' => [
'data-webform-element-id' => 'webform-addons-' . $category_name,
],
'#open' => TRUE,
];
$projects = $this->addons
->getProjects($category_name);
foreach ($projects as $project_name => &$project) {
// Append (Experimental) to title.
if (!empty($project['experimental'])) {
$project['title'] .= ' [' . $this
->t('EXPERIMENTAL') . ']';
}
// Prepend logo to title.
if (isset($project['logo'])) {
$project['title'] = Markup::create('<img src="' . $project['logo']
->toString() . '" alt="' . $project['title'] . '"/>' . $project['title']);
}
$project['description'] .= '<br /><small>' . $project['url']
->toString() . '</small>';
// Append recommended to project's description.
if (!empty($project['recommended'])) {
$project['description'] .= '<br /><b class="color-success"> ★' . $this
->t('Recommended') . '</b>';
}
if (!empty($project['install']) && !$this
->moduleHandler()
->moduleExists($project_name)) {
// If current user can install module then display a dismissible warning.
if ($this
->currentUser()
->hasPermission('administer modules')) {
$build['projects'][$project_name . '_message'] = [
'#type' => 'webform_message',
'#message_id' => $project_name . '_message',
'#message_type' => 'warning',
'#message_close' => TRUE,
'#message_storage' => WebformMessage::STORAGE_USER,
'#message_message' => $this
->t('Please install to the <a href=":href">@title</a> project to improve the Webform module\'s user experience.', [
':href' => $project['url']
->toString(),
'@title' => $project['title'],
]) . ' <em>' . $project['install'] . '</em>',
'#weight' => -100,
];
}
}
}
$build['projects'][$category_name]['content'] = [
'#theme' => 'admin_block_content',
'#content' => $projects,
];
}
// Reset compact mode to stored setting.
$this->request->cookies
->get('Drupal_visitor_admin_compact_mode', $system_admin_compact_mode);
// No results.
$build['no_results'] = [
'#type' => 'webform_message',
'#message_message' => $this
->t('No add-ons found. Try a different search.'),
'#message_type' => 'info',
'#attributes' => [
'class' => [
'webform-addons-no-results',
],
],
];
$build['#attached']['library'][] = 'webform/webform.addons';
$build['#attached']['library'][] = 'webform/webform.admin';
return $build;
}
}
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:: |
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. | |
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. | |
WebformAddonsController:: |
protected | property | The webform add-ons manager. | |
WebformAddonsController:: |
protected | property | The current request. | |
WebformAddonsController:: |
protected | property | The webform theme manager. | |
WebformAddonsController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
WebformAddonsController:: |
public | function | Returns the Webform add-ons page. |