class panels_views_plugin_row_fields in Panels 7.3
Same name and namespace in other branches
- 6.3 plugins/views/panels_views_plugin_row_fields.inc \panels_views_plugin_row_fields
The basic 'fields' row plugin.
This displays fields one after another, giving options for inline or not.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_row
- class \views_plugin_row_fields
- class \views_plugin_row
- class \views_plugin
Expanded class hierarchy of panels_views_plugin_row_fields
1 string reference to 'panels_views_plugin_row_fields'
- panels_views_plugins in plugins/
views/ panels.views.inc - Implementation of hook_views_plugins.
File
- plugins/
views/ panels_views_plugin_row_fields.inc, line 15 - Contains the base row style plugin.
View source
class panels_views_plugin_row_fields extends views_plugin_row_fields {
function option_definition() {
$options = parent::option_definition();
$options['layout'] = array(
'default' => 'twocol',
);
$options['regions'] = array(
'default' => array(),
);
return $options;
}
/**
* Provide a form for setting options.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
ctools_include('plugins', 'panels');
$layouts = panels_get_layouts();
$options = array();
foreach ($layouts as $name => $layout) {
if (empty($layout['builder'])) {
$options[$name] = $layout['title'];
}
if ($name == $this->options['layout']) {
$current_layout = $layout;
}
}
$form['layout'] = array(
'#prefix' => '<div class="container-inline">',
'#type' => 'select',
'#options' => $options,
'#title' => t('Panel layout'),
'#default_value' => $this->options['layout'],
);
$form['change'] = array(
'#type' => 'submit',
'#value' => t('Change'),
'#submit' => array(
'panels_change_layout_button',
),
'#suffix' => '</div>',
);
if (!empty($current_layout)) {
$fields = $this->display->handler
->get_field_labels();
$regions = panels_get_regions($current_layout, panels_new_display());
foreach ($fields as $id => $title) {
$form['regions'][$id] = array(
'#type' => 'select',
'#title' => $title,
'#options' => $regions,
);
if (!empty($this->options['regions'][$id]) && !empty($regions[$this->options['regions'][$id]])) {
$form['regions'][$id]['#default_value'] = $this->options['regions'][$id];
}
}
}
}
/**
* Perform any necessary changes to the form values prior to storage.
* There is no need for this function to actually store the data.
*/
function options_submit(&$form, &$form_state) {
$form_state['values']['row_options']['inline'] = array_filter($form_state['values']['row_options']['inline']);
}
/**
* Render a row object. This usually passes through to a theme template
* of some form, but not always.
*/
function render($row) {
ctools_include('plugins', 'panels');
$layout = panels_get_layout($this->options['layout']);
if (!$layout) {
// Fall back to normal behavior if the layout is somehow invalid. This
// can happen if the layout was removed, for example.
return theme($this
->theme_functions(), array(
'view' => $this->view,
'options' => $this->options,
'row' => $row,
));
}
// Store a backup copy of the array because we're going to be screwing
// with this a lot.
$fields = $this->view->field;
unset($this->view->field);
$meta = 'standard';
// This row style gets run many times; only run this code once.
if (empty($this->region_fields)) {
$this->region_fields = array();
$regions = panels_get_regions($layout, panels_new_display());
// Ensure each region has an empty array.
foreach ($regions as $region_id => $name) {
if (empty($default_region)) {
$default_region = $region_id;
}
$this->region_fields[$region_id] = array();
}
// Go through all our fields and place them in regions according to the
// settings.
foreach ($fields as $id => $field) {
$region_id = '';
// ensure we don't accidentlly use the last field's region.
if (!empty($this->options['regions'][$id]) && !empty($regions[$this->options['regions'][$id]])) {
$region_id = $this->options['regions'][$id];
}
else {
// Fallback to putting unknown fields into the first region.
$region_id = $default_region;
}
// Ensure this works in PHP4 by keeping the reference.
$this->region_fields[$region_id][$id] =& $fields[$id];
}
// We don't need to set 'inline' for every record, so we do it inside
// this loop. We do need to set inline if we are in the live preview
// so that the CSS will get transmitted via javascript:
$meta = !empty($this->view->live_preview) ? 'inline' : 'standard';
}
// Now that we have distributed our fields, go through the regions and
// render them into the content array.
foreach ($this->region_fields as $region_id => $fields_list) {
$this->view->field = $fields_list;
$content[$region_id] = theme($this
->theme_functions(), array(
'view' => $this->view,
'options' => $this->options,
'row' => $row,
));
}
// Restore our $fields array.
$this->view->field = $fields;
// Now that we have a rendered content array, render it.
return panels_print_layout($layout, $content, $meta);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
panels_views_plugin_row_fields:: |
function |
Provide a form for setting options. Overrides views_plugin_row_fields:: |
||
panels_views_plugin_row_fields:: |
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 views_plugin_row_fields:: |
||
panels_views_plugin_row_fields:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_plugin_row_fields:: |
||
panels_views_plugin_row_fields:: |
function |
Render a row object. This usually passes through to a theme template
of some form, but not always. Overrides views_plugin_row:: |
||
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin:: |
public | function | Validate that the plugin is correct and can be saved. | 3 |
views_plugin_row:: |
public | function | 2 | |
views_plugin_row:: |
public | function |
Validate the options form. Overrides views_plugin:: |
|
views_plugin_row:: |
public | function | Allow the style to do stuff before each row is rendered. | 5 |
views_plugin_row:: |
public | function |
Add anything to the query that we might need to. Overrides views_plugin:: |
|
views_plugin_row:: |
public | function |