class OpmlFields

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/row/OpmlFields.php \Drupal\views\Plugin\views\row\OpmlFields
  2. 8.9.x core/modules/views/src/Plugin/views/row/OpmlFields.php \Drupal\views\Plugin\views\row\OpmlFields
  3. 10 core/modules/views/src/Plugin/views/row/OpmlFields.php \Drupal\views\Plugin\views\row\OpmlFields

Renders an OPML item based on fields.

Hierarchy

Expanded class hierarchy of OpmlFields

File

core/modules/views/src/Plugin/views/row/OpmlFields.php, line 12

Namespace

Drupal\views\Plugin\views\row
View source
class OpmlFields extends RowPluginBase {
    
    /**
     * Does the row plugin support to add fields to its output.
     *
     * @var bool
     */
    protected $usesFields = TRUE;
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['text_field'] = [
            'default' => '',
        ];
        $options['created_field'] = [
            'default' => '',
        ];
        $options['type_field'] = [
            'default' => '',
        ];
        $options['description_field'] = [
            'default' => '',
        ];
        $options['html_url_field'] = [
            'default' => '',
        ];
        $options['language_field'] = [
            'default' => '',
        ];
        $options['xml_url_field'] = [
            'default' => '',
        ];
        $options['url_field'] = [
            'default' => '',
        ];
        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);
        $types = [
            'rss' => $this->t('RSS'),
            'link' => $this->t('Link'),
            'include' => $this->t('Include'),
        ];
        $types = array_merge($initial_labels, $types);
        $form['type_field'] = [
            '#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'] = [
            '#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'] = [
            '#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'] = [
            '#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' => [
                'visible' => [
                    ':input[name="row_options[type_field]"]' => [
                        'value' => 'rss',
                    ],
                ],
            ],
        ];
        $form['html_url_field'] = [
            '#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' => [
                'visible' => [
                    ':input[name="row_options[type_field]"]' => [
                        'value' => 'rss',
                    ],
                ],
            ],
        ];
        $form['language_field'] = [
            '#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' => [
                'visible' => [
                    ':input[name="row_options[type_field]"]' => [
                        'value' => 'rss',
                    ],
                ],
            ],
        ];
        $form['xml_url_field'] = [
            '#type' => 'select',
            '#title' => $this->t('XML URL attribute'),
            '#description' => $this->t('The field that is going to be used as the OPML XML URL attribute for each row.'),
            '#options' => $view_fields_labels,
            '#default_value' => $this->options['xml_url_field'],
            '#states' => [
                'visible' => [
                    ':input[name="row_options[type_field]"]' => [
                        'value' => 'rss',
                    ],
                ],
            ],
        ];
        $form['url_field'] = [
            '#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' => [
                'visible' => [
                    ':input[name="row_options[type_field]"]' => [
                        [
                            'value' => 'link',
                        ],
                        [
                            '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'], [
                '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 = [];
        $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 = [
            '#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
     *   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

Title Sort descending 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
OpmlFields::$usesFields protected property Does the row plugin support to add fields to its 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 Renders a row object. Overrides RowPluginBase::render
OpmlFields::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
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 61
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. 7
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3
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
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.