class JsonFeedSerializer in JSON Feed 8

Default style plugin to render a JSON feed.

Plugin annotation


@ViewsStyle(
  id = "json_feed_serializer",
  title = @Translation("JSON Feed"),
  help = @Translation("Generates a JSON feed from a view."),
  display_types = {"json_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\json_feed\Plugin\views\style\JsonFeedSerializer

Expanded class hierarchy of JsonFeedSerializer

File

src/Plugin/views/style/JsonFeedSerializer.php, line 22

Namespace

Drupal\json_feed\Plugin\views\style

View source

class JsonFeedSerializer extends StylePluginBase {

  /**
   * Does the style plugin for itself support to add fields to it's output.
   *
   * @var bool
   */
  protected $usesRowPlugin = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesGrouping = FALSE;

  /**
   * {@inheritdoc}
   */
  public function attachTo(array &$build, $display_id, Url $feed_url, $title) {
    $url_options = [];
    $input = $this->view
      ->getExposedInput();
    if ($input) {
      $url_options['query'] = $input;
    }
    $url_options['absolute'] = TRUE;
    $url = $feed_url
      ->setOptions($url_options)
      ->toString();
    $build['#attached']['library'][] = 'json_feed/json-feed';

    // Add the feed icon to the view.
    $this->view->feedIcons[] = [
      '#theme' => 'json_feed_icon',
      '#url' => $url,
      '#title' => $title,
    ];

    // Attach a link to the JSON feed, which is an alternate representation.
    $build['#attached']['html_head_link'][][] = [
      'rel' => 'alternate',
      'type' => 'application/json',
      'title' => $title,
      'href' => $url,
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['description'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['home_page_url_note'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('JSON Feed home_page_url'),
      '#description' => $this
        ->t("Set Link Display to your view's main Page display to enable home_page_url"),
    ];
    $form['description'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('JSON Feed description'),
      '#default_value' => $this->options['description'],
      '#description' => $this
        ->t('This will appear in the JSON feed itself.'),
      '#maxlength' => 1024,
    ];
    $form['author'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Author'),
      '#open' => TRUE,
    ];
    $form['author']['author_name_field'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('feed author name attribute'),
      '#description' => $this
        ->t("JSON author name attribute."),
      '#default_value' => $this->options['author']['author_name_field'],
    ];
    $form['author']['author_url_field'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('feed author url attribute'),
      '#description' => $this
        ->t("The URL of a site owned by the feed's author."),
      '#default_value' => $this->options['author']['author_url_field'],
    ];
    $form['author']['author_avatar_field'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('feed author avatar attribute'),
      '#description' => $this
        ->t("The URL for an image for the feed's author."),
      '#default_value' => $this->options['author']['author_avatar_field'],
    ];
    $form['expired'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Feed Expired'),
      '#default_value' => $this->options['expired'],
      '#description' => $this
        ->t('Specifies whether or not the feed is finished and will ever update again. For instance, a feed for a temporary event could expire.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function validate() {
    $errors = parent::validate();

    // Ensure there's a title.
    if (!$this->view->display_handler
      ->getOption('sitename_title') && !$this->view
      ->getTitle()) {
      $errors[] = $this
        ->t('The view must have a title');
    }
    return $errors;
  }

  /**
   * Get RSS feed description.
   *
   * @return string
   *   The string containing the description with the tokens replaced.
   */
  public function getDescription() {
    $description = $this->options['description'];

    // Allow substitutions from the first row.
    $description = $this
      ->tokenizeValue($description, 0);
    return $description;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {

    // Build items list.
    $items = [];
    foreach ($this->view->result as $row_index => $row) {
      $this->view->row_index = $row_index;
      $items[] = $this->view->rowPlugin
        ->render($row);
    }
    unset($this->view->row_index);

    // Create feed.
    $feed['version'] = 'https://jsonfeed.org/version/1';
    $feed['title'] = strip_tags($this
      ->getTitle());
    $feed['description'] = strip_tags($this
      ->getDescription());
    $feed['home_page_url'] = strip_tags($this
      ->getFeedHomePageUrl());
    $feed['feed_url'] = strip_tags($this->displayHandler
      ->getUrl()
      ->setAbsolute()
      ->toString());
    $feed['favicon'] = strip_tags($this
      ->getFavicon());
    $feed['author'] = array_map('strip_tags', $this
      ->getAuthor());
    if ($next_url = $this
      ->getNextPage()) {
      $feed['next_url'] = strip_tags($next_url);
    }
    $feed['items'] = $items;

    // Remove empty attributes.
    $feed = array_filter($feed);

    // Add expired, which if false would be stripped out by array_filter.
    $feed['expired'] = $this
      ->isFeedExpired();
    return Json::encode($feed);
  }

  /**
   * Get JSON feed author information.
   *
   * @return array
   *   An array containing the feed's author data.
   */
  protected function getAuthor() {
    if (empty($this->options['author'])) {
      return [];
    }
    $author_data = $this->options['author'];
    $author['name'] = !empty($author_data['author_name_field']) ? strip_tags($author_data['author_name_field']) : NULL;
    $author['url'] = !empty($author_data['author_url_field']) ? strip_tags($author_data['author_url_field']) : NULL;
    $author['avatar'] = !empty($author_data['author_avatar_field']) ? strip_tags($author_data['author_avatar_field']) : NULL;

    // Remove empty attributes.
    $author = array_filter($author);
    return $author;
  }

  /**
   * Get the feed title.
   *
   * @return string
   *   The title to use for the feed
   */
  protected function getTitle() {
    $config = \Drupal::config('system.site');

    // Find title.
    if ($this->view->display_handler
      ->getOption('sitename_title')) {
      $title = $config
        ->get('name');
      if ($slogan = $config
        ->get('slogan')) {
        $title .= ' - ' . $slogan;
      }
    }
    else {
      $title = $this->view
        ->getTitle();
    }
    return $title;
  }

  /**
   * The URL of the feed.
   */
  protected function getFeedHomePageUrl() {

    // Figure out which display which has a path we're using for this feed. If
    // there isn't one, use the global $base_url.
    $link_display_id = $this->view->display_handler
      ->getLinkDisplay();
    if ($link_display_id && ($display = $this->view->displayHandlers
      ->get($link_display_id))) {
      $url = $this->view
        ->getUrl(NULL, $link_display_id);
    }
    $url_options = [
      'absolute' => TRUE,
    ];
    $base_url = Url::fromRoute('<front>')
      ->setAbsolute()
      ->toString();

    /** @var \Drupal\Core\Url $url */
    if ($url) {

      // Compare the link to the default home page; if it's the default home
      // page, just use $base_url.
      $config = \Drupal::config('system.site');
      $url_string = $url
        ->setOptions($url_options)
        ->toString();
      if ($url_string === Url::fromUserInput($config
        ->get('page.front'))
        ->toString()) {
        $url_string = $base_url;
      }
      return $url_string;
    }
    return $base_url;
  }

  /**
   * Get the URL of the next page.
   */
  protected function getNextPage() {

    // Check for pager and pager settings.
    $pager = $this->displayHandler
      ->getPlugin('pager');
    if (empty($pager) || !$pager
      ->hasMoreRecords()) {
      return NULL;
    }
    $pager_manager = \Drupal::service('pager.manager');
    $options = [
      'query' => $pager_manager
        ->getUpdatedParameters([], 0, $pager
        ->getCurrentPage() + 1),
    ];
    return Url::fromRoute('<current>', [], $options)
      ->setAbsolute()
      ->toString();
  }

  /**
   * Get the favicon URL.
   *
   * @return string
   *   String contraining the URL of the site's favicon.
   */
  protected function getFavicon() {
    $favicon = theme_get_setting('favicon.url');
    return $favicon ? Url::fromUserInput($favicon)
      ->setAbsolute()
      ->toString() : NULL;
  }

  /**
   * Determine if the feed is expired.
   *
   * @return bool
   *   TRUE if the feed is expired, else FALSE.
   */
  protected function isFeedExpired() {
    if (empty($this->options['expired'])) {
      return FALSE;
    }
    return $this->options['expired'] ? TRUE : FALSE;
  }

}

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
JsonFeedSerializer::$usesGrouping	protected	property	Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
JsonFeedSerializer::$usesRowPlugin	protected	property	Does the style plugin for itself support to add fields to it's output. Overrides StylePluginBase::$usesRowPlugin
JsonFeedSerializer::attachTo	public	function
JsonFeedSerializer::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
JsonFeedSerializer::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
JsonFeedSerializer::getAuthor	protected	function	Get JSON feed author information.
JsonFeedSerializer::getDescription	public	function	Get RSS feed description.
JsonFeedSerializer::getFavicon	protected	function	Get the favicon URL.
JsonFeedSerializer::getFeedHomePageUrl	protected	function	The URL of the feed.
JsonFeedSerializer::getNextPage	protected	function	Get the URL of the next page.
JsonFeedSerializer::getTitle	protected	function	Get the feed title.
JsonFeedSerializer::isFeedExpired	protected	function	Determine if the feed is expired.
JsonFeedSerializer::render	public	function	Render the display in this style. Overrides StylePluginBase::render
JsonFeedSerializer::validate	public	function	Validate that the plugin is correct and can be saved. Overrides StylePluginBase::validate
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
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::$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::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 JsonFeedSerializer in JSON Feed 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation