You are here

Home » API reference » Field Formatter Template 8 » ViewFormatterTemplate.php

class ViewFormatterTemplate in Field Formatter Template 8

Same name and namespace in other branches
  1. 8.2 modules/vff/src/Plugin/views/style/ViewFormatterTemplate.php \Drupal\vff\Plugin\views\style\ViewFormatterTemplate

Style plugin to render each item in an ordered or unordered list.

Plugin annotation


@ViewsStyle(
  id = "views_formatter_template",
  title = @Translation("View Formatter Template"),
  help = @Translation("Displays rows in a Bootstrap Grid layout"),
  theme = "views_formatter_template",
  theme_file = "../vff.theme.inc",
  display_types = {"normal"}
)

Hierarchy

Expanded class hierarchy of ViewFormatterTemplate

File

modules/vff/src/Plugin/views/style/ViewFormatterTemplate.php, line 22

Namespace

Drupal\vff\Plugin\views\style
View source 
class ViewFormatterTemplate extends StylePluginBase {

  /**
   * Overrides \Drupal\views\Plugin\views\style\StylePluginBase::usesRowPlugin.
   *
   * @var bool
   */
  protected $usesRowPlugin = TRUE;

  /**
   * Overrides \Drupal\views\Plugin\views\style\StylePluginBase::usesRowClass.
   *
   * @var bool
   */
  protected $usesRowClass = TRUE;

  /**
   * Does the style plugin support grouping of rows.
   *
   * @var bool
   */
  protected $usesGrouping = FALSE;

  /**
   * Definition.
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['template'] = [
      'default' => '',
    ];
    $options['render_type'] = [
      'default' => 'raw',
    ];
    $options['vff_tree_field'] = [
      'default' => '',
    ];
    $options['vff_tree_parent_field'] = [
      'default' => '',
    ];
    $options['vff_clean_template'] = [
      'default' => '',
    ];
    $options['show_empty'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $fft_templates = fft_get_templates('views');
    $form['template'] = [
      '#title' => $this
        ->t('Template'),
      '#type' => 'select',
      '#options' => $fft_templates['templates'],
      '#default_value' => $this->options['template'],
      '#attributes' => [
        'class' => [
          'fft-template',
        ],
      ],
    ];
    $form['render_type'] = [
      '#title' => $this
        ->t('Field Render Format'),
      '#type' => 'select',
      '#options' => [
        'raw' => 'Raw',
        'styled' => 'Styled',
      ],
      '#default_value' => $this->options['render_type'],
      '#description' => $this
        ->t('Select field render format.'),
    ];
    $field_labels = $this->displayHandler
      ->getFieldLabels(TRUE);
    $form['fields_available'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Fields available for Twig template'),
      '#markup' => json_encode($field_labels),
      '#states' => [
        'visible' => [
          ':input[name="style_options[render_type]"]' => [
            'value' => 'raw',
          ],
        ],
      ],
    ];
    $form['vff_clean_template'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use Clean Template'),
      '#description' => $this
        ->t('Use this checkbox to use clean template. The output will remove wrapper div with view-id,view-content...'),
      '#required' => FALSE,
      '#return_value' => 1,
      '#default_value' => $this->options['vff_clean_template'],
    ];
    $options = [
      '' => $this
        ->t('- None -'),
    ];
    $field_labels = $this->displayHandler
      ->getFieldLabels(TRUE);
    $options += $field_labels;
    if (count($options) > 1) {
      $form['vff_tree_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Tree id field'),
        '#options' => $options,
        '#default_value' => $this->options['vff_tree_field'],
        '#description' => $this
          ->t('Select field id used as parent to build array tree. Useful for build taxonomy tree.'),
        '#group' => 'vff_tree',
      ];
      $form['vff_tree_parent_field'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Tree parent id field'),
        '#options' => $options,
        '#default_value' => $this->options['vff_tree_parent_field'],
        '#description' => $this
          ->t('Select field parent id used as parent to build array tree. Useful for build taxonomy tree.'),
        '#group' => 'vff_tree',
      ];
    }
    $form['show_empty'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show template when empty'),
      '#default_value' => $this->options['show_empty'],
      '#description' => $this
        ->t('Per default the template is hidden for an empty view. With this option it is possible to show an empty template.'),
    ];
    parent::buildOptionsForm($form, $form_state);
  }

  /**
   * Get rendered fields.
   *
   * @return array|null
   *   Return rendered field.
   */
  public function getRenderedFields() {
    return $this->rendered_fields;
  }

  /** @inheritdoc */
  public function evenEmpty() {
    return !empty($this->options['show_empty']) || parent::evenEmpty();
  }

}

Members

Namesort descending 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
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::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
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::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.
ViewFormatterTemplate::$usesGrouping protected property Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
ViewFormatterTemplate::$usesRowClass protected property Overrides \Drupal\views\Plugin\views\style\StylePluginBase::usesRowClass. Overrides StylePluginBase::$usesRowClass
ViewFormatterTemplate::$usesRowPlugin protected property Overrides \Drupal\views\Plugin\views\style\StylePluginBase::usesRowPlugin. Overrides StylePluginBase::$usesRowPlugin
ViewFormatterTemplate::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
ViewFormatterTemplate::defineOptions protected function Definition. Overrides StylePluginBase::defineOptions
ViewFormatterTemplate::evenEmpty public function @inheritdoc Overrides StylePluginBase::evenEmpty
ViewFormatterTemplate::getRenderedFields public function Get rendered fields.