class views_plugin_row

Default plugin to view a single row of a table. This is really just a wrapper around a theme function.

Hierarchy

Expanded class hierarchy of views_plugin_row

Related topics

File

plugins/views_plugin_row.inc, line 23

View source
class views_plugin_row extends views_plugin {
    
    /**
     * {@inheritdoc}
     */
    public function init(&$view, &$display, $options = NULL) {
        $this->view =& $view;
        $this->display =& $display;
        // Overlay incoming options on top of defaults.
        $this->unpack_options($this->options, isset($options) ? $options : $display->handler
            ->get_option('row_options'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function uses_fields() {
        return !empty($this->definition['uses fields']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        if (isset($this->base_table)) {
            $options['relationship'] = array(
                'default' => 'none',
            );
        }
        return $options;
    }
    
    /**
     * Provide a form for setting options.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        if (isset($this->base_table)) {
            $view =& $form_state['view'];
            // A whole bunch of code to figure out what relationships are valid for
            // this item.
            $relationships = $view->display_handler
                ->get_option('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($view, $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 options_validate(&$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 options_submit(&$form, &$form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    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 array $result
     *   The full array of results from the query.
     */
    public 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.
     */
    public function render($row) {
        return theme($this->theme_functions(), array(
            'view' => $this->view,
            'options' => $this->options,
            'row' => $row,
            'field_alias' => isset($this->field_alias) ? $this->field_alias : '',
        ));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so
that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_row::init public function 2
views_plugin_row::options_form public function Provide a form for setting options. Overrides views_plugin::options_form 9
views_plugin_row::options_submit 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 views_plugin::options_submit 1
views_plugin_row::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition 9
views_plugin_row::pre_render public function Allow the style to do stuff before each row is rendered. 5
views_plugin_row::query public function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::render public function Render a row object. This usually passes through to a theme template
of some form, but not always.
7
views_plugin_row::uses_fields public function