class Flexbox in Views Flexbox 8

Style plugin to render each item in a flexbox layout.

Plugin annotation


@ViewsStyle(
  id = "flexbox",
  title = @Translation("Flexbox"),
  help = @Translation("Displays Items with Flexbox."),
  theme = "views_view_flexbox",
  display_types = {"normal"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\style\StylePluginBase
    class \Drupal\views_flexbox\Plugin\views\style\Flexbox

Expanded class hierarchy of Flexbox

1 string reference to 'Flexbox'

views.style.schema.yml in config/schema/views.style.schema.yml: config/schema/views.style.schema.yml

File

src/Plugin/views/style/Flexbox.php, line 23

Namespace

Drupal\views_flexbox\Plugin\views\style

View source

class Flexbox extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = TRUE;

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['style'] = [
      'default' => '_none_',
    ];
    $options['link_to_content'] = [
      'default' => FALSE,
    ];
    $options['link_source'] = [
      'default' => NULL,
    ];
    $options['direction'] = [
      'default' => 'row',
    ];
    $options['justify'] = [
      'default' => 'start',
    ];
    $options['align_items'] = [
      'default' => 'stretch',
    ];
    $options['align_content'] = [
      'default' => 'stretch',
    ];
    $options['item_class_default'] = [
      'default' => TRUE,
    ];
    $options['item_class_custom'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Display Style'),
      '#default_value' => $this->options['style'],
      '#required' => TRUE,
      '#options' => [
        '_none_' => $this
          ->t('None'),
        'cards' => $this
          ->t('Card Layout'),
      ],
    ];
    $form['link_to_content'] = [
      '#title' => $this
        ->t('Link to content'),
      '#description' => $this
        ->t('Link card to content.'),
      '#type' => 'checkbox',
      '#default_value' => $this->options['link_to_content'],
      '#states' => [
        // Show this textfield only if the radio 'other' is selected above.
        'visible' => [
          ':input[name="style_options[style]"]' => [
            'value' => 'cards',
          ],
        ],
      ],
    ];
    if ($this
      ->usesFields()) {
      $form['link_source'] = [
        '#title' => $this
          ->t('Link Source'),
        '#description' => $this
          ->t('Link URL. You may use field tokens from as per the "Replacement patterns" used in "Rewrite the output of this field" for all fields.'),
        '#type' => 'textfield',
        '#default_value' => $this->options['link_source'],
        '#states' => [
          // Show this textfield only if the radio 'other' is selected above.
          'visible' => [
            ':input[name="style_options[link_to_content]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    $form['direction'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Flex Direction'),
      '#default_value' => $this->options['direction'],
      '#required' => TRUE,
      '#options' => [
        'row' => $this
          ->t('Row'),
        'row-reverse' => $this
          ->t('Row Reverse'),
        'column' => $this
          ->t('Column'),
        'column-reverse' => $this
          ->t('Column Reverse'),
      ],
    ];
    $form['justify'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Justify Content'),
      '#default_value' => $this->options['justify'],
      '#required' => TRUE,
      '#options' => [
        'start' => $this
          ->t('Start'),
        'end' => $this
          ->t('End'),
        'center' => $this
          ->t('Center'),
        'space-between' => $this
          ->t('Space Between'),
        'space-around' => $this
          ->t('Space Around'),
        'space-evenly' => $this
          ->t('Space Evenly'),
      ],
    ];
    $form['align_items'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Align Items'),
      '#default_value' => $this->options['align_items'],
      '#required' => TRUE,
      '#options' => [
        'start' => $this
          ->t('Start'),
        'end' => $this
          ->t('End'),
        'center' => $this
          ->t('Center'),
        'strech' => $this
          ->t('Stretch'),
        'baseline' => $this
          ->t('Baseline'),
      ],
    ];
    $form['align_content'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Align Content'),
      '#default_value' => $this->options['align_content'],
      '#required' => TRUE,
      '#options' => [
        'start' => $this
          ->t('Start'),
        'end' => $this
          ->t('End'),
        'center' => $this
          ->t('Center'),
        'strech' => $this
          ->t('Stretch'),
        'space-between' => $this
          ->t('Space Between'),
        'space-around' => $this
          ->t('Space Around'),
      ],
    ];
    $form['item_class_default'] = [
      '#title' => $this
        ->t('Default item classes'),
      '#description' => $this
        ->t('Adds the default views style classes like item-1 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['item_class_default'],
    ];
    $form['item_class_custom'] = [
      '#title' => $this
        ->t('Custom item classes'),
      '#description' => $this
        ->t('Additional classes to provide on each item. Separated by a space.'),
      '#type' => 'textfield',
      '#default_value' => $this->options['item_class_custom'],
    ];
    if ($this
      ->usesFields()) {
      $form['item_class_custom']['#description'] .= ' ' . $this
        ->t('You may use field tokens from as per the "Replacement patterns" used in "Rewrite the output of this field" for all fields.');
    }
  }

  /**
   * Return the token-replaced 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 classes to return, either "item".
   *
   * @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);
  }

  /**
   * Return the token-replaced link for the specified result.
   *
   * @param int $result_index
   *   The delta of the result item to get link for.
   *
   * @return string
   *   A string url.
   */
  public function getLinkLocation($result_index) {
    $link = $this->options['link_source'];
    if (!empty($link) && $this
      ->usesFields() && $this->view->field) {
      $link = strip_tags($this
        ->tokenizeValue($link, $result_index));
    }
    elseif (isset($this->view->results[$result_index]) && isset($this->view->results[$result_index]->_entity)) {
      $link = $this->view->results[$result_index]->_entity
        ->toUrl();
    }
    return $link;
  }

}

Members

Name	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
Flexbox::$usesRowPlugin	protected	property	Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
Flexbox::buildOptionsForm	public	function	Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
Flexbox::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
Flexbox::getCustomClass	public	function	Return the token-replaced classes for the specified result.
Flexbox::getLinkLocation	public	function	Return the token-replaced link for the specified result.
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::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	62
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
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::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::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	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
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.
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	Stores the rendered field values, keyed by the row index and field name.
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	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	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	Should the output of the style plugin be rendered even if it's a empty view.	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.	10
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::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
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.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class Flexbox in Views Flexbox 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation