class MappingTest

Provides a test plugin for the mapping style.

Plugin annotation


@Plugin(
  id = "mapping_test",
  title = @Translation("Field mapping"),
  help = @Translation("Maps specific fields to specific purposes."),
  theme = "views_view_mapping_test",
  type = "normal"
)

Hierarchy

Expanded class hierarchy of MappingTest

Related topics

Views style plugins
Style plugins control how a view is rendered. For example, they can choose to display a collection of fields, node_view() output, table output, or any kind of crazy output they want.

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/style/MappingTest.php, line 28
Definition of Drupal\views_test_data\Plugin\views\style\MappingTest;

Namespace

Drupal\views_test_data\Plugin\views\style
View source
class MappingTest extends Mapping {

  /**
   * Overrides Drupal\views\Plugin\views\style\Mapping::defineMapping().
   */
  protected function defineMapping() {
    return array(
      'title_field' => array(
        '#title' => t('Title field'),
        '#description' => t('Choose the field with the custom title.'),
        '#toggle' => TRUE,
        '#required' => TRUE,
      ),
      'name_field' => array(
        '#title' => t('Name field'),
        '#description' => t('Choose the field with the custom name.'),
      ),
      'numeric_field' => array(
        '#title' => t('Numeric field'),
        '#description' => t('Select one or more numeric fields.'),
        '#multiple' => TRUE,
        '#toggle' => TRUE,
        '#filter' => 'filterNumericFields',
        '#required' => TRUE,
      ),
    );
  }

  /**
   * Restricts the allowed fields to only numeric fields.
   *
   * @param array $fields
   *   An array of field labels, keyed by the field ID.
   */
  protected function filterNumericFields(&$fields) {
    foreach ($this->view->field as $id => $field) {
      if (!$field instanceof Numeric) {
        unset($fields[$id]);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Mapping::$usesFields protected property Use fields without a row plugin. Overrides StylePluginBase::$usesFields
Mapping::$usesGrouping protected property Do not use grouping. Overrides StylePluginBase::$usesGrouping
Mapping::buildOptionsForm public function Overrides Drupal\views\Plugin\views\style\StylePluginBase::buildOptionsForm(). Overrides StylePluginBase::buildOptionsForm
Mapping::defineOptions protected function Overrides Drupal\views\Plugin\views\style\StylePluginBase::defineOptions(). Overrides StylePluginBase::defineOptions
Mapping::render function Overrides Drupal\views\Plugin\views\style\StylePluginBase::render(). Overrides StylePluginBase::render
MappingTest::defineMapping protected function Overrides Drupal\views\Plugin\views\style\Mapping::defineMapping(). Overrides Mapping::defineMapping
MappingTest::filterNumericFields protected function Restricts the allowed fields to only numeric fields.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::submitOptionsForm public function Handle any special handling on the validate form. 10
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
StylePluginBase::$row_plugin property Contains the row plugin, if it's initialized and the style itself supports it.
StylePluginBase::$row_tokens property Store all available tokens row rows.
StylePluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass protected property Does the style plugin support custom css class for the rows. 4
StylePluginBase::$usesRowPlugin protected property Does the style plugin allows to use style plugins. 6
StylePluginBase::build_sort 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::build_sort_post 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::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::even_empty function Should the output of the style plugin be rendered even if it's a empty view. 1
StylePluginBase::get_field function Get a rendered field.
StylePluginBase::get_field_value function Get the raw field value.
StylePluginBase::get_row_class function Return the token replaced row class for the specified row.
StylePluginBase::init public function Initialize a style plugin.
StylePluginBase::pre_render 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_fields function Render all of the fields for a given style and store them on the object.
StylePluginBase::render_grouping function Group records as needed for rendering.
StylePluginBase::render_grouping_sets function Render the grouping sets.
StylePluginBase::tokenize_value function Take a value and apply token replacement logic to it.
StylePluginBase::usesFields function Return TRUE if this style also uses fields. 2
StylePluginBase::usesGrouping function Returns the usesGrouping property. 1
StylePluginBase::usesRowClass function Returns the usesRowClass property. 4
StylePluginBase::usesRowPlugin function Returns the usesRowPlugin property. 6
StylePluginBase::uses_tokens 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::wizard_form function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizard_submit function Alter the options of a display before they are added to the view. 1