You are here

Home » API reference » Views Row Insert 7 » views_row_insert_plugin_style_custom_row.inc

class views_row_insert_plugin_style_custom_row in Views Row Insert 7

Defines a style plugin that adds custom row after every nth view rows.

Hierarchy

Expanded class hierarchy of views_row_insert_plugin_style_custom_row

1 string reference to 'views_row_insert_plugin_style_custom_row'
views_row_insert_views_plugins in ./views_row_insert.views.inc
Implements hook_views_plugins().

File

./views_row_insert_plugin_style_custom_row.inc, line 13
Contains Views Row Insert style plugin.

View source 
class views_row_insert_plugin_style_custom_row extends views_plugin_style {

  /**
   * Overrides views_plugin_style::options_definition().
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['use_plugin'] = array(
      'default' => 1,
    );
    $options['data_mode'] = array(
      'default' => 'block',
    );
    $options['rows_number'] = array(
      'default' => 2,
    );
    $options['class_name'] = array(
      'default' => '',
    );
    $options['block_name'] = array(
      'default' => '',
    );
    $options['exclude_classes'] = array(
      'default' => 0,
    );
    $options['custom_row_data'] = array(
      'default' => '<strong>Your HTML is here</strong>',
    );
    $options['show_method'] = array(
      'default' => 0,
    );
    $options['default_rows'] = array(
      'default' => 1,
    );
    $options['strip_rows'] = array(
      'default' => 1,
    );
    $options['row_header'] = array(
      'default' => 0,
    );
    $options['row_footer'] = array(
      'default' => 0,
    );
    $options['row_limit_flag'] = array(
      'default' => 0,
    );
    $options['row_limit'] = array(
      'default' => 0,
    );
    $options['row_class'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Overrides views_plugin_style::options_form().
   *
   * @inheritdoc
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Make sure we are compatible with the previous version.
    if (!empty($this->options['show_method'])) {
      $row_limit = 1;
      $row_limit_flag = 1;
      $this->options['show_method'] = 0;
    }
    else {
      $row_limit = $this->options['row_limit'];
      $row_limit_flag = $this->options['row_limit_flag'];
    }
    $form['use_plugin'] = array(
      '#type' => 'checkbox',
      '#title' => t('Use this plugin'),
      '#default_value' => $this->options['use_plugin'],
      '#description' => t('Check if you want to use this plugin.'),
    );
    $form['data_mode'] = array(
      '#type' => 'radios',
      '#title' => t('Row type'),
      '#options' => [
        'block' => 'Block',
        'text' => 'Custom content',
      ],
      '#default_value' => $this->options['data_mode'],
    );
    $form['block_name'] = array(
      '#type' => 'select',
      '#title' => t('Select a block'),
      '#options' => _views_row_insert_get_blocks(),
      '#default_value' => $this->options['block_name'],
      '#description' => t('Select a block to insert instead of using custom content.'),
    );
    $form['custom_row_data'] = array(
      '#type' => 'textarea',
      '#title' => t('Custom content'),
      '#default_value' => $this->options['custom_row_data'],
      '#description' => t('Enter text or html code.'),
    );
    $form['rows_number'] = array(
      '#type' => 'textfield',
      '#attributes' => array(
        ' type' => 'number',
        'min' => 1,
      ),
      '#title' => t('Insert after every Nth row'),
      '#default_value' => $this->options['rows_number'],
      '#description' => t('Number of rows to skip.'),
    );
    $form['row_header'] = array(
      '#type' => 'checkbox',
      '#title' => t('Start with inserted row'),
      '#default_value' => $this->options['row_header'],
      '#description' => t('Check if you want to insert the row at the beginning of your output.'),
    );
    $form['row_footer'] = array(
      '#type' => 'checkbox',
      '#title' => t('Insert row at the bottom'),
      '#default_value' => $this->options['row_footer'],
      '#description' => t('If possible, the row will be added at the bottom of your output.'),
    );
    $form['row_limit_flag'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit the amount of inserted rows'),
      '#default_value' => $row_limit_flag,
      '#description' => t('Check if you want to specify the amount of inserted rows.'),
    );
    $form['row_limit'] = array(
      '#type' => 'textfield',
      '#attributes' => array(
        ' type' => 'number',
        'min' => 0,
      ),
      '#title' => t('How many times to display the row?'),
      '#default_value' => $row_limit,
      '#description' => t('Set display limit number of inserted rows per page, 0 - no limitations.'),
    );
    $form['class_name'] = array(
      '#title' => t('Insert row class name(s)'),
      '#type' => 'textfield',
      '#default_value' => $this->options['class_name'],
      '#description' => t('If specified, the inserted row will be wrapped by div element with above classes.'),
    );
    $form['row_class'] = array(
      '#title' => t('Row class'),
      '#type' => 'textfield',
      '#default_value' => $this->options['row_class'],
      '#description' => t('The class to provide on each original row from the view output.'),
    );
    $form['default_rows'] = array(
      '#type' => 'checkbox',
      '#title' => t('Add views row classes'),
      '#default_value' => $this->options['default_rows'],
      '#description' => t('Add the default row classes like views-row-1 to the output. You can use this to quickly reduce the amount of markup the view provides by default, at the cost of making it more difficult to apply CSS.'),
    );
    $form['strip_rows'] = array(
      '#type' => 'checkbox',
      '#title' => t('Add striping (odd/even), first/last row classes'),
      '#default_value' => $this->options['strip_rows'],
      '#description' => t('Add css classes to the first and last line, as well as odd/even classes for striping.'),
    );
    $form['exclude_classes'] = array(
      '#type' => 'checkbox',
      '#title' => t('Do not apply the default classes to created row'),
      '#default_value' => $this->options['exclude_classes'],
      '#description' => t('Check if you want to exclude the default row classes and striping (odd/even), first/last classes from adding to this row.'),
    );
    $form['#attached']['js'] = array(
      drupal_get_path('module', 'views_row_insert') . '/js/helper.js',
    );
    $form['#attached']['js'][] = array(
      'type' => 'setting',
      'data' => array(
        'views_row_insert' => array(
          'data_mode' => $this->options['data_mode'],
          'row_limit_flag' => $row_limit_flag,
        ),
      ),
    );
  }

}

Members

Namesort descending Modifiers Type Description 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 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::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::options_submit public function Handle any special handling on the validate form. 9
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_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public 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
views_plugin_style::build_sort_post public 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
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render public function Render the display in this style. 5
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::render_grouping_sets public function Render the grouping sets.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_row_insert_plugin_style_custom_row::options_form function Overrides views_plugin_style::options_form(). Overrides views_plugin_style::options_form
views_row_insert_plugin_style_custom_row::option_definition function Overrides views_plugin_style::options_definition(). Overrides views_plugin_style::option_definition