You are here

Home » API reference » Support Ticketing System 8 » Rss.php

class Rss in Support Ticketing System 8

Plugin which performs a support_ticket_view on the resulting object and formats it as an RSS item.

Plugin annotation


@ViewsRow(
  id = "support_ticket_rss",
  title = @Translation("Tickets"),
  help = @Translation("Display the tickets with standard support ticket view."),
  theme = "views_view_row_rss",
  register_theme = FALSE,
  base = {"support_ticket_field_data"},
  display_types = {"feed"}
)

Hierarchy

Expanded class hierarchy of Rss

File

modules/support_ticket/src/Plugin/views/row/Rss.php, line 30
Contains \Drupal\support_ticket\Plugin\views\row\Rss.

Namespace

Drupal\support_ticket\Plugin\views\row
View source 
class Rss extends RssPluginBase {

  // Basic properties that let the row style follow relationships.
  var $base_table = 'support_ticket_field_data';
  var $base_field = 'stid';

  // Stores the support tickets loaded with preRender.
  var $support_tickets = array();

  /**
   * {@inheritdoc}
   */
  protected $entityTypeId = 'support_ticket';

  /**
   * The support ticket storage
   *
   * @var \Drupal\support_ticket\SupportTicketStorageInterface
   */
  protected $supportTicketStorage;

  /**
   * Constructs the Rss object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_manager);
    $this->supportTicketStorage = $entity_manager
      ->getStorage('support_ticket');
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm_summary_options() {
    $options = parent::buildOptionsForm_summary_options();
    $options['title'] = $this
      ->t('Title only');
    $options['default'] = $this
      ->t('Use site default RSS settings');
    return $options;
  }
  public function summaryTitle() {
    $options = $this
      ->buildOptionsForm_summary_options();
    return SafeMarkup::checkPlain($options[$this->options['view_mode']]);
  }
  public function preRender($values) {
    $stids = array();
    foreach ($values as $row) {
      $stids[] = $row->{$this->field_alias};
    }
    if (!empty($stids)) {
      $this->support_tickets = $this->supportTicketStorage
        ->loadMultiple($stids);
    }
  }
  public function render($row) {
    global $base_url;
    $stid = $row->{$this->field_alias};
    if (!is_numeric($stid)) {
      return;
    }
    $display_mode = $this->options['view_mode'];
    if ($display_mode == 'default') {
      $display_mode = \Drupal::config('system.rss')
        ->get('items.view_mode');
    }

    // Load the specified support ticket:

    /** @var \Drupal\support_ticket\SupportTicketInterface $support_ticket */
    $support_ticket = $this->support_tickets[$stid];
    if (empty($support_ticket)) {
      return;
    }
    $description_build = [];
    $support_ticket->link = $support_ticket
      ->url('canonical', array(
      'absolute' => TRUE,
    ));
    $support_ticket->rss_namespaces = array();
    $support_ticket->rss_elements = array(
      array(
        'key' => 'pubDate',
        'value' => gmdate('r', $support_ticket
          ->getCreatedTime()),
      ),
      array(
        'key' => 'dc:creator',
        'value' => $support_ticket
          ->getOwner()
          ->getDisplayName(),
      ),
      array(
        'key' => 'guid',
        'value' => $support_ticket
          ->id() . ' at ' . $base_url,
        'attributes' => array(
          'isPermaLink' => 'false',
        ),
      ),
    );

    // The support ticket gets built and modules add to or modify $support_ticket->rss_elements
    // and $support_ticket->rss_namespaces.
    $build_mode = $display_mode;
    $build = support_ticket_view($support_ticket, $build_mode);
    unset($build['#theme']);
    if (!empty($support_ticket->rss_namespaces)) {
      $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $support_ticket->rss_namespaces);
    }
    elseif (function_exists('rdf_get_namespaces')) {

      // Merge RDF namespaces in the XML namespaces in case they are used
      // further in the RSS content.
      $xml_rdf_namespaces = array();
      foreach (rdf_get_namespaces() as $prefix => $uri) {
        $xml_rdf_namespaces['xmlns:' . $prefix] = $uri;
      }
      $this->view->style_plugin->namespaces += $xml_rdf_namespaces;
    }
    if ($display_mode != 'title') {

      // We render support ticket contents.
      $description_build = $build;
    }
    $item = new \stdClass();
    $item->description = $description_build;
    $item->title = $support_ticket
      ->label();
    $item->link = $support_ticket->link;

    // Provide a reference so that the render call in
    // template_preprocess_views_view_row_rss() can still access it.
    $item->elements =& $support_ticket->rss_elements;
    $item->stid = $support_ticket
      ->id();
    $build = array(
      '#theme' => $this
        ->themeFunctions(),
      '#view' => $this->view,
      '#options' => $this->options,
      '#row' => $item,
    );
    return $build;
  }

}

Members

Namesort descending 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
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
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::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
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::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::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
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::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 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::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
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.
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to its output. 4
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
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. There is no need for this function to actually store the data. 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
Rss::$base_field property
Rss::$base_table property
Rss::$entityTypeId protected property The ID of the entity type for which this is an RSS row plugin. Overrides RssPluginBase::$entityTypeId
Rss::$supportTicketStorage protected property The support ticket storage
Rss::$support_tickets property
Rss::buildOptionsForm_summary_options public function Return the main options, which are shown in the summary title. Overrides RssPluginBase::buildOptionsForm_summary_options
Rss::preRender public function Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::preRender
Rss::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render
Rss::summaryTitle public function Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle
Rss::__construct public function Constructs the Rss object. Overrides RssPluginBase::__construct
RssPluginBase::$deprecatedProperties protected property
RssPluginBase::$entityDisplayRepository protected property The entity display repository.
RssPluginBase::$entityTypeManager protected property The entity manager.
RssPluginBase::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
RssPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
RssPluginBase::create public static function Creates an instance of the plugin. Overrides PluginBase::create
RssPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions
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.
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.