class Frontpage in Sitemap 2.0.x
Same name and namespace in other branches
- 8.2 src/Plugin/Sitemap/Frontpage.php \Drupal\sitemap\Plugin\Sitemap\Frontpage
Provides a link to the front page for the sitemap.
Plugin annotation
@Sitemap(
id = "frontpage",
title = @Translation("Site front page"),
description = @Translation("Displays a sitemap link for the site front page."),
settings = {
"title" = "Front page",
"rss" = "/rss.xml",
},
enabled = TRUE,
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\sitemap\SitemapBase implements SitemapInterface uses StringTranslationTrait
- class \Drupal\sitemap\Plugin\Sitemap\Frontpage
- class \Drupal\sitemap\SitemapBase implements SitemapInterface uses StringTranslationTrait
Expanded class hierarchy of Frontpage
File
- src/
Plugin/ Sitemap/ Frontpage.php, line 25
Namespace
Drupal\sitemap\Plugin\SitemapView source
class Frontpage extends SitemapBase {
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
// Provide a default title.
$form['title']['#default_value'] = $this->settings['title'] ?: $this
->t('Front page');
//@TODO: Convert to route instead of relative html path.
$form['rss'] = [
'#type' => 'textfield',
'#title' => $this
->t('Feed URL'),
'#default_value' => $this->settings['rss'],
'#description' => $this
->t('Specify the RSS feed for the front page. If you do not wish to display a feed, leave this field blank.'),
];
return $form;
}
/**
* {@inheritdoc}
*/
public function view() {
$title = $this->settings['title'];
$content[] = [
'#theme' => 'sitemap_frontpage_item',
'#text' => $this
->t('Front page of %sn', [
'%sn' => \Drupal::config('system.site')
->get('name'),
]),
'#url' => Url::fromRoute('<front>', [], [
'html' => TRUE,
])
->toString(),
'#feed' => $this->settings['rss'],
];
return [
'#theme' => 'sitemap_item',
'#title' => $title,
'#content' => $content,
'#sitemap' => $this,
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Frontpage:: |
public | function |
Returns a form to configure settings for the mapping. Overrides SitemapBase:: |
|
Frontpage:: |
public | function |
Builds a renderable array for a sitemap item. Overrides SitemapInterface:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
SitemapBase:: |
public | property | A Boolean indicating whether this mapping is enabled. | |
SitemapBase:: |
public | property | The name of the provider that owns this mapping. | |
SitemapBase:: |
public | property | An associative array containing the configured settings of the sitemap_map. | |
SitemapBase:: |
protected | property | The global sitemap config. | |
SitemapBase:: |
public | property | The weight of this mapping compared to others in the sitemap. | |
SitemapBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
SitemapBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
|
SitemapBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
SitemapBase:: |
public | function |
Returns the administrative description for this mapping plugin. Overrides SitemapInterface:: |
|
SitemapBase:: |
public | function |
Returns the administrative label for this mapping plugin. Overrides SitemapInterface:: |
|
SitemapBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
SitemapBase:: |
public | function |
Returns a short summary for the current mapping settings. Overrides SitemapInterface:: |
|
SitemapBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
|
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. |