class Grid

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

Style plugin to render each item in a grid cell.

Hierarchy

Expanded class hierarchy of Grid

Related topics

1 file declares its use of Grid
ViewExecutableTest.php in core/modules/views/tests/src/Kernel/ViewExecutableTest.php
11 string references to 'Grid'
MediaLibraryTestBase::openMediaLibraryForField in core/modules/media_library/tests/src/FunctionalJavascript/MediaLibraryTestBase.php
Clicks a button that opens a media widget and confirms it is open.
MediaLibraryTestBase::switchToMediaLibraryGrid in core/modules/media_library/tests/src/FunctionalJavascript/MediaLibraryTestBase.php
Switches to the grid display of the widget view.
MediaOverviewTest::testAdministrationPage in core/modules/media_library/tests/src/FunctionalJavascript/MediaOverviewTest.php
Tests that the Media Library's administration page works as expected.
media_library.links.task.yml in core/modules/media_library/media_library.links.task.yml
core/modules/media_library/media_library.links.task.yml
views.style.schema.yml in core/modules/views/config/schema/views.style.schema.yml
core/modules/views/config/schema/views.style.schema.yml

... See full list

File

core/modules/views/src/Plugin/views/style/Grid.php, line 15

Namespace

Drupal\views\Plugin\views\style
View source
class Grid extends StylePluginBase {
    
    /**
     * {@inheritdoc}
     */
    protected $usesRowPlugin = TRUE;
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['columns'] = [
            'default' => '4',
        ];
        $options['automatic_width'] = [
            'default' => TRUE,
        ];
        $options['alignment'] = [
            'default' => 'horizontal',
        ];
        $options['col_class_custom'] = [
            'default' => '',
        ];
        $options['col_class_default'] = [
            'default' => TRUE,
        ];
        $options['row_class_custom'] = [
            'default' => '',
        ];
        $options['row_class_default'] = [
            'default' => TRUE,
        ];
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        $form['columns'] = [
            '#type' => 'number',
            '#title' => $this->t('Number of columns'),
            '#default_value' => $this->options['columns'],
            '#required' => TRUE,
            '#min' => 1,
        ];
        $form['automatic_width'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Automatic width'),
            '#description' => $this->t('The width of each column will be calculated automatically based on the number of columns provided. If additional classes are entered or a theme injects classes based on a grid system, disabling this option may prove beneficial.'),
            '#default_value' => $this->options['automatic_width'],
        ];
        $form['alignment'] = [
            '#type' => 'radios',
            '#title' => $this->t('Alignment'),
            '#options' => [
                'horizontal' => $this->t('Horizontal'),
                'vertical' => $this->t('Vertical'),
            ],
            '#default_value' => $this->options['alignment'],
            '#description' => $this->t('Horizontal alignment will place items starting in the upper left and moving right. Vertical alignment will place items starting in the upper left and moving down.'),
        ];
        $form['col_class_default'] = [
            '#title' => $this->t('Default column classes'),
            '#description' => $this->t('Add the default views column classes like views-col, col-1 and clearfix to the output. 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.'),
            '#type' => 'checkbox',
            '#default_value' => $this->options['col_class_default'],
        ];
        $form['col_class_custom'] = [
            '#title' => $this->t('Custom column class'),
            '#description' => $this->t('Additional classes to provide on each column. Separated by a space.'),
            '#type' => 'textfield',
            '#default_value' => $this->options['col_class_custom'],
        ];
        if ($this->usesFields()) {
            $form['col_class_custom']['#description'] .= ' ' . $this->t('You may use field tokens as per the "Replacement patterns" used in "Rewrite the output of this field" for all fields.');
        }
        $form['row_class_default'] = [
            '#title' => $this->t('Default row classes'),
            '#description' => $this->t('Adds the default views row classes like views-row, row-1 and clearfix to the output. 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.'),
            '#type' => 'checkbox',
            '#default_value' => $this->options['row_class_default'],
        ];
        $form['row_class_custom'] = [
            '#title' => $this->t('Custom row class'),
            '#description' => $this->t('Additional classes to provide on each row. Separated by a space.'),
            '#type' => 'textfield',
            '#default_value' => $this->options['row_class_custom'],
        ];
        if ($this->usesFields()) {
            $form['row_class_custom']['#description'] .= ' ' . $this->t('You may use field tokens as per the "Replacement patterns" used in "Rewrite the output of this field" for all fields.');
        }
    }
    
    /**
     * Return the token-replaced row or column classes for the specified result.
     *
     * @param int $result_index
     *   The delta of the result item to get custom classes for.
     * @param string $type
     *   The type of custom grid class to return, either "row" or "col".
     *
     * @return string
     *   A space-delimited string of classes.
     */
    public function getCustomClass($result_index, $type) {
        $class = $this->options[$type . '_class_custom'];
        if ($this->usesFields() && $this->view->field) {
            $class = strip_tags($this->tokenizeValue($class, $result_index));
        }
        $classes = explode(' ', $class);
        foreach ($classes as &$class) {
            $class = Html::cleanCssIdentifier($class);
        }
        return implode(' ', $classes);
    }

}

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
Grid::$usesRowPlugin protected property Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
Grid::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
Grid::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
Grid::getCustomClass public function Return the token-replaced row or column classes for the specified result.
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::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::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 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. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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
StylePluginBase::$render_tokens public property
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::$usesGrouping protected property Does the style plugin support grouping of rows. 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 Determines if the style handler should interfere with sorts. 1
StylePluginBase::buildSortPost public function Allows the view builder to build a second set of sorts. 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 Determines if the style plugin is rendered even if the view is empty. 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::render public function Render the display in this style. 7
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. 11
StylePluginBase::usesTokens public function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
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.

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