class Fields

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

The basic 'fields' row plugin.

This displays fields one after another, giving options for inline or not.

Hierarchy

Expanded class hierarchy of Fields

Related topics

2 files declare their use of Fields
StyleTest.php in core/modules/views/tests/src/Kernel/Plugin/StyleTest.php
ViewExecutableTest.php in core/modules/views/tests/src/Kernel/ViewExecutableTest.php
308 string references to 'Fields'
AddFormBase::buildEntityFormElement in core/modules/media_library/src/Form/AddFormBase.php
Builds the sub-form for setting required fields on a new media item.
CachePluginBase::getRowCacheKeys in core/modules/views/src/Plugin/views/cache/CachePluginBase.php
Returns the row cache keys.
Comment::rowStyleOptions in core/modules/comment/src/Plugin/views/wizard/Comment.php
Retrieves row style plugin names.
CommentDepthTest::testCommentDepth in core/modules/comment/tests/src/Kernel/Views/CommentDepthTest.php
Test the comment depth.
CommentLinksTest::testLinkApprove in core/modules/comment/tests/src/Kernel/Views/CommentLinksTest.php
Tests the comment approve link.

... See full list

File

core/modules/views/src/Plugin/views/row/Fields.php, line 17

Namespace

Drupal\views\Plugin\views\row
View source
class Fields extends RowPluginBase {
    
    /**
     * Does the row plugin support to add fields to its output.
     *
     * @var bool
     */
    protected $usesFields = TRUE;
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['inline'] = [
            'default' => [],
        ];
        $options['separator'] = [
            'default' => '',
        ];
        $options['hide_empty'] = [
            'default' => FALSE,
        ];
        $options['default_field_elements'] = [
            'default' => TRUE,
        ];
        return $options;
    }
    
    /**
     * Provide a form for setting options.
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        $options = $this->displayHandler
            ->getFieldLabels();
        if (empty($this->options['inline'])) {
            $this->options['inline'] = [];
        }
        $form['default_field_elements'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Provide default field wrapper elements'),
            '#default_value' => $this->options['default_field_elements'],
            '#description' => $this->t('If not checked, fields that are not configured to customize their HTML elements will get no wrappers at all for their field, label and field + label wrappers. You can use this to quickly reduce the amount of markup the view provides by default, at the cost of making it more difficult to apply CSS.'),
        ];
        $form['inline'] = [
            '#type' => 'checkboxes',
            '#title' => $this->t('Inline fields'),
            '#options' => $options,
            '#default_value' => $this->options['inline'],
            '#description' => $this->t('Inline fields will be displayed next to each other rather than one after another. Note that some fields will ignore this if they are block elements, particularly body fields and other formatted HTML.'),
            '#states' => [
                'visible' => [
                    ':input[name="row_options[default_field_elements]"]' => [
                        'checked' => TRUE,
                    ],
                ],
            ],
        ];
        $form['separator'] = [
            '#title' => $this->t('Separator'),
            '#type' => 'textfield',
            '#size' => 10,
            '#default_value' => $this->options['separator'] ?? '',
            '#description' => $this->t('The separator may be placed between inline fields to keep them from squishing up next to each other. You can use HTML in this field.'),
            '#states' => [
                'visible' => [
                    ':input[name="row_options[default_field_elements]"]' => [
                        'checked' => TRUE,
                    ],
                ],
            ],
        ];
        $form['hide_empty'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Hide empty fields'),
            '#default_value' => $this->options['hide_empty'],
            '#description' => $this->t('Do not display fields, labels or markup for fields that are empty.'),
        ];
    }
    
    /**
     * Perform any necessary changes to the form values prior to storage.
     *
     * There is no need for this function to actually store the data.
     */
    public function submitOptionsForm(&$form, FormStateInterface $form_state) {
        $inline = $form_state->getValue([
            'row_options',
            'inline',
        ]);
        $form_state->setValue([
            'row_options',
            'inline',
        ], array_filter($inline));
    }

}

Members

Title Sort descending Deprecated 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
Fields::$usesFields protected property Does the row plugin support to add fields to its output. Overrides RowPluginBase::$usesFields
Fields::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm 1
Fields::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions 1
Fields::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. Overrides RowPluginBase::submitOptionsForm
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 60
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::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. 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. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
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::render public function Renders a row object. 9
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.
TrustedCallbackInterface::TRIGGER_WARNING Deprecated constant Untrusted callbacks trigger E_USER_WARNING errors.

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