class Rss in Podcast (using Views) 8

Default style plugin to render an RSS feed.

Plugin annotation


@ViewsStyle(
  id = "podcast_rss",
  title = @Translation("Podcast RSS Feed"),
  help = @Translation("Generates a podcast RSS feed from a view."),
  theme = "views_view_rss_podcast_feed",
  display_types = {"feed"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\style\StylePluginBase
    class \Drupal\views\Plugin\views\style\Rss
    class \Drupal\podcast\Plugin\views\style\Rss uses PodcastViewsMappingsTrait

Expanded class hierarchy of Rss

1 file declares its use of Rss

podcast.module in ./podcast.module: Primary module hooks for the podcast module.

File

src/Plugin/views/style/Rss.php, line 24

Namespace

Drupal\podcast\Plugin\views\style

View source

class Rss extends ViewsRss {
  use PodcastViewsMappingsTrait;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    unset($options['description']);
    $keys = [
      'copyright',
      'title_field',
      'description_field',
      'link_field',
      'author_field',
      'lastBuildDate_field',
      'itunes:explicit_field',
      'itunes:owner--name_field',
      'itunes:owner--email_field',
      'itunes:author_field',
      'itunes:summary_field',
      'itunes:keywords_field',
      'itunes:image_field',
      'itunes:category_field',
      'itunes:new-feed-url_field',
    ];
    $options = array_reduce($keys, function ($options, $key) {
      $options[$key] = [
        'default' => '',
      ];
      return $options;
    }, $options);
    $options['generator'] = [
      'default' => 'Podcast module for Drupal',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  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);
    unset($form['description']);
    $form['title_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Title field'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['title_field'],
      '#description' => $this
        ->t('Podcast name to display in the feed. Defaults to the view name.'),
      '#maxlength' => 1024,
      '#required' => TRUE,
    ];
    $form['description_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Description field'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['description_field'],
      '#description' => $this
        ->t('Podcast description to display in the feed.'),
      '#maxlength' => 1024,
      '#required' => FALSE,
    ];
    $form['link_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Link field'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['link_field'],
      '#description' => $this
        ->t('Podcast link to the feed.'),
      '#maxlength' => 1024,
      '#required' => TRUE,
    ];
    $form['lastBuildDate_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('lastBuildDate field'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['lastBuildDate_field'],
      '#description' => $this
        ->t('When the feed was last build.'),
      '#maxlength' => 1024,
      '#required' => TRUE,
    ];
    $form['generator'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Generator'),
      '#default_value' => $this->options['generator'],
      '#description' => $this
        ->t('Enter the text you want to display on how this feed was generated.'),
      '#maxlength' => 1024,
    ];
    $form['copyright'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Copyright'),
      '#default_value' => $this->options['copyright'],
      '#description' => $this
        ->t('Copyright notice for the podcast.'),
      '#maxlength' => 1024,
    ];
    $form['author_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Feed Author'),
      '#description' => $this
        ->t('List of owner names names for the feed.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['author_field'],
      '#required' => FALSE,
    ];
    $form['itunes:explicit_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Explicit field'),
      '#description' => $this
        ->t('Signal iTunes weather or not this podcast is explicit. Expects a boolean.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:explicit_field'],
      '#required' => FALSE,
    ];
    $form['itunes:owner--name_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Feed Owner Name'),
      '#description' => $this
        ->t('Owner name for the iTunes feed.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:owner--name_field'],
      '#required' => FALSE,
    ];
    $form['itunes:owner--email_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Feed Owner E-mail'),
      '#description' => $this
        ->t('Owner email for the iTunes feed.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:owner--email_field'],
      '#required' => FALSE,
    ];
    $form['itunes:author_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Feed Author'),
      '#description' => $this
        ->t('List of owner names names for the iTunes feed.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:author_field'],
      '#required' => FALSE,
    ];
    $form['itunes:summary_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Summary'),
      '#description' => $this
        ->t('Summary to be displayed in iTunes.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:summary_field'],
      '#required' => FALSE,
    ];
    $form['itunes:keywords_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Keywords'),
      '#description' => $this
        ->t('Keywords to be displayed in iTunes.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:keywords_field'],
      '#required' => FALSE,
    ];
    $form['itunes:image_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Image'),
      '#description' => $this
        ->t('Image to be displayed in iTunes.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:image_field'],
      '#required' => FALSE,
    ];
    $form['itunes:category_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes Category'),
      '#description' => $this
        ->t('Categories to be displayed in iTunes. Processor expects "$category/$subcategory". Multivalues are coma separated.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:category_field'],
      '#required' => FALSE,
    ];
    $form['itunes:new-feed-url_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('iTunes New Feed URL field'),
      '#description' => $this
        ->t('The URL to the new iTunes feed. This is used when moving the feed from one URL to another.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['itunes:new-feed-url_field'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getChannelElements() {
    $channel_elements = parent::getChannelElements();
    $namespaces = is_array($this->namespaces) ? $this->namespaces : [];
    $this->namespaces = array_merge($namespaces, [
      'xmlns:itunes' => 'http://www.itunes.com/dtds/podcast-1.0.dtd',
      'xmlns:content' => 'http://purl.org/rss/1.0/modules/content/',
      'xmlns:atom' => 'http://www.w3.org/2005/Atom',
    ]);
    return $channel_elements;
  }

  /**
   * Return an array of additional XHTML elements to add to the podcast channel.
   *
   * @return array
   *   A keyval array.
   */
  protected function getPodcastElements() {
    $podcast_elements = [];
    $image_field_value = $this
      ->getField(0, $this->options['itunes:image_field']);
    $image_url = UrlHelper::isExternal($image_field_value) ? $image_field_value : \Drupal::request()
      ->getSchemeAndHttpHost() . $image_field_value;
    $parsed_image_field = parse_url($image_url);
    $podcast_elements[] = [
      'key' => 'itunes:image',
      'value' => '',
      'attributes' => [
        'href' => $image_url,
      ],
    ];
    $podcast_elements[] = [
      'key' => 'image',
      'attributes' => [],
      'values' => [
        [
          'key' => 'url',
          'value' => $image_url,
        ],
        [
          'key' => 'link',
          'value' => $parsed_image_field['scheme'] . '://' . $parsed_image_field['host'] . (!empty($parsed_image_field['port']) ? ':' . $parsed_image_field['port'] : ''),
        ],
        [
          'key' => 'title',
          'value' => $this
            ->getField(0, $this->options['title_field']),
        ],
      ],
    ];
    $podcast_elements[] = [
      'key' => 'generator',
      'value' => $this->options['generator'],
    ];
    $podcast_elements[] = [
      'key' => 'copyright',
      'value' => $this->options['copyright'],
    ];
    $keys = [
      'title',
      'description',
      'lastBuildDate',
      'author',
      'itunes:explicit',
      'itunes:author',
      'itunes:summary',
      'itunes:keywords',
    ];
    $podcast_elements = array_merge(array_map([
      $this,
      'buildElementFromOptions',
    ], $keys), $podcast_elements);
    $owner_name = $this
      ->getField(0, $this->options['itunes:owner--name_field']);
    $owner_email = $this
      ->getField(0, $this->options['itunes:owner--email_field']);
    if (!empty($owner_email) || !empty($owner_name)) {
      $podcast_elements[] = [
        'key' => 'itunes:owner',
        'values' => [
          [
            'key' => 'itunes:name',
            'value' => $owner_name,
          ],
          [
            'key' => 'itunes:email',
            'value' => $owner_email,
          ],
        ],
      ];
    }
    $link_keys = [
      'link',
      'itunes:new-feed-url',
    ];
    $podcast_elements = array_reduce($link_keys, function ($elements, $key) {
      return array_merge($elements, [
        $this
          ->buildElementForLink($key),
      ]);
    }, $podcast_elements);
    $categories = $this
      ->buildElementFromOptions('itunes:category');
    if (!empty($categories)) {
      $category_elements = $this
        ->processCategories($categories);
      $podcast_elements = array_merge($podcast_elements, $category_elements);
    }
    return $podcast_elements;
  }

  /**
   * Processes categories to output the format expected by iTunes.
   *
   * @param array $element
   *   The keyvalue to process.
   *
   * @return array
   *   An array of keyvalue elements representing podcast categories.
   */
  protected function processCategories(array $element) {
    $tag_name = 'itunes:category';

    /** @var string[] $values */
    $values = array_map('trim', explode(',', $element['value']));

    // We need to parse out an optional leading category.
    $hierarchical_categories = array_reduce($values, function ($carry, $value) {
      $parts = explode('/', $value);
      if (empty($parts)) {
        return $carry;
      }
      $category = array_shift($parts);

      // Initialize the category section if it does not exist.
      if (!array_key_exists($category, $carry)) {
        $carry[$category] = [];
      }
      if (empty($parts)) {
        return $carry;
      }
      $carry[$category][] = array_shift($parts);
      return $carry;
    }, []);
    if (empty($hierarchical_categories)) {
      return [];
    }
    $new_elements = [];
    foreach ($hierarchical_categories as $category => $subcategories) {
      $category_container = $this
        ->buildElementFromOptions('itunes:category');
      $category_container['attributes'] = [
        'text' => html_entity_decode($category),
      ];
      $category_container['value'] = Markup::create(implode(array_map(function ($subcategory) use ($tag_name) {
        return sprintf('<%s text="%s"/>', $tag_name, $subcategory);
      }, $subcategories)));
      $new_elements[] = $category_container;
    }
    return $new_elements;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $this->podcast_elements = array_merge($this
      ->getPodcastElements(), isset($this->podcast_elements) ? $this->podcast_elements : []);
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's 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::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
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	62
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
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::isConfigurable	public	function	Determines if the plugin is configurable.
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::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm	16
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::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. 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. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
PodcastViewsMappingsTrait::buildElementForLink	protected	function	Same as buildElementFromOptions but generates full URLs.
PodcastViewsMappingsTrait::buildElementFromOptions	protected	function	Builds the channel element from the options.
Rss::$usesRowPlugin	protected	property	Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
Rss::attachTo	public	function
Rss::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides Rss::buildOptionsForm
Rss::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides Rss::defineOptions
Rss::getChannelElements	protected	function	Return an array of additional XHTML elements to add to the channel. Overrides Rss::getChannelElements
Rss::getDescription	public	function	Get RSS feed description.
Rss::getPodcastElements	protected	function	Return an array of additional XHTML elements to add to the podcast channel.
Rss::processCategories	protected	function	Processes categories to output the format expected by iTunes.
Rss::render	public	function	Render the display in this style. Overrides Rss::render
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
StylePluginBase::$defaultFieldLabels	protected	property	Should field labels be enabled by default.	1
StylePluginBase::$groupingTheme	protected	property	The theme function used to render the grouping set.
StylePluginBase::$rendered_fields	protected	property	Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens	protected	property	Store all available tokens row rows.
StylePluginBase::$usesFields	protected	property	Does the style plugin for itself support to add fields to its output.	3
StylePluginBase::$usesGrouping	protected	property	Does the style plugin support grouping of rows.	3
StylePluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows.	3
StylePluginBase::buildSort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
StylePluginBase::defaultFieldLabels	public	function	Return TRUE if this style enables field labels by default.	1
StylePluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow	public	function	#pre_render callback for view row field rendering.
StylePluginBase::evenEmpty	public	function	Should the output of the style plugin be rendered even if it's a empty view.	2
StylePluginBase::getField	public	function	Gets a rendered field.
StylePluginBase::getFieldValue	public	function	Get the raw field value.
StylePluginBase::getRowClass	public	function	Return the token replaced row class for the specified row.
StylePluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender	public	function	Allow the style to do stuff before each row is rendered.
StylePluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
StylePluginBase::renderFields	protected	function	Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping	public	function	Group records as needed for rendering.
StylePluginBase::renderGroupingSets	public	function	Render the grouping sets.
StylePluginBase::renderRowGroup	protected	function	Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue	public	function	Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields	public	function	Return TRUE if this style also uses fields.	3
StylePluginBase::usesGrouping	public	function	Returns the usesGrouping property.	3
StylePluginBase::usesRowClass	public	function	Returns the usesRowClass property.	3
StylePluginBase::usesRowPlugin	public	function	Returns the usesRowPlugin property.	10
StylePluginBase::usesTokens	public	function	Return TRUE if this style uses tokens.
StylePluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit	public	function	Alter the options of a display before they are added to the view.	1
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class Rss in Podcast (using Views) 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation