You are here

Home » API reference » Zircon Profile 8 » OpmlFields.php

class OpmlFields in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/views/src/Plugin/views/row/OpmlFields.php \Drupal\views\Plugin\views\row\OpmlFields

Renders an OPML item based on fields.

Plugin annotation


@ViewsRow(
  id = "opml_fields",
  title = @Translation("OPML fields"),
  help = @Translation("Display fields as OPML items."),
  theme = "views_view_row_opml",
  display_types = {"feed"}
)

Hierarchy

Expanded class hierarchy of OpmlFields

File

core/modules/views/src/Plugin/views/row/OpmlFields.php, line 23
Contains \Drupal\views\Plugin\views\row\OpmlFields.

Namespace

Drupal\views\Plugin\views\row
View source 
class OpmlFields extends RowPluginBase {

  /**
   * Does the row plugin support to add fields to it's output.
   *
   * @var bool
   */
  protected $usesFields = TRUE;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['text_field'] = array(
      'default' => '',
    );
    $options['created_field'] = array(
      'default' => '',
    );
    $options['type_field'] = array(
      'default' => '',
    );
    $options['description_field'] = array(
      'default' => '',
    );
    $options['html_url_field'] = array(
      'default' => '',
    );
    $options['language_field'] = array(
      'default' => '',
    );
    $options['xml_url_field'] = array(
      'default' => '',
    );
    $options['url_field'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $initial_labels = array(
      '' => $this
        ->t('- None -'),
    );
    $view_fields_labels = $this->displayHandler
      ->getFieldLabels();
    $view_fields_labels = array_merge($initial_labels, $view_fields_labels);
    $types = array(
      'rss' => $this
        ->t('RSS'),
      'link' => $this
        ->t('Link'),
      'include' => $this
        ->t('Include'),
    );
    $types = array_merge($initial_labels, $types);
    $form['type_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Type attribute'),
      '#description' => $this
        ->t('The type of this row.'),
      '#options' => $types,
      '#default_value' => $this->options['type_field'],
    );
    $form['text_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Text attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML text attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['text_field'],
      '#required' => TRUE,
    );
    $form['created_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Created attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML created attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['created_field'],
    );
    $form['description_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Description attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML description attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['description_field'],
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[type_field]"]' => array(
            'value' => 'rss',
          ),
        ),
      ),
    );
    $form['html_url_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('HTML URL attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML htmlUrl attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['html_url_field'],
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[type_field]"]' => array(
            'value' => 'rss',
          ),
        ),
      ),
    );
    $form['language_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Language attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML language attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['language_field'],
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[type_field]"]' => array(
            'value' => 'rss',
          ),
        ),
      ),
    );
    $form['xml_url_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('XML URL attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML text attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['xml_url_field'],
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[type_field]"]' => array(
            'value' => 'rss',
          ),
        ),
      ),
    );
    $form['url_field'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('URL attribute'),
      '#description' => $this
        ->t('The field that is going to be used as the OPML url attribute for each row.'),
      '#options' => $view_fields_labels,
      '#default_value' => $this->options['url_field'],
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[type_field]"]' => array(
            array(
              'value' => 'link',
            ),
            array(
              'value' => 'include',
            ),
          ),
        ),
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function validate() {
    $errors = parent::validate();
    if (empty($this->options['text_field'])) {
      $errors[] = $this
        ->t('Row style plugin requires specifying which views field to use for OPML text attribute.');
    }
    if (!empty($this->options['type_field'])) {
      if ($this->options['type_field'] == 'rss') {
        if (empty($this->options['xml_url_field'])) {
          $errors[] = $this
            ->t('Row style plugin requires specifying which views field to use for XML URL attribute.');
        }
      }
      elseif (in_array($this->options['type_field'], array(
        'link',
        'include',
      ))) {
        if (empty($this->options['url_field'])) {
          $errors[] = $this
            ->t('Row style plugin requires specifying which views field to use for URL attribute.');
        }
      }
    }
    return $errors;
  }

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

    // Create the OPML item array.
    $item = array();
    $row_index = $this->view->row_index;
    $item['text'] = $this
      ->getField($row_index, $this->options['text_field']);
    $item['created'] = $this
      ->getField($row_index, $this->options['created_field']);
    if ($this->options['type_field']) {
      $item['type'] = $this->options['type_field'];
      if ($item['type'] == 'rss') {
        $item['description'] = $this
          ->getField($row_index, $this->options['description_field']);
        $item['language'] = $this
          ->getField($row_index, $this->options['language_field']);
        $item['xmlUrl'] = $this
          ->getField($row_index, $this->options['xml_url_field']);
        $item['htmlUrl'] = $this
          ->getField($row_index, $this->options['html_url_field']);
      }
      else {
        $item['url'] = $this
          ->getField($row_index, $this->options['url_field']);
      }
    }

    // Remove empty attributes.
    $item = array_filter($item);
    $build = array(
      '#theme' => $this
        ->themeFunctions(),
      '#view' => $this->view,
      '#options' => $this->options,
      '#row' => $item,
      '#field_alias' => isset($this->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
   *   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 (string) $this->view->style_plugin
      ->getField($index, $field_id);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
OpmlFields::$usesFields protected property Does the row plugin support to add fields to it's output. Overrides RowPluginBase::$usesFields
OpmlFields::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
OpmlFields::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions
OpmlFields::getField public function Retrieves a views field value from the style plugin.
OpmlFields::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render
OpmlFields::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
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.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 2
PluginBase::$view public property The top object of a view. 1
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 20
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 50
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
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::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::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
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 1
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 function Returns the usesFields property. 4
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.