class SettingsController in Real-time SEO for Drupal 8.2
SettingsController.
Provides the settings pages for the Real-Time SEO module.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\yoast_seo\Controller\SettingsController
Expanded class hierarchy of SettingsController
File
- src/
Controller/ SettingsController.php, line 14
Namespace
Drupal\yoast_seo\ControllerView source
class SettingsController extends ControllerBase {
/**
* Settings page.
*
* @return array
* The configuration form.
*/
public function index() {
$form = [];
$xmlsitemap_enabled = \Drupal::moduleHandler()
->moduleExists('xmlsitemap');
$simple_sitemap_enabled = \Drupal::moduleHandler()
->moduleExists('simple_sitemap');
// Check if a sitemap module is installed and enabled.
if ($xmlsitemap_enabled && $simple_sitemap_enabled) {
// Discourage users from enabling both sitemap modules as they
// might interfere.
$xmlsitemap_description = $this
->t('It looks like you have both the XML Sitemap and Simple XML Sitemap module enabled. Please uninstall one of them as they could interfere with each other.');
}
elseif ($xmlsitemap_enabled) {
// Inform the user about altering the XML Sitemap configuration on the
// module configuration page if they have access to do so.
if (\Drupal::currentUser()
->hasPermission('administer xmlsitemap')) {
$xmlsitemap_description = $this
->t('You can configure the XML Sitemap settings at the @url.', [
'@url' => Link::fromTextAndUrl($this
->t('configuration page'), Url::fromRoute('xmlsitemap.admin_search'))
->toString(),
]);
}
else {
$xmlsitemap_description = $this
->t('You do not have the permission to administer the XML Sitemap.');
}
}
elseif (\Drupal::moduleHandler()
->moduleExists('simple_sitemap')) {
// Inform the user about altering the XML Sitemap configuration on the
// module configuration page if they have access to do so.
if (\Drupal::currentUser()
->hasPermission('administer simple_sitemap')) {
$xmlsitemap_description = $this
->t('You can configure the Simple XML Sitemap settings at the @url.', [
'@url' => Link::fromTextAndUrl($this
->t('configuration page'), Url::fromRoute('simple_sitemap.settings'))
->toString(),
]);
}
else {
$xmlsitemap_description = $this
->t('You do not have the permission to administer the Simple XML Sitemap.');
}
}
else {
// XML Sitemap is not enabled, inform the user they should think about
// installing and enabling it.
$xmlsitemap_description = $this
->t('You currently do not have a sitemap module enabled. We strongly recommend you to install a sitemap module. You can download the <a href="@project1-url">@project1-name</a> or <a href="@project2-url">@project2-name</a> module to use as sitemap generator.', [
'@project1-url' => 'https://www.drupal.org/project/simple_sitemap',
'@project1-name' => 'Simple Sitemap',
'@project2-url' => 'https://www.drupal.org/project/xmlsitemap',
'@project2-name' => 'XML Sitemap',
]);
}
$form['xmlsitemap'] = [
'#type' => 'details',
'#title' => $this
->t('Sitemap'),
'#markup' => $xmlsitemap_description,
'#open' => TRUE,
];
// Inform the user about altering the Metatag configuration on the module
// configuration page if they have access to do so.
// We do not check if the module is enabled since it is our dependency.
if (\Drupal::currentUser()
->hasPermission('administer meta tags')) {
$metatag_description = $this
->t('You can configure and override the Metatag title & description default settings at the @url.', [
'@url' => Link::fromTextAndUrl($this
->t('Metatag configuration page'), Url::fromRoute('entity.metatag_defaults.collection'))
->toString(),
]);
}
else {
$metatag_description = $this
->t('You currently do not have the permission to administer Metatag.');
}
$form['metatag'] = [
'#type' => 'details',
'#title' => $this
->t('Configure Metatag default templates'),
'#markup' => $metatag_description,
'#open' => TRUE,
];
return $form;
}
}
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 manager. | |
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:: |
40 |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
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. Overrides UrlGeneratorTrait:: |
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator 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. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
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. | |
SettingsController:: |
public | function | Settings page. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |