class RssFields
Same name in other branches
- 9 core/modules/views/src/Plugin/views/row/RssFields.php \Drupal\views\Plugin\views\row\RssFields
- 8.9.x core/modules/views/src/Plugin/views/row/RssFields.php \Drupal\views\Plugin\views\row\RssFields
- 11.x core/modules/views/src/Plugin/views/row/RssFields.php \Drupal\views\Plugin\views\row\RssFields
Renders an RSS item based on fields.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\row\RowPluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\row\RssFields extends \Drupal\views\Plugin\views\row\RowPluginBase
- class \Drupal\views\Plugin\views\row\RowPluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of RssFields
File
-
core/
modules/ views/ src/ Plugin/ views/ row/ RssFields.php, line 13
Namespace
Drupal\views\Plugin\views\rowView source
class RssFields extends RowPluginBase {
/**
* Does the row plugin support to add fields to its output.
*
* @var bool
*/
protected $usesFields = TRUE;
protected function defineOptions() {
$options = parent::defineOptions();
$options['title_field'] = [
'default' => '',
];
$options['link_field'] = [
'default' => '',
];
$options['description_field'] = [
'default' => '',
];
$options['creator_field'] = [
'default' => '',
];
$options['date_field'] = [
'default' => '',
];
$options['guid_field_options']['contains']['guid_field'] = [
'default' => '',
];
$options['guid_field_options']['contains']['guid_field_is_permalink'] = [
'default' => TRUE,
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$initial_labels = [
'' => $this->t('- None -'),
];
$view_fields_labels = $this->displayHandler
->getFieldLabels();
$view_fields_labels = array_merge($initial_labels, $view_fields_labels);
$form['title_field'] = [
'#type' => 'select',
'#title' => $this->t('Title field'),
'#description' => $this->t('The field that is going to be used as the RSS item title for each row.'),
'#options' => $view_fields_labels,
'#default_value' => $this->options['title_field'],
'#required' => TRUE,
];
$form['link_field'] = [
'#type' => 'select',
'#title' => $this->t('Link field'),
'#description' => $this->t('The field that is going to be used as the RSS item link for each row. This must either be an internal unprocessed path like "node/123" or a processed, root-relative URL as produced by fields like "Link to content".'),
'#options' => $view_fields_labels,
'#default_value' => $this->options['link_field'],
'#required' => TRUE,
];
$form['description_field'] = [
'#type' => 'select',
'#title' => $this->t('Description field'),
'#description' => $this->t('The field that is going to be used as the RSS item description for each row.'),
'#options' => $view_fields_labels,
'#default_value' => $this->options['description_field'],
'#required' => TRUE,
];
$form['creator_field'] = [
'#type' => 'select',
'#title' => $this->t('Creator field'),
'#description' => $this->t('The field that is going to be used as the RSS item creator for each row.'),
'#options' => $view_fields_labels,
'#default_value' => $this->options['creator_field'],
'#required' => TRUE,
];
$form['date_field'] = [
'#type' => 'select',
'#title' => $this->t('Publication date field'),
'#description' => $this->t('The field that is going to be used as the RSS item pubDate for each row. It needs to be in RFC 2822 format.'),
'#options' => $view_fields_labels,
'#default_value' => $this->options['date_field'],
'#required' => TRUE,
];
$form['guid_field_options'] = [
'#type' => 'details',
'#title' => $this->t('GUID settings'),
'#open' => TRUE,
];
$form['guid_field_options']['guid_field'] = [
'#type' => 'select',
'#title' => $this->t('GUID field'),
'#description' => $this->t('The globally unique identifier of the RSS item.'),
'#options' => $view_fields_labels,
'#default_value' => $this->options['guid_field_options']['guid_field'],
'#required' => TRUE,
];
$form['guid_field_options']['guid_field_is_permalink'] = [
'#type' => 'checkbox',
'#title' => $this->t('GUID is permalink'),
'#description' => $this->t('The RSS item GUID is a permalink.'),
'#default_value' => $this->options['guid_field_options']['guid_field_is_permalink'],
];
}
public function validate() {
$errors = parent::validate();
$required_options = [
'title_field',
'link_field',
'description_field',
'creator_field',
'date_field',
];
foreach ($required_options as $required_option) {
if (empty($this->options[$required_option])) {
$errors[] = $this->t('Row style plugin requires specifying which views fields to use for RSS item.');
break;
}
}
// Once more for guid.
if (empty($this->options['guid_field_options']['guid_field'])) {
$errors[] = $this->t('Row style plugin requires specifying which views fields to use for RSS item.');
}
return $errors;
}
public function render($row) {
static $row_index;
if (!isset($row_index)) {
$row_index = 0;
}
// Create the RSS item object.
$item = new \stdClass();
$item->title = $this->getField($row_index, $this->options['title_field']);
$item->link = $this->getAbsoluteUrl($this->getField($row_index, $this->options['link_field']));
$field = $this->getField($row_index, $this->options['description_field']);
$item->description = is_array($field) ? $field : [
'#markup' => $field,
];
$item->elements = [
// Default rendering of date fields adds a <time> tag and whitespace, we
// want to remove these because this breaks RSS feeds.
[
'key' => 'pubDate',
'value' => trim(strip_tags($this->getField($row_index, $this->options['date_field']))),
],
[
'key' => 'dc:creator',
'value' => $this->getField($row_index, $this->options['creator_field']),
'namespace' => [
'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
],
],
];
$guid_is_permalink_string = 'false';
$item_guid = $this->getField($row_index, $this->options['guid_field_options']['guid_field']);
if ($this->options['guid_field_options']['guid_field_is_permalink']) {
$guid_is_permalink_string = 'true';
$item_guid = $this->getAbsoluteUrl($item_guid);
}
$item->elements[] = [
'key' => 'guid',
'value' => $item_guid,
'attributes' => [
'isPermaLink' => $guid_is_permalink_string,
],
];
$row_index++;
foreach ($item->elements as $element) {
if (isset($element['namespace'])) {
$this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $element['namespace']);
}
}
$build = [
'#theme' => $this->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#row' => $item,
'#field_alias' => $this->field_alias ?? '',
];
return $build;
}
/**
* Retrieves a views field value from the style plugin.
*
* @param $index
* The index count of the row as expected by views_plugin_style::getField().
* @param $field_id
* The ID assigned to the required field in the display.
*
* @return string|null|\Drupal\Component\Render\MarkupInterface
* An empty string if there is no style plugin, or the field ID is empty.
* NULL if the field value is empty. If neither of these conditions apply,
* a MarkupInterface object containing the rendered field value.
*/
public function getField($index, $field_id) {
if (empty($this->view->style_plugin) || !is_object($this->view->style_plugin) || empty($field_id)) {
return '';
}
return $this->view->style_plugin
->getField($index, $field_id);
}
/**
* Convert a rendered URL string to an absolute URL.
*
* @param string $url_string
* The rendered field value ready for display in a normal view.
*
* @return string
* A string with an absolute URL.
*/
protected function getAbsoluteUrl($url_string) {
// If the given URL already starts with a leading slash, it's been processed
// and we need to simply make it an absolute path by prepending the host.
if (str_starts_with($url_string, '/')) {
$host = \Drupal::request()->getSchemeAndHttpHost();
// @todo Views should expect and store a leading /.
// @see https://www.drupal.org/node/2423913
return $host . $url_string;
}
else {
return Url::fromUserInput('/' . $url_string)->setAbsolute()
->toString();
}
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
PluginBase::$definition | public | property | Plugins' definition. | |||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | |||
PluginBase::$options | public | property | Options for this plugin will be held here. | |||
PluginBase::$position | public | property | The handler position. | |||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
PluginBase::$view | public | property | The top object of a view. | 1 | ||
PluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 | |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 60 | |
PluginBase::destroy | public | function | Clears a plugin. | Overrides ViewsPluginInterface::destroy | 2 | |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | ||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | ||
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | ||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
PluginBase::init | public | function | Initialize the plugin. | Overrides ViewsPluginInterface::init | 6 | |
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | ||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | ||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 | |
PluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 | |
PluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
PluginBase::__construct | public | function | Constructs a PluginBase object. | 19 | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | ||
RowPluginBase::$base_field | public | property | 2 | |||
RowPluginBase::$field_alias | public | property | 1 | |||
RowPluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | 1 | |
RowPluginBase::preRender | public | function | Allow the style to do stuff before each row is rendered. | 4 | ||
RowPluginBase::query | public | function | Add anything to the query that we might need to. | Overrides PluginBase::query | 2 | |
RowPluginBase::submitOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | Overrides PluginBase::submitOptionsForm | 1 | |
RowPluginBase::usesFields | public | function | Returns the usesFields property. | 4 | ||
RowPluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | 1 | |
RssFields::$usesFields | protected | property | Does the row plugin support to add fields to its output. | Overrides RowPluginBase::$usesFields | ||
RssFields::buildOptionsForm | public | function | Provide a form for setting options. | Overrides RowPluginBase::buildOptionsForm | ||
RssFields::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides RowPluginBase::defineOptions | ||
RssFields::getAbsoluteUrl | protected | function | Convert a rendered URL string to an absolute URL. | |||
RssFields::getField | public | function | Retrieves a views field value from the style plugin. | |||
RssFields::render | public | function | Renders a row object. | Overrides RowPluginBase::render | ||
RssFields::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.