You are here

Home » API reference » A Simple Timeline 7 » simple_timeline_row_plugin.inc

class simple_timeline_row_plugin in A Simple Timeline 7

Row plugin to render each item on a simple timeline.

Hierarchy

Expanded class hierarchy of simple_timeline_row_plugin

2 string references to 'simple_timeline_row_plugin'
simple_timeline_style_plugin::validate in ./simple_timeline_style_plugin.inc
Validate whether this plugin is configured correctly.
simple_timeline_views_plugins in ./simple_timeline.views.inc
Implements hook_views_plugin().

File

./simple_timeline_row_plugin.inc, line 14
Contains the simple timeline row plugin. Created by JetBrains PhpStorm. User: alan

View source 
class simple_timeline_row_plugin extends views_plugin_row {

  /**
   * Extends the default options inherited by this plugin.
   *
   * @return array
   *   The list of options provided by this plugin.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['simple_timeline_date'] = array(
      'default' => array(),
    );
    $options['simple_timeline_date_separator'] = array(
      'default' => array(),
    );
    $options['simple_timeline_text'] = array(
      'default' => array(),
    );
    $options['simple_timeline_text_separator'] = array(
      'default' => array(),
    );
    $options['simple_timeline_image'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * Extends the options form inherited by this plugin.
   *
   * @param array $form
   *   The form being generated.
   * @param array $form_state
   *   The state that the form has been posted in.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['simple_timeline_date'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Timeline Date fields'),
      '#options' => $this->display->handler
        ->get_field_labels(),
      '#default_value' => $this->options['simple_timeline_date'],
      '#description' => t('Selected fields will be displayed next to each other in the Date section.'),
    );
    $form['simple_timeline_date_separator'] = array(
      '#title' => t('Date Separator'),
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $this->options['simple_timeline_date_separator'],
      '#description' => t('The separator may be placed between inline fields to keep them from squishing up next to each other. You can use HTML in this field.'),
    );
    $form['simple_timeline_text'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Timeline Text fields'),
      '#options' => $this->display->handler
        ->get_field_labels(),
      '#default_value' => $this->options['simple_timeline_text'],
      '#description' => t('Selected fields will be displayed next to each other in the Text section'),
    );
    $form['simple_timeline_text_separator'] = array(
      '#title' => t('Text Separator'),
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $this->options['simple_timeline_text_separator'],
      '#description' => t('The separator may be placed between inline fields to keep them from squishing up next to each other. You can use HTML in this field.'),
    );
    $form['simple_timeline_image'] = array(
      '#type' => 'radios',
      '#title' => t('Timeline Image field'),
      '#options' => $this->display->handler
        ->get_field_labels(),
      '#default_value' => $this->options['simple_timeline_image'],
      '#description' => t('The image to be displayed with each item'),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
simple_timeline_row_plugin::options_form public function Extends the options form inherited by this plugin. Overrides views_plugin_row::options_form
simple_timeline_row_plugin::option_definition public function Extends the default options inherited by this plugin. Overrides views_plugin_row::option_definition
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 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_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::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