Default plugin to view a single row of a table. This is really just a wrapper around a theme function.
Expanded class hierarchy of RowPluginBase
abstract class RowPluginBase extends PluginBase {
/**
* Overrides Drupal\views\Plugin\Plugin::$usesOptions.
*/
protected $usesOptions = TRUE;
/**
* Does the row plugin support to add fields to it's output.
*
* @var bool
*/
protected $usesFields = FALSE;
/**
* Initialize the row plugin.
*/
public function init(ViewExecutable $view, &$display, $options = NULL) {
$this
->setOptionDefaults($this->options, $this
->defineOptions());
$this->view =& $view;
$this->displayHandler =& $display;
// Overlay incoming options on top of defaults
$this
->unpackOptions($this->options, $options);
}
/**
* Returns the usesFields property.
*
* @return bool
*/
function usesFields() {
return $this->usesFields;
}
protected function defineOptions() {
$options = parent::defineOptions();
if (isset($this->base_table)) {
$options['relationship'] = array(
'default' => 'none',
);
}
return $options;
}
/**
* Provide a form for setting options.
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
if (isset($this->base_table)) {
$executable = $form_state['view']
->get('executable');
// A whole bunch of code to figure out what relationships are valid for
// this item.
$relationships = $executable->display_handler
->getOption('relationships');
$relationship_options = array();
foreach ($relationships as $relationship) {
$relationship_handler = views_get_handler($relationship['table'], $relationship['field'], 'relationship');
// If this relationship is valid for this type, add it to the list.
$data = views_fetch_data($relationship['table']);
$base = $data[$relationship['field']]['relationship']['base'];
if ($base == $this->base_table) {
$relationship_handler
->init($executable, $relationship);
$relationship_options[$relationship['id']] = $relationship_handler
->label();
}
}
if (!empty($relationship_options)) {
$relationship_options = array_merge(array(
'none' => t('Do not use a relationship'),
), $relationship_options);
$rel = empty($this->options['relationship']) ? 'none' : $this->options['relationship'];
if (empty($relationship_options[$rel])) {
// Pick the first relationship.
$rel = key($relationship_options);
}
$form['relationship'] = array(
'#type' => 'select',
'#title' => t('Relationship'),
'#options' => $relationship_options,
'#default_value' => $rel,
);
}
else {
$form['relationship'] = array(
'#type' => 'value',
'#value' => 'none',
);
}
}
}
/**
* Validate the options form.
*/
public function validateOptionsForm(&$form, &$form_state) {
}
/**
* 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, &$form_state) {
}
public function query() {
if (isset($this->base_table)) {
if (isset($this->options['relationship']) && isset($this->view->relationship[$this->options['relationship']])) {
$relationship = $this->view->relationship[$this->options['relationship']];
$this->field_alias = $this->view->query
->add_field($relationship->alias, $this->base_field);
}
else {
$this->field_alias = $this->view->query
->add_field($this->base_table, $this->base_field);
}
}
}
/**
* Allow the style to do stuff before each row is rendered.
*
* @param $result
* The full array of results from the query.
*/
function pre_render($result) {
}
/**
* Render a row object. This usually passes through to a theme template
* of some form, but not always.
*
* @param stdClass $row
* A single row of the query result, so an element of $view->result.
*
* @return string
* The rendered output of a single row, used by the style plugin.
*/
function render($row) {
return array(
'#theme' => $this
->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#row' => $row,
'#field_alias' => isset($this->field_alias) ? $this->field_alias : '',
);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
RowPluginBase:: |
protected | property | Does the row plugin support to add fields to it's output. | 2 |
RowPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
RowPluginBase:: |
public | function |
Provide a form for setting options. Overrides PluginBase:: |
7 |
RowPluginBase:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides PluginBase:: |
7 |
RowPluginBase:: |
public | function | Initialize the row plugin. | 1 |
RowPluginBase:: |
function | Allow the style to do stuff before each row is rendered. | 3 | |
RowPluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides PluginBase:: |
|
RowPluginBase:: |
function | Render a row object. This usually passes through to a theme template of some form, but not always. | 6 | |
RowPluginBase:: |
public | function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides PluginBase:: |
1 |
RowPluginBase:: |
function | Returns the usesFields property. | 2 | |
RowPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |